Class CloudDeployClient (1.3.1)

CloudDeployClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.deploy_v1.services.cloud_deploy.transports.base.CloudDeployTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
`CloudDeployTransport`	The transport used by the client instance.

Methods

CloudDeployClient

CloudDeployClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.deploy_v1.services.cloud_deploy.transports.base.CloudDeployTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the cloud deploy client.

Parameters

Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, CloudDeployTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

approve_rollout

approve_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ApproveRolloutRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Approves a Rollout.

from google.cloud import deploy_v1

def sample_approve_rollout():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ApproveRolloutRequest(
        name="name_value",
        approved=True,
    )

    # Make the request
    response = client.approve_rollout(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.ApproveRolloutRequest, dict]` The request object. The request object used by `ApproveRollout`.
`name`	`str` Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.deploy_v1.types.ApproveRolloutResponse`	The response object from ApproveRollout.

build_path

build_path(project: str, location: str, build: str)

Returns a fully-qualified build string.

cluster_path

cluster_path(project: str, location: str, cluster: str)

Returns a fully-qualified cluster string.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

config_path

config_path(project: str, location: str)

Returns a fully-qualified config string.

create_delivery_pipeline

create_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateDeliveryPipelineRequest, dict]] = None, *, parent: Optional[str] = None, delivery_pipeline: Optional[google.cloud.deploy_v1.types.cloud_deploy.DeliveryPipeline] = None, delivery_pipeline_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new DeliveryPipeline in a given project and location.

from google.cloud import deploy_v1

def sample_create_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.CreateDeliveryPipelineRequest(
        parent="parent_value",
        delivery_pipeline_id="delivery_pipeline_id_value",
    )

    # Make the request
    operation = client.create_delivery_pipeline(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.CreateDeliveryPipelineRequest, dict]` The request object. The request object for `CreateDeliveryPipeline`.
`parent`	`str` Required. The parent collection in which the `DeliveryPipeline` should be created. Format should be projects/{project_id}/locations/{location_name}. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`delivery_pipeline`	`google.cloud.deploy_v1.types.DeliveryPipeline` Required. The `DeliveryPipeline` to create. This corresponds to the `delivery_pipeline` field on the `request` instance; if `request` is provided, this should not be set.
`delivery_pipeline_id`	`str` Required. ID of the `DeliveryPipeline`. This corresponds to the `delivery_pipeline_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be DeliveryPipeline A DeliveryPipeline resource in the Google Cloud Deploy API. A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

create_release

create_release(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateReleaseRequest, dict]] = None, *, parent: Optional[str] = None, release: Optional[google.cloud.deploy_v1.types.cloud_deploy.Release] = None, release_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Release in a given project and location.

from google.cloud import deploy_v1

def sample_create_release():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.CreateReleaseRequest(
        parent="parent_value",
        release_id="release_id_value",
    )

    # Make the request
    operation = client.create_release(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.CreateReleaseRequest, dict]` The request object. The request object for `CreateRelease`,
`parent`	`str` Required. The parent collection in which the `Release` should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`release`	`google.cloud.deploy_v1.types.Release` Required. The `Release` to create. This corresponds to the `release` field on the `request` instance; if `request` is provided, this should not be set.
`release_id`	`str` Required. ID of the `Release`. This corresponds to the `release_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Release A Release resource in the Google Cloud Deploy API. A Release defines a specific Skaffold configuration instance that can be deployed.

create_rollout

create_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateRolloutRequest, dict]] = None, *, parent: Optional[str] = None, rollout: Optional[google.cloud.deploy_v1.types.cloud_deploy.Rollout] = None, rollout_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Rollout in a given project and location.

from google.cloud import deploy_v1

def sample_create_rollout():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    rollout = deploy_v1.Rollout()
    rollout.target_id = "target_id_value"

    request = deploy_v1.CreateRolloutRequest(
        parent="parent_value",
        rollout_id="rollout_id_value",
        rollout=rollout,
    )

    # Make the request
    operation = client.create_rollout(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.CreateRolloutRequest, dict]` The request object. CreateRolloutRequest is the request object used by `CreateRollout`.
`parent`	`str` Required. The parent collection in which the `Rollout` should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`rollout`	`google.cloud.deploy_v1.types.Rollout` Required. The `Rollout` to create. This corresponds to the `rollout` field on the `request` instance; if `request` is provided, this should not be set.
`rollout_id`	`str` Required. ID of the `Rollout`. This corresponds to the `rollout_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Rollout A Rollout resource in the Google Cloud Deploy API. A Rollout contains information around a specific deployment to a Target.

create_target

