Manages TPU nodes and other resources
TPU API v1 v1
Package
@google-cloud/tpuConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of TpuClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new TpuClient({fallback: true}, gax); ```
Properties
apiEndpoint
get
apiEndpoint
()
:
string
;
The DNS address for this API service.
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath.
auth
auth
:
gax
.
GoogleAuth
;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
tpuStub
tpuStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
universeDomain
get
universeDomain
()
:
string
;
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
acceleratorTypePath(project, location, acceleratorType)
acceleratorTypePath
(
project
:
string
,
location
:
string
,
acceleratorType
:
string
)
:
string
;
Return a fully-qualified acceleratorType resource name string.
project
string
location
string
acceleratorType
string
string
{string} Resource name string.
cancelOperation(request, options, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
CancelOperationRequest
,
{}
|
undefined
|
null
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
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
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
request
options
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.CancelOperationRequest
, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.longrunning.CancelOperationRequest
, protos.google.protobuf.Empty
, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
cancelOperation
({
name
:
''
});
checkCreateNodeProgress(name)
checkCreateNodeProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
Node
,
protos
.
google
.
cloud
.
tpu
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createNode()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.tpu.v1.Node
, protos.google.cloud.tpu.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource name.
*/
// const parent = 'abc123'
/**
* The unqualified resource name.
*/
// const nodeId = 'abc123'
/**
* Required. The node.
*/
// const node = {}
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callCreateNode
()
{
// Construct request
const
request
=
{
parent
,
node
,
};
// Run request
const
[
operation
]
=
await
tpuClient
.
createNode
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateNode
();
checkDeleteNodeProgress(name)
checkDeleteNodeProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
Node
,
protos
.
google
.
cloud
.
tpu
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteNode()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.tpu.v1.Node
, protos.google.cloud.tpu.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name.
*/
// const name = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callDeleteNode
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
tpuClient
.
deleteNode
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteNode
();
checkReimageNodeProgress(name)
checkReimageNodeProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
Node
,
protos
.
google
.
cloud
.
tpu
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by reimageNode()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.tpu.v1.Node
, protos.google.cloud.tpu.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The resource name.
*/
// const name = 'abc123'
/**
* The version for reimage to create.
*/
// const tensorflowVersion = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callReimageNode
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
tpuClient
.
reimageNode
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callReimageNode
();
checkStartNodeProgress(name)
checkStartNodeProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
Node
,
protos
.
google
.
cloud
.
tpu
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by startNode()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.tpu.v1.Node
, protos.google.cloud.tpu.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The resource name.
*/
// const name = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callStartNode
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
tpuClient
.
startNode
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callStartNode
();
checkStopNodeProgress(name)
checkStopNodeProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
Node
,
protos
.
google
.
cloud
.
tpu
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by stopNode()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.tpu.v1.Node
, protos.google.cloud.tpu.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The resource name.
*/
// const name = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callStopNode
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
tpuClient
.
stopNode
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callStopNode
();
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
createNode(request, options)
createNode
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
ICreateNodeRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Creates a node.
request
options
Promise
<[ LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource name.
*/
// const parent = 'abc123'
/**
* The unqualified resource name.
*/
// const nodeId = 'abc123'
/**
* Required. The node.
*/
// const node = {}
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callCreateNode
()
{
// Construct request
const
request
=
{
parent
,
node
,
};
// Run request
const
[
operation
]
=
await
tpuClient
.
createNode
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateNode
();
createNode(request, options, callback)
createNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
ICreateNodeRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createNode(request, callback)
createNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
ICreateNodeRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteNode(request, options)
deleteNode
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IDeleteNodeRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Deletes a node.
request
options
Promise
<[ LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name.
*/
// const name = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callDeleteNode
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
tpuClient
.
deleteNode
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteNode
();
deleteNode(request, options, callback)
deleteNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IDeleteNodeRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteNode(request, callback)
deleteNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IDeleteNodeRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteOperation(request, options, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
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
options
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
deleteOperation
({
name
:
''
});
getAcceleratorType(request, options)
getAcceleratorType
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetAcceleratorTypeRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tpu
.
v1
.
IAcceleratorType
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetAcceleratorTypeRequest
|
undefined
,
{}
|
undefined
]>;
Gets AcceleratorType.
request
options
Promise
<[ protos.google.cloud.tpu.v1.IAcceleratorType
, protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing AcceleratorType . Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name.
*/
// const name = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callGetAcceleratorType
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
tpuClient
.
getAcceleratorType
(
request
);
console
.
log
(
response
);
}
callGetAcceleratorType
();
getAcceleratorType(request, options, callback)
getAcceleratorType
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetAcceleratorTypeRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tpu
.
v1
.
IAcceleratorType
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetAcceleratorTypeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.tpu.v1.IAcceleratorType
, protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest
| null | undefined, {} | null | undefined>
void
getAcceleratorType(request, callback)
getAcceleratorType
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetAcceleratorTypeRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tpu
.
v1
.
IAcceleratorType
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetAcceleratorTypeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.tpu.v1.IAcceleratorType
, protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest
| null | undefined, {} | null | undefined>
void
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
request
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Promise
< google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getNode(request, options)
getNode
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetNodeRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetNodeRequest
|
undefined
,
{}
|
undefined
]>;
Gets the details of a node.
request
options
Promise
<[ protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IGetNodeRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name.
*/
// const name = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callGetNode
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
tpuClient
.
getNode
(
request
);
console
.
log
(
response
);
}
callGetNode
();
getNode(request, options, callback)
getNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetNodeRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetNodeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IGetNodeRequest
| null | undefined, {} | null | undefined>
void
getNode(request, callback)
getNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetNodeRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetNodeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IGetNodeRequest
| null | undefined, {} | null | undefined>
void
getOperation(request, options, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise
< [
protos
.
google
.
longrunning
.
Operation
]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
request
options
CallOptions
| Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
getTensorFlowVersion(request, options)
getTensorFlowVersion
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetTensorFlowVersionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tpu
.
v1
.
ITensorFlowVersion
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetTensorFlowVersionRequest
|
undefined
,
{}
|
undefined
]>;
Gets TensorFlow Version.
request
options
Promise
<[ protos.google.cloud.tpu.v1.ITensorFlowVersion
, protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing TensorFlowVersion . Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name.
*/
// const name = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callGetTensorFlowVersion
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
tpuClient
.
getTensorFlowVersion
(
request
);
console
.
log
(
response
);
}
callGetTensorFlowVersion
();
getTensorFlowVersion(request, options, callback)
getTensorFlowVersion
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetTensorFlowVersionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tpu
.
v1
.
ITensorFlowVersion
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetTensorFlowVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.tpu.v1.ITensorFlowVersion
, protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest
| null | undefined, {} | null | undefined>
void
getTensorFlowVersion(request, callback)
getTensorFlowVersion
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetTensorFlowVersionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tpu
.
v1
.
ITensorFlowVersion
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IGetTensorFlowVersionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.tpu.v1.ITensorFlowVersion
, protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest
| null | undefined, {} | null | undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listAcceleratorTypes(request, options)
listAcceleratorTypes
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tpu
.
v1
.
IAcceleratorType
[],
protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesRequest
|
null
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesResponse
]>;
Lists accelerator types supported by this API.
request
options
Promise
<[ protos.google.cloud.tpu.v1.IAcceleratorType
[], protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest
| null, protos.google.cloud.tpu.v1.IListAcceleratorTypesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of AcceleratorType
. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAcceleratorTypesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listAcceleratorTypes(request, options, callback)
listAcceleratorTypes
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesRequest
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IAcceleratorType
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest
, protos.google.cloud.tpu.v1.IListAcceleratorTypesResponse
| null | undefined, protos.google.cloud.tpu.v1.IAcceleratorType
>
void
listAcceleratorTypes(request, callback)
listAcceleratorTypes
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesRequest
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IAcceleratorType
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest
, protos.google.cloud.tpu.v1.IListAcceleratorTypesResponse
| null | undefined, protos.google.cloud.tpu.v1.IAcceleratorType
>
void
listAcceleratorTypesAsync(request, options)
listAcceleratorTypesAsync
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
tpu
.
v1
.
IAcceleratorType
> ;
Equivalent to listAcceleratorTypes
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.tpu.v1.IAcceleratorType
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing AcceleratorType . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource name.
*/
// const parent = 'abc123'
/**
* The maximum number of items to return.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous List request, if any.
*/
// const pageToken = 'abc123'
/**
* List filter.
*/
// const filter = 'abc123'
/**
* Sort results.
*/
// const orderBy = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callListAcceleratorTypes
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
tpuClient
.
listAcceleratorTypesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListAcceleratorTypes
();
listAcceleratorTypesStream(request, options)
listAcceleratorTypesStream
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListAcceleratorTypesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing AcceleratorType
on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAcceleratorTypesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
AsyncIterable
< google.cloud.location.ILocation
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
listNodes(request, options)
listNodes
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tpu
.
v1
.
INode
[],
protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesRequest
|
null
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesResponse
]>;
Lists nodes.
request
options
Promise
<[ protos.google.cloud.tpu.v1.INode
[], protos.google.cloud.tpu.v1.IListNodesRequest
| null, protos.google.cloud.tpu.v1.IListNodesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listNodesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listNodes(request, options, callback)
listNodes
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesRequest
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
tpu
.
v1
.
INode
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.tpu.v1.IListNodesRequest
, protos.google.cloud.tpu.v1.IListNodesResponse
| null | undefined, protos.google.cloud.tpu.v1.INode
>
void
listNodes(request, callback)
listNodes
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesRequest
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
tpu
.
v1
.
INode
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.tpu.v1.IListNodesRequest
, protos.google.cloud.tpu.v1.IListNodesResponse
| null | undefined, protos.google.cloud.tpu.v1.INode
>
void
listNodesAsync(request, options)
listNodesAsync
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
> ;
Equivalent to listNodes
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.tpu.v1.INode
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource name.
*/
// const parent = 'abc123'
/**
* The maximum number of items to return.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous List request, if any.
*/
// const pageToken = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callListNodes
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
tpuClient
.
listNodesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListNodes
();
listNodesStream(request, options)
listNodesStream
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListNodesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listNodesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listOperationsAsync(request, options)
listOperationsAsync
(
request
:
protos
.
google
.
longrunning
.
ListOperationsRequest
,
options
?:
gax
.
CallOptions
)
:
AsyncIterable<protos
.
google
.
longrunning
.
ListOperationsResponse
> ;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
request
options
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
AsyncIterable
< protos.google.longrunning.ListOperationsResponse
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
listTensorFlowVersions(request, options)
listTensorFlowVersions
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tpu
.
v1
.
ITensorFlowVersion
[],
protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsRequest
|
null
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsResponse
]>;
List TensorFlow versions supported by this API.
request
options
Promise
<[ protos.google.cloud.tpu.v1.ITensorFlowVersion
[], protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest
| null, protos.google.cloud.tpu.v1.IListTensorFlowVersionsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of TensorFlowVersion
. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listTensorFlowVersionsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listTensorFlowVersions(request, options, callback)
listTensorFlowVersions
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsRequest
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
tpu
.
v1
.
ITensorFlowVersion
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest
, protos.google.cloud.tpu.v1.IListTensorFlowVersionsResponse
| null | undefined, protos.google.cloud.tpu.v1.ITensorFlowVersion
>
void
listTensorFlowVersions(request, callback)
listTensorFlowVersions
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsRequest
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
tpu
.
v1
.
ITensorFlowVersion
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest
, protos.google.cloud.tpu.v1.IListTensorFlowVersionsResponse
| null | undefined, protos.google.cloud.tpu.v1.ITensorFlowVersion
>
void
listTensorFlowVersionsAsync(request, options)
listTensorFlowVersionsAsync
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
tpu
.
v1
.
ITensorFlowVersion
> ;
Equivalent to listTensorFlowVersions
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.tpu.v1.ITensorFlowVersion
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing TensorFlowVersion . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource name.
*/
// const parent = 'abc123'
/**
* The maximum number of items to return.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous List request, if any.
*/
// const pageToken = 'abc123'
/**
* List filter.
*/
// const filter = 'abc123'
/**
* Sort results.
*/
// const orderBy = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callListTensorFlowVersions
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
tpuClient
.
listTensorFlowVersionsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListTensorFlowVersions
();
listTensorFlowVersionsStream(request, options)
listTensorFlowVersionsStream
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IListTensorFlowVersionsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing TensorFlowVersion
on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTensorFlowVersionsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
project
string
location
string
string
{string} Resource name string.
matchAcceleratorTypeFromAcceleratorTypeName(acceleratorTypeName)
matchAcceleratorTypeFromAcceleratorTypeName
(
acceleratorTypeName
:
string
)
:
string
|
number
;
Parse the accelerator_type from AcceleratorType resource.
acceleratorTypeName
string
A fully-qualified path representing AcceleratorType resource.
string | number
{string} A string representing the accelerator_type.
matchLocationFromAcceleratorTypeName(acceleratorTypeName)
matchLocationFromAcceleratorTypeName
(
acceleratorTypeName
:
string
)
:
string
|
number
;
Parse the location from AcceleratorType resource.
acceleratorTypeName
string
A fully-qualified path representing AcceleratorType resource.
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the location.
matchLocationFromNodeName(nodeName)
matchLocationFromNodeName
(
nodeName
:
string
)
:
string
|
number
;
Parse the location from Node resource.
nodeName
string
A fully-qualified path representing Node resource.
string | number
{string} A string representing the location.
matchLocationFromTensorFlowVersionName(tensorFlowVersionName)
matchLocationFromTensorFlowVersionName
(
tensorFlowVersionName
:
string
)
:
string
|
number
;
Parse the location from TensorFlowVersion resource.
tensorFlowVersionName
string
A fully-qualified path representing TensorFlowVersion resource.
string | number
{string} A string representing the location.
matchNodeFromNodeName(nodeName)
matchNodeFromNodeName
(
nodeName
:
string
)
:
string
|
number
;
Parse the node from Node resource.
nodeName
string
A fully-qualified path representing Node resource.
string | number
{string} A string representing the node.
matchProjectFromAcceleratorTypeName(acceleratorTypeName)
matchProjectFromAcceleratorTypeName
(
acceleratorTypeName
:
string
)
:
string
|
number
;
Parse the project from AcceleratorType resource.
acceleratorTypeName
string
A fully-qualified path representing AcceleratorType resource.
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the project.
matchProjectFromNodeName(nodeName)
matchProjectFromNodeName
(
nodeName
:
string
)
:
string
|
number
;
Parse the project from Node resource.
nodeName
string
A fully-qualified path representing Node resource.
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
projectName
string
A fully-qualified path representing Project resource.
string | number
{string} A string representing the project.
matchProjectFromTensorFlowVersionName(tensorFlowVersionName)
matchProjectFromTensorFlowVersionName
(
tensorFlowVersionName
:
string
)
:
string
|
number
;
Parse the project from TensorFlowVersion resource.
tensorFlowVersionName
string
A fully-qualified path representing TensorFlowVersion resource.
string | number
{string} A string representing the project.
matchTensorFlowVersionFromTensorFlowVersionName(tensorFlowVersionName)
matchTensorFlowVersionFromTensorFlowVersionName
(
tensorFlowVersionName
:
string
)
:
string
|
number
;
Parse the tensor_flow_version from TensorFlowVersion resource.
tensorFlowVersionName
string
A fully-qualified path representing TensorFlowVersion resource.
string | number
{string} A string representing the tensor_flow_version.
nodePath(project, location, node)
nodePath
(
project
:
string
,
location
:
string
,
node
:
string
)
:
string
;
Return a fully-qualified node resource name string.
project
string
location
string
node
string
string
{string} Resource name string.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
project
string
string
{string} Resource name string.
reimageNode(request, options)
reimageNode
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IReimageNodeRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Reimages a node's OS.
request
options
Promise
<[ LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The resource name.
*/
// const name = 'abc123'
/**
* The version for reimage to create.
*/
// const tensorflowVersion = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callReimageNode
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
tpuClient
.
reimageNode
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callReimageNode
();
reimageNode(request, options, callback)
reimageNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IReimageNodeRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
reimageNode(request, callback)
reimageNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IReimageNodeRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
startNode(request, options)
startNode
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IStartNodeRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Starts a node.
request
options
Promise
<[ LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The resource name.
*/
// const name = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callStartNode
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
tpuClient
.
startNode
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callStartNode
();
startNode(request, options, callback)
startNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IStartNodeRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
startNode(request, callback)
startNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IStartNodeRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
stopNode(request, options)
stopNode
(
request
?:
protos
.
google
.
cloud
.
tpu
.
v1
.
IStopNodeRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Stops a node, this operation is only available with single TPU nodes.
request
options
Promise
<[ LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* 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.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The resource name.
*/
// const name = 'abc123'
// Imports the Tpu library
const
{
TpuClient
}
=
require
(
' @google-cloud/tpu
'
).
v1
;
// Instantiates a client
const
tpuClient
=
new
TpuClient
();
async
function
callStopNode
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
tpuClient
.
stopNode
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callStopNode
();
stopNode(request, options, callback)
stopNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IStopNodeRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
stopNode(request, callback)
stopNode
(
request
:
protos
.
google
.
cloud
.
tpu
.
v1
.
IStopNodeRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
tpu
.
v1
.
INode
,
protos
.
google
.
cloud
.
tpu
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.tpu.v1.INode
, protos.google.cloud.tpu.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
tensorFlowVersionPath(project, location, tensorFlowVersion)
tensorFlowVersionPath
(
project
:
string
,
location
:
string
,
tensorFlowVersion
:
string
)
:
string
;
Return a fully-qualified tensorFlowVersion resource name string.
project
string
location
string
tensorFlowVersion
string
string
{string} Resource name string.
