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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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
Type Description
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
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var int
Returns
Type Description
$this

getFilter

Reads the TensorboardTimeSeries' data that match the filter expression.

Returns
Type Description
string

setFilter

Reads the TensorboardTimeSeries' data that match the filter expression.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

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

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