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 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"; } ... }Protobuf type
google.protobuf.Mixin
Modifier and Type | Class and Description |
---|---|
static class |
Mixin.Builder
Declares an API Interface to be included in this interface.
|
GeneratedMessageLite.DefaultInstanceBasedParser<T extends GeneratedMessageLite<T,?>>, GeneratedMessageLite.ExtendableBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtendableMessage<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.GeneratedExtension<ContainingType extends MessageLite,Type>, GeneratedMessageLite.MethodToInvoke, GeneratedMessageLite.SerializedForm
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
NAME_FIELD_NUMBER |
static int |
ROOT_FIELD_NUMBER |
memoizedSerializedSize, unknownFields
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
protected Object |
dynamicMethod(GeneratedMessageLite.MethodToInvoke method,
Object arg0,
Object arg1)
A method that implements different types of operations described in
GeneratedMessageLite.MethodToInvoke . |
static Mixin |
getDefaultInstance() |
String |
getName()
The fully qualified name of the interface which is included.
|
ByteString |
getNameBytes()
The fully qualified name of the interface which is included.
|
String |
getRoot()
If non-empty specifies a path under which inherited HTTP paths
are rooted.
|
ByteString |
getRootBytes()
If non-empty specifies a path under which inherited HTTP paths
are rooted.
|
static Mixin.Builder |
newBuilder() |
static Mixin.Builder |
newBuilder(Mixin prototype) |
static Mixin |
parseDelimitedFrom(InputStream input) |
static Mixin |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Mixin |
parseFrom(byte[] data) |
static Mixin |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static Mixin |
parseFrom(ByteBuffer data) |
static Mixin |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static Mixin |
parseFrom(ByteString data) |
static Mixin |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static Mixin |
parseFrom(CodedInputStream input) |
static Mixin |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static Mixin |
parseFrom(InputStream input) |
static Mixin |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<Mixin> |
parser() |
createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getDefaultInstanceForType, isInitialized
public static final int NAME_FIELD_NUMBER
public static final int ROOT_FIELD_NUMBER
public String getName()
The fully qualified name of the interface which is included.
string name = 1;
getName
in interface MixinOrBuilder
public ByteString getNameBytes()
The fully qualified name of the interface which is included.
string name = 1;
getNameBytes
in interface MixinOrBuilder
public String getRoot()
If non-empty specifies a path under which inherited HTTP paths are rooted.
string root = 2;
getRoot
in interface MixinOrBuilder
public ByteString getRootBytes()
If non-empty specifies a path under which inherited HTTP paths are rooted.
string root = 2;
getRootBytes
in interface MixinOrBuilder
public static Mixin parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Mixin parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Mixin parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Mixin parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Mixin parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Mixin parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Mixin parseFrom(InputStream input) throws IOException
IOException
public static Mixin parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Mixin parseDelimitedFrom(InputStream input) throws IOException
IOException
public static Mixin parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Mixin parseFrom(CodedInputStream input) throws IOException
IOException
public static Mixin parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Mixin.Builder newBuilder()
public static Mixin.Builder newBuilder(Mixin prototype)
protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
GeneratedMessageLite
GeneratedMessageLite.MethodToInvoke
.
Theses 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 isInitilaized
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.
For use by generated code only.
dynamicMethod
in class GeneratedMessageLite<Mixin,Mixin.Builder>
public static Mixin getDefaultInstance()
Copyright © 2008–2022. All rights reserved.