0.7.3 (latest) 0.7.2 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

```python
SaasRolloutsAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.saasplatform_saasservicemgmt_v1beta1.services.saas_rollouts.transports.base.SaasRolloutsTransport,
            typing.Callable[
                [...],
                google.cloud.saasplatform_saasservicemgmt_v1beta1.services.saas_rollouts.transports.base.SaasRolloutsTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)
```
Manages the rollout 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** |
| `SaasRolloutsTransport` | 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

### SaasRolloutsAsyncClient

```python
SaasRolloutsAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.saasplatform_saasservicemgmt_v1beta1.services.saas_rollouts.transports.base.SaasRolloutsTransport,
            typing.Callable[
                [...],
                google.cloud.saasplatform_saasservicemgmt_v1beta1.services.saas_rollouts.transports.base.SaasRolloutsTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)
```
Instantiates the saas rollouts async 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,SaasRolloutsTransport,Callable[..., SaasRolloutsTransport]]]` The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the SaasRolloutsTransport 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 `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. |

### common_billing_account_path

```python
common_billing_account_path(billing_account: str) -> str
```
Returns a fully-qualified billing_account string.

### common_folder_path

```python
common_folder_path(folder: str) -> str
```
Returns a fully-qualified folder string.

### common_location_path

```python
common_location_path(project: str, location: str) -> str
```
Returns a fully-qualified location string.

### common_organization_path

```python
common_organization_path(organization: str) -> str
```
Returns a fully-qualified organization string.

### common_project_path

```python
common_project_path(project: str) -> str
```
Returns a fully-qualified project string.

### create_rollout

```python
create_rollout(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_service.CreateRolloutRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    rollout: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_resources.Rollout
    ] = None,
    rollout_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.rollouts_resources.Rollout
```
Create a new rollout.

```python
# 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

async def sample_create_rollout():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasRolloutsAsyncClient()

    # Initialize request argument(s)
    rollout = saasplatform_saasservicemgmt_v1beta1.Rollout()
    rollout.rollout_kind = "rollout_kind_value"

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

    # Make the request
    response = await client.create_rollout(request=request)

    # Handle the response
    print(response)
```

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.CreateRolloutRequest, dict]]` The request object. The request structure for the CreateRollout method. |
| `parent` | `` `str` `` Required. The parent of the rollout. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. |
| `rollout` | `Rollout` Required. The desired state for the rollout. This corresponds to the `rollout` field on the `request` instance; if `request` is provided, this should not be set. |
| `rollout_id` | `` `str` `` Required. The ID value for the new rollout. This corresponds to the `rollout_id` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` 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.Rollout` | Represents a single rollout execution and its results |

### create_rollout_kind

```python
create_rollout_kind(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_service.CreateRolloutKindRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    rollout_kind: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_resources.RolloutKind
    ] = None,
    rollout_kind_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.rollouts_resources.RolloutKind
)
```
Create a new rollout kind.

```python
# 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

async def sample_create_rollout_kind():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasRolloutsAsyncClient()

    # Initialize request argument(s)
    rollout_kind = saasplatform_saasservicemgmt_v1beta1.RolloutKind()
    rollout_kind.unit_kind = "unit_kind_value"

    request = saasplatform_saasservicemgmt_v1beta1.CreateRolloutKindRequest(
        parent="parent_value",
        rollout_kind_id="rollout_kind_id_value",
        rollout_kind=rollout_kind,
    )

    # Make the request
    response = await client.create_rollout_kind(request=request)

    # Handle the response
    print(response)
```

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.CreateRolloutKindRequest, dict]]` The request object. The request structure for the CreateRolloutKind method. |
| `parent` | `` `str` `` Required. The parent of the rollout kind. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. |
| `rollout_kind` | `RolloutKind` Required. The desired state for the rollout kind. This corresponds to the `rollout_kind` field on the `request` instance; if `request` is provided, this should not be set. |
| `rollout_kind_id` | `` `str` `` Required. The ID value for the new rollout kind. This corresponds to the `rollout_kind_id` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` 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.RolloutKind` | An object that describes various settings of Rollout execution. Includes built-in policies across GCP and GDC, and customizable policies. |

### delete_rollout

```python
delete_rollout(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_service.DeleteRolloutRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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 rollout.

```python
# 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

