Documentation (common-protos-java 1.14.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.api.Documentation

All Implemented Interfaces:: DocumentationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class Documentation
extends com.google.protobuf.GeneratedMessageV3
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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Documentation.Builder
`Documentation` provides the information for describing a service.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Nested Classes
Modifier and Type	Class and Description
`static class`	`Documentation.Builder` `Documentation` provides the information for describing a service.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DOCUMENTATION_ROOT_URL_FIELD_NUMBER`
`static int`	`OVERVIEW_FIELD_NUMBER`
`static int`	`PAGES_FIELD_NUMBER`
`static int`	`RULES_FIELD_NUMBER`
`static int`	`SUMMARY_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`static Documentation`	`getDefaultInstance()`
`Documentation`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<Documentation>`	`getParserForType()`
`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.
`int`	`getSerializedSize()`
`java.lang.String`	`getSummary()` A short summary of what the service does.
`com.google.protobuf.ByteString`	`getSummaryBytes()` A short summary of what the service does.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Documentation.Builder`	`newBuilder()`
`static Documentation.Builder`	`newBuilder(Documentation prototype)`
`Documentation.Builder`	`newBuilderForType()`
`protected Documentation.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static Documentation`	`parseDelimitedFrom(java.io.InputStream input)`
`static Documentation`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Documentation`	`parseFrom(byte[] data)`
`static Documentation`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Documentation`	`parseFrom(java.nio.ByteBuffer data)`
`static Documentation`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Documentation`	`parseFrom(com.google.protobuf.ByteString data)`
`static Documentation`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Documentation`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Documentation`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Documentation`	`parseFrom(java.io.InputStream input)`
`static Documentation`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Documentation>`	`parser()`
`Documentation.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- SUMMARY_FIELD_NUMBER
```
public static final int SUMMARY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGES_FIELD_NUMBER
```
public static final int PAGES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RULES_FIELD_NUMBER
```
public static final int RULES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DOCUMENTATION_ROOT_URL_FIELD_NUMBER
```
public static final int DOCUMENTATION_ROOT_URL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OVERVIEW_FIELD_NUMBER
```
public static final int OVERVIEW_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getSummary

public java.lang.String getSummary()

 A short summary of what the service does. Can only be provided by
 plain text.

string summary = 1;

Specified by:: getSummary in interface DocumentationOrBuilder

getSummaryBytes

public com.google.protobuf.ByteString getSummaryBytes()

 A short summary of what the service does. Can only be provided by
 plain text.

string summary = 1;

Specified by:: getSummaryBytes in interface DocumentationOrBuilder

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 interface DocumentationOrBuilder

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 interface DocumentationOrBuilder

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

getPagesOrBuilder
```
public PageOrBuilder getPagesOrBuilder(int index)
```
```
 The top level pages for the documentation set.
 
```
repeated .google.api.Page pages = 5;
Specified by:

getPagesOrBuilder in interface DocumentationOrBuilder