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

ProjectsLocationsTensorboardsExperiments

class ProjectsLocationsTensorboardsExperiments extends Resource (View source)

The "experiments" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $experiments = $aiplatformService->projects_locations_tensorboards_experiments;

Methods

GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse
batchCreate(string $parent, GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest $postBody, array $optParams = [])

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

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

Creates a TensorboardExperiment. (experiments.create)

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

Deletes a TensorboardExperiment. (experiments.delete)

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

Gets a TensorboardExperiment. (experiments.get)

GoogleCloudAiplatformV1ListTensorboardExperimentsResponse
listProjectsLocationsTensorboardsExperiments(string $parent, array $optParams = [])

Lists TensorboardExperiments in a Location.

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

Updates a TensorboardExperiment. (experiments.patch)

GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse
write(string $tensorboardExperiment, GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest $postBody, array $optParams = [])

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.

Details

at line 53
GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse batchCreate(string $parent, GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest $postBody, array $optParams = [])

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

(experiments.batchCreate)

Parameters

string $parent

Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: projec ts/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{exp eriment} The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.
GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse

Exceptions

Exception

at line 75
GoogleCloudAiplatformV1TensorboardExperiment create(string $parent, GoogleCloudAiplatformV1TensorboardExperiment $postBody, array $optParams = [])

Creates a TensorboardExperiment. (experiments.create)

Parameters

string $parent

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

Optional parameters.

Return Value

GoogleCloudAiplatformV1TensorboardExperiment

Exceptions

Exception

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

Deletes a TensorboardExperiment. (experiments.delete)

Parameters

string $name

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

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 107
GoogleCloudAiplatformV1TensorboardExperiment get(string $name, array $optParams = [])

Gets a TensorboardExperiment. (experiments.get)

Parameters

string $name

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

Optional parameters.

Return Value

GoogleCloudAiplatformV1TensorboardExperiment

Exceptions

Exception

at line 138
GoogleCloudAiplatformV1ListTensorboardExperimentsResponse listProjectsLocationsTensorboardsExperiments(string $parent, array $optParams = [])

Lists TensorboardExperiments in a Location.

(experiments.listProjectsLocationsTensorboardsExperiments)

Parameters

string $parent

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

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListTensorboardExperimentsResponse

Exceptions

Exception

at line 162
GoogleCloudAiplatformV1TensorboardExperiment patch(string $name, GoogleCloudAiplatformV1TensorboardExperiment $postBody, array $optParams = [])

Updates a TensorboardExperiment. (experiments.patch)

Parameters

string $name

Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiment s/{experiment}
GoogleCloudAiplatformV1TensorboardExperiment $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1TensorboardExperiment

Exceptions

Exception

at line 181
GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse write(string $tensorboardExperiment, GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest $postBody, array $optParams = [])

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.

(experiments.write)

Parameters

string $tensorboardExperiment

Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations /{location}/tensorboards/{tensorboard}/experiments/{experiment}
GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse

Exceptions

Exception