Package-level declarations

Types

Link copied to clipboard
data class AuditConfigResponse(val auditLogConfigs: List<AuditLogConfigResponse>, val service: String)

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Link copied to clipboard
data class AuditLogConfigResponse(val exemptedMembers: List<String>, val logType: String)

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Link copied to clipboard
data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

Link copied to clipboard
data class BuildConfigResponse(val build: String, val dockerRegistry: String, val dockerRepository: String, val entryPoint: String, val environmentVariables: Map<String, String>, val runtime: String, val source: SourceResponse, val sourceProvenance: SourceProvenanceResponse, val workerPool: String)

Describes the Build step of the function that builds a container from the given source.

Link copied to clipboard
data class EventFilterResponse(val attribute: String, val operator: String, val value: String)

Filters events based on exact matches on the CloudEvents attributes.

Link copied to clipboard
data class EventTriggerResponse(val channel: String, val eventFilters: List<EventFilterResponse>, val eventType: String, val pubsubTopic: String, val retryPolicy: String, val serviceAccountEmail: String, val trigger: String, val triggerRegion: String)

Describes EventTrigger, used to request events to be sent from another service.

Link copied to clipboard
data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Link copied to clipboard
data class GetFunctionIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetFunctionResult(val buildConfig: BuildConfigResponse, val description: String, val environment: String, val eventTrigger: EventTriggerResponse, val kmsKeyName: String, val labels: Map<String, String>, val name: String, val serviceConfig: ServiceConfigResponse, val state: String, val stateMessages: List<GoogleCloudFunctionsV2betaStateMessageResponse>, val updateTime: String)
data class GoogleCloudFunctionsV2betaStateMessageResponse(val message: String, val severity: String, val type: String)

Informational messages about the state of the Cloud Function or Operation.

Link copied to clipboard
data class RepoSourceResponse(val branchName: String, val commitSha: String, val dir: String, val invertRegex: Boolean, val project: String, val repoName: String, val tagName: String)

Location of the source in a Google Cloud Source Repository.

Link copied to clipboard
data class SecretEnvVarResponse(val key: String, val project: String, val secret: String, val version: String)

Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable.

Link copied to clipboard
data class SecretVersionResponse(val path: String, val version: String)

Configuration for a single version.

Link copied to clipboard
data class SecretVolumeResponse(val mountPath: String, val project: String, val secret: String, val versions: List<SecretVersionResponse>)

Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container.

Link copied to clipboard
data class ServiceConfigResponse(val allTrafficOnLatestRevision: Boolean, val availableCpu: String, val availableMemory: String, val environmentVariables: Map<String, String>, val ingressSettings: String, val maxInstanceCount: Int, val maxInstanceRequestConcurrency: Int, val minInstanceCount: Int, val revision: String, val secretEnvironmentVariables: List<SecretEnvVarResponse>, val secretVolumes: List<SecretVolumeResponse>, val securityLevel: String, val service: String, val serviceAccountEmail: String, val timeoutSeconds: Int, val uri: String, val vpcConnector: String, val vpcConnectorEgressSettings: String)

Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).

Link copied to clipboard
data class SourceProvenanceResponse(val resolvedRepoSource: RepoSourceResponse, val resolvedStorageSource: StorageSourceResponse)

Provenance of the source. Ways to find the original source, or verify that some source was used for this build.

Link copied to clipboard
data class SourceResponse(val repoSource: RepoSourceResponse, val storageSource: StorageSourceResponse)

The location of the function source code.

Link copied to clipboard
data class StorageSourceResponse(val bucket: String, val generation: String, val object: String)

Location of the source in an archive file in Google Cloud Storage.