Google Cloud Ai Platform V1 Client - Class ExportTensorboardTimeSeriesDataRequest (1.13.1)

Version latest

• 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 ExportTensorboardTimeSeriesDataRequest.

Request message for TensorboardService.ExportTensorboardTimeSeriesData.

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

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 export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
↳ filter	string Exports the TensorboardTimeSeries' data that match the filter expression.
↳ page_size	int The maximum number of data points to return per page. The default page_size is 1000. Values must be between 1 and 10000. Values above 10000 are coerced to 10000.
↳ page_token	string A page token, received from a previous ExportTensorboardTimeSeriesData call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ExportTensorboardTimeSeriesData must match the call that provided the page token.
↳ order_by	string Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data is returned in a pseudo random order.

getTensorboardTimeSeries

Required. The resource name of the TensorboardTimeSeries to export 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 export 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

getFilter

Exports the TensorboardTimeSeries' data that match the filter expression.

Returns
Type	Description
string

setFilter

Exports the TensorboardTimeSeries' data that match the filter expression.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

The maximum number of data points to return per page.

The default page_size is 1000. Values must be between 1 and 10000. Values above 10000 are coerced to 10000.

Returns
Type	Description
int

setPageSize

The maximum number of data points to return per page.

The default page_size is 1000. Values must be between 1 and 10000. Values above 10000 are coerced to 10000.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

A page token, received from a previous ExportTensorboardTimeSeriesData call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ExportTensorboardTimeSeriesData must match the call that provided the page token.

Returns
Type	Description
string

setPageToken

A page token, received from a previous ExportTensorboardTimeSeriesData call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ExportTensorboardTimeSeriesData must match the call that provided the page token.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOrderBy

Field to use to sort the TensorboardTimeSeries' data.

By default, TensorboardTimeSeries' data is returned in a pseudo random order.

Returns
Type	Description
string

setOrderBy

Field to use to sort the TensorboardTimeSeries' data.

By default, TensorboardTimeSeries' data is returned in a pseudo random order.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
tensorboardTimeSeries	string Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series} Please see TensorboardServiceClient::tensorboardTimeSeriesName() for help formatting this field.

Returns
Type	Description
ExportTensorboardTimeSeriesDataRequest