Package-level declarations

Types

Link copied to clipboard

An advanceChildRollout Job.

Link copied to clipboard
data class AnthosClusterResponse(val membership: String)

Information specifying an Anthos Cluster.

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 BuildArtifactResponse(val image: String, val tag: String)

Description of an a image to use during Skaffold rendering.

Link copied to clipboard
data class CanaryDeploymentResponse(val percentages: List<Int>, val verify: Boolean)

CanaryDeployment represents the canary deployment configuration

Link copied to clipboard
data class CanaryResponse(val canaryDeployment: CanaryDeploymentResponse, val customCanaryDeployment: CustomCanaryDeploymentResponse, val runtimeConfig: RuntimeConfigResponse)

Canary represents the canary deployment strategy.

Link copied to clipboard
data class ChildRolloutJobsResponse(val advanceRolloutJobs: List<JobResponse>, val createRolloutJobs: List<JobResponse>)

ChildRollouts job composition

Link copied to clipboard
data class CloudRunConfigResponse(val automaticTrafficControl: Boolean)

CloudRunConfig contains the Cloud Run runtime configuration.

Link copied to clipboard
data class CloudRunLocationResponse(val location: String)

Information specifying where to deploy a Cloud Run Service.

Link copied to clipboard
data class CloudRunMetadataResponse(val revision: String, val service: String, val serviceUrls: List<String>)

CloudRunMetadata contains information from a Cloud Run deployment.

Link copied to clipboard

A createChildRollout Job.

Link copied to clipboard

CustomCanaryDeployment represents the custom canary deployment configuration.

Link copied to clipboard
data class DefaultPoolResponse(val artifactStorage: String, val serviceAccount: String)

Execution using the default Cloud Build pool.

Link copied to clipboard
data class DeliveryPipelineResponse(val annotations: Map<String, String>, val condition: PipelineConditionResponse, val createTime: String, val description: String, val etag: String, val labels: Map<String, String>, val name: String, val serialPipeline: SerialPipelineResponse, val suspended: Boolean, val uid: String, val updateTime: String)

A DeliveryPipeline resource in the Google Cloud Deploy API. A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Link copied to clipboard

A deploy Job.

Link copied to clipboard
data class DeploymentJobsResponse(val deployJob: JobResponse, val verifyJob: JobResponse)

Deployment job composition.

Link copied to clipboard
data class ExecutionConfigResponse(val artifactStorage: String, val defaultPool: DefaultPoolResponse, val executionTimeout: String, val privatePool: PrivatePoolResponse, val serviceAccount: String, val usages: List<String>, val workerPool: String)

Configuration of the environment to use when calling Skaffold.

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 GatewayServiceMeshResponse(val deployment: String, val httpRoute: String, val service: String)

Information about the Kubernetes Gateway API service mesh configuration.

Link copied to clipboard
data class GetDeliveryPipelineIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetDeliveryPipelineResult(val annotations: Map<String, String>, val condition: PipelineConditionResponse, val createTime: String, val description: String, val etag: String, val labels: Map<String, String>, val name: String, val serialPipeline: SerialPipelineResponse, val suspended: Boolean, val uid: String, val updateTime: String)
Link copied to clipboard
data class GetReleaseResult(val abandoned: Boolean, val annotations: Map<String, String>, val buildArtifacts: List<BuildArtifactResponse>, val condition: ReleaseConditionResponse, val createTime: String, val deliveryPipelineSnapshot: DeliveryPipelineResponse, val description: String, val etag: String, val labels: Map<String, String>, val name: String, val renderEndTime: String, val renderStartTime: String, val renderState: String, val skaffoldConfigPath: String, val skaffoldConfigUri: String, val skaffoldVersion: String, val targetArtifacts: Map<String, String>, val targetRenders: Map<String, String>, val targetSnapshots: List<TargetResponse>, val uid: String)
Link copied to clipboard
data class GetRolloutResult(val annotations: Map<String, String>, val approvalState: String, val approveTime: String, val controllerRollout: String, val createTime: String, val deployEndTime: String, val deployFailureCause: String, val deployStartTime: String, val deployingBuild: String, val description: String, val enqueueTime: String, val etag: String, val failureReason: String, val labels: Map<String, String>, val metadata: MetadataResponse, val name: String, val phases: List<PhaseResponse>, val state: String, val targetId: String, val uid: String)
Link copied to clipboard
data class GetTargetIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetTargetResult(val annotations: Map<String, String>, val anthosCluster: AnthosClusterResponse, val createTime: String, val description: String, val etag: String, val executionConfigs: List<ExecutionConfigResponse>, val gke: GkeClusterResponse, val labels: Map<String, String>, val multiTarget: MultiTargetResponse, val name: String, val requireApproval: Boolean, val run: CloudRunLocationResponse, val targetId: String, val uid: String, val updateTime: String)
Link copied to clipboard
data class GkeClusterResponse(val cluster: String, val internalIp: Boolean)

