Class TensorboardTimeSeries.Builder (3.48.0)

public static final class TensorboardTimeSeries.Builder extends GeneratedMessageV3.Builder<TensorboardTimeSeries.Builder> implements TensorboardTimeSeriesOrBuilder

TensorboardTimeSeries maps to times series produced in training runs

Protobuf type google.cloud.aiplatform.v1beta1.TensorboardTimeSeries

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public TensorboardTimeSeries build()
Returns
Type Description
TensorboardTimeSeries

buildPartial()

public TensorboardTimeSeries buildPartial()
Returns
Type Description
TensorboardTimeSeries

clear()

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

clearCreateTime()

public TensorboardTimeSeries.Builder clearCreateTime()

Output only. Timestamp when this TensorboardTimeSeries was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TensorboardTimeSeries.Builder

clearDescription()

public TensorboardTimeSeries.Builder clearDescription()

Description of this TensorboardTimeSeries.

string description = 3;

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

clearDisplayName()

public TensorboardTimeSeries.Builder clearDisplayName()

Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

clearEtag()

public TensorboardTimeSeries.Builder clearEtag()

Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 7;

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMetadata()

public TensorboardTimeSeries.Builder clearMetadata()

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TensorboardTimeSeries.Builder

clearName()

public TensorboardTimeSeries.Builder clearName()

Output only. Name of the TensorboardTimeSeries.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPluginData()

public TensorboardTimeSeries.Builder clearPluginData()

Data of the current plugin, with the size limited to 65KB.

bytes plugin_data = 9;

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

clearPluginName()

public TensorboardTimeSeries.Builder clearPluginName()

Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

clearUpdateTime()

public TensorboardTimeSeries.Builder clearUpdateTime()

Output only. Timestamp when this TensorboardTimeSeries was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TensorboardTimeSeries.Builder

clearValueType()

public TensorboardTimeSeries.Builder clearValueType()

Required. Immutable. Type of TensorboardTimeSeries value.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

clone()

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

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this TensorboardTimeSeries was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this TensorboardTimeSeries was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this TensorboardTimeSeries was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public TensorboardTimeSeries getDefaultInstanceForType()
Returns
Type Description
TensorboardTimeSeries

getDescription()

public String getDescription()

Description of this TensorboardTimeSeries.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of this TensorboardTimeSeries.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 7;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 7;

Returns
Type Description
ByteString

The bytes for etag.

getMetadata()

public TensorboardTimeSeries.Metadata getMetadata()

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TensorboardTimeSeries.Metadata

The metadata.

getMetadataBuilder()

public TensorboardTimeSeries.Metadata.Builder getMetadataBuilder()

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TensorboardTimeSeries.Metadata.Builder

getMetadataOrBuilder()

public TensorboardTimeSeries.MetadataOrBuilder getMetadataOrBuilder()

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TensorboardTimeSeries.MetadataOrBuilder

getName()

public String getName()

Output only. Name of the TensorboardTimeSeries.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Name of the TensorboardTimeSeries.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getPluginData()

public ByteString getPluginData()

Data of the current plugin, with the size limited to 65KB.

bytes plugin_data = 9;

Returns
Type Description
ByteString

The pluginData.

getPluginName()

public String getPluginName()

Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The pluginName.

getPluginNameBytes()

public ByteString getPluginNameBytes()

Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for pluginName.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this TensorboardTimeSeries was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when this TensorboardTimeSeries was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this TensorboardTimeSeries was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getValueType()

public TensorboardTimeSeries.ValueType getValueType()

Required. Immutable. Type of TensorboardTimeSeries value.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
TensorboardTimeSeries.ValueType

The valueType.

getValueTypeValue()

public int getValueTypeValue()

Required. Immutable. Type of TensorboardTimeSeries value.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for valueType.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this TensorboardTimeSeries was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasMetadata()

public boolean hasMetadata()

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the metadata field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this TensorboardTimeSeries was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public TensorboardTimeSeries.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this TensorboardTimeSeries was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
TensorboardTimeSeries.Builder

mergeFrom(TensorboardTimeSeries other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMetadata(TensorboardTimeSeries.Metadata value)

public TensorboardTimeSeries.Builder mergeMetadata(TensorboardTimeSeries.Metadata value)

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value TensorboardTimeSeries.Metadata
Returns
Type Description
TensorboardTimeSeries.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public TensorboardTimeSeries.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this TensorboardTimeSeries was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
TensorboardTimeSeries.Builder

setCreateTime(Timestamp value)

public TensorboardTimeSeries.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this TensorboardTimeSeries was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
TensorboardTimeSeries.Builder

setCreateTime(Timestamp.Builder builderForValue)

public TensorboardTimeSeries.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this TensorboardTimeSeries was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TensorboardTimeSeries.Builder

setDescription(String value)

public TensorboardTimeSeries.Builder setDescription(String value)

Description of this TensorboardTimeSeries.

string description = 3;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public TensorboardTimeSeries.Builder setDescriptionBytes(ByteString value)

Description of this TensorboardTimeSeries.

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setDisplayName(String value)

public TensorboardTimeSeries.Builder setDisplayName(String value)

Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public TensorboardTimeSeries.Builder setDisplayNameBytes(ByteString value)

Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setEtag(String value)

public TensorboardTimeSeries.Builder setEtag(String value)

Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 7;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public TensorboardTimeSeries.Builder setEtagBytes(ByteString value)

Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 7;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setMetadata(TensorboardTimeSeries.Metadata value)

public TensorboardTimeSeries.Builder setMetadata(TensorboardTimeSeries.Metadata value)

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value TensorboardTimeSeries.Metadata
Returns
Type Description
TensorboardTimeSeries.Builder

setMetadata(TensorboardTimeSeries.Metadata.Builder builderForValue)

public TensorboardTimeSeries.Builder setMetadata(TensorboardTimeSeries.Metadata.Builder builderForValue)

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue TensorboardTimeSeries.Metadata.Builder
Returns
Type Description
TensorboardTimeSeries.Builder

setName(String value)

public TensorboardTimeSeries.Builder setName(String value)

Output only. Name of the TensorboardTimeSeries.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TensorboardTimeSeries.Builder setNameBytes(ByteString value)

Output only. Name of the TensorboardTimeSeries.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setPluginData(ByteString value)

public TensorboardTimeSeries.Builder setPluginData(ByteString value)

Data of the current plugin, with the size limited to 65KB.

bytes plugin_data = 9;

Parameter
Name Description
value ByteString

The pluginData to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setPluginName(String value)

public TensorboardTimeSeries.Builder setPluginName(String value)

Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The pluginName to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setPluginNameBytes(ByteString value)

public TensorboardTimeSeries.Builder setPluginNameBytes(ByteString value)

Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for pluginName to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public TensorboardTimeSeries.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this TensorboardTimeSeries was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
TensorboardTimeSeries.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public TensorboardTimeSeries.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this TensorboardTimeSeries was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TensorboardTimeSeries.Builder

setValueType(TensorboardTimeSeries.ValueType value)

public TensorboardTimeSeries.Builder setValueType(TensorboardTimeSeries.ValueType value)

Required. Immutable. Type of TensorboardTimeSeries value.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value TensorboardTimeSeries.ValueType

The valueType to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.

setValueTypeValue(int value)

public TensorboardTimeSeries.Builder setValueTypeValue(int value)

Required. Immutable. Type of TensorboardTimeSeries value.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value int

The enum numeric value on the wire for valueType to set.

Returns
Type Description
TensorboardTimeSeries.Builder

This builder for chaining.