Package com.google.protobuf
Class Mixin
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
-
- com.google.protobuf.GeneratedMessageLite<Mixin,Mixin.Builder>
-
- com.google.protobuf.Mixin
-
- 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 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 typegoogle.protobuf.Mixin
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Mixin.Builder
Declares 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
Fields Modifier and Type Field Description private static Mixin
DEFAULT_INSTANCE
private java.lang.String
name_
static int
NAME_FIELD_NUMBER
private static Parser<Mixin>
PARSER
private java.lang.String
root_
static int
ROOT_FIELD_NUMBER
-
Fields inherited from class com.google.protobuf.GeneratedMessageLite
memoizedSerializedSize, unknownFields
-
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
-
Constructor Summary
Constructors Modifier Constructor Description private
Mixin()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
clearName()
The fully qualified name of the interface which is included.private void
clearRoot()
If non-empty specifies a path under which inherited HTTP paths are rooted.protected java.lang.Object
dynamicMethod(GeneratedMessageLite.MethodToInvoke method, java.lang.Object arg0, java.lang.Object arg1)
A method that implements different types of operations described inGeneratedMessageLite.MethodToInvoke
.static Mixin
getDefaultInstance()
java.lang.String
getName()
The fully qualified name of the interface which is included.ByteString
getNameBytes()
The fully qualified name of the interface which is included.java.lang.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(java.io.InputStream input)
static Mixin
parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Mixin
parseFrom(byte[] data)
static Mixin
parseFrom(byte[] 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(java.io.InputStream input)
static Mixin
parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Mixin
parseFrom(java.nio.ByteBuffer data)
static Mixin
parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<Mixin>
parser()
private void
setName(java.lang.String value)
The fully qualified name of the interface which is included.private void
setNameBytes(ByteString value)
The fully qualified name of the interface which is included.private void
setRoot(java.lang.String value)
If non-empty specifies a path under which inherited HTTP paths are rooted.private void
setRootBytes(ByteString value)
If non-empty specifies a path under which inherited HTTP paths are rooted.-
Methods inherited from class com.google.protobuf.GeneratedMessageLite
buildMessageInfo, createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstance, getDefaultInstanceForType, getMemoizedSerializedSize, getMethodOrDie, getParserForType, getSerializedSize, hashCode, invokeOrDie, 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, parsePartialFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, setMemoizedSerializedSize, toBuilder, toString, writeTo
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, getSerializedSize, newUninitializedMessageException, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
name_
private java.lang.String name_
-
ROOT_FIELD_NUMBER
public static final int ROOT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
root_
private java.lang.String root_
-
DEFAULT_INSTANCE
private static final Mixin DEFAULT_INSTANCE
-
-
Method Detail
-
getName
public java.lang.String getName()
The fully qualified name of the interface which is included.
string name = 1;
- Specified by:
getName
in interfaceMixinOrBuilder
- Returns:
- The name.
-
getNameBytes
public ByteString getNameBytes()
The fully qualified name of the interface which is included.
string name = 1;
- Specified by:
getNameBytes
in interfaceMixinOrBuilder
- Returns:
- The bytes for name.
-
setName
private void setName(java.lang.String value)
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
private void setNameBytes(ByteString value)
The fully qualified name of the interface which is included.
string name = 1;
- Parameters:
value
- The bytes for name to set.
-
getRoot
public java.lang.String getRoot()
If non-empty specifies a path under which inherited HTTP paths are rooted.
string root = 2;
- Specified by:
getRoot
in interfaceMixinOrBuilder
- Returns:
- The root.
-
getRootBytes
public ByteString getRootBytes()
If non-empty specifies a path under which inherited HTTP paths are rooted.
string root = 2;
- Specified by:
getRootBytes
in interfaceMixinOrBuilder
- Returns:
- The bytes for root.
-
setRoot
private void setRoot(java.lang.String value)
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
private void setRootBytes(ByteString value)
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
public static Mixin parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Mixin parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Mixin parseFrom(ByteString data) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Mixin parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Mixin parseFrom(byte[] data) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Mixin parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Mixin parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Mixin parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Mixin parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Mixin parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Mixin parseFrom(CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Mixin parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilder
public static Mixin.Builder newBuilder()
-
newBuilder
public static Mixin.Builder newBuilder(Mixin prototype)
-
dynamicMethod
protected final java.lang.Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, java.lang.Object arg0, java.lang.Object arg1)
Description copied from class:GeneratedMessageLite
A 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_INSTANCE
returns a new instance of the protocol buffer that has not yet been made immutable. SeeMAKE_IMMUTABLE
.IS_INITIALIZED
returnsnull
for false and the default instance for true. It doesn't use or modify any memoized value.GET_MEMOIZED_IS_INITIALIZED
returns the memoizedisInitialized
byte value.SET_MEMOIZED_IS_INITIALIZED
sets the memoizedisInitialized
byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.NEW_BUILDER
returns aBuilderType
instance.
For use by generated code only.
- Specified by:
dynamicMethod
in classGeneratedMessageLite<Mixin,Mixin.Builder>
-
getDefaultInstance
public static Mixin getDefaultInstance()
-
-