Google Cloud Ai Platform V1 Client - Class ReadTensorboardTimeSeriesDataRequest (0.17.0)

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

Request message for TensorboardService.ReadTensorboardTimeSeriesData.

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

Methods

build

Parameter
NameDescription
tensorboardTimeSeries string

Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series} Please see {@see \Google\Cloud\AIPlatform\V1\TensorboardServiceClient::tensorboardTimeSeriesName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\ReadTensorboardTimeSeriesDataRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ tensorboard_time_series string

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

↳ max_data_points int

The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.

↳ filter string

Reads the TensorboardTimeSeries' data that match the filter expression.

getTensorboardTimeSeries

Required. The resource name of the TensorboardTimeSeries to read data from.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns
TypeDescription
string

setTensorboardTimeSeries

Required. The resource name of the TensorboardTimeSeries to read data from.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMaxDataPoints

The maximum number of TensorboardTimeSeries' data to return.

This value should be a positive integer. This value can be set to -1 to return all data.

Returns
TypeDescription
int

setMaxDataPoints

The maximum number of TensorboardTimeSeries' data to return.

This value should be a positive integer. This value can be set to -1 to return all data.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFilter

Reads the TensorboardTimeSeries' data that match the filter expression.

Returns
TypeDescription
string

setFilter

Reads the TensorboardTimeSeries' data that match the filter expression.

Parameter
NameDescription
var string
Returns
TypeDescription
$this