Package com.google.protobuf
Class Mixin.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
-
- com.google.protobuf.GeneratedMessageLite.Builder<Mixin,Mixin.Builder>
-
- com.google.protobuf.Mixin.Builder
-
- All Implemented Interfaces:
MessageLite.Builder
,MessageLiteOrBuilder
,MixinOrBuilder
,java.lang.Cloneable
- Enclosing class:
- Mixin
public static final class Mixin.Builder extends GeneratedMessageLite.Builder<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/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream
-
-
Field Summary
-
Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
instance
-
-
Constructor Summary
Constructors Modifier Constructor Description private
Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Mixin.Builder
clearName()
The fully qualified name of the interface which is included.Mixin.Builder
clearRoot()
If non-empty specifies a path under which inherited HTTP paths are rooted.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.Mixin.Builder
setName(java.lang.String value)
The fully qualified name of the interface which is included.Mixin.Builder
setNameBytes(ByteString value)
The fully qualified name of the interface which is included.Mixin.Builder
setRoot(java.lang.String value)
If non-empty specifies a path under which inherited HTTP paths are rooted.Mixin.Builder
setRootBytes(ByteString value)
If non-empty specifies a path under which inherited HTTP paths are rooted.-
Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
-
-
-
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
public Mixin.Builder setName(java.lang.String value)
The fully qualified name of the interface which is included.
string name = 1;
- Parameters:
value
- The name to set.- Returns:
- This builder for chaining.
-
clearName
public Mixin.Builder clearName()
The fully qualified name of the interface which is included.
string name = 1;
- Returns:
- This builder for chaining.
-
setNameBytes
public Mixin.Builder setNameBytes(ByteString value)
The fully qualified name of the interface which is included.
string name = 1;
- Parameters:
value
- The bytes for name to set.- Returns:
- This builder for chaining.
-
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
public Mixin.Builder 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.- Returns:
- This builder for chaining.
-
clearRoot
public Mixin.Builder clearRoot()
If non-empty specifies a path under which inherited HTTP paths are rooted.
string root = 2;
- Returns:
- This builder for chaining.
-
setRootBytes
public Mixin.Builder 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.- Returns:
- This builder for chaining.
-
-