Package com.google.cloud.aiplatform.v1

Interface ExportTensorboardTimeSeriesDataRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExportTensorboardTimeSeriesDataRequest, ExportTensorboardTimeSeriesDataRequest.Builder
@Generated public interface ExportTensorboardTimeSeriesDataRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Exports the TensorboardTimeSeries' data that match the filter expression.
    com.google.protobuf.ByteString
    getFilterBytes()
    Exports the TensorboardTimeSeries' data that match the filter expression.
    String
    getOrderBy()
    Field to use to sort the TensorboardTimeSeries' data.
    com.google.protobuf.ByteString
    getOrderByBytes()
    Field to use to sort the TensorboardTimeSeries' data.
    int
    getPageSize()
    The maximum number of data points to return per page.
    String
    getPageToken()
    A page token, received from a previous [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData] call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData] call.
    String
    getTensorboardTimeSeries()
    Required.
    com.google.protobuf.ByteString
    getTensorboardTimeSeriesBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getTensorboardTimeSeries

      String 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}`
      string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The tensorboardTimeSeries.

    • getTensorboardTimeSeriesBytes

      com.google.protobuf.ByteString getTensorboardTimeSeriesBytes()
       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}`
      string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for tensorboardTimeSeries.

    • getFilter

      String getFilter()
       Exports the TensorboardTimeSeries' data that match the filter expression.
      string filter = 2;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Exports the TensorboardTimeSeries' data that match the filter expression.
      string filter = 2;
      Returns:
      The bytes for filter.

    • getPageSize

      int 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.
      int32 page_size = 3;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       A page token, received from a previous
 [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
 must match the call that provided the page token.
      string page_token = 4;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous
 [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
 must match the call that provided the page token.
      string page_token = 4;
      Returns:
      The bytes for pageToken.

    • getOrderBy

      String getOrderBy()
       Field to use to sort the TensorboardTimeSeries' data.
 By default, TensorboardTimeSeries' data is returned in a pseudo random
 order.
      string order_by = 5;
      Returns:
      The orderBy.

    • getOrderByBytes

      com.google.protobuf.ByteString getOrderByBytes()
       Field to use to sort the TensorboardTimeSeries' data.
 By default, TensorboardTimeSeries' data is returned in a pseudo random
 order.
      string order_by = 5;
      Returns:
      The bytes for orderBy.