clouddeploy/v1 library

Cloud Deploy API - v1

For more information, see cloud.google.com/deploy/

Create an instance of CloudDeployApi to access these resources:

Classes

AdvanceChildRolloutJobRun
AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout JobRun.
AdvanceRolloutOperation
Contains the information of an automated advance-rollout operation.
AdvanceRolloutRequest
The request object used by AdvanceRollout.
AdvanceRolloutRule
The AdvanceRollout automation rule will automatically advance a successful Rollout to the next phase.
AnthosCluster
Information specifying an Anthos Cluster.
ApproveRolloutRequest
The request object used by ApproveRollout.
AuditConfig
Specifies the audit configuration for a service.
Automation
An Automation resource in the Cloud Deploy API.
AutomationResourceSelector
AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied.
AutomationRolloutMetadata
AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout.
AutomationRule
AutomationRule defines the automation activities.
AutomationRuleCondition
AutomationRuleCondition contains conditions relevant to an Automation rule.
AutomationRun
An AutomationRun resource in the Cloud Deploy API.
Binding
Associates members, or principals, with a role.
BuildArtifact
Description of an a image to use during Skaffold rendering.
Canary
Canary represents the canary deployment strategy.
CanaryDeployment
CanaryDeployment represents the canary deployment configuration
ChildRolloutJobs
ChildRollouts job composition
CloudDeployApi
CloudRunConfig
CloudRunConfig contains the Cloud Run runtime configuration.
CloudRunLocation
Information specifying where to deploy a Cloud Run Service.
CloudRunMetadata
CloudRunMetadata contains information from a Cloud Run deployment.
CloudRunRenderMetadata
CloudRunRenderMetadata contains Cloud Run information associated with a Release render.
Config
Service-wide configuration.
CreateChildRolloutJobRun
CreateChildRolloutJobRun contains information specific to a createChildRollout JobRun.
CustomCanaryDeployment
CustomCanaryDeployment represents the custom canary deployment configuration.
CustomMetadata
CustomMetadata contains information from a user-defined operation.
CustomTarget
Information specifying a Custom Target.
CustomTargetDeployMetadata
CustomTargetDeployMetadata contains information from a Custom Target deploy operation.
CustomTargetSkaffoldActions
CustomTargetSkaffoldActions represents the CustomTargetType configuration using Skaffold custom actions.
CustomTargetType
A CustomTargetType resource in the Cloud Deploy API.
DefaultPool
Execution using the default Cloud Build pool.
DeliveryPipeline
A DeliveryPipeline resource in the Cloud Deploy API.
DeployArtifact
The artifacts produced by a deploy operation.
DeployJobRun
DeployJobRun contains information specific to a deploy JobRun.
DeployJobRunMetadata
DeployJobRunMetadata surfaces information associated with a DeployJobRun to the user.
DeploymentJobs
Deployment job composition.
DeployParameters
DeployParameters contains deploy parameters information.
ExecutionConfig
Configuration of the environment to use when calling Skaffold.
GatewayServiceMesh
Information about the Kubernetes Gateway API service mesh configuration.
GkeCluster
Information specifying a GKE Cluster.
IgnoreJobRequest
The request object used by IgnoreJob.
Job
Job represents an operation for a Rollout.
JobRun
A JobRun resource in the Cloud Deploy API.
KubernetesConfig
KubernetesConfig contains the Kubernetes runtime configuration.
ListAutomationRunsResponse
The response object from ListAutomationRuns.
ListAutomationsResponse
The response object from ListAutomations.
ListCustomTargetTypesResponse
The response object from ListCustomTargetTypes.
ListDeliveryPipelinesResponse
The response object from ListDeliveryPipelines.
ListJobRunsResponse
ListJobRunsResponse is the response object returned by ListJobRuns.
ListLocationsResponse
The response message for Locations.ListLocations.
ListOperationsResponse
The response message for Operations.ListOperations.
ListReleasesResponse
The response object from ListReleases.
ListRolloutsResponse
ListRolloutsResponse is the response object reutrned by ListRollouts.
ListTargetsResponse
The response object from ListTargets.
Metadata
Metadata includes information associated with a Rollout.
MultiTarget
Information specifying a multiTarget.
Operation
This resource represents a long-running operation that is the result of a network API call.
Phase
Phase represents a collection of jobs that are logically grouped together for a Rollout.
PhaseArtifact
Contains the paths to the artifacts, relative to the URI, for a phase.
PhaseConfig
PhaseConfig represents the configuration for a phase in the custom canary deployment.
PipelineCondition
PipelineCondition contains all conditions relevant to a Delivery Pipeline.
PipelineReadyCondition
PipelineReadyCondition contains information around the status of the Pipeline.
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
Postdeploy
Postdeploy contains the postdeploy job configuration information.
PostdeployJob
A postdeploy Job.
PostdeployJobRun
PostdeployJobRun contains information specific to a postdeploy JobRun.
Predeploy
Predeploy contains the predeploy job configuration information.
PredeployJob
A predeploy Job.
PredeployJobRun
PredeployJobRun contains information specific to a predeploy JobRun.
PrivatePool
Execution using a private Cloud Build pool.
ProjectsLocationsCustomTargetTypesResource
ProjectsLocationsDeliveryPipelinesAutomationRunsResource
ProjectsLocationsDeliveryPipelinesAutomationsResource
ProjectsLocationsDeliveryPipelinesReleasesResource
ProjectsLocationsDeliveryPipelinesReleasesRolloutsJobRunsResource
ProjectsLocationsDeliveryPipelinesReleasesRolloutsResource
ProjectsLocationsDeliveryPipelinesResource
ProjectsLocationsOperationsResource
ProjectsLocationsResource
ProjectsLocationsTargetsResource
ProjectsResource
PromoteReleaseOperation
Contains the information of an automated promote-release operation.
PromoteReleaseRule
PromoteRelease rule will automatically promote a release from the current target to a specified target.
Release
A Release resource in the Cloud Deploy API.
ReleaseCondition
ReleaseCondition contains all conditions relevant to a Release.
ReleaseReadyCondition
ReleaseReadyCondition contains information around the status of the Release.
RenderMetadata
RenderMetadata includes information associated with a Release render.
RepairPhase
RepairPhase tracks the repair attempts that have been made for each RepairPhaseConfig specified in the Automation resource.
RepairRolloutOperation
Contains the information for an automated repair rollout operation.
RepairRolloutRule
The RepairRolloutRule automation rule will automatically repair a failed Rollout.
RetryAttempt
RetryAttempt represents an action of retrying the failed Cloud Deploy job.
RetryJobRequest
RetryJobRequest is the request object used by RetryJob.
RetryPhase
RetryPhase contains the retry attempts and the metadata for initiating a new attempt.
RollbackAttempt
RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'.
RollbackTargetConfig
Configs for the Rollback rollout.
RollbackTargetRequest
The request object for RollbackTarget.
RollbackTargetResponse
The response object from RollbackTarget.
Rollout
A Rollout resource in the Cloud Deploy API.
RuntimeConfig
RuntimeConfig contains the runtime specific configurations for a deployment strategy.
SerialPipeline
SerialPipeline defines a sequential set of stages for a DeliveryPipeline.
ServiceNetworking
Information about the Kubernetes Service networking configuration.
SetIamPolicyRequest
Request message for SetIamPolicy method.
SkaffoldGCBRepoSource
Cloud Build V2 Repository containing Skaffold Configs.
SkaffoldGCSSource
Cloud Storage bucket containing Skaffold Config modules.
SkaffoldGitSource
Git repository containing Skaffold Config modules.
SkaffoldModules
Skaffold Config modules and their remote source.
SkaffoldSupportedCondition
SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends.
SkaffoldVersion
Details of a supported Skaffold version.
Stage
Stage specifies a location to which to deploy.
Standard
Standard represents the standard deployment strategy.
Strategy
Strategy contains deployment strategy information.
Target
A Target resource in the Cloud Deploy API.
TargetArtifact
The artifacts produced by a target render operation.
TargetAttribute
Contains criteria for selecting Targets.
TargetRender
Details of rendering for a single target.
TargetsPresentCondition
TargetsPresentCondition contains information on any Targets referenced in the Delivery Pipeline that do not actually exist.
TargetsTypeCondition
TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.
VerifyJobRun
VerifyJobRun contains information specific to a verify JobRun.

