Package com.google.cloud.aiplatform.v1

Class ReadTensorboardTimeSeriesDataRequest

  • All Implemented Interfaces:
    ReadTensorboardTimeSeriesDataRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ReadTensorboardTimeSeriesDataRequest
extends com.google.protobuf.GeneratedMessageV3
implements ReadTensorboardTimeSeriesDataRequestOrBuilder
     Request message for
 [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData].
    Protobuf type google.cloud.aiplatform.v1.ReadTensorboardTimeSeriesDataRequest
    See Also:
    Serialized Form

    • Field Detail

      • TENSORBOARD_TIME_SERIES_FIELD_NUMBER

        public static final int TENSORBOARD_TIME_SERIES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_DATA_POINTS_FIELD_NUMBER

        public static final int MAX_DATA_POINTS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getTensorboardTimeSeries

        public String getTensorboardTimeSeries()
         Required. The resource name of the TensorboardTimeSeries to read 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) = { ... }
        Specified by:
        getTensorboardTimeSeries in interface ReadTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The tensorboardTimeSeries.

      • getTensorboardTimeSeriesBytes

        public com.google.protobuf.ByteString getTensorboardTimeSeriesBytes()
         Required. The resource name of the TensorboardTimeSeries to read 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) = { ... }
        Specified by:
        getTensorboardTimeSeriesBytes in interface ReadTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The bytes for tensorboardTimeSeries.

      • getMaxDataPoints

        public int getMaxDataPoints()
         The maximum number of TensorboardTimeSeries' data to return.

 This value should be a positive integer.
 This value can be set to -1 to return all data.
        int32 max_data_points = 2;
        Specified by:
        getMaxDataPoints in interface ReadTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The maxDataPoints.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ReadTensorboardTimeSeriesDataRequest parseFrom​(ByteBuffer data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ReadTensorboardTimeSeriesDataRequest parseFrom​(com.google.protobuf.ByteString data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ReadTensorboardTimeSeriesDataRequest parseFrom​(com.google.protobuf.ByteString data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ReadTensorboardTimeSeriesDataRequest parseFrom​(byte[] data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ReadTensorboardTimeSeriesDataRequest parseFrom​(byte[] data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public ReadTensorboardTimeSeriesDataRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ReadTensorboardTimeSeriesDataRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ReadTensorboardTimeSeriesDataRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ReadTensorboardTimeSeriesDataRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder