Package com.google.cloud.dataplex.v1

Class GlossaryTerm.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<GlossaryTerm.Builder>
com.google.cloud.dataplex.v1.GlossaryTerm.Builder
All Implemented Interfaces:
GlossaryTermOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
GlossaryTerm
public static final class GlossaryTerm.Builder extends com.google.protobuf.GeneratedMessage.Builder<GlossaryTerm.Builder> implements GlossaryTermOrBuilder
 GlossaryTerms are the core of Glossary.
 A GlossaryTerm holds a rich text description that can be attached to Entries
 or specific columns to enrich them.
Protobuf type google.cloud.dataplex.v1.GlossaryTerm

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<GlossaryTerm.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<GlossaryTerm.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<GlossaryTerm.Builder>

    • clear

      public GlossaryTerm.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<GlossaryTerm.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<GlossaryTerm.Builder>

    • getDefaultInstanceForType

      public GlossaryTerm getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public GlossaryTerm build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public GlossaryTerm buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public GlossaryTerm.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GlossaryTerm.Builder>

    • mergeFrom

      public GlossaryTerm.Builder mergeFrom(GlossaryTerm other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<GlossaryTerm.Builder>

    • mergeFrom

      public GlossaryTerm.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GlossaryTerm.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       Output only. Identifier. The resource name of the GlossaryTerm.
 Format:
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface GlossaryTermOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Identifier. The resource name of the GlossaryTerm.
 Format:
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface GlossaryTermOrBuilder
      Returns:
      The bytes for name.

    • setName

      public GlossaryTerm.Builder setName(String value)
       Output only. Identifier. The resource name of the GlossaryTerm.
 Format:
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public GlossaryTerm.Builder clearName()
       Output only. Identifier. The resource name of the GlossaryTerm.
 Format:
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      Returns:
      This builder for chaining.

    • setNameBytes

      public GlossaryTerm.Builder setNameBytes(com.google.protobuf.ByteString value)
       Output only. Identifier. The resource name of the GlossaryTerm.
 Format:
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getUid

      public String getUid()
       Output only. System generated unique id for the GlossaryTerm. This ID will
 be different if the GlossaryTerm is deleted and re-created with the same
 name.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
      Specified by:
      getUid in interface GlossaryTermOrBuilder
      Returns:
      The uid.

    • getUidBytes

      public com.google.protobuf.ByteString getUidBytes()
       Output only. System generated unique id for the GlossaryTerm. This ID will
 be different if the GlossaryTerm is deleted and re-created with the same
 name.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
      Specified by:
      getUidBytes in interface GlossaryTermOrBuilder
      Returns:
      The bytes for uid.

    • setUid

      public GlossaryTerm.Builder setUid(String value)
       Output only. System generated unique id for the GlossaryTerm. This ID will
 be different if the GlossaryTerm is deleted and re-created with the same
 name.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
      Parameters:
      value - The uid to set.
      Returns:
      This builder for chaining.

    • clearUid

      public GlossaryTerm.Builder clearUid()
       Output only. System generated unique id for the GlossaryTerm. This ID will
 be different if the GlossaryTerm is deleted and re-created with the same
 name.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
      Returns:
      This builder for chaining.

    • setUidBytes

      public GlossaryTerm.Builder setUidBytes(com.google.protobuf.ByteString value)
       Output only. System generated unique id for the GlossaryTerm. This ID will
 be different if the GlossaryTerm is deleted and re-created with the same
 name.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
      Parameters:
      value - The bytes for uid to set.
      Returns:
      This builder for chaining.

    • getDisplayName

      public String getDisplayName()
       Optional. User friendly display name of the GlossaryTerm. This is
 user-mutable. This will be same as the GlossaryTermId, if not specified.
      string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayName in interface GlossaryTermOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Optional. User friendly display name of the GlossaryTerm. This is
 user-mutable. This will be same as the GlossaryTermId, if not specified.
      string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayNameBytes in interface GlossaryTermOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      public GlossaryTerm.Builder setDisplayName(String value)
       Optional. User friendly display name of the GlossaryTerm. This is
 user-mutable. This will be same as the GlossaryTermId, if not specified.
      string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public GlossaryTerm.Builder clearDisplayName()
       Optional. User friendly display name of the GlossaryTerm. This is
 user-mutable. This will be same as the GlossaryTermId, if not specified.
      string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public GlossaryTerm.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       Optional. User friendly display name of the GlossaryTerm. This is
 user-mutable. This will be same as the GlossaryTermId, if not specified.
      string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
       Optional. The user-mutable description of the GlossaryTerm.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface GlossaryTermOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The user-mutable description of the GlossaryTerm.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface GlossaryTermOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      public GlossaryTerm.Builder setDescription(String value)
       Optional. The user-mutable description of the GlossaryTerm.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public GlossaryTerm.Builder clearDescription()
       Optional. The user-mutable description of the GlossaryTerm.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public GlossaryTerm.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       Optional. The user-mutable description of the GlossaryTerm.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The time at which the GlossaryTerm was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface GlossaryTermOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The time at which the GlossaryTerm was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface GlossaryTermOrBuilder
      Returns:
      The createTime.

    • setCreateTime

      public GlossaryTerm.Builder setCreateTime(com.google.protobuf.Timestamp value)
       Output only. The time at which the GlossaryTerm was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setCreateTime

      public GlossaryTerm.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. The time at which the GlossaryTerm was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeCreateTime

      public GlossaryTerm.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       Output only. The time at which the GlossaryTerm was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearCreateTime

      public GlossaryTerm.Builder clearCreateTime()
       Output only. The time at which the GlossaryTerm was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
       Output only. The time at which the GlossaryTerm was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time at which the GlossaryTerm was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface GlossaryTermOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The time at which the GlossaryTerm was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface GlossaryTermOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time at which the GlossaryTerm was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface GlossaryTermOrBuilder
      Returns:
      The updateTime.

    • setUpdateTime

      public GlossaryTerm.Builder setUpdateTime(com.google.protobuf.Timestamp value)
       Output only. The time at which the GlossaryTerm was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setUpdateTime

      public GlossaryTerm.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. The time at which the GlossaryTerm was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeUpdateTime

      public GlossaryTerm.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
       Output only. The time at which the GlossaryTerm was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearUpdateTime

      public GlossaryTerm.Builder clearUpdateTime()
       Output only. The time at which the GlossaryTerm was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getUpdateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
       Output only. The time at which the GlossaryTerm was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time at which the GlossaryTerm was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface GlossaryTermOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: GlossaryTermOrBuilder
       Optional. User-defined labels for the GlossaryTerm.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface GlossaryTermOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. User-defined labels for the GlossaryTerm.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface GlossaryTermOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface GlossaryTermOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. User-defined labels for the GlossaryTerm.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface GlossaryTermOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. User-defined labels for the GlossaryTerm.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface GlossaryTermOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. User-defined labels for the GlossaryTerm.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface GlossaryTermOrBuilder

    • clearLabels

      public GlossaryTerm.Builder clearLabels()

    • removeLabels

      public GlossaryTerm.Builder removeLabels(String key)
       Optional. User-defined labels for the GlossaryTerm.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.

    • putLabels

      public GlossaryTerm.Builder putLabels(String key, String value)
       Optional. User-defined labels for the GlossaryTerm.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

    • putAllLabels

      public GlossaryTerm.Builder putAllLabels(Map<String,String> values)
       Optional. User-defined labels for the GlossaryTerm.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getParent

      public String getParent()
       Required. The immediate parent of the GlossaryTerm in the
 resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
 Format:
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 OR
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
      string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface GlossaryTermOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The immediate parent of the GlossaryTerm in the
 resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
 Format:
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 OR
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
      string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface GlossaryTermOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public GlossaryTerm.Builder setParent(String value)
       Required. The immediate parent of the GlossaryTerm in the
 resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
 Format:
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 OR
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
      string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public GlossaryTerm.Builder clearParent()
       Required. The immediate parent of the GlossaryTerm in the
 resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
 Format:
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 OR
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
      string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public GlossaryTerm.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. The immediate parent of the GlossaryTerm in the
 resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
 Format:
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 OR
 projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
      string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.