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
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: |
↳ 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 will be 1000. Values must be between 1 and 10000. Values above 10000 will be coerced to 10000. |
↳ page_token |
string
A page token, received from a previous TensorboardService.ExportTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ExportTensorboardTimeSeries must match the call that provided the page token. |
↳ order_by |
string
Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data will be 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 will be 1000. Values must be between 1 and 10000. Values above 10000 will be coerced to 10000.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
The maximum number of data points to return per page.
The default page_size will be 1000. Values must be between 1 and 10000. Values above 10000 will be coerced to 10000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
A page token, received from a previous TensorboardService.ExportTensorboardTimeSeries call.
Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ExportTensorboardTimeSeries must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
A page token, received from a previous TensorboardService.ExportTensorboardTimeSeries call.
Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ExportTensorboardTimeSeries 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 will be returned in a pseudo random order.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Field to use to sort the TensorboardTimeSeries' data.
By default, TensorboardTimeSeries' data will be returned in a pseudo random order.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |