Class GSuiteAddOnsAsyncClient (0.3.12)

GSuiteAddOnsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.transports.base.GSuiteAddOnsTransport, typing.Callable[[...], google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.transports.base.GSuiteAddOnsTransport]]] = '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 object>)

A service for managing Google Workspace Add-ons deployments.

A Google Workspace Add-on is a third-party embedded component that can be installed in Google Workspace Applications like Gmail, Calendar, Drive, and the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can display UI cards, receive contextual information from the host application, and perform actions in the host application (See:

https://developers.google.com/gsuite/add-ons/overview for more information).

A Google Workspace Add-on deployment resource specifies metadata about the add-on, including a specification of the entry points in the host application that trigger add-on executions (see:

https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests). Add-on deployments defined via the Google Workspace Add-ons API define their entrypoints using HTTPS URLs (See:

https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),

A Google Workspace Add-on deployment can be installed in developer mode, which allows an add-on developer to test the experience an end-user would see when installing and running the add-on in their G Suite applications. When running in developer mode, more detailed error messages are exposed in the add-on UI to aid in debugging.

A Google Workspace Add-on deployment can be published to Google Workspace Marketplace, which allows other Google Workspace users to discover and install the add-on. See:

https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview for details.

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

GSuiteAddOnsAsyncClient

GSuiteAddOnsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.transports.base.GSuiteAddOnsTransport, typing.Callable[[...], google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.transports.base.GSuiteAddOnsTransport]]] = '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 object>)

Instantiates the g suite add ons 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,GSuiteAddOnsTransport,Callable[..., GSuiteAddOnsTransport]]]` 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 GSuiteAddOnsTransport 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.

authorization_path

authorization_path(project: str) -> str

Returns a fully-qualified authorization string.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

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

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_deployment

create_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.gsuiteaddons_v1.types.gsuiteaddons.CreateDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    deployment: typing.Optional[
        google.cloud.gsuiteaddons_v1.types.gsuiteaddons.Deployment
    ] = None,
    deployment_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, str]] = ()
) -> google.cloud.gsuiteaddons_v1.types.gsuiteaddons.Deployment

Creates a deployment with the specified name and configuration.

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

async def sample_create_deployment():
    # Create a client
    client = gsuiteaddons_v1.GSuiteAddOnsAsyncClient()

    # Initialize request argument(s)
    request = gsuiteaddons_v1.CreateDeploymentRequest(
        parent="parent_value",
        deployment_id="deployment_id_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.gsuiteaddons_v1.types.CreateDeploymentRequest, dict]]` The request object. Request message to create a deployment.
`parent`	`str` Required. Name of the project in which to create the deployment. Example: `projects/my_project`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`deployment`	`Deployment` Required. The deployment to create (deployment.name cannot be set). This corresponds to the `deployment` field on the `request` instance; if `request` is provided, this should not be set.
`deployment_id`	`str` Required. The id to use for this deployment. The full name of the created resource will be `projects/<project_number>/deployments/<deployment_id>`. This corresponds to the `deployment_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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.gsuiteaddons_v1.types.Deployment`	A Google Workspace Add-on deployment

delete_deployment

delete_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.gsuiteaddons_v1.types.gsuiteaddons.DeleteDeploymentRequest,
            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, str]] = ()
) -> None

Deletes the deployment with the given name.

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

async def sample_delete_deployment():
    # Create a client
    client = gsuiteaddons_v1.GSuiteAddOnsAsyncClient()

    # Initialize request argument(s)
    request = gsuiteaddons_v1.DeleteDeploymentRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_deployment(request=request)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.gsuiteaddons_v1.types.DeleteDeploymentRequest, dict]]` The request object. Request message to delete a deployment.
`name`	`str` Required. The full resource name of the deployment to delete. Example: `projects/my_project/deployments/my_deployment`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

deployment_path

deployment_path(project: str, deployment: str) -> str

Returns a fully-qualified deployment string.

from_service_account_file

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

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

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

Returns
Type	Description
`GSuiteAddOnsAsyncClient`	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
`GSuiteAddOnsAsyncClient`	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
`GSuiteAddOnsAsyncClient`	The constructed client.

get_authorization

get_authorization(
    request: typing.Optional[
        typing.Union[
            google.cloud.gsuiteaddons_v1.types.gsuiteaddons.GetAuthorizationRequest,
            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, str]] = ()
) -> google.cloud.gsuiteaddons_v1.types.gsuiteaddons.Authorization

Gets the authorization information for deployments in a given project.

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

async def sample_get_authorization():
    # Create a client
    client = gsuiteaddons_v1.GSuiteAddOnsAsyncClient()

    # Initialize request argument(s)
    request = gsuiteaddons_v1.GetAuthorizationRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.gsuiteaddons_v1.types.GetAuthorizationRequest, dict]]` The request object. Request message to get Google Workspace Add-ons authorization information.
`name`	`str` Required. Name of the project for which to get the Google Workspace Add-ons authorization information. Example: `projects/my_project/authorization`. 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.gsuiteaddons_v1.types.Authorization`	The authorization information used when invoking deployment endpoints.

get_deployment

get_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.gsuiteaddons_v1.types.gsuiteaddons.GetDeploymentRequest, 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, str]] = ()
) -> google.cloud.gsuiteaddons_v1.types.gsuiteaddons.Deployment

Gets the deployment with the specified name.

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

async def sample_get_deployment():
    # Create a client
    client = gsuiteaddons_v1.GSuiteAddOnsAsyncClient()

    # Initialize request argument(s)
    request = gsuiteaddons_v1.GetDeploymentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.gsuiteaddons_v1.types.GetDeploymentRequest, dict]]` The request object. Request message to get a deployment.
