Class WriteTensorboardRunDataRequest (3.46.0)

public final class WriteTensorboardRunDataRequest extends GeneratedMessageV3 implements WriteTensorboardRunDataRequestOrBuilder

Request message for TensorboardService.WriteTensorboardRunData.

Protobuf type google.cloud.aiplatform.v1.WriteTensorboardRunDataRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > WriteTensorboardRunDataRequest

Static Fields

TENSORBOARD_RUN_FIELD_NUMBER

public static final int TENSORBOARD_RUN_FIELD_NUMBER
Field Value
Type Description
int

TIME_SERIES_DATA_FIELD_NUMBER

public static final int TIME_SERIES_DATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WriteTensorboardRunDataRequest getDefaultInstance()
Returns
Type Description
WriteTensorboardRunDataRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static WriteTensorboardRunDataRequest.Builder newBuilder()
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

newBuilder(WriteTensorboardRunDataRequest prototype)

public static WriteTensorboardRunDataRequest.Builder newBuilder(WriteTensorboardRunDataRequest prototype)
Parameter
Name Description
prototype WriteTensorboardRunDataRequest
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

parseDelimitedFrom(InputStream input)

public static WriteTensorboardRunDataRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteTensorboardRunDataRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WriteTensorboardRunDataRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WriteTensorboardRunDataRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WriteTensorboardRunDataRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WriteTensorboardRunDataRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WriteTensorboardRunDataRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteTensorboardRunDataRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WriteTensorboardRunDataRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteTensorboardRunDataRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WriteTensorboardRunDataRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WriteTensorboardRunDataRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteTensorboardRunDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WriteTensorboardRunDataRequest> parser()
Returns
Type Description
Parser<WriteTensorboardRunDataRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public WriteTensorboardRunDataRequest getDefaultInstanceForType()
Returns
Type Description
WriteTensorboardRunDataRequest

getParserForType()

public Parser<WriteTensorboardRunDataRequest> getParserForType()
Returns
Type Description
Parser<WriteTensorboardRunDataRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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) = { ... }

Returns
Type Description
String

The tensorboardRun.

getTensorboardRunBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for tensorboardRun.

getTimeSeriesData(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
TimeSeriesData

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];

Returns
Type Description
int

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];

Returns
Type Description
List<TimeSeriesData>

getTimeSeriesDataOrBuilder(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
TimeSeriesDataOrBuilder

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];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.TimeSeriesDataOrBuilder>

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WriteTensorboardRunDataRequest.Builder newBuilderForType()
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WriteTensorboardRunDataRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WriteTensorboardRunDataRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public WriteTensorboardRunDataRequest.Builder toBuilder()
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException