Package com.google.api

Class 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.GeneratedMessageV3.Builder<DocumentationRule.Builder>
implements DocumentationRuleOrBuilder
     A documentation rule provides information about individual API elements.
    Protobuf type google.api.DocumentationRule

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

      • clone

        public DocumentationRule.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>

      • setField

        public DocumentationRule.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>

      • clearField

        public DocumentationRule.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>

      • clearOneof

        public DocumentationRule.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>

      • setRepeatedField

        public DocumentationRule.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>

      • addRepeatedField

        public DocumentationRule.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.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>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.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.

      • setUnknownFields

        public final DocumentationRule.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>

      • mergeUnknownFields

        public final DocumentationRule.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>