As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Tpu

class google.cloud.tpu_v2.services.tpu.TpuAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.tpu_v2.services.tpu.transports.base.TpuTransport, typing.Callable[[...], google.cloud.tpu_v2.services.tpu.transports.base.TpuTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Manages TPU nodes and other resources

TPU API v2

Instantiates the tpu async client.

Parameters

• 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,TpuTransport,Callable[..., TpuTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the TpuTransport constructor. If set to None, a transport is chosen automatically.

• client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

  Custom options for the client.

  1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

  2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

• client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static accelerator_type_path(project: str, location: str, accelerator_type: str) → str

Returns a fully-qualified accelerator_type string.

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → 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

• request (CancelOperationRequest) – The request object. Request message for CancelOperation method.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

static common_billing_account_path(billing_account: str) → str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str

Returns a fully-qualified organization string.

static common_project_path(project: str) → str

Returns a fully-qualified project string.

async create_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.CreateNodeRequest, dict]] = None, *, parent: Optional[str] = None, node: Optional[google.cloud.tpu_v2.types.cloud_tpu.Node] = None, node_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Creates a node.

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

async def sample_create_node():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    node = tpu_v2.Node()
    node.runtime_version = "runtime_version_value"

    request = tpu_v2.CreateNodeRequest(
        parent="parent_value",
        node=node,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.CreateNodeRequest, dict]]) – The request object. Request for [CreateNode][google.cloud.tpu.v2.Tpu.CreateNode].

• parent (str) – Required. The parent resource name. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• node (google.cloud.tpu_v2.types.Node) – Required. The node. This corresponds to the node field on the request instance; if request is provided, this should not be set.

• node_id (str) – The unqualified resource name. This corresponds to the node_id field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.tpu_v2.types.Node A TPU instance.

Return type

google.api_core.operation_async.AsyncOperation

async delete_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.DeleteNodeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Deletes a node.

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

async def sample_delete_node():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.DeleteNodeRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.DeleteNodeRequest, dict]]) – The request object. Request for [DeleteNode][google.cloud.tpu.v2.Tpu.DeleteNode].

• name (str) – Required. The resource name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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);

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → 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

• request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

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

Creates an instance of this client using the provided credentials

file.

Parameters

• filename (str) – The path to the service account private key json file.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

TpuAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials

info.

Parameters

• info (dict) – The service account private key info.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

TpuAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials

file.

Parameters

• filename (str) – The path to the service account private key json file.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

TpuAsyncClient

async generate_service_identity(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.GenerateServiceIdentityRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.types.cloud_tpu.GenerateServiceIdentityResponse

Generates the Cloud TPU service identity for the project.

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

async def sample_generate_service_identity():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.GenerateServiceIdentityRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.GenerateServiceIdentityRequest, dict]]) – The request object. Request for [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for

[GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].

Return type

google.cloud.tpu_v2.types.GenerateServiceIdentityResponse

async get_accelerator_type(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.GetAcceleratorTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.types.cloud_tpu.AcceleratorType

Gets AcceleratorType.

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

async def sample_get_accelerator_type():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.GetAcceleratorTypeRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.GetAcceleratorTypeRequest, dict]]) – The request object. Request for [GetAcceleratorType][google.cloud.tpu.v2.Tpu.GetAcceleratorType].

• name (str) – Required. The resource name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A accelerator type that a Node can be configured with.

Return type

google.cloud.tpu_v2.types.AcceleratorType

async get_guest_attributes(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.GetGuestAttributesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.types.cloud_tpu.GetGuestAttributesResponse

Retrieves the guest attributes for the node.

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

async def sample_get_guest_attributes():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.GetGuestAttributesRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.GetGuestAttributesRequest, dict]]) – The request object. Request for [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for

[GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].

Return type

google.cloud.tpu_v2.types.GetGuestAttributesResponse

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters

• request (GetLocationRequest) – The request object. Request message for GetLocation method.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Location object.

Return type

Location

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

Return the API endpoint and client cert source for mutual TLS.

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

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

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.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.GetNodeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.types.cloud_tpu.Node

Gets the details of a node.

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

async def sample_get_node():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.GetNodeRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.GetNodeRequest, dict]]) – The request object. Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode].

• name (str) – Required. The resource name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A TPU instance.

Return type

google.cloud.tpu_v2.types.Node

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters

• request (GetOperationRequest) – The request object. Request message for GetOperation method.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

