Package com.google.api
Class DocumentationRule.Builder
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
,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
Modifier and TypeMethodDescriptionaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
Deprecation description of the selected element(s).Description of the selected API(s).clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) The selector is a comma-separated list of patterns.clone()
Deprecation description of the selected element(s).com.google.protobuf.ByteString
Deprecation description of the selected element(s).Description of the selected API(s).com.google.protobuf.ByteString
Description of the selected API(s).static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
The selector is a comma-separated list of patterns.com.google.protobuf.ByteString
The selector is a comma-separated list of patterns.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFrom
(DocumentationRule other) mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) setDeprecationDescription
(String value) Deprecation description of the selected element(s).setDeprecationDescriptionBytes
(com.google.protobuf.ByteString value) Deprecation description of the selected element(s).setDescription
(String value) Description of the selected API(s).setDescriptionBytes
(com.google.protobuf.ByteString value) Description of the selected API(s).setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setSelector
(String value) The selector is a comma-separated list of patterns.setSelectorBytes
(com.google.protobuf.ByteString value) The selector is a comma-separated list of patterns.setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, 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.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.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<DocumentationRule.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.GeneratedMessageV3.Builder<DocumentationRule.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.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<DocumentationRule.Builder>
-
setField
public DocumentationRule.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>
-
clearField
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>
-
clearOneof
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>
-
setRepeatedField
public DocumentationRule.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>
-
addRepeatedField
public DocumentationRule.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<DocumentationRule.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>
-
mergeFrom
public DocumentationRule.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<DocumentationRule.Builder>
- Throws:
IOException
-
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". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
string selector = 1;
- Specified by:
getSelector
in interfaceDocumentationRuleOrBuilder
- Returns:
- The selector.
-
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". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
string selector = 1;
- Specified by:
getSelectorBytes
in interfaceDocumentationRuleOrBuilder
- Returns:
- The bytes for selector.
-
setSelector
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". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
string selector = 1;
- Parameters:
value
- The selector to set.- Returns:
- This builder for chaining.
-
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". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
string selector = 1;
- Returns:
- This builder for chaining.
-
setSelectorBytes
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". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
string selector = 1;
- Parameters:
value
- The bytes for selector to set.- Returns:
- This builder for chaining.
-
getDescription
Description of the selected API(s).
string description = 2;
- Specified by:
getDescription
in interfaceDocumentationRuleOrBuilder
- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()Description of the selected API(s).
string description = 2;
- Specified by:
getDescriptionBytes
in interfaceDocumentationRuleOrBuilder
- Returns:
- The bytes for description.
-
setDescription
Description of the selected API(s).
string description = 2;
- Parameters:
value
- The description to set.- Returns:
- This builder for chaining.
-
clearDescription
Description of the selected API(s).
string description = 2;
- Returns:
- This builder for chaining.
-
setDescriptionBytes
Description of the selected API(s).
string description = 2;
- Parameters:
value
- The bytes for description to set.- Returns:
- This builder for chaining.
-
getDeprecationDescription
Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.
string deprecation_description = 3;
- Specified by:
getDeprecationDescription
in interfaceDocumentationRuleOrBuilder
- Returns:
- The deprecationDescription.
-
getDeprecationDescriptionBytes
public com.google.protobuf.ByteString getDeprecationDescriptionBytes()Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.
string deprecation_description = 3;
- Specified by:
getDeprecationDescriptionBytes
in interfaceDocumentationRuleOrBuilder
- Returns:
- The bytes for deprecationDescription.
-
setDeprecationDescription
Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.
string deprecation_description = 3;
- Parameters:
value
- The deprecationDescription to set.- Returns:
- This builder for chaining.
-
clearDeprecationDescription
Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.
string deprecation_description = 3;
- Returns:
- This builder for chaining.
-
setDeprecationDescriptionBytes
public DocumentationRule.Builder setDeprecationDescriptionBytes(com.google.protobuf.ByteString value) Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.
string deprecation_description = 3;
- Parameters:
value
- The bytes for deprecationDescription to set.- Returns:
- This builder for chaining.
-
setUnknownFields
public final DocumentationRule.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>
-
mergeUnknownFields
public final DocumentationRule.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>
-