Google Cloud Ai Platform V1 Client - Class ExportTensorboardTimeSeriesDataRequest (0.31.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
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Exports the TensorboardTimeSeries' data that match the filter expression.

Returns
TypeDescription
string

setFilter

Exports the TensorboardTimeSeries' data that match the filter expression.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Field to use to sort the TensorboardTimeSeries' data.

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

Returns
TypeDescription
string

setOrderBy

Field to use to sort the TensorboardTimeSeries' data.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

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

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\ExportTensorboardTimeSeriesDataRequest