Class TelcoAutomationClient (0.2.8) 

TelcoAutomationClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.telcoautomation_v1alpha1.services.telco_automation.transports.base.TelcoAutomationTransport, typing.Callable[[...], google.cloud.telcoautomation_v1alpha1.services.telco_automation.transports.base.TelcoAutomationTransport]]] = 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>)

TelcoAutomation Service manages the control plane cluster a.k.a. Orchestration Cluster (GKE cluster with config controller) of TNA. It also exposes blueprint APIs which manages the lifecycle of blueprints that control the infrastructure setup (e.g GDCE clusters) and deployment of network functions.

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
TelcoAutomationTransport 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

TelcoAutomationClient

TelcoAutomationClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.telcoautomation_v1alpha1.services.telco_automation.transports.base.TelcoAutomationTransport, typing.Callable[[...], google.cloud.telcoautomation_v1alpha1.services.telco_automation.transports.base.TelcoAutomationTransport]]] = 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 telco automation 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,TelcoAutomationTransport,Callable[..., TelcoAutomationTransport]]]

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 TelcoAutomationTransport 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.

apply_deployment

apply_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ApplyDeploymentRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.Deployment

Applies the deployment's YAML files to the parent orchestration cluster.

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

def sample_apply_deployment():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ApplyDeploymentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ApplyDeploymentRequest, dict]

The request object. Request object for ApplyDeployment. The resources in given deployment gets applied to Orchestration Cluster. A new revision is created when a deployment is applied.
name str

Required. The name of the deployment to apply to orchestration cluster. 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.telcoautomation_v1alpha1.types.Deployment Deployment contains a collection of YAML files (This collection is also known as package) that can to applied on an orchestration cluster (GKE cluster with TNA addons) or a workload cluster.

apply_hydrated_deployment

apply_hydrated_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ApplyHydratedDeploymentRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.HydratedDeployment

Applies a hydrated deployment to a workload cluster.

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

def sample_apply_hydrated_deployment():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ApplyHydratedDeploymentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ApplyHydratedDeploymentRequest, dict]

The request object. Request for applying a hydrated deployment.
name str

Required. The name of the hydrated deployment to apply. 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.telcoautomation_v1alpha1.types.HydratedDeployment A collection of kubernetes yaml files which are deployed on a Workload Cluster. Hydrated Deployments are created by TNA intent based automation.

approve_blueprint

approve_blueprint(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ApproveBlueprintRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.Blueprint

Approves a blueprint and commits a new revision.

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

def sample_approve_blueprint():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ApproveBlueprintRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ApproveBlueprintRequest, dict]

The request object. Request object for ApproveBlueprint.
name str

Required. The name of the blueprint to approve. The blueprint must be in Proposed state. A new revision is committed on approval. 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.telcoautomation_v1alpha1.types.Blueprint A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. A blueprint can be a) imported from TNA's public catalog b) modified as per a user's need c) proposed and approved. On approval, a revision of blueprint is created which can be used to create a deployment on Orchestration or Workload Cluster.

blueprint_path

blueprint_path(
    project: str, location: str, orchestration_cluster: str, blueprint: str
) -> str

Returns a fully-qualified blueprint string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = 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

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation 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.

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.

compute_deployment_status

compute_deployment_status(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ComputeDeploymentStatusRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.ComputeDeploymentStatusResponse
)

Returns the requested deployment status.

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

def sample_compute_deployment_status():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ComputeDeploymentStatusRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ComputeDeploymentStatusRequest, dict]

The request object. Request object for ComputeDeploymentStatus.
name str

Required. The name of the deployment without revisionID. 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.telcoautomation_v1alpha1.types.ComputeDeploymentStatusResponse Response object for ComputeDeploymentStatus.

create_blueprint

create_blueprint(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.CreateBlueprintRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    blueprint: typing.Optional[
        google.cloud.telcoautomation_v1alpha1.types.telcoautomation.Blueprint
    ] = None,
    blueprint_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.telcoautomation_v1alpha1.types.telcoautomation.Blueprint

Creates a blueprint.

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

def sample_create_blueprint():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    blueprint = telcoautomation_v1alpha1.Blueprint()
    blueprint.source_blueprint = "source_blueprint_value"

    request = telcoautomation_v1alpha1.CreateBlueprintRequest(
        parent="parent_value",
        blueprint=blueprint,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.CreateBlueprintRequest, dict]

The request object. Request object for CreateBlueprint.
parent str

Required. The name of parent resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". This corresponds to the parent field on the request instance; if request is provided, this should not be set.
blueprint google.cloud.telcoautomation_v1alpha1.types.Blueprint

Required. The Blueprint to create. This corresponds to the blueprint field on the request instance; if request is provided, this should not be set.
blueprint_id str

Optional. The name of the blueprint. This corresponds to the blueprint_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.telcoautomation_v1alpha1.types.Blueprint A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. A blueprint can be a) imported from TNA's public catalog b) modified as per a user's need c) proposed and approved. On approval, a revision of blueprint is created which can be used to create a deployment on Orchestration or Workload Cluster.

create_deployment

create_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.CreateDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    deployment: typing.Optional[
        google.cloud.telcoautomation_v1alpha1.types.telcoautomation.Deployment
    ] = None,
    deployment_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.telcoautomation_v1alpha1.types.telcoautomation.Deployment

Creates a 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 telcoautomation_v1alpha1

def sample_create_deployment():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    deployment = telcoautomation_v1alpha1.Deployment()
    deployment.source_blueprint_revision = "source_blueprint_revision_value"

    request = telcoautomation_v1alpha1.CreateDeploymentRequest(
        parent="parent_value",
        deployment=deployment,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.CreateDeploymentRequest, dict]

The request object. Request object for CreateDeployment.
parent str

Required. The name of parent resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". This corresponds to the parent field on the request instance; if request is provided, this should not be set.
deployment google.cloud.telcoautomation_v1alpha1.types.Deployment

Required. The Deployment to create. This corresponds to the deployment field on the request instance; if request is provided, this should not be set.
deployment_id str

Optional. The name of the deployment. 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.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.telcoautomation_v1alpha1.types.Deployment Deployment contains a collection of YAML files (This collection is also known as package) that can to applied on an orchestration cluster (GKE cluster with TNA addons) or a workload cluster.

create_edge_slm

create_edge_slm(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.CreateEdgeSlmRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    edge_slm: typing.Optional[
        google.cloud.telcoautomation_v1alpha1.types.telcoautomation.EdgeSlm
    ] = None,
    edge_slm_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.api_core.operation.Operation

Creates a new EdgeSlm in a given project and location.

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

def sample_create_edge_slm():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.CreateEdgeSlmRequest(
        parent="parent_value",
        edge_slm_id="edge_slm_id_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.CreateEdgeSlmRequest, dict]

The request object. Message for creating a EdgeSlm.
parent str

Required. Value for parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
edge_slm google.cloud.telcoautomation_v1alpha1.types.EdgeSlm

Required. The resource being created This corresponds to the edge_slm field on the request instance; if request is provided, this should not be set.
edge_slm_id str

Required. Id of the requesting object If auto-generating Id server-side, remove this field and edge_slm_id from the method_signature of Create RPC This corresponds to the edge_slm_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.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be EdgeSlm EdgeSlm represents an SLM instance which manages the lifecycle of edge components installed on Workload clusters managed by an Orchestration Cluster.

create_orchestration_cluster

create_orchestration_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.CreateOrchestrationClusterRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    orchestration_cluster: typing.Optional[
        google.cloud.telcoautomation_v1alpha1.types.telcoautomation.OrchestrationCluster
    ] = None,
    orchestration_cluster_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.api_core.operation.Operation

Creates a new OrchestrationCluster in a given project and location.

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

def sample_create_orchestration_cluster():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.CreateOrchestrationClusterRequest(
        parent="parent_value",
        orchestration_cluster_id="orchestration_cluster_id_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.CreateOrchestrationClusterRequest, dict]

The request object. Message for creating a OrchestrationCluster.
parent str

Required. Value for parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
orchestration_cluster google.cloud.telcoautomation_v1alpha1.types.OrchestrationCluster

Required. The resource being created This corresponds to the orchestration_cluster field on the request instance; if request is provided, this should not be set.
orchestration_cluster_id str

Required. Id of the requesting object If auto-generating Id server-side, remove this field and orchestration_cluster_id from the method_signature of Create RPC This corresponds to the orchestration_cluster_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.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be OrchestrationCluster Orchestration cluster represents a GKE cluster with config controller and TNA specific components installed on it.

delete_blueprint

delete_blueprint(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.DeleteBlueprintRequest,
            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

Deletes a blueprint and all its revisions.

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

def sample_delete_blueprint():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.DeleteBlueprintRequest(
        name="name_value",
    )

    # Make the request
    client.delete_blueprint(request=request)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.DeleteBlueprintRequest, dict]

The request object. Request object for DeleteBlueprint.
name str

Required. The name of blueprint to delete. Blueprint name should be in the format {blueprint_id}, if {blueprint_id}@{revision_id} is passed then the API throws invalid argument. 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_edge_slm

delete_edge_slm(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.DeleteEdgeSlmRequest,
            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.api_core.operation.Operation

Deletes a single EdgeSlm.

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

def sample_delete_edge_slm():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.DeleteEdgeSlmRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.DeleteEdgeSlmRequest, dict]

The request object. Message for deleting a EdgeSlm.
name str

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

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = 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

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation 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.

delete_orchestration_cluster

delete_orchestration_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.DeleteOrchestrationClusterRequest,
            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.api_core.operation.Operation

Deletes a single OrchestrationCluster.

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

def sample_delete_orchestration_cluster():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.DeleteOrchestrationClusterRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.DeleteOrchestrationClusterRequest, dict]

The request object. Message for deleting a OrchestrationCluster.
name str

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

deployment_path

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

Returns a fully-qualified deployment string.

discard_blueprint_changes

discard_blueprint_changes(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.DiscardBlueprintChangesRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.DiscardBlueprintChangesResponse
)

Discards the changes in a blueprint and reverts the blueprint to the last approved blueprint revision. No changes take place if a blueprint does not have revisions.

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

def sample_discard_blueprint_changes():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.DiscardBlueprintChangesRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.DiscardBlueprintChangesRequest, dict]

The request object. Request object for DiscardBlueprintChanges.
name str

Required. The name of the blueprint of which changes are being discarded. 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.telcoautomation_v1alpha1.types.DiscardBlueprintChangesResponse Response object for DiscardBlueprintChanges.

discard_deployment_changes

discard_deployment_changes(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.DiscardDeploymentChangesRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.DiscardDeploymentChangesResponse
)

Discards the changes in a deployment and reverts the deployment to the last approved deployment revision. No changes take place if a deployment does not have revisions.

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

def sample_discard_deployment_changes():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.DiscardDeploymentChangesRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.DiscardDeploymentChangesRequest, dict]

The request object. Request object for DiscardDeploymentChanges.
name str

Required. The name of the deployment of which changes are being discarded. 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.telcoautomation_v1alpha1.types.DiscardDeploymentChangesResponse Response object for DiscardDeploymentChanges.

edge_slm_path

edge_slm_path(project: str, location: str, edge_slm: str) -> str

Returns a fully-qualified edge_slm 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
TelcoAutomationClient 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
TelcoAutomationClient 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
TelcoAutomationClient The constructed client.

get_blueprint

get_blueprint(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.GetBlueprintRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.Blueprint

Returns the requested blueprint.

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

def sample_get_blueprint():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.GetBlueprintRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.GetBlueprintRequest, dict]

The request object. Request object for GetBlueprint.
name str

Required. The name of the blueprint. Case 1: If the name provided in the request is {blueprint_id}@{revision_id}, then the revision with revision_id will be returned. Case 2: If the name provided in the request is {blueprint}, then the current state of the blueprint is returned. 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.telcoautomation_v1alpha1.types.Blueprint A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. A blueprint can be a) imported from TNA's public catalog b) modified as per a user's need c) proposed and approved. On approval, a revision of blueprint is created which can be used to create a deployment on Orchestration or Workload Cluster.

get_deployment

get_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.GetDeploymentRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.Deployment

Returns the requested 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 telcoautomation_v1alpha1