async get_runtime_version(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.GetRuntimeVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.types.cloud_tpu.RuntimeVersion

Gets a runtime version.

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

async def sample_get_runtime_version():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.GetRuntimeVersionRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.GetRuntimeVersionRequest, dict]]) – The request object. Request for [GetRuntimeVersion][google.cloud.tpu.v2.Tpu.GetRuntimeVersion].

• name (str) – Required. The resource name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A runtime version that a Node can be configured with.

Return type

google.cloud.tpu_v2.types.RuntimeVersion

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.tpu_v2.services.tpu.transports.base.TpuTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_accelerator_types(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.ListAcceleratorTypesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesAsyncPager

Lists accelerator types supported by this API.

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

async def sample_list_accelerator_types():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.ListAcceleratorTypesRequest(
        parent="parent_value",
    )

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

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

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.ListAcceleratorTypesRequest, dict]]) – The request object. Request for [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].

• parent (str) – Required. The parent resource 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_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for

[ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesAsyncPager

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters

• request (ListLocationsRequest) – The request object. Request message for ListLocations method.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_nodes(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.ListNodesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.services.tpu.pagers.ListNodesAsyncPager

Lists nodes.

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

async def sample_list_nodes():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.ListNodesRequest(
        parent="parent_value",
    )

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

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

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.ListNodesRequest, dict]]) – The request object. Request for [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes].

• parent (str) – Required. The parent resource 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_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.tpu_v2.services.tpu.pagers.ListNodesAsyncPager

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters

• request (ListOperationsRequest) – The request object. Request message for ListOperations method.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

async list_runtime_versions(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.ListRuntimeVersionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsAsyncPager

Lists runtime versions supported by this API.

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

async def sample_list_runtime_versions():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.ListRuntimeVersionsRequest(
        parent="parent_value",
    )

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

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

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.ListRuntimeVersionsRequest, dict]]) – The request object. Request for [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].

• parent (str) – Required. The parent resource 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_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for

[ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsAsyncPager

static node_path(project: str, location: str, node: str) → str

Returns a fully-qualified node string.

static parse_accelerator_type_path(path: str) → Dict[str, str]

Parses a accelerator_type path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

static parse_node_path(path: str) → Dict[str, str]

Parses a node path into its component segments.

static parse_runtime_version_path(path: str) → Dict[str, str]

Parses a runtime_version path into its component segments.

static runtime_version_path(project: str, location: str, runtime_version: str) → str

Returns a fully-qualified runtime_version string.

async start_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.StartNodeRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Starts a node.

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

async def sample_start_node():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.StartNodeRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.StartNodeRequest, dict]]) – The request object. Request for [StartNode][google.cloud.tpu.v2.Tpu.StartNode].

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.tpu_v2.types.Node A TPU instance.

Return type

google.api_core.operation_async.AsyncOperation

async stop_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.StopNodeRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Stops a node. This operation is only available with single TPU nodes.

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

async def sample_stop_node():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    request = tpu_v2.StopNodeRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.StopNodeRequest, dict]]) – The request object. Request for [StopNode][google.cloud.tpu.v2.Tpu.StopNode].

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.tpu_v2.types.Node A TPU instance.

Return type

google.api_core.operation_async.AsyncOperation

property transport: google.cloud.tpu_v2.services.tpu.transports.base.TpuTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

TpuTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

async update_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.UpdateNodeRequest, dict]] = None, *, node: Optional[google.cloud.tpu_v2.types.cloud_tpu.Node] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Updates the configurations of a node.

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

async def sample_update_node():
    # Create a client
    client = tpu_v2.TpuAsyncClient()

    # Initialize request argument(s)
    node = tpu_v2.Node()
    node.runtime_version = "runtime_version_value"

    request = tpu_v2.UpdateNodeRequest(
        node=node,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.tpu_v2.types.UpdateNodeRequest, dict]]) – The request object. Request for [UpdateNode][google.cloud.tpu.v2.Tpu.UpdateNode].

• node (google.cloud.tpu_v2.types.Node) –

  Required. The node. Only fields specified in update_mask are updated.

  This corresponds to the node field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  Required. Mask of fields from [Node][Tpu.Node] to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.tpu_v2.types.Node A TPU instance.

Return type

google.api_core.operation_async.AsyncOperation

class google.cloud.tpu_v2.services.tpu.TpuClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.tpu_v2.services.tpu.transports.base.TpuTransport, typing.Callable[[...], google.cloud.tpu_v2.services.tpu.transports.base.TpuTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Manages TPU nodes and other resources

TPU API v2

Instantiates the tpu client.

Parameters

• 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,TpuTransport,Callable[..., TpuTransport]]]) – 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 TpuTransport 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static accelerator_type_path(project: str, location: str, accelerator_type: str) → str

