Class SaasDeploymentsClient (0.1.0)

SaasDeploymentsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.transports.base.SaasDeploymentsTransport, typing.Callable[[...], google.cloud.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.transports.base.SaasDeploymentsTransport]]] = 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 object>)

Manages the deployment of SaaS services.

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
`SaasDeploymentsTransport`	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

SaasDeploymentsClient

SaasDeploymentsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.transports.base.SaasDeploymentsTransport, typing.Callable[[...], google.cloud.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.transports.base.SaasDeploymentsTransport]]] = 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 object>)

Instantiates the saas deployments 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,SaasDeploymentsTransport,Callable[..., SaasDeploymentsTransport]]]` 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 SaasDeploymentsTransport 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.

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_release

create_release(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.CreateReleaseRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    release: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Release
    ] = None,
    release_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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Release
)

Create a new release.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_create_release():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    release = saasplatform_saasservicemgmt_v1beta1.Release()
    release.unit_kind = "unit_kind_value"

    request = saasplatform_saasservicemgmt_v1beta1.CreateReleaseRequest(
        parent="parent_value",
        release_id="release_id_value",
        release=release,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.CreateReleaseRequest, dict]` The request object. The request structure for the CreateRelease method.
`parent`	`str` Required. The parent of the release. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`release`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Release` Required. The desired state for the release. This corresponds to the `release` field on the `request` instance; if `request` is provided, this should not be set.
`release_id`	`str` Required. The ID value for the new 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, 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.saasplatform_saasservicemgmt_v1beta1.types.Release`	A new version to be propagated and deployed to units. This includes pointers to packaged blueprints for actuation (e.g Helm or Terraform configuration packages) via artifact registry.

create_saas

create_saas(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.CreateSaasRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    saas: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Saas
    ] = None,
    saas_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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Saas

Create a new saas.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_create_saas():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.CreateSaasRequest(
        parent="parent_value",
        saas_id="saas_id_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.CreateSaasRequest, dict]` The request object. The request structure for the CreateSaas method.
`parent`	`str` Required. The parent of the saas. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`saas`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Saas` Required. The desired state for the saas. This corresponds to the `saas` field on the `request` instance; if `request` is provided, this should not be set.
`saas_id`	`str` Required. The ID value for the new saas. This corresponds to the `saas_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.saasplatform_saasservicemgmt_v1beta1.types.Saas`	Saas is a representation of a SaaS service managed by the Producer.

create_tenant

create_tenant(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.CreateTenantRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    tenant: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Tenant
    ] = None,
    tenant_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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Tenant
)

Create a new tenant.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_create_tenant():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    tenant = saasplatform_saasservicemgmt_v1beta1.Tenant()
    tenant.saas = "saas_value"

    request = saasplatform_saasservicemgmt_v1beta1.CreateTenantRequest(
        parent="parent_value",
        tenant_id="tenant_id_value",
        tenant=tenant,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.CreateTenantRequest, dict]` The request object. The request structure for the CreateTenant method.
`parent`	`str` Required. The parent of the tenant. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`tenant`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Tenant` Required. The desired state for the tenant. This corresponds to the `tenant` field on the `request` instance; if `request` is provided, this should not be set.
`tenant_id`	`str` Required. The ID value for the new tenant. This corresponds to the `tenant_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.saasplatform_saasservicemgmt_v1beta1.types.Tenant`	Tenant represents the service producer side of an instance of the service created based on a request from a consumer. In a typical scenario a Tenant has a one-to-one mapping with a resource given out to a service consumer. Example: tenant: name: "projects/svc1/locations/loc/tenants/inst-068afff8" consumer_resource: "projects/gshoe/locations/loc/shoes/black-shoe"

create_unit

create_unit(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.CreateUnitRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    unit: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Unit
    ] = None,
    unit_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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Unit

Create a new unit.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_create_unit():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.CreateUnitRequest(
        parent="parent_value",
        unit_id="unit_id_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.CreateUnitRequest, dict]` The request object. The request structure for the CreateUnit method.
`parent`	`str` Required. The parent of the unit. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`unit`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Unit` Required. The desired state for the unit. This corresponds to the `unit` field on the `request` instance; if `request` is provided, this should not be set.
`unit_id`	`str` Required. The ID value for the new unit. This corresponds to the `unit_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.saasplatform_saasservicemgmt_v1beta1.types.Unit`	A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.

create_unit_kind

create_unit_kind(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.CreateUnitKindRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    unit_kind: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.UnitKind
    ] = None,
    unit_kind_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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.UnitKind
)

Create a new unit kind.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_create_unit_kind():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    unit_kind = saasplatform_saasservicemgmt_v1beta1.UnitKind()
    unit_kind.saas = "saas_value"

    request = saasplatform_saasservicemgmt_v1beta1.CreateUnitKindRequest(
        parent="parent_value",
        unit_kind_id="unit_kind_id_value",
        unit_kind=unit_kind,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.CreateUnitKindRequest, dict]` The request object. The request structure for the CreateUnitKind method.
`parent`	`str` Required. The parent of the unit kind. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`unit_kind`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitKind` Required. The desired state for the unit kind. This corresponds to the `unit_kind` field on the `request` instance; if `request` is provided, this should not be set.
`unit_kind_id`	`str` Required. The ID value for the new unit kind. This corresponds to the `unit_kind_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.saasplatform_saasservicemgmt_v1beta1.types.UnitKind`	Definition of a Unit. Units belonging to the same UnitKind are managed together; for example they follow the same release model (blueprints, versions etc.) and are typically rolled out together.

create_unit_operation

create_unit_operation(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.CreateUnitOperationRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    unit_operation: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.UnitOperation
    ] = None,
    unit_operation_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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.UnitOperation
)

Create a new unit operation.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_create_unit_operation():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    unit_operation = saasplatform_saasservicemgmt_v1beta1.UnitOperation()
    unit_operation.unit = "unit_value"

    request = saasplatform_saasservicemgmt_v1beta1.CreateUnitOperationRequest(
        parent="parent_value",
        unit_operation_id="unit_operation_id_value",
        unit_operation=unit_operation,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.CreateUnitOperationRequest, dict]` The request object. The request structure for the CreateUnitOperation method.
`parent`	`str` Required. The parent of the unit operation. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`unit_operation`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitOperation` Required. The desired state for the unit operation. This corresponds to the `unit_operation` field on the `request` instance; if `request` is provided, this should not be set.
`unit_operation_id`	`str` Required. The ID value for the new unit operation. This corresponds to the `unit_operation_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.saasplatform_saasservicemgmt_v1beta1.types.UnitOperation UnitOperation encapsulates the intent of changing/interacting with the service component represented by the specific Unit. Multiple UnitOperations can be created (requested) and scheduled in the future, however only one will be allowed to execute at a time (that can change in the future for non-mutating operations). UnitOperations allow different actors interacting with the same unit to focus only on the change they have requested. This is a base object that contains the common fields in all unit operations. Next: 19

delete_release

delete_release(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.DeleteReleaseRequest,
            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]]] = ()
) -> None

Delete a single release.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_delete_release():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.DeleteReleaseRequest(
        name="name_value",
    )

    # Make the request
    client.delete_release(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.DeleteReleaseRequest, dict]` The request object. The request structure for the DeleteRelease method.
`name`	`str` Required. The resource name of the resource within a service. 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`.

delete_saas

delete_saas(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.DeleteSaasRequest,
            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]]] = ()
) -> None

Delete a single saas.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_delete_saas():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.DeleteSaasRequest(
        name="name_value",
    )

    # Make the request
    client.delete_saas(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.DeleteSaasRequest, dict]` The request object. The request structure for the DeleteSaas method.
`name`	`str` Required. The resource name of the resource within a service. 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`.

delete_tenant

delete_tenant(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.DeleteTenantRequest,
            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]]] = ()
) -> None