Information specifying a GKE Cluster.

Link copied to clipboard
data class JobResponse(val advanceChildRolloutJob: AdvanceChildRolloutJobResponse, val createChildRolloutJob: CreateChildRolloutJobResponse, val deployJob: DeployJobResponse, val jobRun: String, val skipMessage: String, val state: String, val verifyJob: VerifyJobResponse)

Job represents an operation for a Rollout.

Link copied to clipboard
data class KubernetesConfigResponse(val gatewayServiceMesh: GatewayServiceMeshResponse, val serviceNetworking: ServiceNetworkingResponse)

KubernetesConfig contains the Kubernetes runtime configuration.

Link copied to clipboard
data class MetadataResponse(val cloudRun: CloudRunMetadataResponse)

Metadata includes information associated with a Rollout.

Link copied to clipboard
data class MultiTargetResponse(val targetIds: List<String>)

Information specifying a multiTarget.

Link copied to clipboard
data class PhaseConfigResponse(val percentage: Int, val phaseId: String, val profiles: List<String>, val verify: Boolean)

PhaseConfig represents the configuration for a phase in the custom canary deployment.

Link copied to clipboard
data class PhaseResponse(val childRolloutJobs: ChildRolloutJobsResponse, val deploymentJobs: DeploymentJobsResponse, val skipMessage: String, val state: String)

Phase represents a collection of jobs that are logically grouped together for a Rollout.

Link copied to clipboard
data class PipelineConditionResponse(val pipelineReadyCondition: PipelineReadyConditionResponse, val targetsPresentCondition: TargetsPresentConditionResponse, val targetsTypeCondition: TargetsTypeConditionResponse)

PipelineCondition contains all conditions relevant to a Delivery Pipeline.

Link copied to clipboard
data class PipelineReadyConditionResponse(val status: Boolean, val updateTime: String)

PipelineReadyCondition contains information around the status of the Pipeline.

Link copied to clipboard
data class PrivatePoolResponse(val artifactStorage: String, val serviceAccount: String, val workerPool: String)

Execution using a private Cloud Build pool.

Link copied to clipboard
data class ReleaseConditionResponse(val releaseReadyCondition: ReleaseReadyConditionResponse, val skaffoldSupportedCondition: SkaffoldSupportedConditionResponse)

ReleaseCondition contains all conditions relevant to a Release.

Link copied to clipboard
data class ReleaseReadyConditionResponse(val status: Boolean)

ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release.

Link copied to clipboard
data class RuntimeConfigResponse(val cloudRun: CloudRunConfigResponse, val kubernetes: KubernetesConfigResponse)

RuntimeConfig contains the runtime specific configurations for a deployment strategy.

Link copied to clipboard
data class SerialPipelineResponse(val stages: List<StageResponse>)

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

Link copied to clipboard
data class ServiceNetworkingResponse(val deployment: String, val service: String)

Information about the Kubernetes Service networking configuration.

Link copied to clipboard
data class SkaffoldSupportedConditionResponse(val maintenanceModeTime: String, val skaffoldSupportState: String, val status: Boolean, val supportExpirationTime: String)

SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends.

Link copied to clipboard
data class StageResponse(val profiles: List<String>, val strategy: StrategyResponse, val targetId: String)

Stage specifies a location to which to deploy.

Link copied to clipboard
data class StandardResponse(val verify: Boolean)

Standard represents the standard deployment strategy.

Link copied to clipboard
data class StrategyResponse(val canary: CanaryResponse, val standard: StandardResponse)

Strategy contains deployment strategy information.

Link copied to clipboard
data class TargetResponse(val annotations: Map<String, String>, val anthosCluster: AnthosClusterResponse, val createTime: String, val description: String, val etag: String, val executionConfigs: List<ExecutionConfigResponse>, val gke: GkeClusterResponse, val labels: Map<String, String>, val multiTarget: MultiTargetResponse, val name: String, val requireApproval: Boolean, val run: CloudRunLocationResponse, val targetId: String, val uid: String, val updateTime: String)

A Target resource in the Google Cloud Deploy API. A Target defines a location to which a Skaffold configuration can be deployed.

Link copied to clipboard
data class TargetsPresentConditionResponse(val missingTargets: List<String>, val status: Boolean, val updateTime: String)

TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist.

Link copied to clipboard
data class TargetsTypeConditionResponse(val errorDetails: String, val status: Boolean)

TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.

Link copied to clipboard

A verify Job.