create_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateTargetRequest, dict]] = None, *, parent: Optional[str] = None, target: Optional[google.cloud.deploy_v1.types.cloud_deploy.Target] = None, target_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Target in a given project and location.

from google.cloud import deploy_v1

def sample_create_target():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.CreateTargetRequest(
        parent="parent_value",
        target_id="target_id_value",
    )

    # Make the request
    operation = client.create_target(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.CreateTargetRequest, dict]` The request object. The request object for `CreateTarget`.
`parent`	`str` Required. The parent collection in which the `Target` should be created. Format should be projects/{project_id}/locations/{location_name}. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`target`	`google.cloud.deploy_v1.types.Target` Required. The `Target` to create. This corresponds to the `target` field on the `request` instance; if `request` is provided, this should not be set.
`target_id`	`str` Required. ID of the `Target`. This corresponds to the `target_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Target A Target resource in the Google Cloud Deploy API. A Target defines a location to which a Skaffold configuration can be deployed.

delete_delivery_pipeline

delete_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteDeliveryPipelineRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single DeliveryPipeline.

from google.cloud import deploy_v1

def sample_delete_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteDeliveryPipelineRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_delivery_pipeline(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.DeleteDeliveryPipelineRequest, dict]` The request object. The request object for `DeleteDeliveryPipeline`.
`name`	`str` Required. The name of the `DeliveryPipeline` to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_target

delete_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteTargetRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single Target.

from google.cloud import deploy_v1

def sample_delete_target():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteTargetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_target(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.DeleteTargetRequest, dict]` The request object. The request object for `DeleteTarget`.
`name`	`str` Required. The name of the `Target` to delete. Format should be projects/{project_id}/locations/{location_name}/targets/{target_name}. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

delivery_pipeline_path

delivery_pipeline_path(project: str, location: str, delivery_pipeline: str)

Returns a fully-qualified delivery_pipeline string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`CloudDeployClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
`info`	`dict` The service account private key info.

Returns

Type	Description
`CloudDeployClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`CloudDeployClient`	The constructed client.

get_config

