Packages

final case class Mixin(name: String = "", root: String = "", unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[Mixin] with Product with Serializable

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows:

- If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method.

- Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited.

- If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the [root][] path if specified.

Example of a simple mixin:

package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } }

package google.storage.v2; service Storage { rpc GetAcl(GetAclRequest) returns (Acl);

// Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } }

Example of a mixin configuration:

apis:

  • name: google.storage.v2.Storage mixins:
    • name: google.acl.v1.AccessControl

The mixin construct implies that all methods in AccessControl are also declared with same name and request/response types in Storage. A documentation generator or annotation processor will see the effective Storage.GetAcl method after inherting documentation and annotations as follows:

service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... }

Note how the version in the path pattern changed from v1 to v2.

If the root field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example:

apis:

  • name: google.storage.v2.Storage mixins:
    • name: google.acl.v1.AccessControl root: acls

This implies the following inherited HTTP annotation:

service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }

name

The fully qualified name of the interface which is included.

root

If non-empty specifies a path under which inherited HTTP paths are rooted.

Annotations
@SerialVersionUID()
Linear Supertypes
Updatable[Mixin], scalapb.GeneratedMessage, Serializable, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Mixin
  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 Mixin(name: String = "", root: String = "", unknownFields: scalapb.UnknownFieldSet = ...)

    name

    The fully qualified name of the interface which is included.

    root

    If non-empty specifies a path under which inherited HTTP paths are rooted.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def companion: Mixin.type
    Definition Classes
    Mixin → GeneratedMessage
  7. def discardUnknownFields: Mixin
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Mixin → GeneratedMessage
  12. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    Mixin → GeneratedMessage
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val name: String
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. val root: String
  19. def serializedSize: Int
    Definition Classes
    Mixin → GeneratedMessage
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. 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
  22. 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
  23. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  24. 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
    Mixin → GeneratedMessage
  25. val unknownFields: scalapb.UnknownFieldSet
  26. def update(ms: (Lens[Mixin, Mixin]) ⇒ Mutation[Mixin]*): Mixin
    Definition Classes
    Updatable
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. def withName(__v: String): Mixin
  31. def withRoot(__v: String): Mixin
  32. def withUnknownFields(__v: scalapb.UnknownFieldSet): Mixin
  33. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  34. 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
    Mixin → GeneratedMessage
  35. 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[Mixin]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped