Package com.google.protobuf

Class Mixin.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MixinOrBuilder, java.lang.Cloneable
    Enclosing class:
    Mixin
    public static final class Mixin.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<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 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Mixin.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      Mixin build()  
      Mixin buildPartial()  
      Mixin.Builder clear()  
      Mixin.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      Mixin.Builder clearName()
      The fully qualified name of the interface which is included.
      Mixin.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      Mixin.Builder clearRoot()
      If non-empty specifies a path under which inherited HTTP paths are rooted.
      Mixin.Builder clone()  
      Mixin getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      java.lang.String getName()
      The fully qualified name of the interface which is included.
      com.google.protobuf.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.
      com.google.protobuf.ByteString getRootBytes()
      If non-empty specifies a path under which inherited HTTP paths are rooted.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      Mixin.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      Mixin.Builder mergeFrom​(com.google.protobuf.Message other)  
      Mixin.Builder mergeFrom​(Mixin other)  
      Mixin.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      Mixin.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      Mixin.Builder setName​(java.lang.String value)
      The fully qualified name of the interface which is included.
      Mixin.Builder setNameBytes​(com.google.protobuf.ByteString value)
      The fully qualified name of the interface which is included.
      Mixin.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)  
      Mixin.Builder setRoot​(java.lang.String value)
      If non-empty specifies a path under which inherited HTTP paths are rooted.
      Mixin.Builder setRootBytes​(com.google.protobuf.ByteString value)
      If non-empty specifies a path under which inherited HTTP paths are rooted.
      Mixin.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

        getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.Message.Builder

        mergeDelimitedFrom, mergeDelimitedFrom

      • Methods inherited from interface com.google.protobuf.MessageLite.Builder

        mergeFrom

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • clear

        public Mixin.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • getDefaultInstanceForType

        public Mixin getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Mixin build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Mixin buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Mixin.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • setField

        public Mixin.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                              java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • clearField

        public Mixin.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • clearOneof

        public Mixin.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • setRepeatedField

        public Mixin.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      int index,
                                      java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • addRepeatedField

        public Mixin.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • mergeFrom

        public Mixin.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Mixin.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • mergeFrom

        public Mixin.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Mixin.Builder>
        Throws:
        java.io.IOException

      • getName

        public java.lang.String getName()
         The fully qualified name of the interface which is included.
        string name = 1;
        Specified by:
        getName in interface MixinOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The fully qualified name of the interface which is included.
        string name = 1;
        Specified by:
        getNameBytes in interface MixinOrBuilder
        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​(com.google.protobuf.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 interface MixinOrBuilder
        Returns:
        The root.

      • getRootBytes

        public com.google.protobuf.ByteString getRootBytes()
         If non-empty specifies a path under which inherited HTTP paths
 are rooted.
        string root = 2;
        Specified by:
        getRootBytes in interface MixinOrBuilder
        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​(com.google.protobuf.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.

      • setUnknownFields

        public final Mixin.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>

      • mergeUnknownFields

        public final Mixin.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>