Package com.google.api
Class Documentation.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
- com.google.api.Documentation.Builder
-
- All Implemented Interfaces:
DocumentationOrBuilder
,com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.lang.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: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) 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>[fully.qualified.proto.name][]</code></pre> To override the display text used for the link, this can be used: <pre><code>[display text][fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>(-- internal comment --)</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>(== include path/to/file ==)</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>(== resource_for v1.shelves.books ==)</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.
Protobuf typegoogle.api.Documentation
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Documentation.Builder
addAllPages(java.lang.Iterable<? extends Page> values)
The top level pages for the documentation set.Documentation.Builder
addAllRules(java.lang.Iterable<? extends DocumentationRule> values)
A list of documentation rules that apply to individual API elements.Documentation.Builder
addPages(int index, Page value)
The top level pages for the documentation set.Documentation.Builder
addPages(int index, Page.Builder builderForValue)
The top level pages for the documentation set.Documentation.Builder
addPages(Page value)
The top level pages for the documentation set.Documentation.Builder
addPages(Page.Builder builderForValue)
The top level pages for the documentation set.Page.Builder
addPagesBuilder()
The top level pages for the documentation set.Page.Builder
addPagesBuilder(int index)
The top level pages for the documentation set.Documentation.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Documentation.Builder
addRules(int index, DocumentationRule value)
A list of documentation rules that apply to individual API elements.Documentation.Builder
addRules(int index, DocumentationRule.Builder builderForValue)
A list of documentation rules that apply to individual API elements.Documentation.Builder
addRules(DocumentationRule value)
A list of documentation rules that apply to individual API elements.Documentation.Builder
addRules(DocumentationRule.Builder builderForValue)
A list of documentation rules that apply to individual API elements.DocumentationRule.Builder
addRulesBuilder()
A list of documentation rules that apply to individual API elements.DocumentationRule.Builder
addRulesBuilder(int index)
A list of documentation rules that apply to individual API elements.Documentation
build()
Documentation
buildPartial()
Documentation.Builder
clear()
Documentation.Builder
clearDocumentationRootUrl()
The URL to the root of documentation.Documentation.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Documentation.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Documentation.Builder
clearOverview()
Declares a single overview page.Documentation.Builder
clearPages()
The top level pages for the documentation set.Documentation.Builder
clearRules()
A list of documentation rules that apply to individual API elements.Documentation.Builder
clearServiceRootUrl()
Specifies the service root url if the default one (the service name from the yaml file) is not suitable.Documentation.Builder
clearSummary()
A short description of what the service does.Documentation.Builder
clone()
Documentation
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
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.Page.Builder
getPagesBuilder(int index)
The top level pages for the documentation set.java.util.List<Page.Builder>
getPagesBuilderList()
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.DocumentationRule.Builder
getRulesBuilder(int index)
A list of documentation rules that apply to individual API elements.java.util.List<DocumentationRule.Builder>
getRulesBuilderList()
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.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
Documentation.Builder
mergeFrom(Documentation other)
Documentation.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Documentation.Builder
mergeFrom(com.google.protobuf.Message other)
Documentation.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Documentation.Builder
removePages(int index)
The top level pages for the documentation set.Documentation.Builder
removeRules(int index)
A list of documentation rules that apply to individual API elements.Documentation.Builder
setDocumentationRootUrl(java.lang.String value)
The URL to the root of documentation.Documentation.Builder
setDocumentationRootUrlBytes(com.google.protobuf.ByteString value)
The URL to the root of documentation.Documentation.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Documentation.Builder
setOverview(java.lang.String value)
Declares a single overview page.Documentation.Builder
setOverviewBytes(com.google.protobuf.ByteString value)
Declares a single overview page.Documentation.Builder
setPages(int index, Page value)
The top level pages for the documentation set.Documentation.Builder
setPages(int index, Page.Builder builderForValue)
The top level pages for the documentation set.Documentation.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Documentation.Builder
setRules(int index, DocumentationRule value)
A list of documentation rules that apply to individual API elements.Documentation.Builder
setRules(int index, DocumentationRule.Builder builderForValue)
A list of documentation rules that apply to individual API elements.Documentation.Builder
setServiceRootUrl(java.lang.String value)
Specifies the service root url if the default one (the service name from the yaml file) is not suitable.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.Documentation.Builder
setSummary(java.lang.String value)
A short description of what the service does.Documentation.Builder
setSummaryBytes(com.google.protobuf.ByteString value)
A short description of what the service does.Documentation.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
-
Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableBuilder
addExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension
-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
getOneofFieldDescriptor, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, 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
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Overrides:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
clear
public Documentation.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<Documentation.Builder>
-
getDefaultInstanceForType
public Documentation getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public Documentation build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public Documentation buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public Documentation.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
setField
public Documentation.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
clearField
public Documentation.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
clearOneof
public Documentation.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
setRepeatedField
public Documentation.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
addRepeatedField
public Documentation.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
mergeFrom
public Documentation.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Documentation.Builder>
-
mergeFrom
public Documentation.Builder mergeFrom(Documentation other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,Documentation.Builder>
-
mergeFrom
public Documentation.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Documentation.Builder>
- Throws:
java.io.IOException
-
getSummary
public 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;
- Specified by:
getSummary
in interfaceDocumentationOrBuilder
- 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 interfaceDocumentationOrBuilder
- Returns:
- The bytes for summary.
-
setSummary
public Documentation.Builder setSummary(java.lang.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.
-
getPagesList
public java.util.List<Page> getPagesList()
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
- Specified by:
getPagesList
in interfaceDocumentationOrBuilder
-
getPagesCount
public int getPagesCount()
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
- Specified by:
getPagesCount
in interfaceDocumentationOrBuilder
-
getPages
public Page getPages(int index)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
- Specified by:
getPages
in interfaceDocumentationOrBuilder
-
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(java.lang.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;
-
getPagesOrBuilder
public PageOrBuilder getPagesOrBuilder(int index)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
- Specified by:
getPagesOrBuilder
in interfaceDocumentationOrBuilder
-
getPagesOrBuilderList
public java.util.List<? extends PageOrBuilder> getPagesOrBuilderList()
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
- Specified by:
getPagesOrBuilderList
in interfaceDocumentationOrBuilder
-
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 java.util.List<Page.Builder> getPagesBuilderList()
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
-
getRulesList
public 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;
- Specified by:
getRulesList
in interfaceDocumentationOrBuilder
-
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 interfaceDocumentationOrBuilder
-
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 interfaceDocumentationOrBuilder
-
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(java.lang.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 interfaceDocumentationOrBuilder
-
getRulesOrBuilderList
public 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;
- Specified by:
getRulesOrBuilderList
in interfaceDocumentationOrBuilder
-
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 java.util.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;
-
getDocumentationRootUrl
public java.lang.String getDocumentationRootUrl()
The URL to the root of documentation.
string documentation_root_url = 4;
- Specified by:
getDocumentationRootUrl
in interfaceDocumentationOrBuilder
- Returns:
- The documentationRootUrl.
-
getDocumentationRootUrlBytes
public com.google.protobuf.ByteString getDocumentationRootUrlBytes()
The URL to the root of documentation.
string documentation_root_url = 4;
- Specified by:
getDocumentationRootUrlBytes
in interfaceDocumentationOrBuilder
- Returns:
- The bytes for documentationRootUrl.
-
setDocumentationRootUrl
public Documentation.Builder setDocumentationRootUrl(java.lang.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 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;
- Specified by:
getServiceRootUrl
in interfaceDocumentationOrBuilder
- 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 interfaceDocumentationOrBuilder
- Returns:
- The bytes for serviceRootUrl.
-
setServiceRootUrl
public Documentation.Builder setServiceRootUrl(java.lang.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 java.lang.String getOverview()
Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: (== include overview.md ==) </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) </code></pre> Note: you cannot specify both `overview` field and `pages` field.
string overview = 2;
- Specified by:
getOverview
in interfaceDocumentationOrBuilder
- Returns:
- The overview.
-
getOverviewBytes
public com.google.protobuf.ByteString getOverviewBytes()
Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: (== include overview.md ==) </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) </code></pre> Note: you cannot specify both `overview` field and `pages` field.
string overview = 2;
- Specified by:
getOverviewBytes
in interfaceDocumentationOrBuilder
- Returns:
- The bytes for overview.
-
setOverview
public Documentation.Builder setOverview(java.lang.String value)
Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: (== include overview.md ==) </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) </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: (== include overview.md ==) </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) </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: (== include overview.md ==) </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) </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 interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
mergeUnknownFields
public final Documentation.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Documentation.Builder>
-
-