Package com.google.cloud.aiplatform.v1

Interface BatchReadTensorboardTimeSeriesDataRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getTensorboard()
    Required.
    com.google.protobuf.ByteString
    getTensorboardBytes()
    Required.
    String
    getTimeSeries(int index)
    Required.
    com.google.protobuf.ByteString
    getTimeSeriesBytes(int index)
    Required.
    int
    getTimeSeriesCount()
    Required.
    List<String>
    getTimeSeriesList()
    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

    • getTensorboard

      String getTensorboard()
       Required. The resource name of the Tensorboard containing
 TensorboardTimeSeries to read data from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}`.
 The TensorboardTimeSeries referenced by
 [time_series][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series]
 must be sub resources of this Tensorboard.
      string tensorboard = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The tensorboard.

    • getTensorboardBytes

      com.google.protobuf.ByteString getTensorboardBytes()
       Required. The resource name of the Tensorboard containing
 TensorboardTimeSeries to read data from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}`.
 The TensorboardTimeSeries referenced by
 [time_series][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series]
 must be sub resources of this Tensorboard.
      string tensorboard = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for tensorboard.

    • getTimeSeriesList

      List<String> getTimeSeriesList()
       Required. The resource names of the TensorboardTimeSeries to read data
 from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
      repeated string time_series = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the timeSeries.

    • getTimeSeriesCount

      int getTimeSeriesCount()
       Required. The resource names of the TensorboardTimeSeries to read data
 from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
      repeated string time_series = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The count of timeSeries.

    • getTimeSeries

      String getTimeSeries(int index)
       Required. The resource names of the TensorboardTimeSeries to read data
 from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
      repeated string time_series = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The timeSeries at the given index.

    • getTimeSeriesBytes

      com.google.protobuf.ByteString getTimeSeriesBytes(int index)
       Required. The resource names of the TensorboardTimeSeries to read data
 from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
      repeated string time_series = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the timeSeries at the given index.