def sample_get_deployment():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.GetDeploymentRequest, dict]

The request object. Request object for GetDeployment.
name str

Required. The name of the deployment. Case 1: If the name provided in the request is {deployment_id}@{revision_id}, then the revision with revision_id will be returned. Case 2: If the name provided in the request is {deployment}, then the current state of the deployment is returned. 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.telcoautomation_v1alpha1.types.Deployment Deployment contains a collection of YAML files (This collection is also known as package) that can to applied on an orchestration cluster (GKE cluster with TNA addons) or a workload cluster.

get_edge_slm

get_edge_slm(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.GetEdgeSlmRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.EdgeSlm

Gets details of a single EdgeSlm.

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

def sample_get_edge_slm():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.GetEdgeSlmRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.GetEdgeSlmRequest, dict]

The request object. Message for getting a EdgeSlm.
name str

Required. Name of the resource 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.telcoautomation_v1alpha1.types.EdgeSlm EdgeSlm represents an SLM instance which manages the lifecycle of edge components installed on Workload clusters managed by an Orchestration Cluster.

get_hydrated_deployment

get_hydrated_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.GetHydratedDeploymentRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.HydratedDeployment

Returns the requested hydrated 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 telcoautomation_v1alpha1

def sample_get_hydrated_deployment():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.GetHydratedDeploymentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.GetHydratedDeploymentRequest, dict]

The request object. Request object for GetHydratedDeployment.
name str

Required. Name of the hydrated deployment. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.telcoautomation_v1alpha1.types.HydratedDeployment A collection of kubernetes yaml files which are deployed on a Workload Cluster. Hydrated Deployments are created by TNA intent based automation.

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_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = 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.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation 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
.operations_pb2.Operation An Operation object.

get_orchestration_cluster

get_orchestration_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.GetOrchestrationClusterRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.OrchestrationCluster

Gets details of a single OrchestrationCluster.

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

def sample_get_orchestration_cluster():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.GetOrchestrationClusterRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.GetOrchestrationClusterRequest, dict]

The request object. Message for getting a OrchestrationCluster.
name str

Required. Name of the resource 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.telcoautomation_v1alpha1.types.OrchestrationCluster Orchestration cluster represents a GKE cluster with config controller and TNA specific components installed on it.

get_public_blueprint

get_public_blueprint(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.GetPublicBlueprintRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.PublicBlueprint

Returns the requested public blueprint.

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

def sample_get_public_blueprint():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.GetPublicBlueprintRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.GetPublicBlueprintRequest, dict]

The request object. Request object for GetPublicBlueprint.
name str

Required. The name of the public blueprint. 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.telcoautomation_v1alpha1.types.PublicBlueprint A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. Public blueprint is a TNA provided blueprint that in present in TNA's public catalog. A user can copy the public blueprint to their private catalog for further modifications.

hydrated_deployment_path

hydrated_deployment_path(
    project: str,
    location: str,
    orchestration_cluster: str,
    deployment: str,
    hydrated_deployment: str,
) -> str

Returns a fully-qualified hydrated_deployment string.

list_blueprint_revisions

list_blueprint_revisions(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ListBlueprintRevisionsRequest,
            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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListBlueprintRevisionsPager
)

List blueprint revisions of a given blueprint.

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

def sample_list_blueprint_revisions():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ListBlueprintRevisionsRequest(
        name="name_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ListBlueprintRevisionsRequest, dict]

The request object. Request object for ListBlueprintRevisions.
name str

Required. The name of the blueprint to list revisions for. 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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListBlueprintRevisionsPager Response object for ListBlueprintRevisions. Iterating over this object will yield results and resolve additional pages automatically.

list_blueprints

list_blueprints(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ListBlueprintsRequest,
            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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListBlueprintsPager
)

List all blueprints.

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

def sample_list_blueprints():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ListBlueprintsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ListBlueprintsRequest, dict]

The request object. Request object for ListBlueprints.
parent str

Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". 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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListBlueprintsPager Response object for ListBlueprints. Iterating over this object will yield results and resolve additional pages automatically.

list_deployment_revisions

