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

ProjectsLocationsTensorboardsExperimentsRunsTimeSeries

class ProjectsLocationsTensorboardsExperimentsRunsTimeSeries extends Resource (View source)

The "timeSeries" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $timeSeries = $aiplatformService->projects_locations_tensorboards_experiments_runs_timeSeries;

Methods

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

Creates a TensorboardTimeSeries. (timeSeries.create)

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

Deletes a TensorboardTimeSeries. (timeSeries.delete)

GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse
exportTensorboardTimeSeries(string $tensorboardTimeSeries, GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest $postBody, array $optParams = [])

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses. (timeSeries.exportTensorboardTimeSeries)

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

Gets a TensorboardTimeSeries. (timeSeries.get)

GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse
listProjectsLocationsTensorboardsExperimentsRunsTimeSeries(string $parent, array $optParams = [])

Lists TensorboardTimeSeries in a Location.

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

Updates a TensorboardTimeSeries. (timeSeries.patch)

GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse
read(string $tensorboardTimeSeries, array $optParams = [])

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse
readBlobData(string $timeSeries, array $optParams = [])

Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission. (timeSeries.readBlobData)

Details

at line 54
GoogleCloudAiplatformV1TensorboardTimeSeries create(string $parent, GoogleCloudAiplatformV1TensorboardTimeSeries $postBody, array $optParams = [])

Creates a TensorboardTimeSeries. (timeSeries.create)

Parameters

string $parent

Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: projects/{project}/locations/{l ocation}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
GoogleCloudAiplatformV1TensorboardTimeSeries $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1TensorboardTimeSeries

Exceptions

Exception

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

Deletes a TensorboardTimeSeries. (timeSeries.delete)

Parameters

string $name

Required. The name of the TensorboardTimeSeries to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tenso rboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 89
GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse exportTensorboardTimeSeries(string $tensorboardTimeSeries, GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest $postBody, array $optParams = [])

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses. (timeSeries.exportTensorboardTimeSeries)

Parameters

string $tensorboardTimeSeries

Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locati ons/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} /timeSeries/{time_series}
GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse

Exceptions

Exception

at line 105
GoogleCloudAiplatformV1TensorboardTimeSeries get(string $name, array $optParams = [])

Gets a TensorboardTimeSeries. (timeSeries.get)

Parameters

string $name

Required. The name of the TensorboardTimeSeries resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/e xperiments/{experiment}/runs/{run}/timeSeries/{time_series}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1TensorboardTimeSeries

Exceptions

Exception

at line 136
GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse listProjectsLocationsTensorboardsExperimentsRunsTimeSeries(string $parent, array $optParams = [])

Lists TensorboardTimeSeries in a Location.

(timeSeries.listProjectsLocationsTensorboardsExperimentsRunsTimeSeries)

Parameters

string $parent

Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: projects/{project}/locations/{location}/ tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse

Exceptions

Exception

at line 158
GoogleCloudAiplatformV1TensorboardTimeSeries patch(string $name, GoogleCloudAiplatformV1TensorboardTimeSeries $postBody, array $optParams = [])

Updates a TensorboardTimeSeries. (timeSeries.patch)

Parameters

string $name

Output only. Name of the TensorboardTimeSeries.
GoogleCloudAiplatformV1TensorboardTimeSeries $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1TensorboardTimeSeries

Exceptions

Exception

at line 185
GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse read(string $tensorboardTimeSeries, array $optParams = [])

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

(timeSeries.read)

Parameters

string $tensorboardTimeSeries

Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/{project}/location s/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/t imeSeries/{time_series}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse

Exceptions

Exception

at line 206
GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse readBlobData(string $timeSeries, array $optParams = [])

Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission. (timeSeries.readBlobData)

Parameters

string $timeSeries

Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: projects/{project}/locations/{l ocation}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeS eries/{time_series}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse

Exceptions

Exception