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}
Generated from protobuf field string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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}
Generated from protobuf field string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Exports the TensorboardTimeSeries' data that match the filter expression.
Generated from protobuf field string filter = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Exports the TensorboardTimeSeries' data that match the filter expression.
Generated from protobuf field string filter = 2;
| 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.
Generated from protobuf field int32 page_size = 3;
| 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.
Generated from protobuf field int32 page_size = 3;
| 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.
Generated from protobuf field string page_token = 4;
| 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.
Generated from protobuf field string page_token = 4;
| 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.
Generated from protobuf field string order_by = 5;
| 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.
Generated from protobuf field string order_by = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |