Class TensorboardExperiment.Builder (3.31.0)

public static final class TensorboardExperiment.Builder extends GeneratedMessageV3.Builder<TensorboardExperiment.Builder> implements TensorboardExperimentOrBuilder

A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.

Protobuf type google.cloud.aiplatform.v1beta1.TensorboardExperiment

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TensorboardExperiment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides

build()

public TensorboardExperiment build()
Returns
TypeDescription
TensorboardExperiment

buildPartial()

public TensorboardExperiment buildPartial()
Returns
TypeDescription
TensorboardExperiment

clear()

public TensorboardExperiment.Builder clear()
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides

clearCreateTime()

public TensorboardExperiment.Builder clearCreateTime()

Output only. Timestamp when this TensorboardExperiment was created.

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

Returns
TypeDescription
TensorboardExperiment.Builder

clearDescription()

public TensorboardExperiment.Builder clearDescription()

Description of this TensorboardExperiment.

string description = 3;

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

clearDisplayName()

public TensorboardExperiment.Builder clearDisplayName()

User provided name of this TensorboardExperiment.

string display_name = 2;

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

clearEtag()

public TensorboardExperiment.Builder clearEtag()

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

string etag = 7;

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TensorboardExperiment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides

clearLabels()

public TensorboardExperiment.Builder clearLabels()
Returns
TypeDescription
TensorboardExperiment.Builder

clearName()

public TensorboardExperiment.Builder clearName()

Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

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

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TensorboardExperiment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides

clearSource()

public TensorboardExperiment.Builder clearSource()

Immutable. Source of the TensorboardExperiment. Example: a custom training job.

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

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

clearUpdateTime()

public TensorboardExperiment.Builder clearUpdateTime()

Output only. Timestamp when this TensorboardExperiment was last updated.

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

Returns
TypeDescription
TensorboardExperiment.Builder

clone()

public TensorboardExperiment.Builder clone()
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

The labels with user-defined metadata to organize your TensorboardExperiment.

Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

  • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this TensorboardExperiment was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this TensorboardExperiment was created.

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this TensorboardExperiment was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public TensorboardExperiment getDefaultInstanceForType()
Returns
TypeDescription
TensorboardExperiment

getDescription()

public String getDescription()

Description of this TensorboardExperiment.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of this TensorboardExperiment.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

User provided name of this TensorboardExperiment.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User provided name of this TensorboardExperiment.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

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

string etag = 7;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 7;

Returns
TypeDescription
ByteString

The bytes for etag.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The labels with user-defined metadata to organize your TensorboardExperiment.

Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

  • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.

map<string, string> labels = 6;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The labels with user-defined metadata to organize your TensorboardExperiment.

Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

  • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.

map<string, string> labels = 6;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The labels with user-defined metadata to organize your TensorboardExperiment.

Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

  • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.

map<string, string> labels = 6;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The labels with user-defined metadata to organize your TensorboardExperiment.

Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

  • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

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

Returns
TypeDescription
ByteString

The bytes for name.

getSource()

public String getSource()

Immutable. Source of the TensorboardExperiment. Example: a custom training job.

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

Returns
TypeDescription
String

The source.

getSourceBytes()

public ByteString getSourceBytes()

Immutable. Source of the TensorboardExperiment. Example: a custom training job.

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

Returns
TypeDescription
ByteString

The bytes for source.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this TensorboardExperiment was last updated.

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when this TensorboardExperiment was last updated.

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

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this TensorboardExperiment was last updated.

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

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this TensorboardExperiment was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this TensorboardExperiment was last updated.

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public TensorboardExperiment.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this TensorboardExperiment was created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
TensorboardExperiment.Builder

mergeFrom(TensorboardExperiment other)

public TensorboardExperiment.Builder mergeFrom(TensorboardExperiment other)
Parameter
NameDescription
otherTensorboardExperiment
Returns
TypeDescription
TensorboardExperiment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TensorboardExperiment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TensorboardExperiment.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TensorboardExperiment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides

mergeUpdateTime(Timestamp value)

public TensorboardExperiment.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this TensorboardExperiment was last updated.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
TensorboardExperiment.Builder

putAllLabels(Map<String,String> values)

public TensorboardExperiment.Builder putAllLabels(Map<String,String> values)

The labels with user-defined metadata to organize your TensorboardExperiment.

Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

  • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.

map<string, string> labels = 6;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
TensorboardExperiment.Builder

putLabels(String key, String value)

public TensorboardExperiment.Builder putLabels(String key, String value)

The labels with user-defined metadata to organize your TensorboardExperiment.

Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

  • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.

map<string, string> labels = 6;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
TensorboardExperiment.Builder

removeLabels(String key)

public TensorboardExperiment.Builder removeLabels(String key)

The labels with user-defined metadata to organize your TensorboardExperiment.

Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

  • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
TensorboardExperiment.Builder

setCreateTime(Timestamp value)

public TensorboardExperiment.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this TensorboardExperiment was created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
TensorboardExperiment.Builder

setCreateTime(Timestamp.Builder builderForValue)

public TensorboardExperiment.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this TensorboardExperiment was created.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
TensorboardExperiment.Builder

setDescription(String value)

public TensorboardExperiment.Builder setDescription(String value)

Description of this TensorboardExperiment.

string description = 3;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public TensorboardExperiment.Builder setDescriptionBytes(ByteString value)

Description of this TensorboardExperiment.

string description = 3;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

setDisplayName(String value)

public TensorboardExperiment.Builder setDisplayName(String value)

User provided name of this TensorboardExperiment.

string display_name = 2;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public TensorboardExperiment.Builder setDisplayNameBytes(ByteString value)

User provided name of this TensorboardExperiment.

string display_name = 2;

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

setEtag(String value)

public TensorboardExperiment.Builder setEtag(String value)

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

string etag = 7;

Parameter
NameDescription
valueString

The etag to set.

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public TensorboardExperiment.Builder setEtagBytes(ByteString value)

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

string etag = 7;

Parameter
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TensorboardExperiment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides

setName(String value)

public TensorboardExperiment.Builder setName(String value)

Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TensorboardExperiment.Builder setNameBytes(ByteString value)

Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

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

public TensorboardExperiment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides

setSource(String value)

public TensorboardExperiment.Builder setSource(String value)

Immutable. Source of the TensorboardExperiment. Example: a custom training job.

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

Parameter
NameDescription
valueString

The source to set.

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

setSourceBytes(ByteString value)

public TensorboardExperiment.Builder setSourceBytes(ByteString value)

Immutable. Source of the TensorboardExperiment. Example: a custom training job.

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

Parameter
NameDescription
valueByteString

The bytes for source to set.

Returns
TypeDescription
TensorboardExperiment.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TensorboardExperiment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TensorboardExperiment.Builder
Overrides

setUpdateTime(Timestamp value)

public TensorboardExperiment.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this TensorboardExperiment was last updated.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
TensorboardExperiment.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public TensorboardExperiment.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this TensorboardExperiment was last updated.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
TensorboardExperiment.Builder