get_config(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the configuration for a location.

from google.cloud import deploy_v1

def sample_get_config():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_config(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.GetConfigRequest, dict]` The request object. Request to get a configuration.
`name`	`str` Required. Name of requested configuration. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.deploy_v1.types.Config`	Service-wide configuration.

get_delivery_pipeline

get_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetDeliveryPipelineRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single DeliveryPipeline.

from google.cloud import deploy_v1

def sample_get_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetDeliveryPipelineRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_delivery_pipeline(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.GetDeliveryPipelineRequest, dict]` The request object. The request object for `GetDeliveryPipeline`
`name`	`str` Required. Name of the `DeliveryPipeline`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.deploy_v1.types.DeliveryPipeline`	A DeliveryPipeline resource in the Google Cloud Deploy API. A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter

Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions

Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns

Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_release

get_release(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetReleaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Release.

from google.cloud import deploy_v1

def sample_get_release():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetReleaseRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_release(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.GetReleaseRequest, dict]` The request object. The request object for `GetRelease`.
`name`	`str` Required. Name of the `Release`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.deploy_v1.types.Release`	A Release resource in the Google Cloud Deploy API. A Release defines a specific Skaffold configuration instance that can be deployed.

get_rollout

get_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetRolloutRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Rollout.

from google.cloud import deploy_v1

def sample_get_rollout():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetRolloutRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_rollout(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.GetRolloutRequest, dict]` The request object. GetRolloutRequest is the request object used by `GetRollout`.
`name`	`str` Required. Name of the `Rollout`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.deploy_v1.types.Rollout`	A Rollout resource in the Google Cloud Deploy API. A Rollout contains information around a specific deployment to a Target.

get_target

get_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetTargetRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Target.

from google.cloud import deploy_v1

def sample_get_target():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetTargetRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_target(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.GetTargetRequest, dict]` The request object. The request object for `GetTarget`.
`name`	`str` Required. Name of the `Target`. Format must be projects/{project_id}/locations/{location_name}/targets/{target_name}. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.deploy_v1.types.Target`	A Target resource in the Google Cloud Deploy API. A Target defines a location to which a Skaffold configuration can be deployed.

list_delivery_pipelines

list_delivery_pipelines(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListDeliveryPipelinesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists DeliveryPipelines in a given project and location.

from google.cloud import deploy_v1

def sample_list_delivery_pipelines():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListDeliveryPipelinesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_delivery_pipelines(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.ListDeliveryPipelinesRequest, dict]` The request object. The request object for `ListDeliveryPipelines`.
`parent`	`str` Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeliveryPipelinesPager`	The response object from ListDeliveryPipelines. Iterating over this object will yield results and resolve additional pages automatically.

list_releases

list_releases(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListReleasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Releases in a given project and location.

from google.cloud import deploy_v1

def sample_list_releases():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListReleasesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_releases(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.ListReleasesRequest, dict]` The request object. The request object for `ListReleases`.
`parent`	`str` Required. The `DeliveryPipeline` which owns this collection of `Release` objects. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.deploy_v1.services.cloud_deploy.pagers.ListReleasesPager`	The response object from ListReleases. Iterating over this object will yield results and resolve additional pages automatically.

list_rollouts

list_rollouts(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListRolloutsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Rollouts in a given project and location.

from google.cloud import deploy_v1

def sample_list_rollouts():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListRolloutsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_rollouts(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.ListRolloutsRequest, dict]` The request object. ListRolloutsRequest is the request object used by `ListRollouts`.
`parent`	`str` Required. The `Release` which owns this collection of `Rollout` objects. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.deploy_v1.services.cloud_deploy.pagers.ListRolloutsPager`	ListRolloutsResponse is the response object reutrned by ListRollouts. Iterating over this object will yield results and resolve additional pages automatically.

list_targets

list_targets(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListTargetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Targets in a given project and location.

from google.cloud import deploy_v1

def sample_list_targets():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListTargetsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_targets(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.ListTargetsRequest, dict]` The request object. The request object for `ListTargets`.
`parent`	`str` Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.deploy_v1.services.cloud_deploy.pagers.ListTargetsPager`	The response object from ListTargets. Iterating over this object will yield results and resolve additional pages automatically.

membership_path

membership_path(project: str, location: str, membership: str)

Returns a fully-qualified membership string.

parse_build_path

parse_build_path(path: str)

Parses a build path into its component segments.

parse_cluster_path

parse_cluster_path(path: str)

Parses a cluster path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_config_path

parse_config_path(path: str)

Parses a config path into its component segments.

parse_delivery_pipeline_path

parse_delivery_pipeline_path(path: str)

Parses a delivery_pipeline path into its component segments.

parse_membership_path

parse_membership_path(path: str)

Parses a membership path into its component segments.

parse_release_path

parse_release_path(path: str)

Parses a release path into its component segments.

parse_rollout_path

parse_rollout_path(path: str)

Parses a rollout path into its component segments.

parse_target_path

parse_target_path(path: str)

Parses a target path into its component segments.

parse_worker_pool_path

parse_worker_pool_path(path: str)

Parses a worker_pool path into its component segments.

release_path

release_path(project: str, location: str, delivery_pipeline: str, release: str)

Returns a fully-qualified release string.

rollout_path

rollout_path(
    project: str, location: str, delivery_pipeline: str, release: str, rollout: str
)

Returns a fully-qualified rollout string.

target_path

target_path(project: str, location: str, target: str)

Returns a fully-qualified target string.

update_delivery_pipeline

update_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateDeliveryPipelineRequest, dict]] = None, *, delivery_pipeline: Optional[google.cloud.deploy_v1.types.cloud_deploy.DeliveryPipeline] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the parameters of a single DeliveryPipeline.

from google.cloud import deploy_v1

def sample_update_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.UpdateDeliveryPipelineRequest(
    )

    # Make the request
    operation = client.update_delivery_pipeline(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.UpdateDeliveryPipelineRequest, dict]` The request object. The request object for `UpdateDeliveryPipeline`.
`delivery_pipeline`	`google.cloud.deploy_v1.types.DeliveryPipeline` Required. The `DeliveryPipeline` to update. This corresponds to the `delivery_pipeline` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` 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. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be DeliveryPipeline A DeliveryPipeline resource in the Google Cloud Deploy API. A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

update_target

update_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateTargetRequest, dict]] = None, *, target: Optional[google.cloud.deploy_v1.types.cloud_deploy.Target] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the parameters of a single Target.

from google.cloud import deploy_v1

def sample_update_target():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.UpdateTargetRequest(
    )

    # Make the request
    operation = client.update_target(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.deploy_v1.types.UpdateTargetRequest, dict]` The request object. The request object for `UpdateTarget`.
`target`	`google.cloud.deploy_v1.types.Target` Required. The `Target` to update. This corresponds to the `target` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` 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. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Target A Target resource in the Google Cloud Deploy API. A Target defines a location to which a Skaffold configuration can be deployed.

worker_pool_path

worker_pool_path(project: str, location: str, worker_pool: str)

Returns a fully-qualified worker_pool string.