Mixin

Declares an API to be included in this API. The including API must redeclare all the methods from the included API, 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 API 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 API which is included.
root: If non-empty specifies a path under which inherited HTTP paths are rooted.

Annotations: @SerialVersionUID()

Linear Supertypes

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

Instance Constructors

new Mixin(name: String = "", root: String = "")

name
The fully qualified name of the API which is included.
root
If non-empty specifies a path under which inherited HTTP paths are rooted.

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
Mixin → 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] )
def getAllFields: Map[FieldDescriptor, Any]

Definition Classes
GeneratedMessage
final def getClass(): Class[_]

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

Definition Classes
Mixin → GeneratedMessage
final def isInstanceOf[T0]: Boolean

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

Definition Classes
Mixin → Message
val name: String

The fully qualified name of the API which is included.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val root: String

If non-empty specifies a path under which inherited HTTP paths are rooted.
final def serializedSize: Int

Definition Classes
Mixin → GeneratedMessage
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toByteArray: Array[Byte]

Definition Classes
GeneratedMessage
def toString(): String

Definition Classes
Mixin → AnyRef → Any
def update(ms: (Lens[Mixin, Mixin]) ⇒ Mutation[Mixin]*): Mixin

Definition Classes
Updatable
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 withName(__v: String): Mixin
def withRoot(__v: String): Mixin
def writeDelimitedTo(output: OutputStream): Unit

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

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

Definition Classes
GeneratedMessage

Related Docs: object Mixin | package api

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

Instance Constructors

new Mixin(name: String = "", root: String = "")

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def companion: Mixin.type

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def getAllFields: Map[FieldDescriptor, Any]

final def getClass(): Class[_]

def getField(__field: FieldDescriptor): Any

final def isInstanceOf[T0]: Boolean

def mergeFrom(_input__: CodedInputStream): Mixin

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val root: String

final def serializedSize: Int

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

def toByteArray: Array[Byte]

def toString(): String

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withName(__v: String): Mixin

def withRoot(__v: String): Mixin

def writeDelimitedTo(output: OutputStream): Unit

def writeTo(_output__: CodedOutputStream): Unit

def writeTo(output: OutputStream): Unit

Inherited from Product

Inherited from Equals

Inherited from Updatable[Mixin]

Inherited from trueaccord.scalapb.Message[Mixin]

Inherited from trueaccord.scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped