Package-level declarations

Types

Link copied to clipboard
data class AddressableResponse(val url: String)

Information for connecting over HTTP(s).

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 ConfigMapEnvSourceResponse(val localObjectReference: LocalObjectReferenceResponse, val name: String, val optional: Boolean)

Not supported by Cloud Run. ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

Link copied to clipboard
data class ConfigMapKeySelectorResponse(val key: String, val localObjectReference: LocalObjectReferenceResponse, val name: String, val optional: Boolean)

Not supported by Cloud Run.

Link copied to clipboard
data class ConfigMapVolumeSourceResponse(val defaultMode: Int, val items: List<KeyToPathResponse>, val name: String, val optional: Boolean)

Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths.

Link copied to clipboard
data class ContainerPortResponse(val containerPort: Int, val name: String, val protocol: String)

ContainerPort represents a network port in a single container.

Link copied to clipboard
data class ContainerResponse(val args: List<String>, val command: List<String>, val env: List<EnvVarResponse>, val envFrom: List<EnvFromSourceResponse>, val image: String, val imagePullPolicy: String, val livenessProbe: ProbeResponse, val name: String, val ports: List<ContainerPortResponse>, val readinessProbe: ProbeResponse, val resources: ResourceRequirementsResponse, val securityContext: SecurityContextResponse, val startupProbe: ProbeResponse, val terminationMessagePath: String, val terminationMessagePolicy: String, val volumeMounts: List<VolumeMountResponse>, val workingDir: String)

A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.

Link copied to clipboard
data class DomainMappingSpecResponse(val certificateMode: String, val forceOverride: Boolean, val routeName: String)

The desired state of the Domain Mapping.

Link copied to clipboard
data class DomainMappingStatusResponse(val conditions: List<GoogleCloudRunV1ConditionResponse>, val mappedRouteName: String, val observedGeneration: Int, val resourceRecords: List<ResourceRecordResponse>, val url: String)

The current state of the Domain Mapping.

Link copied to clipboard
data class EmptyDirVolumeSourceResponse(val medium: String, val sizeLimit: String)

Ephemeral storage which can be backed by real disks (HD, SSD), network storage or memory (i.e. tmpfs). For now only in memory (tmpfs) is supported. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs).

Link copied to clipboard
data class EnvFromSourceResponse(val configMapRef: ConfigMapEnvSourceResponse, val prefix: String, val secretRef: SecretEnvSourceResponse)

Not supported by Cloud Run. EnvFromSource represents the source of a set of ConfigMaps

Link copied to clipboard
data class EnvVarResponse(val name: String, val value: String, val valueFrom: EnvVarSourceResponse)

EnvVar represents an environment variable present in a Container.

Link copied to clipboard
data class EnvVarSourceResponse(val configMapKeyRef: ConfigMapKeySelectorResponse, val secretKeyRef: SecretKeySelectorResponse)

EnvVarSource represents a source for the value of an EnvVar.

Link copied to clipboard
data class ExecActionResponse(val command: List<String>)

Not supported by Cloud Run. ExecAction describes a "run in container" action.

Link copied to clipboard
data class ExecutionReferenceResponse(val completionTimestamp: String, val creationTimestamp: String, val name: String)

Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.

Link copied to clipboard
data class ExecutionSpecResponse(val parallelism: Int, val taskCount: Int, val template: TaskTemplateSpecResponse)

ExecutionSpec describes how the execution will look.

Link copied to clipboard

ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job.

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 GetDomainMappingResult(val apiVersion: String, val kind: String, val metadata: ObjectMetaResponse, val spec: DomainMappingSpecResponse, val status: DomainMappingStatusResponse)
Link copied to clipboard
data class GetJobIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetJobResult(val apiVersion: String, val kind: String, val metadata: ObjectMetaResponse, val spec: JobSpecResponse, val status: JobStatusResponse)
Link copied to clipboard
data class GetServiceIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetServiceResult(val apiVersion: String, val kind: String, val metadata: ObjectMetaResponse, val spec: ServiceSpecResponse, val status: ServiceStatusResponse)
Link copied to clipboard
data class GoogleCloudRunV1ConditionResponse(val lastTransitionTime: String, val message: String, val reason: String, val severity: String, val status: String, val type: String)

Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type "Ready" or "Completed" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.

Link copied to clipboard
data class GRPCActionResponse(val port: Int, val service: String)

GRPCAction describes an action involving a GRPC port.

Link copied to clipboard
data class HTTPGetActionResponse(val host: String, val httpHeaders: List<HTTPHeaderResponse>, val path: String, val port: Int, val scheme: String)

HTTPGetAction describes an action based on HTTP Get requests.

Link copied to clipboard
data class HTTPHeaderResponse(val name: String, val value: String)

HTTPHeader describes a custom header to be used in HTTP probes

Link copied to clipboard

JobSpec describes how the job will look.

Link copied to clipboard
data class JobStatusResponse(val conditions: List<GoogleCloudRunV1ConditionResponse>, val executionCount: Int, val latestCreatedExecution: ExecutionReferenceResponse, val observedGeneration: Int)

JobStatus represents the current state of a Job.

Link copied to clipboard
data class KeyToPathResponse(val key: String, val mode: Int, val path: String)

Maps a string key to a path within a volume.

Link copied to clipboard
data class LocalObjectReferenceResponse(val name: String)

Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Link copied to clipboard
data class ObjectMetaResponse(val annotations: Map<String, String>, val clusterName: String, val creationTimestamp: String, val deletionGracePeriodSeconds: Int, val deletionTimestamp: String, val finalizers: List<String>, val generateName: String, val generation: Int, val labels: Map<String, String>, val name: String, val namespace: String, val ownerReferences: List<OwnerReferenceResponse>, val resourceVersion: String, val selfLink: String, val uid: String)

k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Link copied to clipboard
data class OwnerReferenceResponse(val apiVersion: String, val blockOwnerDeletion: Boolean, val controller: Boolean, val kind: String, val name: String, val uid: String)

This is not supported or used by Cloud Run.

Link copied to clipboard
data class ProbeResponse(val exec: ExecActionResponse, val failureThreshold: Int, val grpc: GRPCActionResponse, val httpGet: HTTPGetActionResponse, val initialDelaySeconds: Int, val periodSeconds: Int, val successThreshold: Int, val tcpSocket: TCPSocketActionResponse, val timeoutSeconds: Int)

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Link copied to clipboard
data class ResourceRecordResponse(val name: String, val rrdata: String, val type: String)

A DNS resource record.

Link copied to clipboard
data class ResourceRequirementsResponse(val limits: Map<String, String>, val requests: Map<String, String>)

ResourceRequirements describes the compute resource requirements.

Link copied to clipboard
data class RevisionSpecResponse(val containerConcurrency: Int, val containers: List<ContainerResponse>, val enableServiceLinks: Boolean, val imagePullSecrets: List<LocalObjectReferenceResponse>, val serviceAccountName: String, val timeoutSeconds: Int, val volumes: List<VolumeResponse>)

RevisionSpec holds the desired state of the Revision (from the client).

Link copied to clipboard

RevisionTemplateSpec describes the data a revision should have when created from a template.

Link copied to clipboard
data class SecretEnvSourceResponse(val localObjectReference: LocalObjectReferenceResponse, val name: String, val optional: Boolean)

Not supported by Cloud Run. SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

Link copied to clipboard
data class SecretKeySelectorResponse(val key: String, val localObjectReference: LocalObjectReferenceResponse, val name: String, val optional: Boolean)

SecretKeySelector selects a key of a Secret.

Link copied to clipboard
data class SecretVolumeSourceResponse(val defaultMode: Int, val items: List<KeyToPathResponse>, val optional: Boolean, val secretName: String)

A volume representing a secret stored in Google Secret Manager. The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names.

Link copied to clipboard
data class SecurityContextResponse(val runAsUser: Int)

Not supported by Cloud Run. SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

Link copied to clipboard

ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s).

Link copied to clipboard
data class ServiceStatusResponse(val address: AddressableResponse, val conditions: List<GoogleCloudRunV1ConditionResponse>, val latestCreatedRevisionName: String, val latestReadyRevisionName: String, val observedGeneration: Int, val traffic: List<TrafficTargetResponse>, val url: String)

The current state of the Service. Output only.

Link copied to clipboard
data class TaskSpecResponse(val containers: List<ContainerResponse>, val maxRetries: Int, val serviceAccountName: String, val timeoutSeconds: String, val volumes: List<VolumeResponse>)

TaskSpec is a description of a task.

Link copied to clipboard

TaskTemplateSpec describes the data a task should have when created from a template.

Link copied to clipboard
data class TCPSocketActionResponse(val host: String, val port: Int)

TCPSocketAction describes an action based on opening a socket

Link copied to clipboard
data class TrafficTargetResponse(val configurationName: String, val latestRevision: Boolean, val percent: Int, val revisionName: String, val tag: String, val url: String)

TrafficTarget holds a single entry of the routing table for a Route.

Link copied to clipboard
data class VolumeMountResponse(val mountPath: String, val name: String, val readOnly: Boolean, val subPath: String)

VolumeMount describes a mounting of a Volume within a container.

Link copied to clipboard
data class VolumeResponse(val configMap: ConfigMapVolumeSourceResponse, val emptyDir: EmptyDirVolumeSourceResponse, val name: String, val secret: SecretVolumeSourceResponse)

Volume represents a named volume in a container.