Returns a fully-qualified accelerator_type string.

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → 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

• request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

static common_billing_account_path(billing_account: str) → str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str

Returns a fully-qualified organization string.

static common_project_path(project: str) → str

Returns a fully-qualified project string.

create_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.CreateNodeRequest, dict]] = None, *, parent: Optional[str] = None, node: Optional[google.cloud.tpu_v2.types.cloud_tpu.Node] = None, node_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Creates a node.

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

def sample_create_node():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    node = tpu_v2.Node()
    node.runtime_version = "runtime_version_value"

    request = tpu_v2.CreateNodeRequest(
        parent="parent_value",
        node=node,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.tpu_v2.types.CreateNodeRequest, dict]) – The request object. Request for [CreateNode][google.cloud.tpu.v2.Tpu.CreateNode].

• parent (str) – Required. The parent resource name. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• node (google.cloud.tpu_v2.types.Node) – Required. The node. This corresponds to the node field on the request instance; if request is provided, this should not be set.

• node_id (str) – The unqualified resource name. This corresponds to the node_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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.tpu_v2.types.Node A TPU instance.

Return type

google.api_core.operation.Operation

delete_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.DeleteNodeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Deletes a node.

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

def sample_delete_node():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.DeleteNodeRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.tpu_v2.types.DeleteNodeRequest, dict]) – The request object. Request for [DeleteNode][google.cloud.tpu.v2.Tpu.DeleteNode].

• name (str) – Required. The resource name. 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

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);

}

Return type

google.api_core.operation.Operation

delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → 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

• request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

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

Creates an instance of this client using the provided credentials

file.

Parameters

• filename (str) – The path to the service account private key json file.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

TpuClient

classmethod from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials

info.

Parameters

• info (dict) – The service account private key info.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

TpuClient

classmethod from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials

file.

Parameters

• filename (str) – The path to the service account private key json file.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

TpuClient

generate_service_identity(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.GenerateServiceIdentityRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.types.cloud_tpu.GenerateServiceIdentityResponse

Generates the Cloud TPU service identity for the project.

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

def sample_generate_service_identity():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.GenerateServiceIdentityRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.tpu_v2.types.GenerateServiceIdentityRequest, dict]) – The request object. Request for [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].

• 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for

[GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].

Return type

google.cloud.tpu_v2.types.GenerateServiceIdentityResponse

get_accelerator_type(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.GetAcceleratorTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.types.cloud_tpu.AcceleratorType

Gets AcceleratorType.

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

def sample_get_accelerator_type():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.GetAcceleratorTypeRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.tpu_v2.types.GetAcceleratorTypeRequest, dict]) – The request object. Request for [GetAcceleratorType][google.cloud.tpu.v2.Tpu.GetAcceleratorType].

• name (str) – Required. The resource name. 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

A accelerator type that a Node can be configured with.

Return type

google.cloud.tpu_v2.types.AcceleratorType

get_guest_attributes(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.GetGuestAttributesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.types.cloud_tpu.GetGuestAttributesResponse

Retrieves the guest attributes for the node.

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

def sample_get_guest_attributes():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.GetGuestAttributesRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.tpu_v2.types.GetGuestAttributesRequest, dict]) – The request object. Request for [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].

• 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for

[GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].

Return type

google.cloud.tpu_v2.types.GetGuestAttributesResponse

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters

• request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: 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.

Parameters

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.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.GetNodeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.types.cloud_tpu.Node

Gets the details of a node.

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

def sample_get_node():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.GetNodeRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.tpu_v2.types.GetNodeRequest, dict]) – The request object. Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode].

• name (str) – Required. The resource name. 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

A TPU instance.

Return type

google.cloud.tpu_v2.types.Node

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters

• request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

get_runtime_version(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.GetRuntimeVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.types.cloud_tpu.RuntimeVersion

Gets a runtime version.

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

def sample_get_runtime_version():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.GetRuntimeVersionRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.tpu_v2.types.GetRuntimeVersionRequest, dict]) – The request object. Request for [GetRuntimeVersion][google.cloud.tpu.v2.Tpu.GetRuntimeVersion].

• name (str) – Required. The resource name. 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

A runtime version that a Node can be configured with.

Return type

google.cloud.tpu_v2.types.RuntimeVersion

