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

ProjectsLocationsTensorboards

class ProjectsLocationsTensorboards extends Resource (View source)

The "tensorboards" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $tensorboards = $aiplatformService->projects_locations_tensorboards;

Methods

GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse
batchRead(string $tensorboard, array $optParams = [])

Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. (tensorboards.batchRead)

GoogleLongrunningOperation
create(string $parent, GoogleCloudAiplatformV1Tensorboard $postBody, array $optParams = [])

Creates a Tensorboard. (tensorboards.create)

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

Deletes a Tensorboard. (tensorboards.delete)

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

Gets a Tensorboard. (tensorboards.get)

GoogleCloudAiplatformV1ListTensorboardsResponse
listProjectsLocationsTensorboards(string $parent, array $optParams = [])

Lists Tensorboards in a Location.

GoogleLongrunningOperation
patch(string $name, GoogleCloudAiplatformV1Tensorboard $postBody, array $optParams = [])

Updates a Tensorboard. (tensorboards.patch)

GoogleCloudAiplatformV1ReadTensorboardSizeResponse
readSize(string $tensorboard, array $optParams = [])

Returns the storage size for a given TensorBoard instance.

GoogleCloudAiplatformV1ReadTensorboardUsageResponse
readUsage(string $tensorboard, array $optParams = [])

Returns a list of monthly active users for a given TensorBoard instance.

Details

at line 58
GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse batchRead(string $tensorboard, array $optParams = [])

Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. (tensorboards.batchRead)

Parameters

string $tensorboard

Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse

Exceptions

Exception

at line 74
GoogleLongrunningOperation create(string $parent, GoogleCloudAiplatformV1Tensorboard $postBody, array $optParams = [])

Creates a Tensorboard. (tensorboards.create)

Parameters

string $parent

Required. The resource name of the Location to create the Tensorboard in. Format: projects/{project}/locations/{location}
GoogleCloudAiplatformV1Tensorboard $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 89
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a Tensorboard. (tensorboards.delete)

Parameters

string $name

Required. The name of the Tensorboard to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 104
GoogleCloudAiplatformV1Tensorboard get(string $name, array $optParams = [])

Gets a Tensorboard. (tensorboards.get)

Parameters

string $name

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Tensorboard

Exceptions

Exception

at line 134
GoogleCloudAiplatformV1ListTensorboardsResponse listProjectsLocationsTensorboards(string $parent, array $optParams = [])

Lists Tensorboards in a Location.

(tensorboards.listProjectsLocationsTensorboards)

Parameters

string $parent

Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListTensorboardsResponse

Exceptions

Exception

at line 157
GoogleLongrunningOperation patch(string $name, GoogleCloudAiplatformV1Tensorboard $postBody, array $optParams = [])

Updates a Tensorboard. (tensorboards.patch)

Parameters

string $name

Output only. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
GoogleCloudAiplatformV1Tensorboard $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 173
GoogleCloudAiplatformV1ReadTensorboardSizeResponse readSize(string $tensorboard, array $optParams = [])

Returns the storage size for a given TensorBoard instance.

(tensorboards.readSize)

Parameters

string $tensorboard

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ReadTensorboardSizeResponse

Exceptions

Exception

at line 189
GoogleCloudAiplatformV1ReadTensorboardUsageResponse readUsage(string $tensorboard, array $optParams = [])

Returns a list of monthly active users for a given TensorBoard instance.

(tensorboards.readUsage)

Parameters

string $tensorboard

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ReadTensorboardUsageResponse

Exceptions

Exception