async def sample_delete_rollout():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasRolloutsAsyncClient()

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

    # Make the request
    await client.delete_rollout(request=request)
```

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.DeleteRolloutRequest, dict]]` The request object. The request structure for the DeleteRollout 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_async.AsyncRetry` 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_rollout_kind

```python
delete_rollout_kind(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_service.DeleteRolloutKindRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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 rollout kind.

```python
# 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

async def sample_delete_rollout_kind():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasRolloutsAsyncClient()

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

    # Make the request
    await client.delete_rollout_kind(request=request)
```

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.DeleteRolloutKindRequest, dict]]` The request object. The request structure for the DeleteRolloutKind 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_async.AsyncRetry` 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

```python
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** |
| `SaasRolloutsAsyncClient` | The constructed client. |

### from_service_account_info

```python
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** |
| `SaasRolloutsAsyncClient` | The constructed client. |

### from_service_account_json

```python
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** |
| `SaasRolloutsAsyncClient` | The constructed client. |

### get_location

```python
get_location(
    request: typing.Optional[
        typing.Union[google.cloud.location.locations_pb2.GetLocationRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncRetry` 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

```python
get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)
```
Return the API endpoint and client cert source for mutual TLS.

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

The API endpoint is determined in the following order:
(1) if `client_options.api_endpoint` if provided, use the provided one.
(2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the
default mTLS endpoint; if the environment 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_rollout

```python
get_rollout(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_service.GetRolloutRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.rollouts_resources.Rollout
```
Retrieve a single rollout.

```python
# 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

async def sample_get_rollout():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasRolloutsAsyncClient()

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

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

    # Handle the response
    print(response)
```

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.GetRolloutRequest, dict]]` The request object. The request structure for the GetRollout 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_async.AsyncRetry` 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.Rollout` | Represents a single rollout execution and its results |

### get_rollout_kind

```python
get_rollout_kind(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_service.GetRolloutKindRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.rollouts_resources.RolloutKind
)
```
Retrieve a single rollout kind.

```python
# 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

async def sample_get_rollout_kind():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasRolloutsAsyncClient()

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

    # Make the request
    response = await client.get_rollout_kind(request=request)

    # Handle the response
    print(response)
```

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.GetRolloutKindRequest, dict]]` The request object. The request structure for the GetRolloutKind 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_async.AsyncRetry` 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.RolloutKind` | An object that describes various settings of Rollout execution. Includes built-in policies across GCP and GDC, and customizable policies. |

### get_transport_class

```python
get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.saasplatform_saasservicemgmt_v1beta1.services.saas_rollouts.transports.base.SaasRolloutsTransport
]
```
Returns an appropriate transport class.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `label` | `typing.Optional[str]` The name of the desired transport. If none is provided, then the first transport in the registry is used. |

### list_locations

```python
list_locations(
    request: typing.Optional[
        typing.Union[google.cloud.location.locations_pb2.ListLocationsRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncRetry` 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_rollout_kinds

```python
list_rollout_kinds(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_service.ListRolloutKindsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_rollouts.pagers.ListRolloutKindsAsyncPager
)
```
Retrieve a collection of rollout kinds.

```python
# 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

async def sample_list_rollout_kinds():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasRolloutsAsyncClient()

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

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

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.ListRolloutKindsRequest, dict]]` The request object. The request structure for the ListRolloutKinds method. |
| `parent` | `` `str` `` Required. The parent of the rollout 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_async.AsyncRetry` 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_rollouts.pagers.ListRolloutKindsAsyncPager` | The response structure for the ListRolloutKinds method. Iterating over this object will yield results and resolve additional pages automatically. |

### list_rollouts

```python
list_rollouts(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_service.ListRolloutsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_rollouts.pagers.ListRolloutsAsyncPager
)
```
Retrieve a collection of rollouts.

```python
# 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

async def sample_list_rollouts():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasRolloutsAsyncClient()

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

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

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.ListRolloutsRequest, dict]]` The request object. The request structure for the ListRollouts method. |
| `parent` | `` `str` `` Required. The parent of the rollout. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` 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_rollouts.pagers.ListRolloutsAsyncPager` | The response structure for the ListRollouts method. Iterating over this object will yield results and resolve additional pages automatically. |

### parse_common_billing_account_path

```python
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
```
Parse a billing_account path into its component segments.

### parse_common_folder_path

```python
parse_common_folder_path(path: str) -> typing.Dict[str, str]
```
Parse a folder path into its component segments.

### parse_common_location_path

```python
parse_common_location_path(path: str) -> typing.Dict[str, str]
```
Parse a location path into its component segments.

### parse_common_organization_path

```python
parse_common_organization_path(path: str) -> typing.Dict[str, str]
```
Parse a organization path into its component segments.

### parse_common_project_path

```python
parse_common_project_path(path: str) -> typing.Dict[str, str]
```
Parse a project path into its component segments.

### parse_release_path

```python
parse_release_path(path: str) -> typing.Dict[str, str]
```
Parses a release path into its component segments.

### parse_rollout_kind_path

```python
parse_rollout_kind_path(path: str) -> typing.Dict[str, str]
```
Parses a rollout_kind path into its component segments.

### parse_rollout_path

```python
parse_rollout_path(path: str) -> typing.Dict[str, str]
```
Parses a rollout path into its component segments.

### parse_unit_kind_path

```python
parse_unit_kind_path(path: str) -> typing.Dict[str, str]
```
Parses a unit_kind path into its component segments.

### release_path

```python
release_path(project: str, location: str, release: str) -> str
```
Returns a fully-qualified release string.

### rollout_kind_path

```python
rollout_kind_path(project: str, location: str, rollout_kind_id: str) -> str
```
Returns a fully-qualified rollout_kind string.

### rollout_path

```python
rollout_path(project: str, location: str, rollout_id: str) -> str
```
Returns a fully-qualified rollout string.

### unit_kind_path

```python
unit_kind_path(project: str, location: str, unitKind: str) -> str
```
Returns a fully-qualified unit_kind string.

### update_rollout

```python
update_rollout(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_service.UpdateRolloutRequest,
            dict,
        ]
    ] = None,
    *,
    rollout: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_resources.Rollout
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.rollouts_resources.Rollout
```
Update a single rollout.

```python
# 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

