Package com.google.cloud.aiplatform.v1

Class ExportTensorboardTimeSeriesDataRequest

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

    • 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 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) = { ... }
        Specified by:
        getTensorboardTimeSeries in interface ExportTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The tensorboardTimeSeries.

      • getTensorboardTimeSeriesBytes

        public 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) = { ... }
        Specified by:
        getTensorboardTimeSeriesBytes in interface ExportTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The bytes for tensorboardTimeSeries.

      • getPageSize

        public 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;
        Specified by:
        getPageSize in interface ExportTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public 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;
        Specified by:
        getPageToken in interface ExportTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public 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;
        Specified by:
        getPageTokenBytes in interface ExportTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getOrderByBytes

        public 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;
        Specified by:
        getOrderByBytes in interface ExportTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • 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 ExportTensorboardTimeSeriesDataRequest parseFrom​(ByteBuffer data,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ExportTensorboardTimeSeriesDataRequest> 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 ExportTensorboardTimeSeriesDataRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder