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 EventTriggerResponse(val eventType: String, val failurePolicy: FailurePolicyResponse, val resource: String, val service: String)

Describes EventTrigger, used to request events 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 FailurePolicyResponse(val retry: RetryResponse)

Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).

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 availableMemoryMb: Int, val buildEnvironmentVariables: Map<String, String>, val buildId: String, val buildName: String, val buildWorkerPool: String, val description: String, val dockerRegistry: String, val dockerRepository: String, val entryPoint: String, val environmentVariables: Map<String, String>, val eventTrigger: EventTriggerResponse, val httpsTrigger: HttpsTriggerResponse, val ingressSettings: String, val kmsKeyName: String, val labels: Map<String, String>, val maxInstances: Int, val minInstances: Int, val name: String, val network: String, val runtime: String, val secretEnvironmentVariables: List<SecretEnvVarResponse>, val secretVolumes: List<SecretVolumeResponse>, val serviceAccountEmail: String, val sourceArchiveUrl: String, val sourceRepository: SourceRepositoryResponse, val sourceToken: String, val sourceUploadUrl: String, val status: String, val timeout: String, val updateTime: String, val versionId: String, val vpcConnector: String, val vpcConnectorEgressSettings: String)
Link copied to clipboard
data class HttpsTriggerResponse(val securityLevel: String, val url: String)

Describes HttpsTrigger, could be used to connect web hooks to function.

Link copied to clipboard

Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution.

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. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.

Link copied to clipboard
data class SourceRepositoryResponse(val deployedUrl: String, val url: String)

Describes SourceRepository, used to represent parameters related to source repository where a function is hosted.