Class WriteTensorboardRunDataRequest.Builder (3.46.0)

public static final class WriteTensorboardRunDataRequest.Builder extends GeneratedMessageV3.Builder<WriteTensorboardRunDataRequest.Builder> implements WriteTensorboardRunDataRequestOrBuilder

Request message for TensorboardService.WriteTensorboardRunData.

Protobuf type google.cloud.aiplatform.v1.WriteTensorboardRunDataRequest

Static Methods

getDescriptor()

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

Methods

addAllTimeSeriesData(Iterable<? extends TimeSeriesData> values)

public WriteTensorboardRunDataRequest.Builder addAllTimeSeriesData(Iterable<? extends TimeSeriesData> values)

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
values Iterable<? extends com.google.cloud.aiplatform.v1.TimeSeriesData>
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addTimeSeriesData(TimeSeriesData value)

public WriteTensorboardRunDataRequest.Builder addTimeSeriesData(TimeSeriesData value)

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
value TimeSeriesData
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

addTimeSeriesData(TimeSeriesData.Builder builderForValue)

public WriteTensorboardRunDataRequest.Builder addTimeSeriesData(TimeSeriesData.Builder builderForValue)

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
builderForValue TimeSeriesData.Builder
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

addTimeSeriesData(int index, TimeSeriesData value)

public WriteTensorboardRunDataRequest.Builder addTimeSeriesData(int index, TimeSeriesData value)

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

Parameters
Name Description
index int
value TimeSeriesData
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

addTimeSeriesData(int index, TimeSeriesData.Builder builderForValue)

public WriteTensorboardRunDataRequest.Builder addTimeSeriesData(int index, TimeSeriesData.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue TimeSeriesData.Builder
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

addTimeSeriesDataBuilder()

public TimeSeriesData.Builder addTimeSeriesDataBuilder()

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

addTimeSeriesDataBuilder(int index)

public TimeSeriesData.Builder addTimeSeriesDataBuilder(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.Builder

build()

public WriteTensorboardRunDataRequest build()
Returns
Type Description
WriteTensorboardRunDataRequest

buildPartial()

public WriteTensorboardRunDataRequest buildPartial()
Returns
Type Description
WriteTensorboardRunDataRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearTensorboardRun()

public WriteTensorboardRunDataRequest.Builder clearTensorboardRun()

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

This builder for chaining.

clearTimeSeriesData()

public WriteTensorboardRunDataRequest.Builder clearTimeSeriesData()

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

clone()

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

getDefaultInstanceForType()

public WriteTensorboardRunDataRequest getDefaultInstanceForType()
Returns
Type Description
WriteTensorboardRunDataRequest

getDescriptorForType()

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

getTimeSeriesDataBuilder(int index)

public TimeSeriesData.Builder getTimeSeriesDataBuilder(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.Builder

getTimeSeriesDataBuilderList()

public List<TimeSeriesData.Builder> getTimeSeriesDataBuilderList()

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

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>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(WriteTensorboardRunDataRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeTimeSeriesData(int index)

public WriteTensorboardRunDataRequest.Builder removeTimeSeriesData(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
WriteTensorboardRunDataRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setTensorboardRun(String value)

public WriteTensorboardRunDataRequest.Builder setTensorboardRun(String value)

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

Parameter
Name Description
value String

The tensorboardRun to set.

Returns
Type Description
WriteTensorboardRunDataRequest.Builder

This builder for chaining.

setTensorboardRunBytes(ByteString value)

public WriteTensorboardRunDataRequest.Builder setTensorboardRunBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for tensorboardRun to set.

Returns
Type Description
WriteTensorboardRunDataRequest.Builder

This builder for chaining.

setTimeSeriesData(int index, TimeSeriesData value)

public WriteTensorboardRunDataRequest.Builder setTimeSeriesData(int index, TimeSeriesData value)

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

Parameters
Name Description
index int
value TimeSeriesData
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

setTimeSeriesData(int index, TimeSeriesData.Builder builderForValue)

public WriteTensorboardRunDataRequest.Builder setTimeSeriesData(int index, TimeSeriesData.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue TimeSeriesData.Builder
Returns
Type Description
WriteTensorboardRunDataRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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