com.google.protobuf.api

Api

final case class Api(name: String = "", methods: Seq[Method] = scala.collection.Seq.empty[Nothing], options: Seq[OptionProto] = scala.collection.Seq.empty[Nothing], version: String = "", sourceContext: Option[SourceContext] = scala.None, mixins: Seq[Mixin] = scala.collection.Seq.empty[Nothing], syntax: Syntax = ...) extends trueaccord.scalapb.GeneratedMessage with trueaccord.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( 0L )
Linear Supertypes
Product, Equals, Updatable[Api], trueaccord.scalapb.Message[Api], trueaccord.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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Api(name: String = "", methods: Seq[Method] = scala.collection.Seq.empty[Nothing], options: Seq[OptionProto] = scala.collection.Seq.empty[Nothing], version: String = "", sourceContext: Option[SourceContext] = scala.None, mixins: Seq[Mixin] = scala.collection.Seq.empty[Nothing], 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: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

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

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

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

  9. def addMethods(__vs: Method*): Api

  10. def addMixins(__vs: Mixin*): Api

  11. def addOptions(__vs: OptionProto*): Api

  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  13. def clearMethods: Api

  14. def clearMixins: Api

  15. def clearOptions: Api

  16. def clearSourceContext: Api

  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. def companion: Api.type

    Definition Classes
    Api → GeneratedMessage

  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  22. def getField(__field: FieldDescriptor): PValue

    Definition Classes
    Api → GeneratedMessage

  23. def getFieldByNumber(__fieldNumber: Int): Any

    Definition Classes
    Api → GeneratedMessage

  24. def getSourceContext: SourceContext

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  26. def mergeFrom(_input__: CodedInputStream): Api

    Definition Classes
    Api → Message

  27. val methods: Seq[Method]

    The methods of this api, in unspecified order.

  28. val mixins: Seq[Mixin]

    Included APIs.

    Included APIs. See [Mixin][].

  29. val name: String

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

  30. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  31. final def notify(): Unit

    Definition Classes
    AnyRef

  32. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  33. val options: Seq[OptionProto]

    Any metadata attached to the API.

  34. final def serializedSize: Int

    Definition Classes
    Api → GeneratedMessage

  35. val sourceContext: Option[SourceContext]

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

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

    Definition Classes
    AnyRef

  37. val syntax: Syntax

    The source syntax of the service.

  38. def toByteArray: Array[Byte]

    Definition Classes
    GeneratedMessage

  39. def toByteString: ByteString

    Definition Classes
    GeneratedMessage

  40. def toPMessage: PMessage

    Definition Classes
    GeneratedMessage

  41. def toString(): String

    Definition Classes
    Api → AnyRef → Any

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

    Definition Classes
    Updatable

  43. val version: String

    A version string for this api.

    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.

  44. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  46. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

  49. def withName(__v: String): Api

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

  51. def withSourceContext(__v: SourceContext): Api

  52. def withSyntax(__v: Syntax): Api

  53. def withVersion(__v: String): Api

  54. def writeDelimitedTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

  55. def writeTo(_output__: CodedOutputStream): Unit

    Definition Classes
    Api → GeneratedMessage

  56. 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 trueaccord.scalapb.Message[Api]

Inherited from trueaccord.scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped