Class BatchReadTensorboardTimeSeriesDataRequest.Builder (3.45.0)

public static final class BatchReadTensorboardTimeSeriesDataRequest.Builder extends GeneratedMessageV3.Builder<BatchReadTensorboardTimeSeriesDataRequest.Builder> implements BatchReadTensorboardTimeSeriesDataRequestOrBuilder

Request message for TensorboardService.BatchReadTensorboardTimeSeriesData.

Protobuf type google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest

Static Methods

getDescriptor()

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

Methods

addAllTimeSeries(Iterable<String> values)

public BatchReadTensorboardTimeSeriesDataRequest.Builder addAllTimeSeries(Iterable<String> values)

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
values Iterable<String>

The timeSeries to add.

Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchReadTensorboardTimeSeriesDataRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides

addTimeSeries(String value)

public BatchReadTensorboardTimeSeriesDataRequest.Builder addTimeSeries(String value)

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
value String

The timeSeries to add.

Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

addTimeSeriesBytes(ByteString value)

public BatchReadTensorboardTimeSeriesDataRequest.Builder addTimeSeriesBytes(ByteString value)

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
value ByteString

The bytes of the timeSeries to add.

Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

build()

public BatchReadTensorboardTimeSeriesDataRequest build()
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest

buildPartial()

public BatchReadTensorboardTimeSeriesDataRequest buildPartial()
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest

clear()

public BatchReadTensorboardTimeSeriesDataRequest.Builder clear()
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public BatchReadTensorboardTimeSeriesDataRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchReadTensorboardTimeSeriesDataRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides

clearTensorboard()

public BatchReadTensorboardTimeSeriesDataRequest.Builder clearTensorboard()

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
BatchReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

clearTimeSeries()

public BatchReadTensorboardTimeSeriesDataRequest.Builder clearTimeSeries()

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
BatchReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

clone()

public BatchReadTensorboardTimeSeriesDataRequest.Builder clone()
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides

getDefaultInstanceForType()

public BatchReadTensorboardTimeSeriesDataRequest getDefaultInstanceForType()
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BatchReadTensorboardTimeSeriesDataRequest other)

public BatchReadTensorboardTimeSeriesDataRequest.Builder mergeFrom(BatchReadTensorboardTimeSeriesDataRequest other)
Parameter
Name Description
other BatchReadTensorboardTimeSeriesDataRequest
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchReadTensorboardTimeSeriesDataRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BatchReadTensorboardTimeSeriesDataRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchReadTensorboardTimeSeriesDataRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public BatchReadTensorboardTimeSeriesDataRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BatchReadTensorboardTimeSeriesDataRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides

setTensorboard(String value)

public BatchReadTensorboardTimeSeriesDataRequest.Builder setTensorboard(String value)

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

Parameter
Name Description
value String

The tensorboard to set.

Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setTensorboardBytes(ByteString value)

public BatchReadTensorboardTimeSeriesDataRequest.Builder setTensorboardBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for tensorboard to set.

Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setTimeSeries(int index, String value)

public BatchReadTensorboardTimeSeriesDataRequest.Builder setTimeSeries(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.

value String

The timeSeries to set.

Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchReadTensorboardTimeSeriesDataRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchReadTensorboardTimeSeriesDataRequest.Builder
Overrides