Api

Api is a light-weight descriptor for an API Interface.

Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

name: The fully qualified name of this interface, including package name followed by the interface's simple name.
methods: The methods of this interface, in unspecified order.
options: Any metadata attached to the interface.
version: A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
sourceContext: Source context for the protocol buffer service represented by this message.
mixins: Included interfaces. See [Mixin][].
syntax: The source syntax of the service.

Annotations: @SerialVersionUID()

Linear Supertypes

Product, Equals, Updatable[Api], scalapb.Message[Api], scalapb.GeneratedMessage, Serializable, Serializable, AnyRef, Any

Instance Constructors

new Api(name: String = "", methods: Seq[Method] = _root_.scala.collection.Seq.empty, options: Seq[OptionProto] = _root_.scala.collection.Seq.empty, version: String = "", sourceContext: Option[SourceContext] = _root_.scala.None, mixins: Seq[Mixin] = _root_.scala.collection.Seq.empty, syntax: Syntax = ...)

name
The fully qualified name of this interface, including package name followed by the interface's simple name.
methods
The methods of this interface, in unspecified order.
options
Any metadata attached to the interface.
version
A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
sourceContext
Source context for the protocol buffer service represented by this message.
mixins
Included interfaces. See [Mixin][].
syntax
The source syntax of the service.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def addAllMethods(__vs: TraversableOnce[Method]): Api
def addAllMixins(__vs: TraversableOnce[Mixin]): Api
def addAllOptions(__vs: TraversableOnce[OptionProto]): Api
def addMethods(__vs: Method*): Api
def addMixins(__vs: Mixin*): Api
def addOptions(__vs: OptionProto*): Api
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clearMethods: Api
def clearMixins: Api
def clearOptions: Api
def clearSourceContext: Api
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def companion: Api.type

Definition Classes
Api → GeneratedMessage
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getField(__field: FieldDescriptor): PValue

Definition Classes
Api → GeneratedMessage
def getFieldByNumber(__fieldNumber: Int): Any

Definition Classes
Api → GeneratedMessage
def getSourceContext: SourceContext
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mergeFrom(_input__: CodedInputStream): Api

Definition Classes
Api → Message
val methods: Seq[Method]

The methods of this interface, in unspecified order.
val mixins: Seq[Mixin]

Included interfaces.
Included interfaces. See [Mixin][].
val name: String

The fully qualified name of this interface, including package name followed by the interface's simple name.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val options: Seq[OptionProto]

Any metadata attached to the interface.
final def serializedSize: Int

Definition Classes
Api → GeneratedMessage
val sourceContext: Option[SourceContext]

Source context for the protocol buffer service represented by this message.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val syntax: Syntax

The source syntax of the service.
def toByteArray: Array[Byte]

Definition Classes
GeneratedMessage
def toByteString: ByteString

Definition Classes
GeneratedMessage
def toPMessage: PMessage

Definition Classes
GeneratedMessage
def toProtoString: String

Returns a human-readable ASCII format representation of this message.
Returns a human-readable ASCII format representation of this message.
The original message can be decoded from this format by using fromAscii on the companion object.
returns
human-readable representation of this message.

Definition Classes
Api → GeneratedMessage
def update(ms: (Lens[Api, Api]) ⇒ Mutation[Api]*): Api

Definition Classes
Updatable
val version: String

A version string for this interface.
A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withMethods(__v: Seq[Method]): Api
def withMixins(__v: Seq[Mixin]): Api
def withName(__v: String): Api
def withOptions(__v: Seq[OptionProto]): Api
def withSourceContext(__v: SourceContext): Api
def withSyntax(__v: Syntax): Api
def withVersion(__v: String): Api
def writeDelimitedTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage
def writeTo(_output__: CodedOutputStream): Unit

Definition Classes
Api → GeneratedMessage
def writeTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use toPMessage
def getField(field: FieldDescriptor): Any

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Related Docs: object Api | package api

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAllMethods(__vs: TraversableOnce[Method]): Api

def addAllMixins(__vs: TraversableOnce[Mixin]): Api

def addAllOptions(__vs: TraversableOnce[OptionProto]): Api

def addMethods(__vs: Method*): Api

def addMixins(__vs: Mixin*): Api

def addOptions(__vs: OptionProto*): Api

final def asInstanceOf[T0]: T0

def clearMethods: Api

def clearMixins: Api

def clearOptions: Api

def clearSourceContext: Api

def clone(): AnyRef

def companion: Api.type

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getField(__field: FieldDescriptor): PValue

def getFieldByNumber(__fieldNumber: Int): Any

def getSourceContext: SourceContext

final def isInstanceOf[T0]: Boolean

def mergeFrom(_input__: CodedInputStream): Api

val methods: Seq[Method]

val mixins: Seq[Mixin]

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val options: Seq[OptionProto]

final def serializedSize: Int

val sourceContext: Option[SourceContext]

final def synchronized[T0](arg0: ⇒ T0): T0

val syntax: Syntax

def toByteArray: Array[Byte]

def toByteString: ByteString

def toPMessage: PMessage

def toProtoString: String

def update(ms: (Lens[Api, Api]) ⇒ Mutation[Api]*): Api

val version: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withMethods(__v: Seq[Method]): Api

def withMixins(__v: Seq[Mixin]): Api

def withName(__v: String): Api

def withOptions(__v: Seq[OptionProto]): Api

def withSourceContext(__v: SourceContext): Api

def withSyntax(__v: Syntax): Api

def withVersion(__v: String): Api

def writeDelimitedTo(output: OutputStream): Unit

def writeTo(_output__: CodedOutputStream): Unit

def writeTo(output: OutputStream): Unit

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

def getField(field: FieldDescriptor): Any

Inherited from Product

Inherited from Equals

Inherited from Updatable[Api]

Inherited from scalapb.Message[Api]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped