Class TpuClient (1.19.1)

Manages TPU nodes and other resources

TPU API v2

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the tpu client.

Releases underlying transport's resources.

Returns a fully-qualified accelerator_type string.

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.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

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)

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)

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.

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

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

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

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)

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)

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)

Gets information about a location.

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.

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)

Gets the latest state of a long-running operation.

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)

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)

Lists information about the supported locations for this service.

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)

Lists operations that match the specified filter in the request.

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)

Returns a fully-qualified node string.

Parses a accelerator_type path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a node path into its component segments.

Parses a runtime_version path into its component segments.

Returns a fully-qualified runtime_version string.

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)

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)

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)