Class Mixin

public final class Mixin extends GeneratedMessageLite<Mixin,Mixin.Builder> implements MixinOrBuilder

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 inheriting 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"; } ... }

Protobuf type google.protobuf.Mixin

Implements

MixinOrBuilder

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ROOT_FIELD_NUMBER

public static final int ROOT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Mixin getDefaultInstance()
Returns
TypeDescription
Mixin

newBuilder()

public static Mixin.Builder newBuilder()
Returns
TypeDescription
Mixin.Builder

newBuilder(Mixin prototype)

public static Mixin.Builder newBuilder(Mixin prototype)
Parameter
NameDescription
prototypeMixin
Returns
TypeDescription
Mixin.Builder

parseDelimitedFrom(InputStream input)

public static Mixin parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Mixin parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Mixin parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Mixin parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Mixin parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Mixin parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Mixin parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Mixin parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Mixin parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Mixin parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Mixin parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Mixin parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Mixin
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Mixin> parser()
Returns
TypeDescription
Parser<Mixin>

Methods

dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)

protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)

A method that implements different types of operations described in MethodToInvoke. These different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.

  • NEW_INSTANCE returns a new instance of the protocol buffer that has not yet been made immutable. See MAKE_IMMUTABLE.
  • IS_INITIALIZED returns null for false and the default instance for true. It doesn't use or modify any memoized value.
  • GET_MEMOIZED_IS_INITIALIZED returns the memoized isInitialized byte value.
  • SET_MEMOIZED_IS_INITIALIZED sets the memoized isInitialized byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.
  • NEW_BUILDER returns a BuilderType instance.

This method, plus the implementation of the Builder, enables the Builder class to be proguarded away entirely on Android.

For use by generated code only.

Parameters
NameDescription
methodGeneratedMessageLite.MethodToInvoke
arg0Object
arg1Object
Returns
TypeDescription
Object
Overrides

getName()

public String getName()

The fully qualified name of the interface which is included.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The fully qualified name of the interface which is included.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getRoot()

public String getRoot()

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

string root = 2;

Returns
TypeDescription
String

The root.

getRootBytes()

public ByteString getRootBytes()

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

string root = 2;

Returns
TypeDescription
ByteString

The bytes for root.