Class BatchReadTensorboardTimeSeriesDataRequest (3.31.0)

public final class BatchReadTensorboardTimeSeriesDataRequest extends GeneratedMessageV3 implements BatchReadTensorboardTimeSeriesDataRequestOrBuilder

Request message for TensorboardService.BatchReadTensorboardTimeSeriesData.

Protobuf type google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest

Inheritance

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

Static Fields

TENSORBOARD_FIELD_NUMBER

public static final int TENSORBOARD_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_SERIES_FIELD_NUMBER

public static final int TIME_SERIES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchReadTensorboardTimeSeriesDataRequest getDefaultInstance()
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BatchReadTensorboardTimeSeriesDataRequest.Builder newBuilder()
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest.Builder

newBuilder(BatchReadTensorboardTimeSeriesDataRequest prototype)

public static BatchReadTensorboardTimeSeriesDataRequest.Builder newBuilder(BatchReadTensorboardTimeSeriesDataRequest prototype)
Parameter
NameDescription
prototypeBatchReadTensorboardTimeSeriesDataRequest
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest.Builder

parseDelimitedFrom(InputStream input)

public static BatchReadTensorboardTimeSeriesDataRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchReadTensorboardTimeSeriesDataRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BatchReadTensorboardTimeSeriesDataRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchReadTensorboardTimeSeriesDataRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchReadTensorboardTimeSeriesDataRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchReadTensorboardTimeSeriesDataRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchReadTensorboardTimeSeriesDataRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchReadTensorboardTimeSeriesDataRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BatchReadTensorboardTimeSeriesDataRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchReadTensorboardTimeSeriesDataRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BatchReadTensorboardTimeSeriesDataRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchReadTensorboardTimeSeriesDataRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BatchReadTensorboardTimeSeriesDataRequest> parser()
Returns
TypeDescription
Parser<BatchReadTensorboardTimeSeriesDataRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public BatchReadTensorboardTimeSeriesDataRequest getDefaultInstanceForType()
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest

getParserForType()

public Parser<BatchReadTensorboardTimeSeriesDataRequest> getParserForType()
Returns
TypeDescription
Parser<BatchReadTensorboardTimeSeriesDataRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTensorboard()

public 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 must be sub resources of this Tensorboard.

string tensorboard = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The tensorboard.

getTensorboardBytes()

public 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 must be sub resources of this Tensorboard.

string tensorboard = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for tensorboard.

getTimeSeries(int index)

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The timeSeries at the given index.

getTimeSeriesBytes(int index)

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

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the timeSeries at the given index.

getTimeSeriesCount()

public 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
TypeDescription
int

The count of timeSeries.

getTimeSeriesList()

public ProtocolStringList 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
TypeDescription
ProtocolStringList

A list containing the timeSeries.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BatchReadTensorboardTimeSeriesDataRequest.Builder newBuilderForType()
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchReadTensorboardTimeSeriesDataRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BatchReadTensorboardTimeSeriesDataRequest.Builder toBuilder()
Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException