Mixin (Protocol Buffers [Core] 3.2.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.protobuf.Mixin

All Implemented Interfaces:: Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, MixinOrBuilder, Serializable

public final class Mixin
extends GeneratedMessageV3
implements MixinOrBuilder

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

Protobuf type google.protobuf.Mixin

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Mixin.Builder
Declares an API to be included in this API.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Nested Classes
Modifier and Type	Class and Description
`static class`	`Mixin.Builder` Declares an API to be included in this API.

Field Summary

Fields
Modifier and Type Field and Description

static int NAME_FIELD_NUMBER

static int ROOT_FIELD_NUMBER
- Fields inherited from class com.google.protobuf.GeneratedMessageV3
  alwaysUseFieldBuilders, unknownFields
- Fields inherited from class com.google.protobuf.AbstractMessage
  memoizedSize
- Fields inherited from class com.google.protobuf.AbstractMessageLite
  memoizedHashCode

Fields
Modifier and Type	Field and Description
`static int`	`NAME_FIELD_NUMBER`
`static int`	`ROOT_FIELD_NUMBER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Compares the specified object with this message for equality.
`static Mixin`	`getDefaultInstance()`
`Mixin`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`String`	`getName()` The fully qualified name of the API which is included.
`ByteString`	`getNameBytes()` The fully qualified name of the API which is included.
`Parser<Mixin>`	`getParserForType()` Gets the parser for a message of the same type as this message.
`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.
`int`	`getSerializedSize()` Get the number of bytes required to encode this message.
`UnknownFieldSet`	`getUnknownFields()` Get the `UnknownFieldSet` for this message.
`int`	`hashCode()` Returns the hash code value for this message.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()` Get the FieldAccessorTable for this type.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`static Mixin.Builder`	`newBuilder()`
`static Mixin.Builder`	`newBuilder(Mixin prototype)`
`Mixin.Builder`	`newBuilderForType()` Constructs a new builder for a message of the same type as this message.
`protected Mixin.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)` TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
`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(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()`
`Mixin.Builder`	`toBuilder()` Constructs a builder initialized with the current message.
`void`	`writeTo(CodedOutputStream output)` Serializes the message and writes it to `output`.

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, 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.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- Field Detail
  - NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - ROOT_FIELD_NUMBER
```
public static final int ROOT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
    Description copied from interface: MessageOrBuilder
    
    Get the UnknownFieldSet for this message.
    
    Specified by:
    
    getUnknownFields in interface MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class GeneratedMessageV3
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Description copied from class: GeneratedMessageV3
    
    Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.
    
    Specified by:
    
    internalGetFieldAccessorTable in class GeneratedMessageV3
  - getName
```
public String getName()
```
```
 The fully qualified name of the API which is included.
 
```
    string name = 1;
    Specified by:
    
    getName in interface MixinOrBuilder
  - getNameBytes
```
public ByteString getNameBytes()
```
```
 The fully qualified name of the API which is included.
 
```
    string name = 1;
    Specified by:
    
    getNameBytes in interface MixinOrBuilder
  - getRoot
```
public String getRoot()
```
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
    string root = 2;
    Specified by:
    
    getRoot in interface MixinOrBuilder
  - getRootBytes
```
public ByteString getRootBytes()
```
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
    string root = 2;
    Specified by:
    
    getRootBytes in interface MixinOrBuilder
  - isInitialized
```
public final boolean isInitialized()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Returns true if all required fields in the message and all embedded messages are set, false otherwise.
    See also: MessageOrBuilder.getInitializationErrorString()
    
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class GeneratedMessageV3
  - writeTo
```
public void writeTo(CodedOutputStream output)
             throws IOException
```
    Description copied from interface: MessageLite
    
    Serializes the message and writes it to output. This does not flush or close the stream.
    
    Specified by:
    
    writeTo in interface MessageLite
    
    Overrides:
    
    writeTo in class GeneratedMessageV3
    
    Throws:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Description copied from interface: MessageLite
    
    Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.
    
    Specified by:
    
    getSerializedSize in interface MessageLite
    
    Overrides:
    
    getSerializedSize in class GeneratedMessageV3
  - equals
```
public boolean equals(Object obj)
```
    Description copied from interface: Message
    
    Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.
    
    Specified by:
    
    equals in interface Message
    
    Overrides:
    
    equals in class AbstractMessage
    
    Parameters:
    
    obj - object to be compared for equality with this message
    
    Returns:
    
    true if the specified object is equal to this message
  - hashCode
```
public int hashCode()
```
    Description copied from interface: Message
    
    Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.
    
    Specified by:
    
    hashCode in interface Message
    
    Overrides:
    
    hashCode in class AbstractMessage
    
    Returns:
    
    the hash code value for this message
    
    See Also:
    
    Map.hashCode()
  - 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(InputStream input)
                       throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Mixin parseFrom(InputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static Mixin parseDelimitedFrom(InputStream input)
                                throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static Mixin parseDelimitedFrom(InputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Mixin parseFrom(CodedInputStream input)
                       throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Mixin parseFrom(CodedInputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws IOException
```
    Throws:
    
    IOException
  - newBuilderForType
```
public Mixin.Builder newBuilderForType()
```
    Description copied from interface: MessageLite
    
    Constructs a new builder for a message of the same type as this message.
    
    Specified by:
    
    newBuilderForType in interface Message
    
    Specified by:
    
    newBuilderForType in interface MessageLite
  - newBuilder
```
public static Mixin.Builder newBuilder()
```
  - newBuilder
```
public static Mixin.Builder newBuilder(Mixin prototype)
```
  - toBuilder
```
public Mixin.Builder toBuilder()
```
    Description copied from interface: MessageLite
    
    Constructs a builder initialized with the current message. Use this to derive a new message from the current one.
    
    Specified by:
    
    toBuilder in interface Message
    
    Specified by:
    
    toBuilder in interface MessageLite
  - newBuilderForType
```
protected Mixin.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
```
    Description copied from class: GeneratedMessageV3
    
    TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
    
    Specified by:
    
    newBuilderForType in class GeneratedMessageV3
  - getDefaultInstance
```
public static Mixin getDefaultInstance()
```
  - parser
```
public static Parser<Mixin> parser()
```
  - getParserForType
```
public Parser<Mixin> getParserForType()
```
    Description copied from interface: MessageLite
    
    Gets the parser for a message of the same type as this message.
    
    Specified by:
    
    getParserForType in interface Message
    
    Specified by:
    
    getParserForType in interface MessageLite
    
    Overrides:
    
    getParserForType in class GeneratedMessageV3
  - getDefaultInstanceForType
```
public Mixin getDefaultInstanceForType()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageOrBuilder

Class Mixin

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

NAME_FIELD_NUMBER

ROOT_FIELD_NUMBER

Method Detail

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getName

getNameBytes

getRoot

getRootBytes

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType