public static final class DocumentationRule.Builder extends GeneratedMessageV3.Builder<DocumentationRule.Builder> implements DocumentationRuleOrBuilderA documentation rule provides information about individual API elements.
Protobuf type google.api.DocumentationRule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DocumentationRule.BuilderImplements
DocumentationRuleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DocumentationRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
build()
public DocumentationRule build()| Returns | |
|---|---|
| Type | Description |
DocumentationRule |
|
buildPartial()
public DocumentationRule buildPartial()| Returns | |
|---|---|
| Type | Description |
DocumentationRule |
|
clear()
public DocumentationRule.Builder clear()| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
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 | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
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 | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public DocumentationRule.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public DocumentationRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
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 | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
This builder for chaining. |
clone()
public DocumentationRule.Builder clone()| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
getDefaultInstanceForType()
public DocumentationRule getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DocumentationRule |
|
getDeprecationDescription()
public String getDeprecationDescription() Deprecation description of the selected element(s). It can be provided if
an element is marked as deprecated.
string deprecation_description = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The deprecationDescription. |
getDeprecationDescriptionBytes()
public ByteString getDeprecationDescriptionBytes() Deprecation description of the selected element(s). It can be provided if
an element is marked as deprecated.
string deprecation_description = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for deprecationDescription. |
getDescription()
public 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;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getSelector()
public 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;
| Returns | |
|---|---|
| Type | Description |
String |
The selector. |
getSelectorBytes()
public 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for selector. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(DocumentationRule other)
public DocumentationRule.Builder mergeFrom(DocumentationRule other)| Parameter | |
|---|---|
| Name | Description |
other |
DocumentationRule |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DocumentationRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DocumentationRule.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DocumentationRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
setDeprecationDescription(String value)
public DocumentationRule.Builder setDeprecationDescription(String value) Deprecation description of the selected element(s). It can be provided if
an element is marked as deprecated.
string deprecation_description = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe deprecationDescription to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
This builder for chaining. |
setDeprecationDescriptionBytes(ByteString value)
public DocumentationRule.Builder setDeprecationDescriptionBytes(ByteString value) Deprecation description of the selected element(s). It can be provided if
an element is marked as deprecated.
string deprecation_description = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for deprecationDescription to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
This builder for chaining. |
setDescription(String value)
public DocumentationRule.Builder setDescription(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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public DocumentationRule.Builder setDescriptionBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public DocumentationRule.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DocumentationRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|
setSelector(String value)
public DocumentationRule.Builder setSelector(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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe selector to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
This builder for chaining. |
setSelectorBytes(ByteString value)
public DocumentationRule.Builder setSelectorBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for selector to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final DocumentationRule.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DocumentationRule.Builder |
|