list_deployment_revisions(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ListDeploymentRevisionsRequest,
            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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListDeploymentRevisionsPager
)

List deployment revisions of a given 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 telcoautomation_v1alpha1

def sample_list_deployment_revisions():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ListDeploymentRevisionsRequest(
        name="name_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ListDeploymentRevisionsRequest, dict]

The request object. Request for listing all revisions of a deployment.
name str

Required. The name of the deployment to list revisions for. 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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListDeploymentRevisionsPager List of deployment revisions for a given deployment. Iterating over this object will yield results and resolve additional pages automatically.

list_deployments

list_deployments(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ListDeploymentsRequest,
            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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListDeploymentsPager
)

List all deployments.

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

def sample_list_deployments():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

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

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ListDeploymentsRequest, dict]

The request object. Request object for ListDeployments.
parent str

Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". 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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListDeploymentsPager Response object for ListDeployments. Iterating over this object will yield results and resolve additional pages automatically.

list_edge_slms

list_edge_slms(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ListEdgeSlmsRequest,
            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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListEdgeSlmsPager
)

Lists EdgeSlms in a given project and location.

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

def sample_list_edge_slms():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ListEdgeSlmsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ListEdgeSlmsRequest, dict]

The request object. Message for requesting list of EdgeSlms
parent str

Required. Parent value for ListEdgeSlmsRequest 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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListEdgeSlmsPager Message for response to listing EdgeSlms. Iterating over this object will yield results and resolve additional pages automatically.

list_hydrated_deployments

list_hydrated_deployments(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ListHydratedDeploymentsRequest,
            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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListHydratedDeploymentsPager
)

List all hydrated deployments present under a 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 telcoautomation_v1alpha1

def sample_list_hydrated_deployments():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ListHydratedDeploymentsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ListHydratedDeploymentsRequest, dict]

The request object. Request object for ListHydratedDeployments.
parent str

Required. The deployment managing the hydrated deployments. 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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListHydratedDeploymentsPager Response object for ListHydratedDeployments. Iterating over this object will yield results and resolve additional pages automatically.

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_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = 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.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations 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
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

list_orchestration_clusters

list_orchestration_clusters(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ListOrchestrationClustersRequest,
            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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListOrchestrationClustersPager
)

Lists OrchestrationClusters in a given project and location.

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

def sample_list_orchestration_clusters():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ListOrchestrationClustersRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ListOrchestrationClustersRequest, dict]

The request object. Message for requesting list of OrchestrationClusters.
parent str

Required. Parent value for ListOrchestrationClustersRequest 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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListOrchestrationClustersPager Message for response to listing OrchestrationClusters. Iterating over this object will yield results and resolve additional pages automatically.

list_public_blueprints

list_public_blueprints(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ListPublicBlueprintsRequest,
            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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListPublicBlueprintsPager
)

Lists the blueprints in TNA's public catalog. Default page size = 20, Max Page Size = 100.

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

def sample_list_public_blueprints():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ListPublicBlueprintsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ListPublicBlueprintsRequest, dict]

The request object. Request object for ListPublicBlueprints.
parent str

Required. Parent value of public blueprint. Format should be - "projects/{project_id}/locations/{location_name}". This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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.telcoautomation_v1alpha1.services.telco_automation.pagers.ListPublicBlueprintsPager Response object for ListPublicBlueprints. Iterating over this object will yield results and resolve additional pages automatically.

orchestration_cluster_path

orchestration_cluster_path(
    project: str, location: str, orchestration_cluster: str
) -> str

Returns a fully-qualified orchestration_cluster string.

parse_blueprint_path

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

Parses a blueprint 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_edge_slm_path

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

Parses a edge_slm path into its component segments.

parse_hydrated_deployment_path

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

Parses a hydrated_deployment path into its component segments.

parse_orchestration_cluster_path

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

Parses a orchestration_cluster path into its component segments.

parse_public_blueprint_path

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

Parses a public_blueprint path into its component segments.

propose_blueprint

propose_blueprint(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.ProposeBlueprintRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.Blueprint

Proposes a blueprint for approval of changes.

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

def sample_propose_blueprint():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.ProposeBlueprintRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.ProposeBlueprintRequest, dict]

The request object. Request object for ProposeBlueprint.
name str

Required. The name of the blueprint being proposed. 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.telcoautomation_v1alpha1.types.Blueprint A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. A blueprint can be a) imported from TNA's public catalog b) modified as per a user's need c) proposed and approved. On approval, a revision of blueprint is created which can be used to create a deployment on Orchestration or Workload Cluster.

public_blueprint_path

public_blueprint_path(project: str, location: str, public_lueprint: str) -> str

Returns a fully-qualified public_blueprint string.

reject_blueprint

reject_blueprint(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.RejectBlueprintRequest,
            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.telcoautomation_v1alpha1.types.telcoautomation.Blueprint

Rejects a blueprint revision proposal and flips it back to Draft state.

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

def sample_reject_blueprint():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.RejectBlueprintRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.RejectBlueprintRequest, dict]

The request object. Request object for RejectBlueprint.
name str

Required. The name of the blueprint being rejected. 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.telcoautomation_v1alpha1.types.Blueprint A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. A blueprint can be a) imported from TNA's public catalog b) modified as per a user's need c) proposed and approved. On approval, a revision of blueprint is created which can be used to create a deployment on Orchestration or Workload Cluster.

remove_deployment

remove_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.RemoveDeploymentRequest,
            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

Removes the deployment by marking it as DELETING. Post which deployment and it's revisions gets deleted.

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

def sample_remove_deployment():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.RemoveDeploymentRequest(
        name="name_value",
    )

    # Make the request
    client.remove_deployment(request=request)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.RemoveDeploymentRequest, dict]

The request object. Request object for RemoveDeployment.
name str

Required. The name of deployment to initiate delete. 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.

rollback_deployment

rollback_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.RollbackDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    revision_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.telcoautomation_v1alpha1.types.telcoautomation.Deployment

Rollback the active deployment to the given past approved deployment revision.

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

def sample_rollback_deployment():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.RollbackDeploymentRequest(
        name="name_value",
        revision_id="revision_id_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.RollbackDeploymentRequest, dict]

The request object. Request object for RollbackDeployment.
name str

Required. Name of the deployment. This corresponds to the name field on the request instance; if request is provided, this should not be set.
revision_id str

Required. The revision id of deployment to roll back to. This corresponds to the revision_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.telcoautomation_v1alpha1.types.Deployment Deployment contains a collection of YAML files (This collection is also known as package) that can to applied on an orchestration cluster (GKE cluster with TNA addons) or a workload cluster.

search_blueprint_revisions

search_blueprint_revisions(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.SearchBlueprintRevisionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    query: 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.telcoautomation_v1alpha1.services.telco_automation.pagers.SearchBlueprintRevisionsPager
)

Searches across blueprint revisions.

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

def sample_search_blueprint_revisions():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.SearchBlueprintRevisionsRequest(
        parent="parent_value",
        query="query_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.SearchBlueprintRevisionsRequest, dict]

The request object. Request object for SearchBlueprintRevisions.
parent str

Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". This corresponds to the parent field on the request instance; if request is provided, this should not be set.
query str

Required. Supported queries: 1. "" : Lists all revisions across all blueprints. 2. "latest=true" : Lists latest revisions across all blueprints. 3. "name={name}" : Lists all revisions of blueprint with name {name}. 4. "name={name} latest=true": Lists latest revision of blueprint with name {name} This corresponds to the query 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.telcoautomation_v1alpha1.services.telco_automation.pagers.SearchBlueprintRevisionsPager Response object for SearchBlueprintRevisions. Iterating over this object will yield results and resolve additional pages automatically.

search_deployment_revisions

search_deployment_revisions(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.SearchDeploymentRevisionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    query: 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.telcoautomation_v1alpha1.services.telco_automation.pagers.SearchDeploymentRevisionsPager
)

Searches across deployment revisions.

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

def sample_search_deployment_revisions():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.SearchDeploymentRevisionsRequest(
        parent="parent_value",
        query="query_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.SearchDeploymentRevisionsRequest, dict]

The request object. Request object for SearchDeploymentRevisions.
parent str

Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". This corresponds to the parent field on the request instance; if request is provided, this should not be set.
query str

Required. Supported queries: 1. "" : Lists all revisions across all deployments. 2. "latest=true" : Lists latest revisions across all deployments. 3. "name={name}" : Lists all revisions of deployment with name {name}. 4. "name={name} latest=true": Lists latest revision of deployment with name {name} This corresponds to the query 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.telcoautomation_v1alpha1.services.telco_automation.pagers.SearchDeploymentRevisionsPager Response object for SearchDeploymentRevisions. Iterating over this object will yield results and resolve additional pages automatically.

update_blueprint

update_blueprint(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.UpdateBlueprintRequest,
            dict,
        ]
    ] = None,
    *,
    blueprint: typing.Optional[
        google.cloud.telcoautomation_v1alpha1.types.telcoautomation.Blueprint
    ] = 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.telcoautomation_v1alpha1.types.telcoautomation.Blueprint

Updates a blueprint.

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

def sample_update_blueprint():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    blueprint = telcoautomation_v1alpha1.Blueprint()
    blueprint.source_blueprint = "source_blueprint_value"

    request = telcoautomation_v1alpha1.UpdateBlueprintRequest(
        blueprint=blueprint,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.UpdateBlueprintRequest, dict]

The request object. Request object for UpdateBlueprint.
blueprint google.cloud.telcoautomation_v1alpha1.types.Blueprint

Required. The blueprint to update. This corresponds to the blueprint field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Update mask is used to specify the fields to be overwritten in the blueprint resource by the update. 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.telcoautomation_v1alpha1.types.Blueprint A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. A blueprint can be a) imported from TNA's public catalog b) modified as per a user's need c) proposed and approved. On approval, a revision of blueprint is created which can be used to create a deployment on Orchestration or Workload Cluster.

