1. class
  2. Google
  3. \
  4. Service
  5. \
  6. TPU
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsNodes

ProjectsLocationsNodes

class ProjectsLocationsNodes extends Resource (View source)

The "nodes" collection of methods.

Typical usage is:

 $tpuService = new Google\Service\TPU(...);
 $nodes = $tpuService->projects_locations_nodes;

Methods

Operation
create(string $parent, Node $postBody, array $optParams = [])

Creates a node. (nodes.create)

Operation
delete(string $name, array $optParams = [])

Deletes a node. (nodes.delete)

Node
get(string $name, array $optParams = [])

Gets the details of a node. (nodes.get)

GetGuestAttributesResponse
getGuestAttributes(string $name, GetGuestAttributesRequest $postBody, array $optParams = [])

Retrieves the guest attributes for the node. (nodes.getGuestAttributes)

ListNodesResponse
listProjectsLocationsNodes(string $parent, array $optParams = [])

Lists nodes. (nodes.listProjectsLocationsNodes)

Operation
patch(string $name, Node $postBody, array $optParams = [])

Updates the configurations of a node. (nodes.patch)

Operation
start(string $name, StartNodeRequest $postBody, array $optParams = [])

Starts a node. (nodes.start)

Operation
stop(string $name, StopNodeRequest $postBody, array $optParams = [])

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

Details

at line 49
Operation create(string $parent, Node $postBody, array $optParams = [])

Creates a node. (nodes.create)

Parameters

string $parent

Required. The parent resource name.
Node $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 63
Operation delete(string $name, array $optParams = [])

Deletes a node. (nodes.delete)

Parameters

string $name

Required. The resource name.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 77
Node get(string $name, array $optParams = [])

Gets the details of a node. (nodes.get)

Parameters

string $name

Required. The resource name.
array $optParams

Optional parameters.

Return Value

Node

Exceptions

Exception

at line 92
GetGuestAttributesResponse getGuestAttributes(string $name, GetGuestAttributesRequest $postBody, array $optParams = [])

Retrieves the guest attributes for the node. (nodes.getGuestAttributes)

Parameters

string $name

Required. The resource name.
GetGuestAttributesRequest $postBody
array $optParams

Optional parameters.

Return Value

GetGuestAttributesResponse

Exceptions

Exception

at line 110
ListNodesResponse listProjectsLocationsNodes(string $parent, array $optParams = [])

Lists nodes. (nodes.listProjectsLocationsNodes)

Parameters

string $parent

Required. The parent resource name.
array $optParams

Optional parameters.

Return Value

ListNodesResponse

Exceptions

Exception

at line 129
Operation patch(string $name, Node $postBody, array $optParams = [])

Updates the configurations of a node. (nodes.patch)

Parameters

string $name

Output only. Immutable. The name of the TPU.
Node $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 144
Operation start(string $name, StartNodeRequest $postBody, array $optParams = [])

Starts a node. (nodes.start)

Parameters

string $name

Required. The resource name.
StartNodeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 160
Operation stop(string $name, StopNodeRequest $postBody, array $optParams = [])

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

(nodes.stop)

Parameters

string $name

Required. The resource name.
StopNodeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception