Class Glossary.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Glossary.Builder>
com.google.cloud.dataplex.v1.Glossary.Builder
All Implemented Interfaces:
GlossaryOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Glossary

public static final class Glossary.Builder extends com.google.protobuf.GeneratedMessage.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
  • 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<Glossary.Builder>
    • internalGetMutableMapFieldReflection

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

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

      public Glossary.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<Glossary.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<Glossary.Builder>
    • getDefaultInstanceForType

      public Glossary getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

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

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

      public Glossary.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<Glossary.Builder>
    • mergeFrom

      public Glossary.Builder mergeFrom(Glossary other)
    • isInitialized

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

      public Glossary.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<Glossary.Builder>
      Throws:
      IOException
    • 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];
      Specified by:
      getName in interface GlossaryOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface GlossaryOrBuilder
      Returns:
      The bytes for name.
    • setName

      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];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • setNameBytes

      public Glossary.Builder setNameBytes(com.google.protobuf.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];
      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 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) = { ... }
      Specified by:
      getUid in interface GlossaryOrBuilder
      Returns:
      The uid.
    • getUidBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getUidBytes in interface GlossaryOrBuilder
      Returns:
      The bytes for uid.
    • setUid

      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) = { ... }
      Parameters:
      value - The uid to set.
      Returns:
      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:
      This builder for chaining.
    • setUidBytes

      public Glossary.Builder setUidBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for uid to set.
      Returns:
      This builder for chaining.
    • 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];
      Specified by:
      getDisplayName in interface GlossaryOrBuilder
      Returns:
      The displayName.
    • getDisplayNameBytes

      public com.google.protobuf.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];
      Specified by:
      getDisplayNameBytes in interface GlossaryOrBuilder
      Returns:
      The bytes for displayName.
    • setDisplayName

      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];
      Parameters:
      value - The displayName to set.
      Returns:
      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:
      This builder for chaining.
    • setDisplayNameBytes

      public Glossary.Builder setDisplayNameBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.
    • getDescription

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

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

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

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

      public Glossary.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       Optional. The user-mutable description of the Glossary.
       
      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 Glossary was created.
       
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface GlossaryOrBuilder
      Returns:
      Whether the createTime field is set.
    • getCreateTime

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

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

      public Glossary.Builder setCreateTime(com.google.protobuf.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];
    • mergeCreateTime

      public Glossary.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       Output only. The time at which the Glossary was created.
       
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • 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];
    • getCreateTimeBuilder

      public com.google.protobuf.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];
    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time at which the Glossary was created.
       
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface GlossaryOrBuilder
    • 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];
      Specified by:
      hasUpdateTime in interface GlossaryOrBuilder
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      public com.google.protobuf.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];
      Specified by:
      getUpdateTime in interface GlossaryOrBuilder
      Returns:
      The updateTime.
    • setUpdateTime

      public Glossary.Builder setUpdateTime(com.google.protobuf.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];
    • setUpdateTime

      public Glossary.Builder setUpdateTime(com.google.protobuf.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];
    • mergeUpdateTime

      public Glossary.Builder mergeUpdateTime(com.google.protobuf.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];
    • 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];
    • getUpdateTimeBuilder

      public com.google.protobuf.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];
    • getUpdateTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getUpdateTimeOrBuilder in interface GlossaryOrBuilder
    • getLabelsCount

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

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

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

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

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

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

      public Glossary.Builder clearLabels()
    • removeLabels

      public Glossary.Builder removeLabels(String key)
       Optional. User-defined labels for the Glossary.
       
      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 Glossary.Builder putLabels(String key, String value)
       Optional. User-defined labels for the Glossary.
       
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
    • putAllLabels

      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];
    • getTermCount

      public int getTermCount()
       Output only. The number of GlossaryTerms in the Glossary.
       
      int32 term_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTermCount in interface GlossaryOrBuilder
      Returns:
      The termCount.
    • setTermCount

      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];
      Parameters:
      value - The termCount to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • getCategoryCount

      public int getCategoryCount()
       Output only. The number of GlossaryCategories in the Glossary.
       
      int32 category_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCategoryCount in interface GlossaryOrBuilder
      Returns:
      The categoryCount.
    • setCategoryCount

      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];
      Parameters:
      value - The categoryCount to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • 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];
      Specified by:
      getEtag in interface GlossaryOrBuilder
      Returns:
      The etag.
    • getEtagBytes

      public com.google.protobuf.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];
      Specified by:
      getEtagBytes in interface GlossaryOrBuilder
      Returns:
      The bytes for etag.
    • setEtag

      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];
      Parameters:
      value - The etag to set.
      Returns:
      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:
      This builder for chaining.
    • setEtagBytes

      public Glossary.Builder setEtagBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for etag to set.
      Returns:
      This builder for chaining.