Packages

final case class Api(name: String = "", methods: Seq[Method] = _root_.scala.collection.Seq.empty, options: Seq[OptionProto] = _root_.scala.collection.Seq.empty, version: String = "", sourceContext: Option[SourceContext] = None, mixins: Seq[Mixin] = _root_.scala.collection.Seq.empty, syntax: Syntax = ...) extends scalapb.GeneratedMessage with scalapb.Message[Api] with Updatable[Api] with Product with Serializable

Api is a light-weight descriptor for a protocol buffer service.

name

The fully qualified name of this api, including package name followed by the api's simple name.

methods

The methods of this api, in unspecified order.

options

Any metadata attached to the API.

version

A version string for this api. 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 API, 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, none-GA apis.

sourceContext

Source context for the protocol buffer service represented by this message.

mixins

Included APIs. 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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Api
  2. Product
  3. Equals
  4. Updatable
  5. Message
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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] = None, mixins: Seq[Mixin] = _root_.scala.collection.Seq.empty, syntax: Syntax = ...)

    name

    The fully qualified name of this api, including package name followed by the api's simple name.

    methods

    The methods of this api, in unspecified order.

    options

    Any metadata attached to the API.

    version

    A version string for this api. 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 API, 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, none-GA apis.

    sourceContext

    Source context for the protocol buffer service represented by this message.

    mixins

    Included APIs. See [Mixin][].

    syntax

    The source syntax of the service.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllMethods(__vs: TraversableOnce[Method]): Api
  5. def addAllMixins(__vs: TraversableOnce[Mixin]): Api
  6. def addAllOptions(__vs: TraversableOnce[OptionProto]): Api
  7. def addMethods(__vs: Method*): Api
  8. def addMixins(__vs: Mixin*): Api
  9. def addOptions(__vs: OptionProto*): Api
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clearMethods: Api
  12. def clearMixins: Api
  13. def clearOptions: Api
  14. def clearSourceContext: Api
  15. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def companion: Api.type
    Definition Classes
    Api → GeneratedMessage
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  20. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Api → GeneratedMessage
  21. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Api → GeneratedMessage
  22. def getSourceContext: SourceContext
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def mergeFrom(_input__: CodedInputStream): Api
    Definition Classes
    Api → Message
  25. val methods: Seq[Method]
  26. val mixins: Seq[Mixin]
  27. val name: String
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  31. val options: Seq[OptionProto]
  32. final def serializedSize: Int
    Definition Classes
    Api → GeneratedMessage
  33. val sourceContext: Option[SourceContext]
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. val syntax: Syntax
  36. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  37. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  38. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  39. def toString(): String
    Definition Classes
    Api → AnyRef → Any
  40. def update(ms: (Lens[Api, Api]) ⇒ Mutation[Api]*): Api
    Definition Classes
    Updatable
  41. val version: String
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. def withMethods(__v: Seq[Method]): Api
  46. def withMixins(__v: Seq[Mixin]): Api
  47. def withName(__v: String): Api
  48. def withOptions(__v: Seq[OptionProto]): Api
  49. def withSourceContext(__v: SourceContext): Api
  50. def withSyntax(__v: Syntax): Api
  51. def withVersion(__v: String): Api
  52. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  53. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Api → GeneratedMessage
  54. def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. 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

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