API documentation for deploy_v1.types package.
Classes
ApproveRolloutRequest
The request object used by ApproveRollout.
.. attribute:: name
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
:type: str
ApproveRolloutResponse
The response object from ApproveRollout.
BuildArtifact
Description of an a image to use during Skaffold rendering. .. attribute:: image
Image name in Skaffold configuration.
:type: str
Config
Service-wide configuration. .. attribute:: name
Name of the configuration.
:type: str
CreateDeliveryPipelineRequest
The request object for CreateDeliveryPipeline.
.. attribute:: parent
Required. The parent collection in which the
DeliveryPipeline should be created. Format should be
projects/{project_id}/locations/{location_name}.
:type: str
CreateReleaseRequest
The request object for CreateRelease,
.. attribute:: parent
Required. The parent collection in which the Release
should be created. Format should be
projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
:type: str
CreateRolloutRequest
CreateRolloutRequest is the request object used by
CreateRollout.
CreateTargetRequest
The request object for CreateTarget.
.. attribute:: parent
Required. The parent collection in which the Target
should be created. Format should be
projects/{project_id}/locations/{location_name}.
:type: str
DefaultPool
Execution using the default Cloud Build pool. .. attribute:: service_account
Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) will be used.
:type: str
DeleteDeliveryPipelineRequest
The request object for DeleteDeliveryPipeline.
.. attribute:: name
Required. The name of the DeliveryPipeline to delete.
Format should be
projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
:type: str
DeleteTargetRequest
The request object for DeleteTarget.
.. attribute:: name
Required. The name of the Target to delete. Format
should be
projects/{project_id}/locations/{location_name}/targets/{target_name}.
:type: str
DeliveryPipeline
A DeliveryPipeline resource in the Google Cloud Deploy API.
A DeliveryPipeline defines a pipeline through which a Skaffold
configuration can progress.
ExecutionConfig
Configuration of the environment to use when calling Skaffold.
GetConfigRequest
Request to get a configuration. .. attribute:: name
Required. Name of requested configuration.
:type: str
GetDeliveryPipelineRequest
The request object for GetDeliveryPipeline
.. attribute:: name
Required. Name of the DeliveryPipeline. Format must be
projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
:type: str
GetReleaseRequest
The request object for GetRelease.
.. attribute:: name
Required. Name of the Release. Format must be
projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
:type: str
GetRolloutRequest
GetRolloutRequest is the request object used by GetRollout.
.. attribute:: name
Required. Name of the Rollout. Format must be
projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}.
:type: str
GetTargetRequest
The request object for GetTarget.
.. attribute:: name
Required. Name of the Target. Format must be
projects/{project_id}/locations/{location_name}/targets/{target_name}.
:type: str
GkeCluster
Information specifying a GKE Cluster. .. attribute:: cluster
Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}.
:type: str
ListDeliveryPipelinesRequest
The request object for ListDeliveryPipelines.
.. attribute:: parent
Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}.
:type: str
ListDeliveryPipelinesResponse
The response object from ListDeliveryPipelines.
.. attribute:: delivery_pipelines
The DeliveryPipeline objects.
:type: Sequence[google.cloud.deploy_v1.types.DeliveryPipeline]
ListReleasesRequest
The request object for ListReleases.
.. attribute:: parent
Required. The DeliveryPipeline which owns this
collection of Release objects.
:type: str
ListReleasesResponse
The response object from ListReleases.
.. attribute:: releases
The Release objects.
:type: Sequence[google.cloud.deploy_v1.types.Release]
ListRolloutsRequest
ListRolloutsRequest is the request object used by ListRollouts.
.. attribute:: parent
Required. The Release which owns this collection of
Rollout objects.
:type: str
ListRolloutsResponse
ListRolloutsResponse is the response object reutrned by
ListRollouts.
ListTargetsRequest
The request object for ListTargets.
.. attribute:: parent
Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}.
:type: str
ListTargetsResponse
The response object from ListTargets.
.. attribute:: targets
The Target objects.
:type: Sequence[google.cloud.deploy_v1.types.Target]
OperationMetadata
Represents the metadata of the long-running operation. .. attribute:: create_time
Output only. The time the operation was created.
:type: google.protobuf.timestamp_pb2.Timestamp
PipelineCondition
PipelineCondition contains all conditions relevant to a Delivery Pipeline.
PipelineReadyCondition
PipelineReadyCondition contains information around the status of the Pipeline.
PrivatePool
Execution using a private Cloud Build pool. .. attribute:: worker_pool
Required. Resource name of the Cloud Build worker pool to
use. The format is
projects/{project}/locations/{location}/workerPools/{pool}.
:type: str
Release
A Release resource in the Google Cloud Deploy API.
A Release defines a specific Skaffold configuration instance
that can be deployed.
Rollout
A Rollout resource in the Google Cloud Deploy API.
A Rollout contains information around a specific deployment to a
Target.
SerialPipeline
SerialPipeline defines a sequential set of stages for a
DeliveryPipeline.
SkaffoldVersion
Details of a supported Skaffold version. .. attribute:: version
Release version number. For example, "1.20.3".
:type: str
Stage
Stage specifies a location to which to deploy. .. attribute:: target_id
The target_id to which this stage points. This field refers
exclusively to the last segment of a target name. For
example, this field would just be my-target (rather than
projects/project/deliveryPipelines/pipeline/targets/my-target).
The parent DeliveryPipeline of the Target is
inferred to be the parent DeliveryPipeline of the
Release in which this Stage lives.
:type: str
Target
A Target resource in the Google Cloud Deploy API.
A Target defines a location to which a Skaffold configuration
can be deployed.
TargetArtifact
The artifacts produced by a target render operation. .. attribute:: artifact_uri
Output only. URI of a directory containing the artifacts. This contains deployment configuration used by Skaffold during a rollout, and all paths are relative to this location.
:type: str
TargetsPresentCondition
TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist.
UpdateDeliveryPipelineRequest
The request object for UpdateDeliveryPipeline.
.. attribute:: update_mask
Required. Field mask is used to specify the fields to be
overwritten in the DeliveryPipeline resource by the
update. The fields specified in the update_mask are relative
to the resource, not the full request. A field will be
overwritten if it is in the mask. If the user does not
provide a mask then all fields will be overwritten.
:type: google.protobuf.field_mask_pb2.FieldMask
UpdateTargetRequest
The request object for UpdateTarget.
.. attribute:: update_mask
Required. Field mask is used to specify the fields to be overwritten in the Target resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
:type: google.protobuf.field_mask_pb2.FieldMask