Class BlueGreenDeploymentsServiceClient (0.1.2)

BlueGreenDeploymentsServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.sqladmin_v1beta4.services.blue_green_deployments_service.transports.base.BlueGreenDeploymentsServiceTransport,
            typing.Callable[
                [...],
                google.cloud.sqladmin_v1beta4.services.blue_green_deployments_service.transports.base.BlueGreenDeploymentsServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Service for managing blue-green deployments.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
`str`	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type	Description
`BlueGreenDeploymentsServiceTransport`	The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
`str`	The universe domain used by the client instance.

Methods

BlueGreenDeploymentsServiceClient

BlueGreenDeploymentsServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.sqladmin_v1beta4.services.blue_green_deployments_service.transports.base.BlueGreenDeploymentsServiceTransport,
            typing.Callable[
                [...],
                google.cloud.sqladmin_v1beta4.services.blue_green_deployments_service.transports.base.BlueGreenDeploymentsServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the blue green deployments service 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`	`Optional[Union[str,BlueGreenDeploymentsServiceTransport,Callable[..., BlueGreenDeploymentsServiceTransport]]]` The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the BlueGreenDeploymentsServiceTransport constructor. If set to None, a transport is chosen automatically.
`client_options`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS 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. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that the `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS.
`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.

blue_green_deployment_path

blue_green_deployment_path(
    project: str, location: str, blue_green_deployment: str
) -> str

Returns a fully-qualified blue_green_deployment string.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_blue_green_deployment

create_blue_green_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.sqladmin_v1beta4.types.cloud_sql_blue_green_deployments.CreateBlueGreenDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    blue_green_deployment: typing.Optional[
        google.cloud.sqladmin_v1beta4.types.cloud_sql_blue_green_deployments.BlueGreenDeployment
    ] = None,
    blue_green_deployment_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation

Creates a blue-green deployment under a given project and location. This deployment provisions a synchronized green environment (target instance) from a blue production environment (source instance), facilitating updates like major version upgrades on the green instance without impacting the blue instance.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import sqladmin_v1beta4

def sample_create_blue_green_deployment():
    # Create a client
    client = sqladmin_v1beta4.BlueGreenDeploymentsServiceClient()

    # Initialize request argument(s)
    blue_green_deployment = sqladmin_v1beta4.BlueGreenDeployment()
    blue_green_deployment.source_instance = "source_instance_value"

    request = sqladmin_v1beta4.CreateBlueGreenDeploymentRequest(
        parent="parent_value",
        blue_green_deployment_id="blue_green_deployment_id_value",
        blue_green_deployment=blue_green_deployment,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.sqladmin_v1beta4.types.CreateBlueGreenDeploymentRequest, dict]` The request object. The request message for creating a `BlueGreenDeployment` resource.
`parent`	`str` Required. The parent resource where this blue-green deployment will be created. Format: projects/{project}/locations/{location} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`blue_green_deployment`	`google.cloud.sqladmin_v1beta4.types.BlueGreenDeployment` Required. The `BlueGreenDeployment` resource to create. This corresponds to the `blue_green_deployment` field on the `request` instance; if `request` is provided, this should not be set.
`blue_green_deployment_id`	`str` Required. The ID to use for the blue-green deployment, which will become the final component of the deployment's resource name. This corresponds to the `blue_green_deployment_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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.sqladmin_v1beta4.types.Operation`	An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

delete_blue_green_deployment

delete_blue_green_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.sqladmin_v1beta4.types.cloud_sql_blue_green_deployments.DeleteBlueGreenDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation

Deletes a blue-green deployment, including metadata and underlying resources based on the deployment state. If issued before switchover, this deletes the green instance. If issued after switchover, this deletes the old blue instance (source instance) if the delete_old_source field in the request is set to true. All blue-green deployment metadata is permanently deleted. Resources deleted as a result of this operation are no longer accessible and can't be restored.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import sqladmin_v1beta4

def sample_delete_blue_green_deployment():
    # Create a client
    client = sqladmin_v1beta4.BlueGreenDeploymentsServiceClient()

    # Initialize request argument(s)
    request = sqladmin_v1beta4.DeleteBlueGreenDeploymentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.sqladmin_v1beta4.types.DeleteBlueGreenDeploymentRequest, dict]` The request object. Request message for deleting a `BlueGreenDeployment` resource.
`name`	`str` Required. The name of the blue-green deployment to delete. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment} 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.sqladmin_v1beta4.types.Operation`	An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

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
`BlueGreenDeploymentsServiceClient`	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
`BlueGreenDeploymentsServiceClient`	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
`BlueGreenDeploymentsServiceClient`	The constructed client.

get_blue_green_deployment

get_blue_green_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.sqladmin_v1beta4.types.cloud_sql_blue_green_deployments.GetBlueGreenDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.sqladmin_v1beta4.types.cloud_sql_blue_green_deployments.BlueGreenDeployment
)

Retrieves a blue-green deployment resource under a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import sqladmin_v1beta4

def sample_get_blue_green_deployment():
    # Create a client
    client = sqladmin_v1beta4.BlueGreenDeploymentsServiceClient()

    # Initialize request argument(s)
    request = sqladmin_v1beta4.GetBlueGreenDeploymentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.sqladmin_v1beta4.types.GetBlueGreenDeploymentRequest, dict]` The request object. The request message for getting a `BlueGreenDeployment` resource.
`name`	`str` Required. The name of the blue-green deployment to retrieve. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment} 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.sqladmin_v1beta4.types.BlueGreenDeployment`	A BlueGreenDeployment resource represents a Cloud SQL blue-green deployment setup. It orchestrates the lifecycle of creating a synchronized "green" environment from a "blue" production environment, performing updates, and managing the switchover process to minimize downtime.

get_mtls_endpoint_and_cert_source

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

Deprecated. 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 variable 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.

list_blue_green_deployments

list_blue_green_deployments(
    request: typing.Optional[
        typing.Union[
            google.cloud.sqladmin_v1beta4.types.cloud_sql_blue_green_deployments.ListBlueGreenDeploymentsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.sqladmin_v1beta4.services.blue_green_deployments_service.pagers.ListBlueGreenDeploymentsPager
)

Lists blue-green deployments under a given project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import sqladmin_v1beta4

def sample_list_blue_green_deployments():
    # Create a client
    client = sqladmin_v1beta4.BlueGreenDeploymentsServiceClient()

    # Initialize request argument(s)
    request = sqladmin_v1beta4.ListBlueGreenDeploymentsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.sqladmin_v1beta4.types.ListBlueGreenDeploymentsRequest, dict]` The request object. The request message for listing blue-green deployment resources.
`parent`	`str` Required. The parent resource whose blue-green deployments are to be listed. Format: projects/{project}/locations/{location} 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.sqladmin_v1beta4.services.blue_green_deployments_service.pagers.ListBlueGreenDeploymentsPager`	The response message for listing blue-green deployment resources. Iterating over this object will yield results and resolve additional pages automatically.

parse_blue_green_deployment_path

parse_blue_green_deployment_path(path: str) -> typing.Dict[str, str]

Parses a blue_green_deployment path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

switchover_blue_green_deployment

switchover_blue_green_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.sqladmin_v1beta4.types.cloud_sql_blue_green_deployments.SwitchoverBlueGreenDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation

Switches over to green instance for a blue-green deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import sqladmin_v1beta4

def sample_switchover_blue_green_deployment():
    # Create a client
    client = sqladmin_v1beta4.BlueGreenDeploymentsServiceClient()

    # Initialize request argument(s)
    request = sqladmin_v1beta4.SwitchoverBlueGreenDeploymentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.sqladmin_v1beta4.types.SwitchoverBlueGreenDeploymentRequest, dict]` The request object. Request message for switching over a `BlueGreenDeployment` resource.
`name`	`str` Required. The name of the blue-green deployment to switch over. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment} 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.sqladmin_v1beta4.types.Operation`	An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.