Package com.google.api

Class Documentation.Builder

  • All Implemented Interfaces:
    DocumentationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Documentation
    public static final class Documentation.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
implements DocumentationOrBuilder
     `Documentation` provides the information for describing a service.
 Example:
 <pre><code>documentation:
   summary: >
     The Google Calendar API gives access
     to most calendar features.
   pages:
   - name: Overview
     content: &#40;== include google/foo/overview.md ==&#41;
   - name: Tutorial
     content: &#40;== include google/foo/tutorial.md ==&#41;
     subpages;
     - name: Java
       content: &#40;== include google/foo/tutorial_java.md ==&#41;
   rules:
   - selector: google.calendar.Calendar.Get
     description: >
       ...
   - selector: google.calendar.Calendar.Put
     description: >
       ...
 </code></pre>
 Documentation is provided in markdown syntax. In addition to
 standard markdown features, definition lists, tables and fenced
 code blocks are supported. Section headers can be provided and are
 interpreted relative to the section nesting of the context where
 a documentation fragment is embedded.
 Documentation from the IDL is merged with documentation defined
 via the config at normalization time, where documentation provided
 by config rules overrides IDL provided.
 A number of constructs specific to the API platform are supported
 in documentation text.
 In order to reference a proto element, the following
 notation can be used:
 <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>
 To override the display text used for the link, this can be used:
 <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
 Text can be excluded from doc using the following notation:
 <pre><code>&#40;-- internal comment --&#41;</code></pre>
 A few directives are available in documentation. Note that
 directives must appear on a single line to be properly
 identified. The `include` directive includes a markdown file from
 an external source:
 <pre><code>&#40;== include path/to/file ==&#41;</code></pre>
 The `resource_for` directive marks a message to be the resource of
 a collection in REST view. If it is not specified, tools attempt
 to infer the resource from the operations in a collection:
 <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>
 The directive `suppress_warning` does not directly affect documentation
 and is documented together with service config validation.
    Protobuf type google.api.Documentation

    • 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<Documentation.Builder>

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

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

      • getSummary

        public String getSummary()
         A short description of what the service does. The summary must be plain
 text. It becomes the overview of the service displayed in Google Cloud
 Console.
 NOTE: This field is equivalent to the standard field `description`.
        string summary = 1;
        Specified by:
        getSummary in interface DocumentationOrBuilder
        Returns:
        The summary.

      • getSummaryBytes

        public com.google.protobuf.ByteString getSummaryBytes()
         A short description of what the service does. The summary must be plain
 text. It becomes the overview of the service displayed in Google Cloud
 Console.
 NOTE: This field is equivalent to the standard field `description`.
        string summary = 1;
        Specified by:
        getSummaryBytes in interface DocumentationOrBuilder
        Returns:
        The bytes for summary.

      • setSummary

        public Documentation.Builder setSummary​(String value)
         A short description of what the service does. The summary must be plain
 text. It becomes the overview of the service displayed in Google Cloud
 Console.
 NOTE: This field is equivalent to the standard field `description`.
        string summary = 1;
        Parameters:
        value - The summary to set.
        Returns:
        This builder for chaining.

      • clearSummary

        public Documentation.Builder clearSummary()
         A short description of what the service does. The summary must be plain
 text. It becomes the overview of the service displayed in Google Cloud
 Console.
 NOTE: This field is equivalent to the standard field `description`.
        string summary = 1;
        Returns:
        This builder for chaining.

      • setSummaryBytes

        public Documentation.Builder setSummaryBytes​(com.google.protobuf.ByteString value)
         A short description of what the service does. The summary must be plain
 text. It becomes the overview of the service displayed in Google Cloud
 Console.
 NOTE: This field is equivalent to the standard field `description`.
        string summary = 1;
        Parameters:
        value - The bytes for summary to set.
        Returns:
        This builder for chaining.

      • getPagesCount

        public int getPagesCount()
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;
        Specified by:
        getPagesCount in interface DocumentationOrBuilder

      • getPages

        public Page getPages​(int index)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;
        Specified by:
        getPages in interface DocumentationOrBuilder

      • setPages

        public Documentation.Builder setPages​(int index,
                                      Page value)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • setPages

        public Documentation.Builder setPages​(int index,
                                      Page.Builder builderForValue)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • addPages

        public Documentation.Builder addPages​(Page value)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • addPages

        public Documentation.Builder addPages​(int index,
                                      Page value)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • addPages

        public Documentation.Builder addPages​(Page.Builder builderForValue)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • addPages

        public Documentation.Builder addPages​(int index,
                                      Page.Builder builderForValue)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • addAllPages

        public Documentation.Builder addAllPages​(Iterable<? extends Page> values)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • clearPages

        public Documentation.Builder clearPages()
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • removePages

        public Documentation.Builder removePages​(int index)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • getPagesBuilder

        public Page.Builder getPagesBuilder​(int index)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • addPagesBuilder

        public Page.Builder addPagesBuilder()
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • addPagesBuilder

        public Page.Builder addPagesBuilder​(int index)
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • getPagesBuilderList

        public List<Page.Builder> getPagesBuilderList()
         The top level pages for the documentation set.
        repeated .google.api.Page pages = 5;

      • getRulesList

        public List<DocumentationRule> getRulesList()
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;
        Specified by:
        getRulesList in interface DocumentationOrBuilder

      • getRulesCount

        public int getRulesCount()
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;
        Specified by:
        getRulesCount in interface DocumentationOrBuilder

      • getRules

        public DocumentationRule getRules​(int index)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;
        Specified by:
        getRules in interface DocumentationOrBuilder

      • setRules

        public Documentation.Builder setRules​(int index,
                                      DocumentationRule value)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • setRules

        public Documentation.Builder setRules​(int index,
                                      DocumentationRule.Builder builderForValue)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • addRules

        public Documentation.Builder addRules​(DocumentationRule value)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • addRules

        public Documentation.Builder addRules​(int index,
                                      DocumentationRule value)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • addRules

        public Documentation.Builder addRules​(DocumentationRule.Builder builderForValue)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • addRules

        public Documentation.Builder addRules​(int index,
                                      DocumentationRule.Builder builderForValue)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • addAllRules

        public Documentation.Builder addAllRules​(Iterable<? extends DocumentationRule> values)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • clearRules

        public Documentation.Builder clearRules()
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • removeRules

        public Documentation.Builder removeRules​(int index)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • getRulesBuilder

        public DocumentationRule.Builder getRulesBuilder​(int index)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • getRulesOrBuilder

        public DocumentationRuleOrBuilder getRulesOrBuilder​(int index)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;
        Specified by:
        getRulesOrBuilder in interface DocumentationOrBuilder

      • addRulesBuilder

        public DocumentationRule.Builder addRulesBuilder()
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • addRulesBuilder

        public DocumentationRule.Builder addRulesBuilder​(int index)
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • getRulesBuilderList

        public List<DocumentationRule.Builder> getRulesBuilderList()
         A list of documentation rules that apply to individual API elements.
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.DocumentationRule rules = 3;

      • getDocumentationRootUrlBytes

        public com.google.protobuf.ByteString getDocumentationRootUrlBytes()
         The URL to the root of documentation.
        string documentation_root_url = 4;
        Specified by:
        getDocumentationRootUrlBytes in interface DocumentationOrBuilder
        Returns:
        The bytes for documentationRootUrl.

      • setDocumentationRootUrl

        public Documentation.Builder setDocumentationRootUrl​(String value)
         The URL to the root of documentation.
        string documentation_root_url = 4;
        Parameters:
        value - The documentationRootUrl to set.
        Returns:
        This builder for chaining.

      • clearDocumentationRootUrl

        public Documentation.Builder clearDocumentationRootUrl()
         The URL to the root of documentation.
        string documentation_root_url = 4;
        Returns:
        This builder for chaining.

      • setDocumentationRootUrlBytes

        public Documentation.Builder setDocumentationRootUrlBytes​(com.google.protobuf.ByteString value)
         The URL to the root of documentation.
        string documentation_root_url = 4;
        Parameters:
        value - The bytes for documentationRootUrl to set.
        Returns:
        This builder for chaining.

      • getServiceRootUrl

        public String getServiceRootUrl()
         Specifies the service root url if the default one (the service name
 from the yaml file) is not suitable. This can be seen in any fully
 specified service urls as well as sections that show a base that other
 urls are relative to.
        string service_root_url = 6;
        Specified by:
        getServiceRootUrl in interface DocumentationOrBuilder
        Returns:
        The serviceRootUrl.

      • getServiceRootUrlBytes

        public com.google.protobuf.ByteString getServiceRootUrlBytes()
         Specifies the service root url if the default one (the service name
 from the yaml file) is not suitable. This can be seen in any fully
 specified service urls as well as sections that show a base that other
 urls are relative to.
        string service_root_url = 6;
        Specified by:
        getServiceRootUrlBytes in interface DocumentationOrBuilder
        Returns:
        The bytes for serviceRootUrl.

      • setServiceRootUrl

        public Documentation.Builder setServiceRootUrl​(String value)
         Specifies the service root url if the default one (the service name
 from the yaml file) is not suitable. This can be seen in any fully
 specified service urls as well as sections that show a base that other
 urls are relative to.
        string service_root_url = 6;
        Parameters:
        value - The serviceRootUrl to set.
        Returns:
        This builder for chaining.

      • clearServiceRootUrl

        public Documentation.Builder clearServiceRootUrl()
         Specifies the service root url if the default one (the service name
 from the yaml file) is not suitable. This can be seen in any fully
 specified service urls as well as sections that show a base that other
 urls are relative to.
        string service_root_url = 6;
        Returns:
        This builder for chaining.

      • setServiceRootUrlBytes

        public Documentation.Builder setServiceRootUrlBytes​(com.google.protobuf.ByteString value)
         Specifies the service root url if the default one (the service name
 from the yaml file) is not suitable. This can be seen in any fully
 specified service urls as well as sections that show a base that other
 urls are relative to.
        string service_root_url = 6;
        Parameters:
        value - The bytes for serviceRootUrl to set.
        Returns:
        This builder for chaining.

      • getOverview

        public String getOverview()
         Declares a single overview page. For example:
 <pre><code>documentation:
   summary: ...
   overview: &#40;== include overview.md ==&#41;
 </code></pre>
 This is a shortcut for the following declaration (using pages style):
 <pre><code>documentation:
   summary: ...
   pages:
   - name: Overview
     content: &#40;== include overview.md ==&#41;
 </code></pre>
 Note: you cannot specify both `overview` field and `pages` field.
        string overview = 2;
        Specified by:
        getOverview in interface DocumentationOrBuilder
        Returns:
        The overview.

      • getOverviewBytes

        public com.google.protobuf.ByteString getOverviewBytes()
         Declares a single overview page. For example:
 <pre><code>documentation:
   summary: ...
   overview: &#40;== include overview.md ==&#41;
 </code></pre>
 This is a shortcut for the following declaration (using pages style):
 <pre><code>documentation:
   summary: ...
   pages:
   - name: Overview
     content: &#40;== include overview.md ==&#41;
 </code></pre>
 Note: you cannot specify both `overview` field and `pages` field.
        string overview = 2;
        Specified by:
        getOverviewBytes in interface DocumentationOrBuilder
        Returns:
        The bytes for overview.

      • setOverview

        public Documentation.Builder setOverview​(String value)
         Declares a single overview page. For example:
 <pre><code>documentation:
   summary: ...
   overview: &#40;== include overview.md ==&#41;
 </code></pre>
 This is a shortcut for the following declaration (using pages style):
 <pre><code>documentation:
   summary: ...
   pages:
   - name: Overview
     content: &#40;== include overview.md ==&#41;
 </code></pre>
 Note: you cannot specify both `overview` field and `pages` field.
        string overview = 2;
        Parameters:
        value - The overview to set.
        Returns:
        This builder for chaining.

      • clearOverview

        public Documentation.Builder clearOverview()
         Declares a single overview page. For example:
 <pre><code>documentation:
   summary: ...
   overview: &#40;== include overview.md ==&#41;
 </code></pre>
 This is a shortcut for the following declaration (using pages style):
 <pre><code>documentation:
   summary: ...
   pages:
   - name: Overview
     content: &#40;== include overview.md ==&#41;
 </code></pre>
 Note: you cannot specify both `overview` field and `pages` field.
        string overview = 2;
        Returns:
        This builder for chaining.

      • setOverviewBytes

        public Documentation.Builder setOverviewBytes​(com.google.protobuf.ByteString value)
         Declares a single overview page. For example:
 <pre><code>documentation:
   summary: ...
   overview: &#40;== include overview.md ==&#41;
 </code></pre>
 This is a shortcut for the following declaration (using pages style):
 <pre><code>documentation:
   summary: ...
   pages:
   - name: Overview
     content: &#40;== include overview.md ==&#41;
 </code></pre>
 Note: you cannot specify both `overview` field and `pages` field.
        string overview = 2;
        Parameters:
        value - The bytes for overview to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Documentation.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<Documentation.Builder>

      • mergeUnknownFields

        public final Documentation.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<Documentation.Builder>