Package com.google.cloud.aiplatform.v1

Class WriteTensorboardRunDataRequest

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

    • Field Detail

      • TENSORBOARD_RUN_FIELD_NUMBER

        public static final int TENSORBOARD_RUN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TIME_SERIES_DATA_FIELD_NUMBER

        public static final int TIME_SERIES_DATA_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

      • getTensorboardRun

        public String getTensorboardRun()
         Required. The resource name of the TensorboardRun to write data to.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
        string tensorboard_run = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getTensorboardRun in interface WriteTensorboardRunDataRequestOrBuilder
        Returns:
        The tensorboardRun.

      • getTensorboardRunBytes

        public com.google.protobuf.ByteString getTensorboardRunBytes()
         Required. The resource name of the TensorboardRun to write data to.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
        string tensorboard_run = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getTensorboardRunBytes in interface WriteTensorboardRunDataRequestOrBuilder
        Returns:
        The bytes for tensorboardRun.

      • getTimeSeriesDataList

        public List<TimeSeriesData> getTimeSeriesDataList()
         Required. The TensorboardTimeSeries data to write.
 Values with in a time series are indexed by their step value.
 Repeated writes to the same step will overwrite the existing value for that
 step.
 The upper limit of data points per write request is 5000.
        repeated .google.cloud.aiplatform.v1.TimeSeriesData time_series_data = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTimeSeriesDataList in interface WriteTensorboardRunDataRequestOrBuilder

      • getTimeSeriesDataOrBuilderList

        public List<? extends TimeSeriesDataOrBuilder> getTimeSeriesDataOrBuilderList()
         Required. The TensorboardTimeSeries data to write.
 Values with in a time series are indexed by their step value.
 Repeated writes to the same step will overwrite the existing value for that
 step.
 The upper limit of data points per write request is 5000.
        repeated .google.cloud.aiplatform.v1.TimeSeriesData time_series_data = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTimeSeriesDataOrBuilderList in interface WriteTensorboardRunDataRequestOrBuilder

      • getTimeSeriesDataCount

        public int getTimeSeriesDataCount()
         Required. The TensorboardTimeSeries data to write.
 Values with in a time series are indexed by their step value.
 Repeated writes to the same step will overwrite the existing value for that
 step.
 The upper limit of data points per write request is 5000.
        repeated .google.cloud.aiplatform.v1.TimeSeriesData time_series_data = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTimeSeriesDataCount in interface WriteTensorboardRunDataRequestOrBuilder

      • getTimeSeriesData

        public TimeSeriesData getTimeSeriesData​(int index)
         Required. The TensorboardTimeSeries data to write.
 Values with in a time series are indexed by their step value.
 Repeated writes to the same step will overwrite the existing value for that
 step.
 The upper limit of data points per write request is 5000.
        repeated .google.cloud.aiplatform.v1.TimeSeriesData time_series_data = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTimeSeriesData in interface WriteTensorboardRunDataRequestOrBuilder

      • getTimeSeriesDataOrBuilder

        public TimeSeriesDataOrBuilder getTimeSeriesDataOrBuilder​(int index)
         Required. The TensorboardTimeSeries data to write.
 Values with in a time series are indexed by their step value.
 Repeated writes to the same step will overwrite the existing value for that
 step.
 The upper limit of data points per write request is 5000.
        repeated .google.cloud.aiplatform.v1.TimeSeriesData time_series_data = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTimeSeriesDataOrBuilder in interface WriteTensorboardRunDataRequestOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

        public WriteTensorboardRunDataRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

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

      • getParserForType

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