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

Generated from protobuf message google.protobuf.Mixin

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 
Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::clear()
    public Google\Protobuf\Internal\Message::discardUnknownFields()
    public getName()
     
    The fully qualified name of the interface which is included.

    Generated from protobuf field string name = 1;

    • return string
    public getRoot()
     
    If non-empty specifies a path under which inherited HTTP paths are rooted.

    Generated from protobuf field string root = 2;

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data)
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     
    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     
    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setName( $var)
     
    The fully qualified name of the interface which is included.

    Generated from protobuf field string name = 1;

    • return $this
    public setRoot( $var)
     
    If non-empty specifies a path under which inherited HTTP paths are rooted.

    Generated from protobuf field string root = 2;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $name
     
    The fully qualified name of the interface which is included.

    Generated from protobuf field string name = 1;

    private $root
     
    If non-empty specifies a path under which inherited HTTP paths are rooted.

    Generated from protobuf field string root = 2;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     


    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     
    Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       
      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         


        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         


        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         


        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         
        Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           
          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             


            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only