Google Cloud Ai Platform V1 Client - Class CreateTensorboardTimeSeriesRequest (0.39.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

Namespace

Google \ Cloud \ AIPlatform \ V1

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 becomes 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}

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}

Parameter
Name Description
var string
Returns
Type Description
$this

getTensorboardTimeSeriesId

Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "[a-z0-9][a-z0-9-]{0, 127}"

Returns
Type Description
string

setTensorboardTimeSeriesId

Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "[a-z0-9][a-z0-9-]{0, 127}"

Parameter
Name Description
var string
Returns
Type Description
$this

getTensorboardTimeSeries

Required. The TensorboardTimeSeries to create.

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

hasTensorboardTimeSeries

clearTensorboardTimeSeries

setTensorboardTimeSeries

Required. The TensorboardTimeSeries to create.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\TensorboardTimeSeries
Returns
Type Description
$this

static::build

Parameters
Name Description
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} Please see Google\Cloud\AIPlatform\V1\TensorboardServiceClient::tensorboardTimeSeriesName() for help formatting this field.

tensorboardTimeSeries Google\Cloud\AIPlatform\V1\TensorboardTimeSeries

Required. The TensorboardTimeSeries to create.

Returns
Type Description
Google\Cloud\AIPlatform\V1\CreateTensorboardTimeSeriesRequest