`name`	`str` Required. The full resource name of the deployment to get. Example: `projects/my_project/deployments/my_deployment`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.gsuiteaddons_v1.types.Deployment`	A Google Workspace Add-on deployment

get_install_status

get_install_status(
    request: typing.Optional[
        typing.Union[
            google.cloud.gsuiteaddons_v1.types.gsuiteaddons.GetInstallStatusRequest,
            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, str]] = ()
) -> google.cloud.gsuiteaddons_v1.types.gsuiteaddons.InstallStatus

Fetches the install status of a developer mode deployment.

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

async def sample_get_install_status():
    # Create a client
    client = gsuiteaddons_v1.GSuiteAddOnsAsyncClient()

    # Initialize request argument(s)
    request = gsuiteaddons_v1.GetInstallStatusRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.gsuiteaddons_v1.types.GetInstallStatusRequest, dict]]` The request object. Request message to get the install status of a developer mode deployment.
`name`	`str` Required. The full resource name of the deployment. Example: `projects/my_project/deployments/my_deployment/installStatus`. 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.gsuiteaddons_v1.types.InstallStatus`	Developer mode install status of a deployment

get_mtls_endpoint_and_cert_source

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_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.transports.base.GSuiteAddOnsTransport
]

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.

install_deployment

install_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.gsuiteaddons_v1.types.gsuiteaddons.InstallDeploymentRequest,
            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, str]] = ()
) -> None

Installs a deployment in developer mode. See:

https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.

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

async def sample_install_deployment():
    # Create a client
    client = gsuiteaddons_v1.GSuiteAddOnsAsyncClient()

    # Initialize request argument(s)
    request = gsuiteaddons_v1.InstallDeploymentRequest(
        name="name_value",
    )

    # Make the request
    await client.install_deployment(request=request)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.gsuiteaddons_v1.types.InstallDeploymentRequest, dict]]` The request object. Request message to install a developer mode deployment.
`name`	`str` Required. The full resource name of the deployment to install. Example: `projects/my_project/deployments/my_deployment`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

install_status_path

install_status_path(project: str, deployment: str) -> str

Returns a fully-qualified install_status string.

list_deployments

list_deployments(
    request: typing.Optional[
        typing.Union[
            google.cloud.gsuiteaddons_v1.types.gsuiteaddons.ListDeploymentsRequest, 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, str]] = ()
) -> (
    google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.pagers.ListDeploymentsAsyncPager
)

Lists all deployments in a particular project.

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

async def sample_list_deployments():
    # Create a client
    client = gsuiteaddons_v1.GSuiteAddOnsAsyncClient()

    # Initialize request argument(s)
    request = gsuiteaddons_v1.ListDeploymentsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.gsuiteaddons_v1.types.ListDeploymentsRequest, dict]]` The request object. Request message to list deployments for a project.
`parent`	`str` Required. Name of the project in which to create the deployment. Example: `projects/my_project`. 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.gsuiteaddons_v1.services.g_suite_add_ons.pagers.ListDeploymentsAsyncPager`	Response message to list deployments. Iterating over this object will yield results and resolve additional pages automatically.

parse_authorization_path

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

Parses a authorization path into its component segments.

parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

parse_common_folder_path

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

Parse a folder path into its component segments.

parse_common_location_path

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

Parse a location path into its component segments.

parse_common_organization_path

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

Parse a organization path into its component segments.

parse_common_project_path

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

Parse a project path into its component segments.

parse_deployment_path

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

Parses a deployment path into its component segments.

parse_install_status_path

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

Parses a install_status path into its component segments.

replace_deployment

replace_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.gsuiteaddons_v1.types.gsuiteaddons.ReplaceDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    deployment: typing.Optional[
        google.cloud.gsuiteaddons_v1.types.gsuiteaddons.Deployment
    ] = 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, str]] = ()
) -> google.cloud.gsuiteaddons_v1.types.gsuiteaddons.Deployment

Creates or replaces a deployment with the specified name.

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

async def sample_replace_deployment():
    # Create a client
    client = gsuiteaddons_v1.GSuiteAddOnsAsyncClient()

    # Initialize request argument(s)
    request = gsuiteaddons_v1.ReplaceDeploymentRequest(
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.gsuiteaddons_v1.types.ReplaceDeploymentRequest, dict]]` The request object. Request message to create or replace a deployment.
`deployment`	`Deployment` Required. The deployment to create or replace. This corresponds to the `deployment` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.gsuiteaddons_v1.types.Deployment`	A Google Workspace Add-on deployment

uninstall_deployment

uninstall_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.gsuiteaddons_v1.types.gsuiteaddons.UninstallDeploymentRequest,
            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, str]] = ()
) -> None

Uninstalls a developer mode deployment. See:

https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.

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

async def sample_uninstall_deployment():
    # Create a client
    client = gsuiteaddons_v1.GSuiteAddOnsAsyncClient()

    # Initialize request argument(s)
    request = gsuiteaddons_v1.UninstallDeploymentRequest(
        name="name_value",
    )

    # Make the request
    await client.uninstall_deployment(request=request)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.gsuiteaddons_v1.types.UninstallDeploymentRequest, dict]]` The request object. Request message to uninstall a developer mode deployment.
`name`	`str` Required. The full resource name of the deployment to install. Example: `projects/my_project/deployments/my_deployment`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.