Google Cloud Ai Platform V1 Client - Class BatchReadTensorboardTimeSeriesDataRequest (1.3.0)

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

Request message for TensorboardService.BatchReadTensorboardTimeSeriesData.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ tensorboard string

Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.

↳ time_series array

Required. The resource names of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

getTensorboard

Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}.

The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.

Returns
Type Description
string

setTensorboard

Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}.

The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.

Parameter
Name Description
var string
Returns
Type Description
$this

getTimeSeries

Required. The resource names of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTimeSeries

Required. The resource names of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Parameter
Name Description
var string[]
Returns
Type Description
$this

static::build

Parameter
Name Description
tensorboard string

Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. Please see Google\Cloud\AIPlatform\V1\TensorboardServiceClient::tensorboardName() for help formatting this field.

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