Mixin.Builder

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder<BuilderType>
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessage.Builder<Mixin.Builder>
    - - com.google.protobuf.Mixin.Builder

All Implemented Interfaces:: Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, MixinOrBuilder, java.lang.Cloneable

Enclosing class:: Mixin

public static final class Mixin.Builder
extends GeneratedMessage.Builder<Mixin.Builder>
implements MixinOrBuilder

Protobuf type google.protobuf.Mixin

 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 {
       // (-- see AccessControl.GetAcl --)
       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";
       }
       ...
     }

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mixin`	`build()` Constructs the message based on the state of the Builder.
`Mixin`	`buildPartial()` Like `MessageLite.Builder.build()`, but does not throw an exception if the message is missing required fields.
`Mixin.Builder`	`clear()` Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
`Mixin.Builder`	`clearName()` `optional string name = 1;`
`Mixin.Builder`	`clearRoot()` `optional string root = 2;`
`Mixin`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()` Get the message's type's descriptor.
`java.lang.String`	`getName()` `optional string name = 1;`
`ByteString`	`getNameBytes()` `optional string name = 1;`
`java.lang.String`	`getRoot()` `optional string root = 2;`
`ByteString`	`getRootBytes()` `optional string root = 2;`
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`Mixin.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)` Like `MessageLite.Builder.mergeFrom(CodedInputStream)`, but also parses extensions.
`Mixin.Builder`	`mergeFrom(Message other)` Merge `other` into the message being built.
`Mixin.Builder`	`mergeFrom(Mixin other)`
`Mixin.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)` Merge some unknown fields into the `UnknownFieldSet` for this message.
`Mixin.Builder`	`setName(java.lang.String value)` `optional string name = 1;`
`Mixin.Builder`	`setNameBytes(ByteString value)` `optional string name = 1;`
`Mixin.Builder`	`setRoot(java.lang.String value)` `optional string root = 2;`
`Mixin.Builder`	`setRootBytes(ByteString value)` `optional string root = 2;`
`Mixin.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)` Set the `UnknownFieldSet` for this message.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, newBuilderForField, setField, setRepeatedField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

- Method Detail
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - clear
```
public Mixin.Builder clear()
```
    Description copied from class: GeneratedMessage.Builder
    
    Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
    
    Specified by:
    
    clear in interface Message.Builder
    
    Specified by:
    
    clear in interface MessageLite.Builder
    
    Overrides:
    
    clear in class GeneratedMessage.Builder<Mixin.Builder>
  - getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
    Description copied from interface: Message.Builder
    
    Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().
    
    Specified by:
    
    getDescriptorForType in interface Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class GeneratedMessage.Builder<Mixin.Builder>
  - 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
  - build
```
public Mixin build()
```
    Description copied from interface: MessageLite.Builder
    
    Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    build in interface Message.Builder
    
    Specified by:
    
    build in interface MessageLite.Builder
  - buildPartial
```
public Mixin buildPartial()
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    buildPartial in interface Message.Builder
    
    Specified by:
    
    buildPartial in interface MessageLite.Builder
  - mergeFrom
```
public Mixin.Builder mergeFrom(Message other)
```
    Description copied from interface: Message.Builder
    
    Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()). Merging occurs as follows. For each field:
    * For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
    * For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
    * For repeated fields, the elements in other are concatenated with the elements in this message. * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved. This is equivalent to the Message::MergeFrom method in C++.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<Mixin.Builder>
  - mergeFrom
```
public Mixin.Builder mergeFrom(Mixin other)
```
  - 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 GeneratedMessage.Builder<Mixin.Builder>
  - mergeFrom
```
public Mixin.Builder mergeFrom(CodedInputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Specified by:
    
    mergeFrom in interface MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<Mixin.Builder>
    
    Throws:
    
    java.io.IOException
  - getName
```
public java.lang.String getName()
```
    optional string name = 1;
```
 The fully qualified name of the API which is included.
 
```
    Specified by:
    
    getName in interface MixinOrBuilder
  - getNameBytes
```
public ByteString getNameBytes()
```
    optional string name = 1;
```
 The fully qualified name of the API which is included.
 
```
    Specified by:
    
    getNameBytes in interface MixinOrBuilder
  - setName
```
public Mixin.Builder setName(java.lang.String value)
```
    optional string name = 1;
```
 The fully qualified name of the API which is included.
 
```
  - clearName
```
public Mixin.Builder clearName()
```
    optional string name = 1;
```
 The fully qualified name of the API which is included.
 
```
  - setNameBytes
```
public Mixin.Builder setNameBytes(ByteString value)
```
    optional string name = 1;
```
 The fully qualified name of the API which is included.
 
```
  - getRoot
```
public java.lang.String getRoot()
```
    optional string root = 2;
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
    Specified by:
    
    getRoot in interface MixinOrBuilder
  - getRootBytes
```
public ByteString getRootBytes()
```
    optional string root = 2;
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
    Specified by:
    
    getRootBytes in interface MixinOrBuilder
  - setRoot
```
public Mixin.Builder setRoot(java.lang.String value)
```
    optional string root = 2;
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
  - clearRoot
```
public Mixin.Builder clearRoot()
```
    optional string root = 2;
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
  - setRootBytes
```
public Mixin.Builder setRootBytes(ByteString value)
```
    optional string root = 2;
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
  - setUnknownFields
```
public final Mixin.Builder setUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Set the UnknownFieldSet for this message.
    
    Specified by:
    
    setUnknownFields in interface Message.Builder
    
    Overrides:
    
    setUnknownFields in class GeneratedMessage.Builder<Mixin.Builder>
  - mergeUnknownFields
```
public final Mixin.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Merge some unknown fields into the UnknownFieldSet for this message.
    
    Specified by:
    
    mergeUnknownFields in interface Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class GeneratedMessage.Builder<Mixin.Builder>

Class Mixin.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Method Detail

getDescriptor

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

getRoot

getRootBytes

setRoot

clearRoot

setRootBytes

setUnknownFields

mergeUnknownFields