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

Methods

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

Generated from protobuf field string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

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}

Generated from protobuf field string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

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.

Generated from protobuf field int32 max_data_points = 2;

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.

Generated from protobuf field int32 max_data_points = 2;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFilter

Reads the TensorboardTimeSeries' data that match the filter expression.

Generated from protobuf field string filter = 3;

Returns
TypeDescription
string

setFilter

Reads the TensorboardTimeSeries' data that match the filter expression.

Generated from protobuf field string filter = 3;

Parameter
NameDescription
var string
Returns
TypeDescription
$this