list_accelerator_types(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.ListAcceleratorTypesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesPager

Lists accelerator types supported by this API.

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

def sample_list_accelerator_types():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.ListAcceleratorTypesRequest(
        parent="parent_value",
    )

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

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

Parameters

• request (Union[google.cloud.tpu_v2.types.ListAcceleratorTypesRequest, dict]) – The request object. Request for [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].

• parent (str) – Required. The parent resource 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for

[ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesPager

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters

• request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

list_nodes(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.ListNodesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.services.tpu.pagers.ListNodesPager

Lists nodes.

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

def sample_list_nodes():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.ListNodesRequest(
        parent="parent_value",
    )

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

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

Parameters

• request (Union[google.cloud.tpu_v2.types.ListNodesRequest, dict]) – The request object. Request for [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes].

• parent (str) – Required. The parent resource 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.tpu_v2.services.tpu.pagers.ListNodesPager

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters

• request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

list_runtime_versions(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.ListRuntimeVersionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsPager

Lists runtime versions supported by this API.

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

def sample_list_runtime_versions():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.ListRuntimeVersionsRequest(
        parent="parent_value",
    )

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

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

Parameters

• request (Union[google.cloud.tpu_v2.types.ListRuntimeVersionsRequest, dict]) – The request object. Request for [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].

• parent (str) – Required. The parent resource 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for

[ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsPager

static node_path(project: str, location: str, node: str) → str

Returns a fully-qualified node string.

static parse_accelerator_type_path(path: str) → Dict[str, str]

Parses a accelerator_type path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

static parse_node_path(path: str) → Dict[str, str]

Parses a node path into its component segments.

static parse_runtime_version_path(path: str) → Dict[str, str]

Parses a runtime_version path into its component segments.

static runtime_version_path(project: str, location: str, runtime_version: str) → str

Returns a fully-qualified runtime_version string.

start_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.StartNodeRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Starts a node.

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

def sample_start_node():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.StartNodeRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.tpu_v2.types.StartNodeRequest, dict]) – The request object. Request for [StartNode][google.cloud.tpu.v2.Tpu.StartNode].

• 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.tpu_v2.types.Node A TPU instance.

Return type

google.api_core.operation.Operation

stop_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.StopNodeRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Stops a node. This operation is only available with single TPU nodes.

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

def sample_stop_node():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    request = tpu_v2.StopNodeRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.tpu_v2.types.StopNodeRequest, dict]) – The request object. Request for [StopNode][google.cloud.tpu.v2.Tpu.StopNode].

• 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.tpu_v2.types.Node A TPU instance.

Return type

google.api_core.operation.Operation

property transport: google.cloud.tpu_v2.services.tpu.transports.base.TpuTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

TpuTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

update_node(request: Optional[Union[google.cloud.tpu_v2.types.cloud_tpu.UpdateNodeRequest, dict]] = None, *, node: Optional[google.cloud.tpu_v2.types.cloud_tpu.Node] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Updates the configurations of a node.

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

def sample_update_node():
    # Create a client
    client = tpu_v2.TpuClient()

    # Initialize request argument(s)
    node = tpu_v2.Node()
    node.runtime_version = "runtime_version_value"

    request = tpu_v2.UpdateNodeRequest(
        node=node,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.tpu_v2.types.UpdateNodeRequest, dict]) – The request object. Request for [UpdateNode][google.cloud.tpu.v2.Tpu.UpdateNode].

• node (google.cloud.tpu_v2.types.Node) –

  Required. The node. Only fields specified in update_mask are updated.

  This corresponds to the node field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  Required. Mask of fields from [Node][Tpu.Node] to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].

  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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.tpu_v2.types.Node A TPU instance.

Return type

google.api_core.operation.Operation

class google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesAsyncPager(method: Callable[[...], Awaitable[google.cloud.tpu_v2.types.cloud_tpu.ListAcceleratorTypesResponse]], request: google.cloud.tpu_v2.types.cloud_tpu.ListAcceleratorTypesRequest, response: google.cloud.tpu_v2.types.cloud_tpu.ListAcceleratorTypesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_accelerator_types requests.

This class thinly wraps an initial google.cloud.tpu_v2.types.ListAcceleratorTypesResponse object, and provides an __aiter__ method to iterate through its accelerator_types field.

If there are more pages, the __aiter__ method will make additional ListAcceleratorTypes requests and continue to iterate through the accelerator_types field on the corresponding responses.

All the usual google.cloud.tpu_v2.types.ListAcceleratorTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.tpu_v2.types.ListAcceleratorTypesRequest) – The initial request object.

• response (google.cloud.tpu_v2.types.ListAcceleratorTypesResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesPager(method: Callable[[...], google.cloud.tpu_v2.types.cloud_tpu.ListAcceleratorTypesResponse], request: google.cloud.tpu_v2.types.cloud_tpu.ListAcceleratorTypesRequest, response: google.cloud.tpu_v2.types.cloud_tpu.ListAcceleratorTypesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_accelerator_types requests.

This class thinly wraps an initial google.cloud.tpu_v2.types.ListAcceleratorTypesResponse object, and provides an __iter__ method to iterate through its accelerator_types field.

If there are more pages, the __iter__ method will make additional ListAcceleratorTypes requests and continue to iterate through the accelerator_types field on the corresponding responses.

All the usual google.cloud.tpu_v2.types.ListAcceleratorTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.tpu_v2.types.ListAcceleratorTypesRequest) – The initial request object.

• response (google.cloud.tpu_v2.types.ListAcceleratorTypesResponse) – The initial response object.

• 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, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.tpu_v2.services.tpu.pagers.ListNodesAsyncPager(method: Callable[[...], Awaitable[google.cloud.tpu_v2.types.cloud_tpu.ListNodesResponse]], request: google.cloud.tpu_v2.types.cloud_tpu.ListNodesRequest, response: google.cloud.tpu_v2.types.cloud_tpu.ListNodesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_nodes requests.

This class thinly wraps an initial google.cloud.tpu_v2.types.ListNodesResponse object, and provides an __aiter__ method to iterate through its nodes field.

If there are more pages, the __aiter__ method will make additional ListNodes requests and continue to iterate through the nodes field on the corresponding responses.

All the usual google.cloud.tpu_v2.types.ListNodesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.tpu_v2.types.ListNodesRequest) – The initial request object.

• response (google.cloud.tpu_v2.types.ListNodesResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.tpu_v2.services.tpu.pagers.ListNodesPager(method: Callable[[...], google.cloud.tpu_v2.types.cloud_tpu.ListNodesResponse], request: google.cloud.tpu_v2.types.cloud_tpu.ListNodesRequest, response: google.cloud.tpu_v2.types.cloud_tpu.ListNodesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_nodes requests.

This class thinly wraps an initial google.cloud.tpu_v2.types.ListNodesResponse object, and provides an __iter__ method to iterate through its nodes field.

If there are more pages, the __iter__ method will make additional ListNodes requests and continue to iterate through the nodes field on the corresponding responses.

All the usual google.cloud.tpu_v2.types.ListNodesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.tpu_v2.types.ListNodesRequest) – The initial request object.

• response (google.cloud.tpu_v2.types.ListNodesResponse) – The initial response object.

• 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, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.tpu_v2.types.cloud_tpu.ListRuntimeVersionsResponse]], request: google.cloud.tpu_v2.types.cloud_tpu.ListRuntimeVersionsRequest, response: google.cloud.tpu_v2.types.cloud_tpu.ListRuntimeVersionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_runtime_versions requests.

This class thinly wraps an initial google.cloud.tpu_v2.types.ListRuntimeVersionsResponse object, and provides an __aiter__ method to iterate through its runtime_versions field.

If there are more pages, the __aiter__ method will make additional ListRuntimeVersions requests and continue to iterate through the runtime_versions field on the corresponding responses.

All the usual google.cloud.tpu_v2.types.ListRuntimeVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.tpu_v2.types.ListRuntimeVersionsRequest) – The initial request object.

• response (google.cloud.tpu_v2.types.ListRuntimeVersionsResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsPager(method: Callable[[...], google.cloud.tpu_v2.types.cloud_tpu.ListRuntimeVersionsResponse], request: google.cloud.tpu_v2.types.cloud_tpu.ListRuntimeVersionsRequest, response: google.cloud.tpu_v2.types.cloud_tpu.ListRuntimeVersionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_runtime_versions requests.

This class thinly wraps an initial google.cloud.tpu_v2.types.ListRuntimeVersionsResponse object, and provides an __iter__ method to iterate through its runtime_versions field.

If there are more pages, the __iter__ method will make additional ListRuntimeVersions requests and continue to iterate through the runtime_versions field on the corresponding responses.

All the usual google.cloud.tpu_v2.types.ListRuntimeVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.tpu_v2.types.ListRuntimeVersionsRequest) – The initial request object.

• response (google.cloud.tpu_v2.types.ListRuntimeVersionsResponse) – The initial response object.

• 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, str]]) – Strings which should be sent along with the request as metadata.