Class BatchReadTensorboardTimeSeriesDataRequest (3.42.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
Type Description
int

TIME_SERIES_FIELD_NUMBER

public static final int TIME_SERIES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchReadTensorboardTimeSeriesDataRequest getDefaultInstance()
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest

getDescriptor()

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

newBuilder()

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

newBuilder(BatchReadTensorboardTimeSeriesDataRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchReadTensorboardTimeSeriesDataRequest getDefaultInstanceForType()
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the timeSeries.

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 BatchReadTensorboardTimeSeriesDataRequest.Builder newBuilderForType()
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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