Interface DocumentationOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Documentation, Documentation.Builder

    public interface DocumentationOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDocumentationRootUrl()
      The URL to the root of documentation.
      com.google.protobuf.ByteString getDocumentationRootUrlBytes()
      The URL to the root of documentation.
      java.lang.String getOverview()
      Declares a single overview page.
      com.google.protobuf.ByteString getOverviewBytes()
      Declares a single overview page.
      Page getPages​(int index)
      The top level pages for the documentation set.
      int getPagesCount()
      The top level pages for the documentation set.
      java.util.List<Page> getPagesList()
      The top level pages for the documentation set.
      PageOrBuilder getPagesOrBuilder​(int index)
      The top level pages for the documentation set.
      java.util.List<? extends PageOrBuilder> getPagesOrBuilderList()
      The top level pages for the documentation set.
      DocumentationRule getRules​(int index)
      A list of documentation rules that apply to individual API elements.
      int getRulesCount()
      A list of documentation rules that apply to individual API elements.
      java.util.List<DocumentationRule> getRulesList()
      A list of documentation rules that apply to individual API elements.
      DocumentationRuleOrBuilder getRulesOrBuilder​(int index)
      A list of documentation rules that apply to individual API elements.
      java.util.List<? extends DocumentationRuleOrBuilder> getRulesOrBuilderList()
      A list of documentation rules that apply to individual API elements.
      java.lang.String getServiceRootUrl()
      Specifies the service root url if the default one (the service name from the yaml file) is not suitable.
      com.google.protobuf.ByteString getServiceRootUrlBytes()
      Specifies the service root url if the default one (the service name from the yaml file) is not suitable.
      java.lang.String getSummary()
      A short description of what the service does.
      com.google.protobuf.ByteString getSummaryBytes()
      A short description of what the service does.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getSummary

        java.lang.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;
        Returns:
        The summary.
      • getSummaryBytes

        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;
        Returns:
        The bytes for summary.
      • getPagesList

        java.util.List<Page> getPagesList()
         The top level pages for the documentation set.
         
        repeated .google.api.Page pages = 5;
      • getPages

        Page getPages​(int index)
         The top level pages for the documentation set.
         
        repeated .google.api.Page pages = 5;
      • getPagesCount

        int getPagesCount()
         The top level pages for the documentation set.
         
        repeated .google.api.Page pages = 5;
      • getPagesOrBuilderList

        java.util.List<? extends PageOrBuilder> getPagesOrBuilderList()
         The top level pages for the documentation set.
         
        repeated .google.api.Page pages = 5;
      • getPagesOrBuilder

        PageOrBuilder getPagesOrBuilder​(int index)
         The top level pages for the documentation set.
         
        repeated .google.api.Page pages = 5;
      • getRulesList

        java.util.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;
      • getRules

        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;
      • getRulesCount

        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;
      • getRulesOrBuilderList

        java.util.List<? extends DocumentationRuleOrBuilder> getRulesOrBuilderList()
         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

        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;
      • getDocumentationRootUrl

        java.lang.String getDocumentationRootUrl()
         The URL to the root of documentation.
         
        string documentation_root_url = 4;
        Returns:
        The documentationRootUrl.
      • getDocumentationRootUrlBytes

        com.google.protobuf.ByteString getDocumentationRootUrlBytes()
         The URL to the root of documentation.
         
        string documentation_root_url = 4;
        Returns:
        The bytes for documentationRootUrl.
      • getServiceRootUrl

        java.lang.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;
        Returns:
        The serviceRootUrl.
      • getServiceRootUrlBytes

        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;
        Returns:
        The bytes for serviceRootUrl.
      • getOverview

        java.lang.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;
        Returns:
        The overview.
      • getOverviewBytes

        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;
        Returns:
        The bytes for overview.