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

ProjectsLocationsTensorboardsExperimentsRuns

class ProjectsLocationsTensorboardsExperimentsRuns extends Resource (View source)

The "runs" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $runs = $aiplatformService->projects_locations_tensorboards_experiments_runs;

Methods

GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse
batchCreate(string $parent, GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest $postBody, array $optParams = [])

Batch create TensorboardRuns. (runs.batchCreate)

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

Creates a TensorboardRun. (runs.create)

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

Deletes a TensorboardRun. (runs.delete)

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

Gets a TensorboardRun. (runs.get)

GoogleCloudAiplatformV1ListTensorboardRunsResponse
listProjectsLocationsTensorboardsExperimentsRuns(string $parent, array $optParams = [])

Lists TensorboardRuns in a Location.

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

Updates a TensorboardRun. (runs.patch)

GoogleCloudAiplatformV1WriteTensorboardRunDataResponse
write(string $tensorboardRun, GoogleCloudAiplatformV1WriteTensorboardRunDataRequest $postBody, array $optParams = [])

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

Details

at line 51
GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse batchCreate(string $parent, GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest $postBody, array $optParams = [])

Batch create TensorboardRuns. (runs.batchCreate)

Parameters

string $parent

Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: projects/{pr oject}/locations/{location}/tensorboards/{tensorboard}/experiments/{experimen t} The parent field in the CreateTensorboardRunRequest messages must match this field.
GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse

Exceptions

Exception

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

Creates a TensorboardRun. (runs.create)

Parameters

string $parent

Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{pro ject}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment }
GoogleCloudAiplatformV1TensorboardRun $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1TensorboardRun

Exceptions

Exception

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

Deletes a TensorboardRun. (runs.delete)

Parameters

string $name

Required. The name of the TensorboardRun to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/e xperiments/{experiment}/runs/{run}
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 106
GoogleCloudAiplatformV1TensorboardRun get(string $name, array $optParams = [])

Gets a TensorboardRun. (runs.get)

Parameters

string $name

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

Optional parameters.

Return Value

GoogleCloudAiplatformV1TensorboardRun

Exceptions

Exception

at line 137
GoogleCloudAiplatformV1ListTensorboardRunsResponse listProjectsLocationsTensorboardsExperimentsRuns(string $parent, array $optParams = [])

Lists TensorboardRuns in a Location.

(runs.listProjectsLocationsTensorboardsExperimentsRuns)

Parameters

string $parent

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: projects/{project}/lo cations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListTensorboardRunsResponse

Exceptions

Exception

at line 161
GoogleCloudAiplatformV1TensorboardRun patch(string $name, GoogleCloudAiplatformV1TensorboardRun $postBody, array $optParams = [])

Updates a TensorboardRun. (runs.patch)

Parameters

string $name

Output only. Name of the TensorboardRun. Format: project s/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{expe riment}/runs/{run}
GoogleCloudAiplatformV1TensorboardRun $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1TensorboardRun

Exceptions

Exception

at line 180
GoogleCloudAiplatformV1WriteTensorboardRunDataResponse write(string $tensorboardRun, GoogleCloudAiplatformV1WriteTensorboardRunDataRequest $postBody, array $optParams = [])

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

(runs.write)

Parameters

string $tensorboardRun

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{locat ion}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
GoogleCloudAiplatformV1WriteTensorboardRunDataRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1WriteTensorboardRunDataResponse

Exceptions

Exception