Class Tensorboard.Builder (3.42.0)

Version 3.42.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class Tensorboard.Builder extends GeneratedMessageV3.Builder<Tensorboard.Builder> implements TensorboardOrBuilder

Tensorboard is a physical database that stores users' training metrics. A default Tensorboard is provided in each region of a Google Cloud project. If needed users can also create extra Tensorboards in their projects.

Protobuf type google.cloud.aiplatform.v1.Tensorboard

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Tensorboard.Builder

Implements

TensorboardOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Tensorboard.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Tensorboard.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Tensorboard build()

Returns
Type	Description
Tensorboard

buildPartial()

public Tensorboard buildPartial()

Returns
Type	Description
Tensorboard

clear()

public Tensorboard.Builder clear()

Returns
Type	Description
Tensorboard.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBlobStoragePathPrefix()

public Tensorboard.Builder clearBlobStoragePathPrefix()

Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.

string blob_storage_path_prefix = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

clearCreateTime()

public Tensorboard.Builder clearCreateTime()

Output only. Timestamp when this Tensorboard was created.

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

Returns
Type	Description
Tensorboard.Builder

clearDescription()

public Tensorboard.Builder clearDescription()

Description of this Tensorboard.

string description = 3;

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

clearDisplayName()

public Tensorboard.Builder clearDisplayName()

Required. User provided name of this Tensorboard.

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

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

clearEncryptionSpec()

public Tensorboard.Builder clearEncryptionSpec()

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;

Returns
Type	Description
Tensorboard.Builder

clearEtag()

public Tensorboard.Builder clearEtag()

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

string etag = 9;

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Tensorboard.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Tensorboard.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIsDefault()

public Tensorboard.Builder clearIsDefault()

Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.

bool is_default = 12;

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

clearLabels()

public Tensorboard.Builder clearLabels()

Returns
Type	Description
Tensorboard.Builder

clearName()

public Tensorboard.Builder clearName()

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

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

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Tensorboard.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Tensorboard.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRunCount()

public Tensorboard.Builder clearRunCount()

Output only. The number of Runs stored in this Tensorboard.

int32 run_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

clearUpdateTime()

public Tensorboard.Builder clearUpdateTime()

Output only. Timestamp when this Tensorboard was last updated.

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

Returns
Type	Description
Tensorboard.Builder

clone()

public Tensorboard.Builder clone()

Returns
Type	Description
Tensorboard.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

public boolean containsLabels(String key)

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

