Cloud TPU API . projects . locations . nodes

close()

Close httplib2 connections.

create(parent, body=None, nodeId=None, x__xgafv=None)

Creates a node.

Args:
  parent: string, Required. The parent resource name. (required)
  body: object, The request body.
    The object takes the form of:

{ # A TPU instance.
  "acceleratorType": "A String", # Required. The type of hardware accelerators associated with this node.
  "apiVersion": "A String", # Output only. The API version that created this Node.
  "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
  "createTime": "A String", # Output only. The time when the node was created.
  "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
  "health": "A String", # The health status of the TPU node.
  "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
  "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.
  "labels": { # Resource labels to represent user-provided metadata.
    "a_key": "A String",
  },
  "name": "A String", # Output only. Immutable. The name of the TPU
  "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
  "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
    { # A network endpoint over which a TPU worker can be reached.
      "ipAddress": "A String", # The IP address of this network endpoint.
      "port": 42, # The port of this network endpoint.
    },
  ],
  "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
  "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node.
    "preemptible": True or False, # Defines whether the node is preemptible.
    "reserved": True or False, # Whether the node is created under a reservation.
  },
  "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
  "state": "A String", # Output only. The current state for the TPU Node.
  "symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
    { # A Symptom instance.
      "createTime": "A String", # Timestamp when the Symptom is created.
      "details": "A String", # Detailed information of the current Symptom.
      "symptomType": "A String", # Type of the Symptom.
      "workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
    },
  ],
  "tensorflowVersion": "A String", # Required. The version of Tensorflow running in the Node.
  "useServiceNetworking": True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
}

  nodeId: string, The unqualified resource name.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

delete(name, x__xgafv=None)

Deletes a node.

Args:
  name: string, Required. The resource name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

get(name, x__xgafv=None)

Gets the details of a node.

Args:
  name: string, Required. The resource name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A TPU instance.
  "acceleratorType": "A String", # Required. The type of hardware accelerators associated with this node.
  "apiVersion": "A String", # Output only. The API version that created this Node.
  "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
  "createTime": "A String", # Output only. The time when the node was created.
  "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
  "health": "A String", # The health status of the TPU node.
  "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
  "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.
  "labels": { # Resource labels to represent user-provided metadata.
    "a_key": "A String",
  },
  "name": "A String", # Output only. Immutable. The name of the TPU
  "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
  "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
    { # A network endpoint over which a TPU worker can be reached.
      "ipAddress": "A String", # The IP address of this network endpoint.
      "port": 42, # The port of this network endpoint.
    },
  ],
  "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
  "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node.
    "preemptible": True or False, # Defines whether the node is preemptible.
    "reserved": True or False, # Whether the node is created under a reservation.
  },
  "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
  "state": "A String", # Output only. The current state for the TPU Node.
  "symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
    { # A Symptom instance.
      "createTime": "A String", # Timestamp when the Symptom is created.
      "details": "A String", # Detailed information of the current Symptom.
      "symptomType": "A String", # Type of the Symptom.
      "workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
    },
  ],
  "tensorflowVersion": "A String", # Required. The version of Tensorflow running in the Node.
  "useServiceNetworking": True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists nodes.

Args:
  parent: string, Required. The parent resource name. (required)
  pageSize: integer, The maximum number of items to return.
  pageToken: string, The next_page_token value returned from a previous List request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListNodes.
  "nextPageToken": "A String", # The next page token or empty if none.
  "nodes": [ # The listed nodes.
    { # A TPU instance.
      "acceleratorType": "A String", # Required. The type of hardware accelerators associated with this node.
      "apiVersion": "A String", # Output only. The API version that created this Node.
      "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
      "createTime": "A String", # Output only. The time when the node was created.
      "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
      "health": "A String", # The health status of the TPU node.
      "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
      "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.
      "labels": { # Resource labels to represent user-provided metadata.
        "a_key": "A String",
      },
      "name": "A String", # Output only. Immutable. The name of the TPU
      "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
      "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
        { # A network endpoint over which a TPU worker can be reached.
          "ipAddress": "A String", # The IP address of this network endpoint.
          "port": 42, # The port of this network endpoint.
        },
      ],
      "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
      "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node.
        "preemptible": True or False, # Defines whether the node is preemptible.
        "reserved": True or False, # Whether the node is created under a reservation.
      },
      "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
      "state": "A String", # Output only. The current state for the TPU Node.
      "symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
        { # A Symptom instance.
          "createTime": "A String", # Timestamp when the Symptom is created.
          "details": "A String", # Detailed information of the current Symptom.
          "symptomType": "A String", # Type of the Symptom.
          "workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
        },
      ],
      "tensorflowVersion": "A String", # Required. The version of Tensorflow running in the Node.
      "useServiceNetworking": True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
    },
  ],
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

reimage(name, body=None, x__xgafv=None)

Reimages a node's OS.

Args:
  name: string, The resource name. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for ReimageNode.
  "tensorflowVersion": "A String", # The version for reimage to create.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

start(name, body=None, x__xgafv=None)

Starts a node.

Args:
  name: string, The resource name. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for StartNode.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

stop(name, body=None, x__xgafv=None)

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

Args:
  name: string, The resource name. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for StopNode.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}