Top Description Inners Fields Constructors Methods
com.google.protobuf

public final Class Mixin

extends GeneratedMessageV3
implements MixinOrBuilder
Class Inheritance
All Implemented Interfaces
com.google.protobuf.MixinOrBuilder, com.google.protobuf.MessageOrBuilder, com.google.protobuf.MessageLiteOrBuilder

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
Mixin.Builder

Declares an API Interface to be included in this interface.

Field Summary

Modifier and TypeField and Description
private static final Mixin
private byte
private volatile Object
public static final int
private static final Parser<Mixin>
private volatile Object
public static final int
private static final long
Inherited from com.google.protobuf.GeneratedMessageV3:
alwaysUseFieldBuildersunknownFields

Constructor Summary

AccessConstructor and Description
private
private
private
Mixin(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object
object to be compared for equality with this message
obj
)

Overrides com.google.protobuf.AbstractMessage.equals.

Implements com.google.protobuf.Message.equals.

Compares the specified object with this message for equality.
public static Mixin
public Mixin
public static final Descriptors.Descriptor
public String
getName()

Implements com.google.protobuf.MixinOrBuilder.getName.

The fully qualified name of the interface which is included.
public ByteString
getNameBytes()

Implements com.google.protobuf.MixinOrBuilder.getNameBytes.

The fully qualified name of the interface which is included.
public Parser<Mixin>
public String
getRoot()

Implements com.google.protobuf.MixinOrBuilder.getRoot.

If non-empty specifies a path under which inherited HTTP paths
are rooted.
public ByteString
getRootBytes()

Implements com.google.protobuf.MixinOrBuilder.getRootBytes.

If non-empty specifies a path under which inherited HTTP paths
are rooted.
public int
getSerializedSize()

Overrides com.google.protobuf.GeneratedMessageV3.getSerializedSize.

Implements com.google.protobuf.MessageLite.getSerializedSize.

Get the number of bytes required to encode this message.
public final UnknownFieldSet
public int
hashCode()

Overrides com.google.protobuf.AbstractMessage.hashCode.

Implements com.google.protobuf.Message.hashCode.

Returns the hash code value for this message.
protected GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()

Implements abstract com.google.protobuf.GeneratedMessageV3.internalGetFieldAccessorTable.

Get the FieldAccessorTable for this type.
public final boolean
isInitialized()

Overrides com.google.protobuf.GeneratedMessageV3.isInitialized.

Implements com.google.protobuf.MessageLiteOrBuilder.isInitialized.

Returns true if all required fields in the message and all embedded messages are set, false otherwise.
public static Mixin.Builder
public static Mixin.Builder
newBuilder(Mixin prototype)

public Mixin.Builder
newBuilderForType()

Implements com.google.protobuf.Message.newBuilderForType, com.google.protobuf.MessageLite.newBuilderForType.

Constructs a new builder for a message of the same type as this message.
protected Mixin.Builder
newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Implements abstract com.google.protobuf.GeneratedMessageV3.newBuilderForType.

TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
public static Mixin
public static Mixin
public static Mixin
public static Mixin
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Mixin
public static Mixin
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Mixin
parseFrom(byte[] data)

public static Mixin
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Mixin
public static Mixin
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Mixin
public static Mixin
public static Parser<Mixin>
public Mixin.Builder
toBuilder()

Implements com.google.protobuf.Message.toBuilder, com.google.protobuf.MessageLite.toBuilder.

Constructs a builder initialized with the current message.
public void
writeTo(CodedOutputStream output)

Overrides com.google.protobuf.GeneratedMessageV3.writeTo.

Implements com.google.protobuf.MessageLite.writeTo.

Serializes the message and writes it to output.
Inherited from com.google.protobuf.GeneratedMessageV3:
canUseUnsafecomputeStringSizecomputeStringSizeNoTagemptyBooleanListemptyDoubleListemptyFloatListemptyIntListemptyLongListenableAlwaysUseFieldBuildersForTestinggetAllFieldsgetAllFieldsRawgetDescriptorForTypegetFieldgetFieldRawgetOneofFieldDescriptorgetRepeatedFieldgetRepeatedFieldCounthasFieldhasOneofinternalGetMapFieldmakeExtensionsImmutablemutableCopymutableCopymutableCopymutableCopymutableCopynewBooleanListnewBuilderForTypenewDoubleListnewFloatListnewIntListnewLongListparseDelimitedWithIOExceptionparseDelimitedWithIOExceptionparseUnknownFieldparseUnknownFieldProto3parseWithIOExceptionparseWithIOExceptionparseWithIOExceptionparseWithIOExceptionserializeBooleanMapToserializeIntegerMapToserializeLongMapToserializeStringMapTowriteReplacewriteStringwriteStringNoTag