Package com.google.protobuf
Class Mixin
java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
- All Implemented Interfaces:
MessageLite,MessageLiteOrBuilder,MixinOrBuilder
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-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classDeclares an API Interface to be included in this interface.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite
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.ExtensionDescriptor, GeneratedMessageLite.GeneratedExtension<ContainingType extends MessageLite, Type>, GeneratedMessageLite.MethodToInvoke, GeneratedMessageLite.SerializedForm Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Mixinprivate Stringstatic final intprivate Stringstatic final intFields inherited from class com.google.protobuf.GeneratedMessageLite
UNINITIALIZED_HASH_CODE, UNINITIALIZED_SERIALIZED_SIZE, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate voidThe fully qualified name of the interface which is included.private voidIf non-empty specifies a path under which inherited HTTP paths are rooted.protected final ObjectdynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) A method that implements different types of operations described inGeneratedMessageLite.MethodToInvoke.static MixingetName()The fully qualified name of the interface which is included.The fully qualified name of the interface which is included.getRoot()If non-empty specifies a path under which inherited HTTP paths are rooted.If non-empty specifies a path under which inherited HTTP paths are rooted.static Mixin.Builderstatic Mixin.BuildernewBuilder(Mixin prototype) static MixinparseDelimitedFrom(InputStream input) static MixinparseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) static MixinparseFrom(byte[] data) static MixinparseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) static MixinparseFrom(ByteString data) static MixinparseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) static MixinparseFrom(CodedInputStream input) static MixinparseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) static MixinparseFrom(InputStream input) static MixinparseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) static MixinparseFrom(ByteBuffer data) static MixinparseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) parser()private voidThe fully qualified name of the interface which is included.private voidsetNameBytes(ByteString value) The fully qualified name of the interface which is included.private voidIf non-empty specifies a path under which inherited HTTP paths are rooted.private voidsetRootBytes(ByteString value) If non-empty specifies a path under which inherited HTTP paths are rooted.Methods inherited from class com.google.protobuf.GeneratedMessageLite
buildMessageInfo, clearMemoizedHashCode, clearMemoizedSerializedSize, computeHashCode, createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstance, getDefaultInstanceForType, getMemoizedHashCode, getMemoizedSerializedSize, getMethodOrDie, getParserForType, getSerializedSize, getSerializedSize, hashCode, hashCodeIsNotMemoized, invokeOrDie, isInitialized, isInitialized, isMutable, makeImmutable, markImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newMutableInstance, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, setMemoizedHashCode, setMemoizedSerializedSize, toBuilder, toString, writeToMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, newUninitializedMessageException, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
name_
-
ROOT_FIELD_NUMBER
public static final int ROOT_FIELD_NUMBER- See Also:
-
root_
-
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
Mixin
private Mixin()
-
-
Method Details
-
getName
The fully qualified name of the interface which is included.
string name = 1;- Specified by:
getNamein interfaceMixinOrBuilder- Returns:
- The name.
-
getNameBytes
The fully qualified name of the interface which is included.
string name = 1;- Specified by:
getNameBytesin interfaceMixinOrBuilder- Returns:
- The bytes for name.
-
setName
The fully qualified name of the interface which is included.
string name = 1;- Parameters:
value- The name to set.
-
clearName
private void clearName()The fully qualified name of the interface which is included.
string name = 1; -
setNameBytes
The fully qualified name of the interface which is included.
string name = 1;- Parameters:
value- The bytes for name to set.
-
getRoot
If non-empty specifies a path under which inherited HTTP paths are rooted.
string root = 2;- Specified by:
getRootin interfaceMixinOrBuilder- Returns:
- The root.
-
getRootBytes
If non-empty specifies a path under which inherited HTTP paths are rooted.
string root = 2;- Specified by:
getRootBytesin interfaceMixinOrBuilder- Returns:
- The bytes for root.
-
setRoot
If non-empty specifies a path under which inherited HTTP paths are rooted.
string root = 2;- Parameters:
value- The root to set.
-
clearRoot
private void clearRoot()If non-empty specifies a path under which inherited HTTP paths are rooted.
string root = 2; -
setRootBytes
If non-empty specifies a path under which inherited HTTP paths are rooted.
string root = 2;- Parameters:
value- The bytes for root to set.
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Mixin parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Mixin parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Mixin parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Mixin parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Mixin parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Mixin parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilder
-
newBuilder
-
dynamicMethod
protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) Description copied from class:GeneratedMessageLiteA method that implements different types of operations described inGeneratedMessageLite.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_INSTANCEreturns a new instance of the protocol buffer that has not yet been made immutable. SeeMAKE_IMMUTABLE.IS_INITIALIZEDreturnsnullfor false and the default instance for true. It doesn't use or modify any memoized value.GET_MEMOIZED_IS_INITIALIZEDreturns the memoizedisInitializedbyte value.SET_MEMOIZED_IS_INITIALIZEDsets the memoizedisInitializedbyte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.NEW_BUILDERreturns aBuilderTypeinstance.
For use by generated code only.
- Specified by:
dynamicMethodin classGeneratedMessageLite<Mixin,Mixin.Builder>
-
getDefaultInstance
-
parser
-