Label keys and values can be no 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 Tensorboard (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.

map<string, string> labels = 8;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getBlobStoragePathPrefix()

public String getBlobStoragePathPrefix()

Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.

string blob_storage_path_prefix = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The blobStoragePathPrefix.

getBlobStoragePathPrefixBytes()

public ByteString getBlobStoragePathPrefixBytes()

Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.

string blob_storage_path_prefix = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for blobStoragePathPrefix.

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this Tensorboard was created.

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this Tensorboard was created.

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

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Tensorboard was created.

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

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public Tensorboard getDefaultInstanceForType()

Returns
Type	Description
Tensorboard

getDescription()

public String getDescription()

Description of this Tensorboard.

string description = 3;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of this Tensorboard.

string description = 3;

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Required. User provided name of this Tensorboard.

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 Tensorboard.

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

Returns
Type	Description
ByteString	The bytes for displayName.

getEncryptionSpec()

public EncryptionSpec getEncryptionSpec()

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;

Returns
Type	Description
EncryptionSpec	The encryptionSpec.

getEncryptionSpecBuilder()

public EncryptionSpec.Builder getEncryptionSpecBuilder()

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;

Returns
Type	Description
EncryptionSpec.Builder

getEncryptionSpecOrBuilder()

public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;

Returns
Type	Description
EncryptionSpecOrBuilder

getEtag()

public String getEtag()

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

string etag = 9;

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 = 9;

Returns
Type	Description
ByteString	The bytes for etag.

getIsDefault()

public boolean getIsDefault()

Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.

bool is_default = 12;

Returns
Type	Description
boolean	The isDefault.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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

Label keys and values can be no 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 Tensorboard (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.

map<string, string> labels = 8;

Returns
Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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

Label keys and values can be no 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 Tensorboard (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.

map<string, string> labels = 8;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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

Label keys and values can be no 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 Tensorboard (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.

map<string, string> labels = 8;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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

Label keys and values can be no 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 Tensorboard (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.

map<string, string> labels = 8;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getName()

public String getName()

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

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

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
Type	Description
ByteString	The bytes for name.

getRunCount()

public int getRunCount()

Output only. The number of Runs stored in this Tensorboard.

int32 run_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The runCount.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this Tensorboard was last updated.

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

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when this Tensorboard was last updated.

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

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this Tensorboard was last updated.

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

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this Tensorboard was created.

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

Returns
Type	Description
boolean	Whether the createTime field is set.

hasEncryptionSpec()

public boolean hasEncryptionSpec()

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;

Returns
Type	Description
boolean	Whether the encryptionSpec field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this Tensorboard was last updated.

.google.protobuf.Timestamp update_time = 7 [(.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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public Tensorboard.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this Tensorboard was created.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Tensorboard.Builder

mergeEncryptionSpec(EncryptionSpec value)

public Tensorboard.Builder mergeEncryptionSpec(EncryptionSpec value)

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;

Parameter
Name	Description
value	EncryptionSpec

Returns
Type	Description
Tensorboard.Builder

mergeFrom(Tensorboard other)

public Tensorboard.Builder mergeFrom(Tensorboard other)

Parameter
Name	Description
other	Tensorboard

Returns
Type	Description
Tensorboard.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Tensorboard.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Tensorboard.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Tensorboard.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Tensorboard.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Tensorboard.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Tensorboard.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public Tensorboard.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this Tensorboard was last updated.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Tensorboard.Builder

putAllLabels(Map<String,String> values)

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

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

Label keys and values can be no 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 Tensorboard (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.

map<string, string> labels = 8;

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
Tensorboard.Builder

putLabels(String key, String value)

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

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

Label keys and values can be no 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 Tensorboard (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.

map<string, string> labels = 8;

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
Tensorboard.Builder

removeLabels(String key)

public Tensorboard.Builder removeLabels(String key)

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

Label keys and values can be no 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 Tensorboard (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.

map<string, string> labels = 8;

Parameter
Name	Description
key	String

Returns
Type	Description
Tensorboard.Builder

setBlobStoragePathPrefix(String value)

public Tensorboard.Builder setBlobStoragePathPrefix(String value)

Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.

string blob_storage_path_prefix = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	String The blobStoragePathPrefix to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setBlobStoragePathPrefixBytes(ByteString value)

public Tensorboard.Builder setBlobStoragePathPrefixBytes(ByteString value)

Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.

string blob_storage_path_prefix = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes for blobStoragePathPrefix to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setCreateTime(Timestamp value)

public Tensorboard.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this Tensorboard was created.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Tensorboard.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Tensorboard.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this Tensorboard was created.

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Tensorboard.Builder

setDescription(String value)

public Tensorboard.Builder setDescription(String value)

Description of this Tensorboard.

string description = 3;

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Tensorboard.Builder setDescriptionBytes(ByteString value)

Description of this Tensorboard.

string description = 3;

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setDisplayName(String value)

public Tensorboard.Builder setDisplayName(String value)

Required. User provided name of this Tensorboard.

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

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Tensorboard.Builder setDisplayNameBytes(ByteString value)

Required. User provided name of this Tensorboard.

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

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setEncryptionSpec(EncryptionSpec value)

public Tensorboard.Builder setEncryptionSpec(EncryptionSpec value)

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;

Parameter
Name	Description
value	EncryptionSpec

Returns
Type	Description
Tensorboard.Builder

setEncryptionSpec(EncryptionSpec.Builder builderForValue)

public Tensorboard.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;

Parameter
Name	Description
builderForValue	EncryptionSpec.Builder

Returns
Type	Description
Tensorboard.Builder

setEtag(String value)

public Tensorboard.Builder setEtag(String value)

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

string etag = 9;

Parameter
Name	Description
value	String The etag to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setEtagBytes(ByteString value)

public Tensorboard.Builder setEtagBytes(ByteString value)

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

string etag = 9;

Parameter
Name	Description
value	ByteString The bytes for etag to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Tensorboard.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Tensorboard.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIsDefault(boolean value)

public Tensorboard.Builder setIsDefault(boolean value)

Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.

bool is_default = 12;

Parameter
Name	Description
value	boolean The isDefault to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setName(String value)

public Tensorboard.Builder setName(String value)

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

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Tensorboard.Builder setNameBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Tensorboard.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRunCount(int value)

public Tensorboard.Builder setRunCount(int value)

Output only. The number of Runs stored in this Tensorboard.

int32 run_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	int The runCount to set.

Returns
Type	Description
Tensorboard.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Tensorboard.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Tensorboard.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public Tensorboard.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this Tensorboard was last updated.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Tensorboard.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Tensorboard.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this Tensorboard was last updated.

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Tensorboard.Builder