async def sample_update_rollout():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasRolloutsAsyncClient()

    # Initialize request argument(s)
    rollout = saasplatform_saasservicemgmt_v1beta1.Rollout()
    rollout.rollout_kind = "rollout_kind_value"

    request = saasplatform_saasservicemgmt_v1beta1.UpdateRolloutRequest(
        rollout=rollout,
    )

    # Make the request
    response = await client.update_rollout(request=request)

    # Handle the response
    print(response)
```

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UpdateRolloutRequest, dict]]` The request object. The request structure for the UpdateRollout method. |
| `rollout` | `Rollout` Required. The desired state for the rollout. This corresponds to the `rollout` 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 Rollout 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 Rollout 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_async.AsyncRetry` 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.Rollout` | Represents a single rollout execution and its results |

### update_rollout_kind

```python
update_rollout_kind(
    request: typing.Optional[
        typing.Union[
            google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_service.UpdateRolloutKindRequest,
            dict,
        ]
    ] = None,
    *,
    rollout_kind: typing.Optional[
        google.cloud.saasplatform_saasservicemgmt_v1beta1.types.rollouts_resources.RolloutKind
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.rollouts_resources.RolloutKind
)
```
Update a single rollout kind.

```python
# 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

async def sample_update_rollout_kind():
    # Create a client
    client = saasplatform_saasservicemgmt_v1beta1.SaasRolloutsAsyncClient()

    # Initialize request argument(s)
    rollout_kind = saasplatform_saasservicemgmt_v1beta1.RolloutKind()
    rollout_kind.unit_kind = "unit_kind_value"

    request = saasplatform_saasservicemgmt_v1beta1.UpdateRolloutKindRequest(
        rollout_kind=rollout_kind,
    )

    # Make the request
    response = await client.update_rollout_kind(request=request)

    # Handle the response
    print(response)
```

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UpdateRolloutKindRequest, dict]]` The request object. The request structure for the UpdateRolloutKind method. |
| `rollout_kind` | `RolloutKind` Required. The desired state for the rollout kind. This corresponds to the `rollout_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 RolloutKind 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 RolloutKind 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_async.AsyncRetry` 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.RolloutKind` | An object that describes various settings of Rollout execution. Includes built-in policies across GCP and GDC, and customizable policies. |