Package com.google.api
Class DocumentationRule.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<DocumentationRule.Builder>
-
- com.google.api.DocumentationRule.Builder
-
- All Implemented Interfaces:
DocumentationRuleOrBuilder
,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:
- 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 typegoogle.api.DocumentationRule
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 proto element (e.g.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 for any element such as a method, a field, an enum value.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 proto element (e.g.com.google.protobuf.ByteString
getDescriptionBytes()
Description of the selected proto element (e.g.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 for any element such as a method, a field, an enum value.com.google.protobuf.ByteString
getSelectorBytes()
The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
DocumentationRule.Builder
mergeFrom(DocumentationRule other)
DocumentationRule.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
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 proto element (e.g.DocumentationRule.Builder
setDescriptionBytes(com.google.protobuf.ByteString value)
Description of the selected proto element (e.g.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 for any element such as a method, a field, an enum value.DocumentationRule.Builder
setSelectorBytes(com.google.protobuf.ByteString value)
The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.DocumentationRule.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<DocumentationRule.Builder>
-
clear
public 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.GeneratedMessage.Builder<DocumentationRule.Builder>
-
getDefaultInstanceForType
public DocumentationRule 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 DocumentationRule build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public DocumentationRule buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public DocumentationRule.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, java.lang.Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentationRule.Builder>
-
clearField
public DocumentationRule.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<DocumentationRule.Builder>
-
clearOneof
public DocumentationRule.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<DocumentationRule.Builder>
-
setRepeatedField
public DocumentationRule.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<DocumentationRule.Builder>
-
addRepeatedField
public DocumentationRule.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<DocumentationRule.Builder>
-
mergeFrom
public DocumentationRule.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<DocumentationRule.Builder>
-
mergeFrom
public DocumentationRule.Builder mergeFrom(DocumentationRule 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,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 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:
java.io.IOException
-
getSelector
public java.lang.String getSelector()
The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. 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 for any element such as a method, a field, an enum value. 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
public DocumentationRule.Builder setSelector(java.lang.String value)
The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. 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
public DocumentationRule.Builder clearSelector()
The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. 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
public DocumentationRule.Builder setSelectorBytes(com.google.protobuf.ByteString value)
The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. 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
public java.lang.String getDescription()
Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
string description = 2;
- Specified by:
getDescription
in interfaceDocumentationRuleOrBuilder
- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()
Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
string description = 2;
- Specified by:
getDescriptionBytes
in interfaceDocumentationRuleOrBuilder
- Returns:
- The bytes for description.
-
setDescription
public DocumentationRule.Builder setDescription(java.lang.String value)
Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
string description = 2;
- Parameters:
value
- The description to set.- Returns:
- This builder for chaining.
-
clearDescription
public DocumentationRule.Builder clearDescription()
Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
string description = 2;
- Returns:
- This builder for chaining.
-
setDescriptionBytes
public DocumentationRule.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
string description = 2;
- Parameters:
value
- The bytes for description to set.- Returns:
- This builder for chaining.
-
getDeprecationDescription
public java.lang.String 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
public DocumentationRule.Builder setDeprecationDescription(java.lang.String 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 deprecationDescription to set.- Returns:
- This builder for chaining.
-
clearDeprecationDescription
public DocumentationRule.Builder 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>
-
-