Typedefs

AbandonReleaseRequest = $Empty
The request object used by AbandonRelease.
AbandonReleaseResponse = $Empty
The response object for AbandonRelease.
AdvanceChildRolloutJob = $Empty
An advanceChildRollout Job.
AdvanceRolloutResponse = $Empty
The response object from AdvanceRollout.
ApproveRolloutResponse = $Empty
The response object from ApproveRollout.
AuditLogConfig = $AuditLogConfig
Provides the configuration for logging a type of permissions.
CancelAutomationRunRequest = $Empty
The request object used by CancelAutomationRun.
CancelAutomationRunResponse = $Empty
The response object from CancelAutomationRun.
CancelOperationRequest = $Empty
The request message for Operations.CancelOperation.
CancelRolloutRequest = $Empty
The request object used by CancelRollout.
CancelRolloutResponse = $Empty
The response object from CancelRollout.
CreateChildRolloutJob = $Empty
A createChildRollout Job.
Date = $Date
Represents a whole or partial calendar date, such as a birthday.
DeployJob = $Empty
A deploy Job.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
Expr = $Expr
Represents a textual expression in the Common Expression Language (CEL) syntax.
IgnoreJobResponse = $Empty
The response object from IgnoreJob.
Location = $Location00
A resource that represents a Google Cloud location.
RetryJobResponse = $Empty
The response object from 'RetryJob'.
Status = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
TerminateJobRunRequest = $Empty
The request object used by TerminateJobRun.
TerminateJobRunResponse = $Empty
The response object from TerminateJobRun.
TestIamPermissionsRequest = $TestIamPermissionsRequest00
Request message for TestIamPermissions method.
TestIamPermissionsResponse = $PermissionsResponse
Response message for TestIamPermissions method.
VerifyJob = $Empty
A verify Job.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.