Class Glossary.Builder (1.72.0)

public static final class Glossary.Builder extends GeneratedMessageV3.Builder<Glossary.Builder> implements GlossaryOrBuilder

A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it.

Protobuf type google.cloud.dataplex.v1.Glossary

Implements

GlossaryOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Glossary build()
Returns
Type Description
Glossary

buildPartial()

public Glossary buildPartial()
Returns
Type Description
Glossary

clear()

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

clearCategoryCount()

public Glossary.Builder clearCategoryCount()

Output only. The number of GlossaryCategories in the Glossary.

int32 category_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Glossary.Builder

This builder for chaining.

clearCreateTime()

public Glossary.Builder clearCreateTime()

Output only. The time at which the Glossary was created.

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

Returns
Type Description
Glossary.Builder

clearDescription()

public Glossary.Builder clearDescription()

Optional. The user-mutable description of the Glossary.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Glossary.Builder

This builder for chaining.

clearDisplayName()

public Glossary.Builder clearDisplayName()

Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.

string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Glossary.Builder

This builder for chaining.

clearEtag()

public Glossary.Builder clearEtag()

Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Glossary.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

public Glossary.Builder clearLabels()
Returns
Type Description
Glossary.Builder

clearName()

public Glossary.Builder clearName()

Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}

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

Returns
Type Description
Glossary.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearTermCount()

public Glossary.Builder clearTermCount()

Output only. The number of GlossaryTerms in the Glossary.

int32 term_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Glossary.Builder

This builder for chaining.

clearUid()

public Glossary.Builder clearUid()

Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
Glossary.Builder

This builder for chaining.

clearUpdateTime()

public Glossary.Builder clearUpdateTime()

Output only. The time at which the Glossary was last updated.

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

Returns
Type Description
Glossary.Builder

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined labels for the Glossary.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCategoryCount()

public int getCategoryCount()

Output only. The number of GlossaryCategories in the Glossary.

int32 category_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The categoryCount.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time at which the Glossary 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. The time at which the Glossary was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which the Glossary was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Glossary getDefaultInstanceForType()
Returns
Type Description
Glossary

getDescription()

public String getDescription()

Optional. The user-mutable description of the Glossary.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The user-mutable description of the Glossary.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.

string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.

string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. User-defined labels for the Glossary.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. User-defined labels for the Glossary.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels for the Glossary.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. User-defined labels for the Glossary.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

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. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}

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

Returns
Type Description
ByteString

The bytes for name.

getTermCount()

public int getTermCount()

Output only. The number of GlossaryTerms in the Glossary.

int32 term_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The termCount.

getUid()

public String getUid()

Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time at which the Glossary 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. The time at which the Glossary 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. The time at which the Glossary was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time at which the Glossary was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time at which the Glossary 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

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

mergeCreateTime(Timestamp value)

public Glossary.Builder mergeCreateTime(Timestamp value)

Output only. The time at which the Glossary was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Glossary.Builder

mergeFrom(Glossary other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public Glossary.Builder mergeUpdateTime(Timestamp value)

Output only. The time at which the Glossary was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Glossary.Builder

putAllLabels(Map<String,String> values)

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

Optional. User-defined labels for the Glossary.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Glossary.Builder

putLabels(String key, String value)

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

Optional. User-defined labels for the Glossary.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
Glossary.Builder

removeLabels(String key)

public Glossary.Builder removeLabels(String key)

Optional. User-defined labels for the Glossary.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Glossary.Builder

setCategoryCount(int value)

public Glossary.Builder setCategoryCount(int value)

Output only. The number of GlossaryCategories in the Glossary.

int32 category_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The categoryCount to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Glossary.Builder setCreateTime(Timestamp value)

Output only. The time at which the Glossary was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Glossary.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Glossary.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time at which the Glossary was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Glossary.Builder

setDescription(String value)

public Glossary.Builder setDescription(String value)

Optional. The user-mutable description of the Glossary.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Glossary.Builder setDescriptionBytes(ByteString value)

Optional. The user-mutable description of the Glossary.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setDisplayName(String value)

public Glossary.Builder setDisplayName(String value)

Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.

string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Glossary.Builder setDisplayNameBytes(ByteString value)

Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.

string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setEtag(String value)

public Glossary.Builder setEtag(String value)

Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Glossary.Builder setEtagBytes(ByteString value)

Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public Glossary.Builder setName(String value)

Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Glossary.Builder setNameBytes(ByteString value)

Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

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

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

setTermCount(int value)

public Glossary.Builder setTermCount(int value)

Output only. The number of GlossaryTerms in the Glossary.

int32 term_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The termCount to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setUid(String value)

public Glossary.Builder setUid(String value)

Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The uid to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Glossary.Builder setUidBytes(ByteString value)

Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for uid to set.

Returns
Type Description
Glossary.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public Glossary.Builder setUpdateTime(Timestamp value)

Output only. The time at which the Glossary was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Glossary.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Glossary.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time at which the Glossary was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Glossary.Builder