update_deployment

update_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.UpdateDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    deployment: typing.Optional[
        google.cloud.telcoautomation_v1alpha1.types.telcoautomation.Deployment
    ] = 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.telcoautomation_v1alpha1.types.telcoautomation.Deployment

Updates a 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 telcoautomation_v1alpha1

def sample_update_deployment():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    deployment = telcoautomation_v1alpha1.Deployment()
    deployment.source_blueprint_revision = "source_blueprint_revision_value"

    request = telcoautomation_v1alpha1.UpdateDeploymentRequest(
        deployment=deployment,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.UpdateDeploymentRequest, dict]

The request object. Request object for UpdateDeployment.
deployment google.cloud.telcoautomation_v1alpha1.types.Deployment

Required. The deployment to update. This corresponds to the deployment field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Update mask is used to specify the fields to be overwritten in the deployment resource by the update. 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.telcoautomation_v1alpha1.types.Deployment Deployment contains a collection of YAML files (This collection is also known as package) that can to applied on an orchestration cluster (GKE cluster with TNA addons) or a workload cluster.

update_hydrated_deployment

update_hydrated_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.telcoautomation_v1alpha1.types.telcoautomation.UpdateHydratedDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    hydrated_deployment: typing.Optional[
        google.cloud.telcoautomation_v1alpha1.types.telcoautomation.HydratedDeployment
    ] = 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.telcoautomation_v1alpha1.types.telcoautomation.HydratedDeployment

Updates a hydrated 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 telcoautomation_v1alpha1

def sample_update_hydrated_deployment():
    # Create a client
    client = telcoautomation_v1alpha1.TelcoAutomationClient()

    # Initialize request argument(s)
    request = telcoautomation_v1alpha1.UpdateHydratedDeploymentRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.telcoautomation_v1alpha1.types.UpdateHydratedDeploymentRequest, dict]

The request object. Request object for UpdateHydratedDeployment.
hydrated_deployment google.cloud.telcoautomation_v1alpha1.types.HydratedDeployment

Required. The hydrated deployment to update. This corresponds to the hydrated_deployment field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. The list of fields to update. Update mask supports a special value * which fully replaces (equivalent to PUT) the resource provided. 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.telcoautomation_v1alpha1.types.HydratedDeployment A collection of kubernetes yaml files which are deployed on a Workload Cluster. Hydrated Deployments are created by TNA intent based automation.