DocumentationRule.Builder (common-protos-java 1.14.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>
    - - com.google.api.DocumentationRule.Builder

All Implemented Interfaces:

DocumentationRuleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.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 Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentationRule.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`DocumentationRule`	`build()`
`DocumentationRule`	`buildPartial()`
`DocumentationRule.Builder`	`clear()`
`DocumentationRule.Builder`	`clearDeprecationDescription()` Deprecation description of the selected element(s).
`DocumentationRule.Builder`	`clearDescription()` Description of the selected API(s).
`DocumentationRule.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`DocumentationRule.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`DocumentationRule.Builder`	`clearSelector()` The selector is a comma-separated list of patterns.
`DocumentationRule.Builder`	`clone()`
`DocumentationRule`	`getDefaultInstanceForType()`
`java.lang.String`	`getDeprecationDescription()` Deprecation description of the selected element(s).
`com.google.protobuf.ByteString`	`getDeprecationDescriptionBytes()` Deprecation description of the selected element(s).
`java.lang.String`	`getDescription()` Description of the selected API(s).
`com.google.protobuf.ByteString`	`getDescriptionBytes()` Description of the selected API(s).
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getSelector()` The selector is a comma-separated list of patterns.
`com.google.protobuf.ByteString`	`getSelectorBytes()` The selector is a comma-separated list of patterns.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`DocumentationRule.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`DocumentationRule.Builder`	`mergeFrom(DocumentationRule other)`
`DocumentationRule.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`DocumentationRule.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`DocumentationRule.Builder`	`setDeprecationDescription(java.lang.String value)` Deprecation description of the selected element(s).
`DocumentationRule.Builder`	`setDeprecationDescriptionBytes(com.google.protobuf.ByteString value)` Deprecation description of the selected element(s).
`DocumentationRule.Builder`	`setDescription(java.lang.String value)` Description of the selected API(s).
`DocumentationRule.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` Description of the selected API(s).
`DocumentationRule.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`DocumentationRule.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`DocumentationRule.Builder`	`setSelector(java.lang.String value)` The selector is a comma-separated list of patterns.
`DocumentationRule.Builder`	`setSelectorBytes(com.google.protobuf.ByteString value)` The selector is a comma-separated list of patterns.
`DocumentationRule.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

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

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

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,
                                          java.lang.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,
                                                  java.lang.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,
                                                  java.lang.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>

mergeFrom

public DocumentationRule.Builder mergeFrom(DocumentationRule other)

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 java.io.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:

java.io.IOException

getSelector

public java.lang.String getSelector()

 The selector is a comma-separated list of patterns. 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". To
 specify a default for all applicable elements, the whole pattern "*"
 is used.

string selector = 1;

Specified by:: getSelector in interface DocumentationRuleOrBuilder

getSelectorBytes

public com.google.protobuf.ByteString getSelectorBytes()

 The selector is a comma-separated list of patterns. 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". To
 specify a default for all applicable elements, the whole pattern "*"
 is used.

string selector = 1;

Specified by:: getSelectorBytes in interface DocumentationRuleOrBuilder

setSelector

public DocumentationRule.Builder setSelector(java.lang.String value)

 The selector is a comma-separated list of patterns. 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". To
 specify a default for all applicable elements, the whole pattern "*"
 is used.

string selector = 1;

clearSelector

public DocumentationRule.Builder clearSelector()

 The selector is a comma-separated list of patterns. 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". To
 specify a default for all applicable elements, the whole pattern "*"
 is used.

string selector = 1;

setSelectorBytes

public DocumentationRule.Builder setSelectorBytes(com.google.protobuf.ByteString value)

 The selector is a comma-separated list of patterns. 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". To
 specify a default for all applicable elements, the whole pattern "*"
 is used.

string selector = 1;

getDescription
```
public java.lang.String getDescription()
```
```
 Description of the selected API(s).
 
```
string description = 2;
Specified by:

getDescription in interface DocumentationRuleOrBuilder

getDescriptionBytes
```
public com.google.protobuf.ByteString getDescriptionBytes()
```
```
 Description of the selected API(s).
 
```
string description = 2;
Specified by:

getDescriptionBytes in interface DocumentationRuleOrBuilder

setDescription

public DocumentationRule.Builder setDescription(java.lang.String value)

 Description of the selected API(s).

string description = 2;

clearDescription

public DocumentationRule.Builder clearDescription()

 Description of the selected API(s).

string description = 2;

setDescriptionBytes

public DocumentationRule.Builder setDescriptionBytes(com.google.protobuf.ByteString value)

 Description of the selected API(s).

string description = 2;