Google Cloud Ai Platform V1 Client - Class CreateTensorboardTimeSeriesRequest (0.10.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class CreateTensorboardTimeSeriesRequest.

Request message for TensorboardService.CreateTensorboardTimeSeries.

Generated from protobuf message google.cloud.aiplatform.v1.CreateTensorboardTimeSeriesRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{___location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
`↳ tensorboard_time_series_id`	`string` Optional. The user specified unique ID to use for the TensorboardTimeSeries, which will become the final component of the TensorboardTimeSeries's resource name. This value should match "[a-z0-9][a-z0-9-]{0, 127}"
`↳ tensorboard_time_series`	`Google\Cloud\AIPlatform\V1\TensorboardTimeSeries` Required. The TensorboardTimeSeries to create.

getParent

Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in.

Format: projects/{project}/locations/{___location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type	Description
`string`

setParent

Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in.

Format: projects/{project}/locations/{___location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTensorboardTimeSeriesId

Optional. The user specified unique ID to use for the TensorboardTimeSeries, which will become the final component of the TensorboardTimeSeries's resource name.

This value should match "[a-z0-9][a-z0-9-]{0, 127}"

Generated from protobuf field string tensorboard_time_series_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`string`

setTensorboardTimeSeriesId

Optional. The user specified unique ID to use for the TensorboardTimeSeries, which will become the final component of the TensorboardTimeSeries's resource name.

This value should match "[a-z0-9][a-z0-9-]{0, 127}"

Generated from protobuf field string tensorboard_time_series_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTensorboardTimeSeries

Required. The TensorboardTimeSeries to create.

Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardTimeSeries tensorboard_time_series = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\TensorboardTimeSeries\|null`

hasTensorboardTimeSeries

clearTensorboardTimeSeries

setTensorboardTimeSeries