Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ExportTensorboardTimeSeriesDataRequest (v0.14.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ExportTensorboardTimeSeriesDataRequest.

Request message for TensorboardService.ExportTensorboardTimeSeriesData.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Exports the TensorboardTimeSeries' data that match the filter expression.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Exports the TensorboardTimeSeries' data that match the filter expression.
Returns
  • (::String) — Exports the TensorboardTimeSeries' data that match the filter expression.

#order_by

def order_by() -> ::String
Returns
  • (::String) — Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data will be returned in a pseudo random order.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data will be returned in a pseudo random order.
Returns
  • (::String) — Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data will be returned in a pseudo random order.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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

def page_token() -> ::String
Returns
  • (::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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#tensorboard_time_series

def tensorboard_time_series() -> ::String
Returns
  • (::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}

#tensorboard_time_series=

def tensorboard_time_series=(value) -> ::String
Parameter
  • value (::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}
Returns
  • (::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}