proto-google-common-protos-scalapb_0.11/com.google.api.documentation/DocumentationRule

DocumentationRule

@SerialVersionUID(0L) final case
class DocumentationRule(selector: String, description: String, deprecationDescription: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DocumentationRule]

A documentation rule provides information about individual API elements.

Value Params
deprecationDescription

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

description

Description of the selected API(s).

selector

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.

Companion
object
trait Updatable[DocumentationRule]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
override
def serializedSize: Int
Definition Classes
GeneratedMessage
def toProtoString: String
def withDescription(`__v`: String): DocumentationRule
def withSelector(`__v`: String): DocumentationRule
def withUnknownFields(`__v`: UnknownFieldSet): DocumentationRule
def writeTo(`_output__`: CodedOutputStream): Unit

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
final
def toByteArray: Array[Byte]

Serializes the messgae and returns a byte array containing its raw bytes

Serializes the messgae and returns a byte array containing its raw bytes

Inherited from
GeneratedMessage
final
def toByteString: ByteString

Serializes the messgae and returns a ByteString containing its raw bytes

Serializes the messgae and returns a ByteString containing its raw bytes

Inherited from
GeneratedMessage
final
def toPMessage: PMessage
Inherited from
GeneratedMessage
def update(ms: Lens[DocumentationRule, DocumentationRule] => () => DocumentationRule*): DocumentationRule
Inherited from
Updatable
final
def writeDelimitedTo(output: OutputStream): Unit
Inherited from
GeneratedMessage
final
def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Inherited from
GeneratedMessage