Delete a single tenant.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_delete_tenant():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.DeleteTenantRequest(
        name="name_value",
    )

    # Make the request
    client.delete_tenant(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.DeleteTenantRequest, dict]` The request object. The request structure for the DeleteTenant method.
`name`	`str` Required. The resource name of the resource within a service. 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`.

delete_unit

delete_unit(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.DeleteUnitRequest,
            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]]] = ()
) -> None

Delete a single unit.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_delete_unit():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.DeleteUnitRequest(
        name="name_value",
    )

    # Make the request
    client.delete_unit(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.DeleteUnitRequest, dict]` The request object. The request structure for the DeleteUnit method.
`name`	`str` Required. The resource name of the resource within a service. 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`.

delete_unit_kind

delete_unit_kind(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.DeleteUnitKindRequest,
            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]]] = ()
) -> None

Delete a single unit kind.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_delete_unit_kind():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.DeleteUnitKindRequest(
        name="name_value",
    )

    # Make the request
    client.delete_unit_kind(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.DeleteUnitKindRequest, dict]` The request object. The request structure for the DeleteUnitKind method.
`name`	`str` Required. The resource name of the resource within a service. 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`.

delete_unit_operation

delete_unit_operation(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.DeleteUnitOperationRequest,
            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]]] = ()
) -> None

Delete a single unit operation.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_delete_unit_operation():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.DeleteUnitOperationRequest(
        name="name_value",
    )

    # Make the request
    client.delete_unit_operation(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.DeleteUnitOperationRequest, dict]` The request object. The request structure for the DeleteUnitOperation method.
`name`	`str` Required. The resource name of the resource within a service. 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`.

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

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = 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.location.locations_pb2.Location

Gets information about a location.

Parameters
Name	Description
`request`	`.location_pb2.GetLocationRequest` The request object. Request message for `GetLocation` method.
`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
`.location_pb2.Location`	Location object.

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.

get_release

get_release(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.GetReleaseRequest,
            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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Release
)

Retrieve a single release.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_get_release():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.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.saasplatform_saasservicemgmt_v1beta1.types.GetReleaseRequest, dict]` The request object. The request structure for the GetRelease method.
`name`	`str` Required. The resource name of the resource within a service. 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.saasplatform_saasservicemgmt_v1beta1.types.Release`	A new version to be propagated and deployed to units. This includes pointers to packaged blueprints for actuation (e.g Helm or Terraform configuration packages) via artifact registry.

get_saas

get_saas(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.GetSaasRequest,
            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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Saas

Retrieve a single saas.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_get_saas():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.GetSaasRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.GetSaasRequest, dict]` The request object. The request structure for the GetSaas method.
`name`	`str` Required. The resource name of the resource within a service. 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.saasplatform_saasservicemgmt_v1beta1.types.Saas`	Saas is a representation of a SaaS service managed by the Producer.

get_tenant

get_tenant(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.GetTenantRequest,
            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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Tenant
)

Retrieve a single tenant.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_get_tenant():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.GetTenantRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.GetTenantRequest, dict]` The request object. The request structure for the GetTenant method.
`name`	`str` Required. The resource name of the resource within a service. 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.saasplatform_saasservicemgmt_v1beta1.types.Tenant`	Tenant represents the service producer side of an instance of the service created based on a request from a consumer. In a typical scenario a Tenant has a one-to-one mapping with a resource given out to a service consumer. Example: tenant: name: "projects/svc1/locations/loc/tenants/inst-068afff8" consumer_resource: "projects/gshoe/locations/loc/shoes/black-shoe"

get_unit

get_unit(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.GetUnitRequest,
            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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Unit

Retrieve a single unit.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_get_unit():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.GetUnitRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.GetUnitRequest, dict]` The request object. The request structure for the GetUnit method.
`name`	`str` Required. The resource name of the resource within a service. 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.saasplatform_saasservicemgmt_v1beta1.types.Unit`	A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.

get_unit_kind

get_unit_kind(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.GetUnitKindRequest,
            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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.UnitKind
)

Retrieve a single unit kind.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_get_unit_kind():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.GetUnitKindRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.GetUnitKindRequest, dict]` The request object. The request structure for the GetUnitKind method.
`name`	`str` Required. The resource name of the resource within a service. 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.saasplatform_saasservicemgmt_v1beta1.types.UnitKind`	Definition of a Unit. Units belonging to the same UnitKind are managed together; for example they follow the same release model (blueprints, versions etc.) and are typically rolled out together.

get_unit_operation

get_unit_operation(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.GetUnitOperationRequest,
            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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.UnitOperation
)

Retrieve a single unit operation.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_get_unit_operation():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.GetUnitOperationRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.GetUnitOperationRequest, dict]` The request object. The request structure for the GetUnitOperation method.
`name`	`str` Required. The resource name of the resource within a service. 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

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = 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.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name	Description
`request`	`.location_pb2.ListLocationsRequest` The request object. Request message for `ListLocations` method.
`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
`.location_pb2.ListLocationsResponse`	Response message for `ListLocations` method.

list_releases

list_releases(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.ListReleasesRequest,
            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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListReleasesPager
)

Retrieve a collection of releases.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_list_releases():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.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.saasplatform_saasservicemgmt_v1beta1.types.ListReleasesRequest, dict]` The request object. The request structure for the ListReleases method.
`parent`	`str` Required. The parent of the release. 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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListReleasesPager`	The response structure for the ListReleases method. Iterating over this object will yield results and resolve additional pages automatically.

list_saas

list_saas(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.ListSaasRequest,
            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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListSaasPager
)

Retrieve a collection of saas.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_list_saas():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.ListSaasRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.ListSaasRequest, dict]` The request object. The request structure for the ListSaas method.
`parent`	`str` Required. The parent of the saas. 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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListSaasPager`	The response structure for the ListSaas method. Iterating over this object will yield results and resolve additional pages automatically.

list_tenants

list_tenants(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.ListTenantsRequest,
            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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListTenantsPager
)

Retrieve a collection of tenants.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_list_tenants():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.ListTenantsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.ListTenantsRequest, dict]` The request object. The request structure for the ListTenants method.
`parent`	`str` Required. The parent of the tenant. 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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListTenantsPager`	The response structure for the ListTenants method. Iterating over this object will yield results and resolve additional pages automatically.

list_unit_kinds

list_unit_kinds(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.ListUnitKindsRequest,
            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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListUnitKindsPager
)

Retrieve a collection of unit kinds.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_list_unit_kinds():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.ListUnitKindsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.ListUnitKindsRequest, dict]` The request object. The request structure for the ListUnitKinds method.
`parent`	`str` Required. The parent of the unit kind. 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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListUnitKindsPager`	The response structure for the ListUnitKinds method. Iterating over this object will yield results and resolve additional pages automatically.

list_unit_operations

list_unit_operations(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.ListUnitOperationsRequest,
            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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListUnitOperationsPager
)

Retrieve a collection of unit operations.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_list_unit_operations():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.ListUnitOperationsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.ListUnitOperationsRequest, dict]` The request object. The request structure for the ListUnitOperations method.
`parent`	`str` Required. The parent of the unit operation. 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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListUnitOperationsPager`	The response structure for the ListUnitOperations method. Iterating over this object will yield results and resolve additional pages automatically.

list_units

list_units(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.ListUnitsRequest,
            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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListUnitsPager
)

Retrieve a collection of units.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_list_units():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.ListUnitsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.ListUnitsRequest, dict]` The request object. The request structure for the ListUnits method.
`parent`	`str` Required. The parent of the unit. 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.saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers.ListUnitsPager`	The response structure for the ListUnits method. Iterating over this object will yield results and resolve additional pages automatically.

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.

parse_release_path

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

Parses a release path into its component segments.

parse_rollout_path

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

Parses a rollout path into its component segments.

parse_saas_path

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

Parses a saas path into its component segments.

parse_tenant_path

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

Parses a tenant path into its component segments.

parse_unit_kind_path

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

Parses a unit_kind path into its component segments.

parse_unit_operation_path

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

Parses a unit_operation path into its component segments.

parse_unit_path

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

Parses a unit path into its component segments.

release_path

release_path(project: str, location: str, release: str) -> str

Returns a fully-qualified release string.

rollout_path

rollout_path(project: str, location: str, rollout_id: str) -> str

Returns a fully-qualified rollout string.

saas_path

saas_path(project: str, location: str, saas: str) -> str

Returns a fully-qualified saas string.

tenant_path

tenant_path(project: str, location: str, tenant: str) -> str

Returns a fully-qualified tenant string.

unit_kind_path

unit_kind_path(project: str, location: str, unitKind: str) -> str

Returns a fully-qualified unit_kind string.

unit_operation_path

unit_operation_path(project: str, location: str, unitOperation: str) -> str

Returns a fully-qualified unit_operation string.

unit_path

unit_path(project: str, location: str, unit: str) -> str

Returns a fully-qualified unit string.

update_release

update_release(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.UpdateReleaseRequest,
            dict,
        ]
    ] = None,
    *,
    release: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Release
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Release
)

Update a single release.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_update_release():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    release = saasplatform_saasservicemgmt_v1beta1.Release()
    release.unit_kind = "unit_kind_value"

    request = saasplatform_saasservicemgmt_v1beta1.UpdateReleaseRequest(
        release=release,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UpdateReleaseRequest, dict]` The request object. The request structure for the UpdateRelease method.
`release`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Release` Required. The desired state for the release. This corresponds to the `release` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Field mask is used to specify the fields to be overwritten in the Release 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 in the Release 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, 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.saasplatform_saasservicemgmt_v1beta1.types.Release`	A new version to be propagated and deployed to units. This includes pointers to packaged blueprints for actuation (e.g Helm or Terraform configuration packages) via artifact registry.

update_saas

update_saas(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.UpdateSaasRequest,
            dict,
        ]
    ] = None,
    *,
    saas: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Saas
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Saas

Update a single saas.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_update_saas():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.UpdateSaasRequest(
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UpdateSaasRequest, dict]` The request object. The request structure for the UpdateSaas method.
`saas`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Saas` Required. The desired state for the saas. This corresponds to the `saas` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Field mask is used to specify the fields to be overwritten in the Saas 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 in the Saas 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, 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.saasplatform_saasservicemgmt_v1beta1.types.Saas`	Saas is a representation of a SaaS service managed by the Producer.

update_tenant

update_tenant(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.UpdateTenantRequest,
            dict,
        ]
    ] = None,
    *,
    tenant: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Tenant
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Tenant
)

Update a single tenant.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_update_tenant():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    tenant = saasplatform_saasservicemgmt_v1beta1.Tenant()
    tenant.saas = "saas_value"

    request = saasplatform_saasservicemgmt_v1beta1.UpdateTenantRequest(
        tenant=tenant,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UpdateTenantRequest, dict]` The request object. The request structure for the UpdateTenant method.
`tenant`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Tenant` Required. The desired state for the tenant. This corresponds to the `tenant` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Field mask is used to specify the fields to be overwritten in the Tenant 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 in the Tenant 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, 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.saasplatform_saasservicemgmt_v1beta1.types.Tenant`	Tenant represents the service producer side of an instance of the service created based on a request from a consumer. In a typical scenario a Tenant has a one-to-one mapping with a resource given out to a service consumer. Example: tenant: name: "projects/svc1/locations/loc/tenants/inst-068afff8" consumer_resource: "projects/gshoe/locations/loc/shoes/black-shoe"

update_unit

update_unit(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.UpdateUnitRequest,
            dict,
        ]
    ] = None,
    *,
    unit: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Unit
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.Unit

Update a single unit.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_update_unit():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    request = saasplatform_saasservicemgmt_v1beta1.UpdateUnitRequest(
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UpdateUnitRequest, dict]` The request object. The request structure for the UpdateUnit method.
`unit`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Unit` Required. The desired state for the unit. This corresponds to the `unit` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Field mask is used to specify the fields to be overwritten in the Unit 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 in the Unit 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, 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.saasplatform_saasservicemgmt_v1beta1.types.Unit`	A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.

update_unit_kind

update_unit_kind(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.UpdateUnitKindRequest,
            dict,
        ]
    ] = None,
    *,
    unit_kind: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.UnitKind
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.UnitKind
)

Update a single unit kind.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_update_unit_kind():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    unit_kind = saasplatform_saasservicemgmt_v1beta1.UnitKind()
    unit_kind.saas = "saas_value"

    request = saasplatform_saasservicemgmt_v1beta1.UpdateUnitKindRequest(
        unit_kind=unit_kind,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UpdateUnitKindRequest, dict]` The request object. The request structure for the UpdateUnitKind method.
`unit_kind`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitKind` Required. The desired state for the unit kind. This corresponds to the `unit_kind` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Field mask is used to specify the fields to be overwritten in the UnitKind 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 in the UnitKind 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, 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.saasplatform_saasservicemgmt_v1beta1.types.UnitKind`	Definition of a Unit. Units belonging to the same UnitKind are managed together; for example they follow the same release model (blueprints, versions etc.) and are typically rolled out together.

update_unit_operation

update_unit_operation(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_service.UpdateUnitOperationRequest,
            dict,
        ]
    ] = None,
    *,
    unit_operation: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.UnitOperation
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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.saasplatform_saasservicemgmt_v1beta1.types.deployments_resources.UnitOperation
)

Update a single unit operation.

# 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 saasplatform_saasservicemgmt_v1beta1

def sample_update_unit_operation():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasDeploymentsClient()

    # Initialize request argument(s)
    unit_operation = saasplatform_saasservicemgmt_v1beta1.UnitOperation()
    unit_operation.unit = "unit_value"

    request = saasplatform_saasservicemgmt_v1beta1.UpdateUnitOperationRequest(
        unit_operation=unit_operation,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UpdateUnitOperationRequest, dict]` The request object. The request structure for the UpdateUnitOperation method.
`unit_operation`	`google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitOperation` Required. The desired state for the unit operation. This corresponds to the `unit_operation` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Field mask is used to specify the fields to be overwritten in the UnitOperation 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 in the UnitOperation 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, 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

Class SaasDeploymentsClient (0.1.0) Stay organized with collections Save and categorize content based on your preferences.

Properties

api_endpoint

transport

universe_domain

Methods

SaasDeploymentsClient

__exit__

common_billing_account_path

common_folder_path

common_location_path

common_organization_path

common_project_path

create_release

create_saas

create_tenant

create_unit

create_unit_kind

create_unit_operation

delete_release

delete_saas

delete_tenant

delete_unit

delete_unit_kind

delete_unit_operation

from_service_account_file

from_service_account_info

from_service_account_json

get_location

get_mtls_endpoint_and_cert_source

get_release

get_saas

get_tenant

get_unit

get_unit_kind

get_unit_operation

list_locations

list_releases

list_saas

list_tenants

list_unit_kinds

list_unit_operations

list_units

parse_common_billing_account_path

parse_common_folder_path

parse_common_location_path

parse_common_organization_path

parse_common_project_path

parse_release_path

parse_rollout_path

parse_saas_path

parse_tenant_path

parse_unit_kind_path

parse_unit_operation_path

parse_unit_path

release_path

rollout_path

saas_path

tenant_path

unit_kind_path

unit_operation_path

unit_path

update_release

update_saas

update_tenant

update_unit

update_unit_kind

update_unit_operation

Class SaasDeploymentsClient (0.1.0)

exit