Packages

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

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
Updatable[Api], scalapb.GeneratedMessage, Serializable, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Api
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Serializable
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    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

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllMethods(__vs: Iterable[Method]): Api
  5. def addAllMixins(__vs: Iterable[Mixin]): Api
  6. def addAllOptions(__vs: Iterable[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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  16. def companion: Api.type
    Definition Classes
    Api → GeneratedMessage
  17. def discardUnknownFields: Api
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Api → GeneratedMessage
  22. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    Api → GeneratedMessage
  23. def getSourceContext: source_context.SourceContext
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. val options: Seq[OptionProto]
  32. def serializedSize: Int
    Definition Classes
    Api → GeneratedMessage
  33. val sourceContext: scala.Option[source_context.SourceContext]
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. val syntax: type.Syntax
  36. final def toByteArray: Array[Byte]

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

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

    Definition Classes
    GeneratedMessage
  37. final def toByteString: ByteString

    Serializes the message and returns a ByteString containing its raw bytes

    Serializes the message and returns a ByteString containing its raw bytes

    Definition Classes
    GeneratedMessage
  38. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  39. 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
  40. val unknownFields: scalapb.UnknownFieldSet
  41. def update(ms: (Lens[Api, Api]) ⇒ Mutation[Api]*): Api
    Definition Classes
    Updatable
  42. val version: String
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  46. def withMethods(__v: Seq[Method]): Api
  47. def withMixins(__v: Seq[Mixin]): Api
  48. def withName(__v: String): Api
  49. def withOptions(__v: Seq[OptionProto]): Api
  50. def withSourceContext(__v: source_context.SourceContext): Api
  51. def withSyntax(__v: type.Syntax): Api
  52. def withUnknownFields(__v: scalapb.UnknownFieldSet): Api
  53. def withVersion(__v: String): Api
  54. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  55. def writeTo(_output__: CodedOutputStream): Unit

    Serializes the message into the given coded output stream

    Serializes the message into the given coded output stream

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

    Serializes the message into the given output stream

    Serializes the message into the given output stream

    Definition Classes
    GeneratedMessage

Inherited from Updatable[Api]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped