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

Version 0.31.0

• 1.13.1 (latest)
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.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