Class DocumentationRule.Builder (2.9.1)

public static final class DocumentationRule.Builder extends GeneratedMessageV3.Builder<DocumentationRule.Builder> implements DocumentationRuleOrBuilder

A documentation rule provides information about individual API elements.

Protobuf type google.api.DocumentationRule

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentationRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DocumentationRule.Builder
Overrides

build()

public DocumentationRule build()
Returns
TypeDescription
DocumentationRule

buildPartial()

public DocumentationRule buildPartial()
Returns
TypeDescription
DocumentationRule

clear()

public DocumentationRule.Builder clear()
Returns
TypeDescription
DocumentationRule.Builder
Overrides

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
TypeDescription
DocumentationRule.Builder

This builder for chaining.

clearDescription()

public DocumentationRule.Builder clearDescription()

Description of the selected API(s).

string description = 2;

Returns
TypeDescription
DocumentationRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DocumentationRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DocumentationRule.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentationRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DocumentationRule.Builder
Overrides

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". 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
TypeDescription
DocumentationRule.Builder

This builder for chaining.

clone()

public DocumentationRule.Builder clone()
Returns
TypeDescription
DocumentationRule.Builder
Overrides

getDefaultInstanceForType()

public DocumentationRule getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for deprecationDescription.

getDescription()

public String getDescription()

Description of the selected API(s).

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the selected API(s).

string description = 2;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getSelector()

public 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". 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
TypeDescription
String

The selector.

getSelectorBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for selector.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DocumentationRule other)

public DocumentationRule.Builder mergeFrom(DocumentationRule other)
Parameter
NameDescription
otherDocumentationRule
Returns
TypeDescription
DocumentationRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentationRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentationRule.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DocumentationRule.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DocumentationRule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentationRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DocumentationRule.Builder
Overrides

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
NameDescription
valueString

The deprecationDescription to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for deprecationDescription to set.

Returns
TypeDescription
DocumentationRule.Builder

This builder for chaining.

setDescription(String value)

public DocumentationRule.Builder setDescription(String value)

Description of the selected API(s).

string description = 2;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
DocumentationRule.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DocumentationRule.Builder setDescriptionBytes(ByteString value)

Description of the selected API(s).

string description = 2;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
DocumentationRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentationRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DocumentationRule.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DocumentationRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DocumentationRule.Builder
Overrides

setSelector(String value)

public DocumentationRule.Builder setSelector(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". 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
NameDescription
valueString

The selector to set.

Returns
TypeDescription
DocumentationRule.Builder

This builder for chaining.

setSelectorBytes(ByteString value)

public DocumentationRule.Builder setSelectorBytes(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". 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
NameDescription
valueByteString

The bytes for selector to set.

Returns
TypeDescription
DocumentationRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentationRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DocumentationRule.Builder
Overrides