TpuClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
tpu_v1
.
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 v1
Properties
transport
Returns the transport used by the client instance.
TpuTransport
Methods
TpuClient
TpuClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
tpu_v1
.
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
> )
Instantiates the tpu client.
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
Union[str, TpuTransport]
The transport to use. 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. It won't take effect if a transport
instance is provided. (1) The api_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the api_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source
property can be used to provide client certificate for mutual TLS 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.
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.
google.auth.exceptions.MutualTLSChannelError
__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
accelerator_type_path
accelerator_type_path
(
project
:
str
,
location
:
str
,
accelerator_type
:
str
)
-
> str
Returns a fully-qualified accelerator_type string.
cancel_operation
cancel_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
CancelOperationRequest
]
=
None
,
*
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
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
.
request
.operations_pb2.CancelOperationRequest
The request object. Request message for CancelOperation
method.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
create_node
create_node
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
CreateNodeRequest
,
dict
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
node
:
typing
.
Optional
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
Node
]
=
None
,
node_id
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
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_v1
def sample_create_node():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
node = tpu_v1.Node()
node.accelerator_type = "accelerator_type_value"
node.tensorflow_version = "tensorflow_version_value"
request = tpu_v1.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)
request
Union[ google.cloud.tpu_v1.types.CreateNodeRequest
, dict]
The request object. Request for 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_v1.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.
google.api_core.operation.Operation
delete_node
delete_node
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
DeleteNodeRequest
,
dict
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
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_v1
def sample_delete_node():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
request = tpu_v1.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)
request
Union[ google.cloud.tpu_v1.types.DeleteNodeRequest
, dict]
The request object. Request for 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.
google.api_core.operation.Operation
delete_operation
delete_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
DeleteOperationRequest
]
=
None
,
*
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
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
.
request
.operations_pb2.DeleteOperationRequest
The request object. Request message for DeleteOperation
method.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
TpuClient
from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
info
dict
The service account private key info.
TpuClient
from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
TpuClient
get_accelerator_type
get_accelerator_type
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
GetAcceleratorTypeRequest
,
dict
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
tpu_v1
.
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_v1
def sample_get_accelerator_type():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
request = tpu_v1.GetAcceleratorTypeRequest(
name="name_value",
)
# Make the request
response = client. get_accelerator_type
(request=request)
# Handle the response
print(response)
request
Union[ google.cloud.tpu_v1.types.GetAcceleratorTypeRequest
, dict]
The request object. Request for 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.
get_location
get_location
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
GetLocationRequest
]
=
None
,
*
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
location
.
locations_pb2
.
Location
Gets information about a location.
request
.location_pb2.GetLocationRequest
The request object. Request message for GetLocation
method.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
.location_pb2.Location
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114 .
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.
google.auth.exceptions.MutualTLSChannelError
Tuple[str, Callable[[], Tuple[bytes, bytes]]]
get_node
get_node
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
GetNodeRequest
,
dict
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
tpu_v1
.
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_v1
def sample_get_node():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
request = tpu_v1.GetNodeRequest(
name="name_value",
)
# Make the request
response = client. get_node
(request=request)
# Handle the response
print(response)
request
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.
get_operation
get_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
GetOperationRequest
]
=
None
,
*
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
longrunning
.
operations_pb2
.
Operation
Gets the latest state of a long-running operation.
request
.operations_pb2.GetOperationRequest
The request object. Request message for GetOperation
method.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
.operations_pb2.Operation
Operation
object.get_tensor_flow_version
get_tensor_flow_version
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
GetTensorFlowVersionRequest
,
dict
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
TensorFlowVersion
Gets TensorFlow 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_v1
def sample_get_tensor_flow_version():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
request = tpu_v1. GetTensorFlowVersionRequest
(
name="name_value",
)
# Make the request
response = client. get_tensor_flow_version
(request=request)
# Handle the response
print(response)
request
Union[ google.cloud.tpu_v1.types.GetTensorFlowVersionRequest
, dict]
The request object. Request for GetTensorFlowVersion .
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.
list_accelerator_types
list_accelerator_types
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
ListAcceleratorTypesRequest
,
dict
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
tpu_v1
.
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_v1
def sample_list_accelerator_types():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
request = tpu_v1.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)
request
Union[ google.cloud.tpu_v1.types.ListAcceleratorTypesRequest
, dict]
The request object. Request for 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.
list_locations
list_locations
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
ListLocationsRequest
]
=
None
,
*
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
location
.
locations_pb2
.
ListLocationsResponse
Lists information about the supported locations for this service.
request
.location_pb2.ListLocationsRequest
The request object. Request message for ListLocations
method.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
.location_pb2.ListLocationsResponse
ListLocations
method.list_nodes
list_nodes
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
ListNodesRequest
,
dict
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
tpu_v1
.
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_v1
def sample_list_nodes():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
request = tpu_v1.ListNodesRequest(
parent="parent_value",
)
# Make the request
page_result = client. list_nodes
(request=request)
# Handle the response
for response in page_result:
print(response)
request
Union[ google.cloud.tpu_v1.types.ListNodesRequest
, dict]
The request object. Request for 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.
list_operations
list_operations
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
ListOperationsRequest
]
=
None
,
*
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
longrunning
.
operations_pb2
.
ListOperationsResponse
Lists operations that match the specified filter in the request.
request
.operations_pb2.ListOperationsRequest
The request object. Request message for ListOperations
method.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
.operations_pb2.ListOperationsResponse
ListOperations
method.list_tensor_flow_versions
list_tensor_flow_versions
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
ListTensorFlowVersionsRequest
,
dict
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
tpu_v1
.
services
.
tpu
.
pagers
.
ListTensorFlowVersionsPager
List TensorFlow 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_v1
def sample_list_tensor_flow_versions():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
request = tpu_v1. ListTensorFlowVersionsRequest
(
parent="parent_value",
)
# Make the request
page_result = client. list_tensor_flow_versions
(request=request)
# Handle the response
for response in page_result:
print(response)
request
Union[ google.cloud.tpu_v1.types.ListTensorFlowVersionsRequest
, dict]
The request object. Request for ListTensorFlowVersions .
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.
node_path
node_path
(
project
:
str
,
location
:
str
,
node
:
str
)
-
> str
Returns a fully-qualified node string.
parse_accelerator_type_path
parse_accelerator_type_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a accelerator_type path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
parse_node_path
parse_node_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a node path into its component segments.
parse_tensor_flow_version_path
parse_tensor_flow_version_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a tensor_flow_version path into its component segments.
reimage_node
reimage_node
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
ReimageNodeRequest
,
dict
]
]
=
None
,
*
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Reimages a node's OS.
# 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_v1
def sample_reimage_node():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
request = tpu_v1. ReimageNodeRequest
(
)
# Make the request
operation = client. reimage_node
(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
request
Union[ google.cloud.tpu_v1.types.ReimageNodeRequest
, dict]
The request object. Request for ReimageNode .
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.
google.api_core.operation.Operation
start_node
start_node
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
StartNodeRequest
,
dict
]
]
=
None
,
*
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
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_v1
def sample_start_node():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
request = tpu_v1.StartNodeRequest(
)
# Make the request
operation = client. start_node
(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
request
Union[ google.cloud.tpu_v1.types.StartNodeRequest
, dict]
The request object. Request for 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.
google.api_core.operation.Operation
stop_node
stop_node
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
StopNodeRequest
,
dict
]
]
=
None
,
*
,
retry
:
typing
.
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
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_v1
def sample_stop_node():
# Create a client
client = tpu_v1.TpuClient()
# Initialize request argument(s)
request = tpu_v1.StopNodeRequest(
)
# Make the request
operation = client. stop_node
(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
request
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.
google.api_core.operation.Operation
tensor_flow_version_path
tensor_flow_version_path
(
project
:
str
,
location
:
str
,
tensor_flow_version
:
str
)
-
> str
Returns a fully-qualified tensor_flow_version string.