Package com.google.api

Class DocumentationRule.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DocumentationRule.Builder>
com.google.api.DocumentationRule.Builder
All Implemented Interfaces:
DocumentationRuleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
DocumentationRule
public static final class DocumentationRule.Builder extends com.google.protobuf.GeneratedMessage.Builder<DocumentationRule.Builder> implements DocumentationRuleOrBuilder
 A documentation rule provides information about individual API elements.
Protobuf type google.api.DocumentationRule

  • Method Summary

    Modifier and Type
    Method
    Description
    DocumentationRule
    build()
     
    DocumentationRule
    buildPartial()
     
    DocumentationRule.Builder
    clear()
     
    DocumentationRule.Builder
    clearDeprecationDescription()
    Deprecation description of the selected element(s).
    DocumentationRule.Builder
    clearDescription()
    Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field).
    DocumentationRule.Builder
    clearSelector()
    The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.
    DocumentationRule
    getDefaultInstanceForType()
     
    String
    getDeprecationDescription()
    Deprecation description of the selected element(s).
    com.google.protobuf.ByteString
    getDeprecationDescriptionBytes()
    Deprecation description of the selected element(s).
    String
    getDescription()
    Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field).
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field).
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getSelector()
    The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.
    com.google.protobuf.ByteString
    getSelectorBytes()
    The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    DocumentationRule.Builder
    mergeFrom(DocumentationRule other)
     
    DocumentationRule.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    DocumentationRule.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    DocumentationRule.Builder
    setDeprecationDescription(String value)
    Deprecation description of the selected element(s).
    DocumentationRule.Builder
    setDeprecationDescriptionBytes(com.google.protobuf.ByteString value)
    Deprecation description of the selected element(s).
    DocumentationRule.Builder
    setDescription(String value)
    Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field).
    DocumentationRule.Builder
    setDescriptionBytes(com.google.protobuf.ByteString value)
    Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field).
    DocumentationRule.Builder
    setSelector(String value)
    The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.
    DocumentationRule.Builder
    setSelectorBytes(com.google.protobuf.ByteString value)
    The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • clear

      public DocumentationRule.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<DocumentationRule.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<DocumentationRule.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public DocumentationRule.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<DocumentationRule.Builder>

    • mergeFrom

      public DocumentationRule.Builder mergeFrom(DocumentationRule other)

    • isInitialized

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

    • mergeFrom

      public DocumentationRule.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<DocumentationRule.Builder>
      Throws:
      IOException

    • getSelector

      public String getSelector()
       The selector is a comma-separated list of patterns for any element such as
 a method, a field, an enum value. Each pattern is a qualified name of the
 element which may end in "*", indicating a wildcard. Wildcards are only
 allowed at the end and for a whole component of the qualified name,
 i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
 one or more components. To specify a default for all applicable elements,
 the whole pattern "*" is used.
      string selector = 1;
      Specified by:
      getSelector in interface DocumentationRuleOrBuilder
      Returns:
      The selector.

    • getSelectorBytes

      public com.google.protobuf.ByteString getSelectorBytes()
       The selector is a comma-separated list of patterns for any element such as
 a method, a field, an enum value. Each pattern is a qualified name of the
 element which may end in "*", indicating a wildcard. Wildcards are only
 allowed at the end and for a whole component of the qualified name,
 i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
 one or more components. To specify a default for all applicable elements,
 the whole pattern "*" is used.
      string selector = 1;
      Specified by:
      getSelectorBytes in interface DocumentationRuleOrBuilder
      Returns:
      The bytes for selector.

    • setSelector

      public DocumentationRule.Builder setSelector(String value)
       The selector is a comma-separated list of patterns for any element such as
 a method, a field, an enum value. Each pattern is a qualified name of the
 element which may end in "*", indicating a wildcard. Wildcards are only
 allowed at the end and for a whole component of the qualified name,
 i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
 one or more components. To specify a default for all applicable elements,
 the whole pattern "*" is used.
      string selector = 1;
      Parameters:
      value - The selector to set.
      Returns:
      This builder for chaining.

    • clearSelector

      public DocumentationRule.Builder clearSelector()
       The selector is a comma-separated list of patterns for any element such as
 a method, a field, an enum value. Each pattern is a qualified name of the
 element which may end in "*", indicating a wildcard. Wildcards are only
 allowed at the end and for a whole component of the qualified name,
 i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
 one or more components. To specify a default for all applicable elements,
 the whole pattern "*" is used.
      string selector = 1;
      Returns:
      This builder for chaining.

    • setSelectorBytes

      public DocumentationRule.Builder setSelectorBytes(com.google.protobuf.ByteString value)
       The selector is a comma-separated list of patterns for any element such as
 a method, a field, an enum value. Each pattern is a qualified name of the
 element which may end in "*", indicating a wildcard. Wildcards are only
 allowed at the end and for a whole component of the qualified name,
 i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
 one or more components. To specify a default for all applicable elements,
 the whole pattern "*" is used.
      string selector = 1;
      Parameters:
      value - The bytes for selector to set.
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
       Description of the selected proto element (e.g. a message, a method, a
 'service' definition, or a field). Defaults to leading & trailing comments
 taken from the proto source definition of the proto element.
      string description = 2;
      Specified by:
      getDescription in interface DocumentationRuleOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Description of the selected proto element (e.g. a message, a method, a
 'service' definition, or a field). Defaults to leading & trailing comments
 taken from the proto source definition of the proto element.
      string description = 2;
      Specified by:
      getDescriptionBytes in interface DocumentationRuleOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      public DocumentationRule.Builder setDescription(String value)
       Description of the selected proto element (e.g. a message, a method, a
 'service' definition, or a field). Defaults to leading & trailing comments
 taken from the proto source definition of the proto element.
      string description = 2;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public DocumentationRule.Builder clearDescription()
       Description of the selected proto element (e.g. a message, a method, a
 'service' definition, or a field). Defaults to leading & trailing comments
 taken from the proto source definition of the proto element.
      string description = 2;
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public DocumentationRule.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       Description of the selected proto element (e.g. a message, a method, a
 'service' definition, or a field). Defaults to leading & trailing comments
 taken from the proto source definition of the proto element.
      string description = 2;
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • getDeprecationDescription

      public String getDeprecationDescription()
       Deprecation description of the selected element(s). It can be provided if
 an element is marked as `deprecated`.
      string deprecation_description = 3;
      Specified by:
      getDeprecationDescription in interface DocumentationRuleOrBuilder
      Returns:
      The deprecationDescription.

    • getDeprecationDescriptionBytes

      public com.google.protobuf.ByteString getDeprecationDescriptionBytes()
       Deprecation description of the selected element(s). It can be provided if
 an element is marked as `deprecated`.
      string deprecation_description = 3;
      Specified by:
      getDeprecationDescriptionBytes in interface DocumentationRuleOrBuilder
      Returns:
      The bytes for deprecationDescription.

    • setDeprecationDescription

      public DocumentationRule.Builder setDeprecationDescription(String value)
       Deprecation description of the selected element(s). It can be provided if
 an element is marked as `deprecated`.
      string deprecation_description = 3;
      Parameters:
      value - The deprecationDescription to set.
      Returns:
      This builder for chaining.

    • clearDeprecationDescription

      public DocumentationRule.Builder clearDeprecationDescription()
       Deprecation description of the selected element(s). It can be provided if
 an element is marked as `deprecated`.
      string deprecation_description = 3;
      Returns:
      This builder for chaining.

    • setDeprecationDescriptionBytes

      public DocumentationRule.Builder setDeprecationDescriptionBytes(com.google.protobuf.ByteString value)
       Deprecation description of the selected element(s). It can be provided if
 an element is marked as `deprecated`.
      string deprecation_description = 3;
      Parameters:
      value - The bytes for deprecationDescription to set.
      Returns:
      This builder for chaining.