A backend rule provides configuration for an individual API element.

Generated from protobuf message google.api.BackendRule

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

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

    • return
    public Google\Protobuf\Internal\Message::discardUnknownFields()
     

    Clear all unknown fields previously parsed.

    • return
    public getAddress()
     

    The address of the API backend.

    Generated from protobuf field string address = 2;

    • return string
    public getAuthentication()
     
    • return string
    public getDeadline()
     

    The number of seconds to wait for a response from a request. The default
    varies based on the request protocol and deployment environment.

    Generated from protobuf field double deadline = 3;

    • return float
    public getDisableAuth()
     

    When disable_auth is false, a JWT ID token will be generated with the
    value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP
    "Authorization" request header and sent to the backend.

    When disable_auth is true, a JWT ID token won't be generated and the
    original "Authorization" HTTP header will be preserved. If the header is
    used to carry the original token and is expected by the backend, this
    field must be set to true to preserve the header.

    Generated from protobuf field bool disable_auth = 8;

    • return bool
    public getJwtAudience()
     

    The JWT audience is used when generating a JWT ID token for the backend.

    This ID token will be added in the HTTP "authorization" header, and sent
    to the backend.

    Generated from protobuf field string jwt_audience = 7;

    • return string
    public getMinDeadline()
     

    Minimum deadline in seconds needed for this method. Calls having deadline
    value lower than this will be rejected.

    Generated from protobuf field double min_deadline = 4;

    • return float
    public getOperationDeadline()
     

    The number of seconds to wait for the completion of a long running
    operation. The default is no deadline.

    Generated from protobuf field double operation_deadline = 5;

    • return float
    public getPathTranslation()
     

    Generated from protobuf field .google.api.BackendRule.PathTranslation path_translation = 6;

    • return int
    public getSelector()
     

    Selects the methods to which this rule applies.

    Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

    Generated from protobuf field string selector = 1;

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
     

    Merges the contents of the specified message into current message.

    This method merges the contents of the specified message into the
    current message. Singular fields that are set in the specified message
    overwrite the corresponding fields in the current message. Repeated
    fields are appended. Map fields key-value pairs are overwritten.
    Singular/Oneof sub-messages are recursively merged. All overwritten
    sub-messages are deep-copied.

    • return
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
     

    Parses a json string to protobuf message.

    This function takes a string in the json wire format, matching the
    encoding output by serializeToJsonString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
     

    Parses a protocol buffer contained in a string.

    This function takes a string in the (non-human-readable) binary wire
    format, matching the encoding output by serializeToString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
     
    • 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 setAddress( $var)
     

    The address of the API backend.

    Generated from protobuf field string address = 2;

    • return $this
    public setDeadline( $var)
     

    The number of seconds to wait for a response from a request. The default
    varies based on the request protocol and deployment environment.

    Generated from protobuf field double deadline = 3;

    • return $this
    public setDisableAuth( $var)
     

    When disable_auth is false, a JWT ID token will be generated with the
    value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP
    "Authorization" request header and sent to the backend.

    When disable_auth is true, a JWT ID token won't be generated and the
    original "Authorization" HTTP header will be preserved. If the header is
    used to carry the original token and is expected by the backend, this
    field must be set to true to preserve the header.

    Generated from protobuf field bool disable_auth = 8;

    • return $this
    public setJwtAudience( $var)
     

    The JWT audience is used when generating a JWT ID token for the backend.

    This ID token will be added in the HTTP "authorization" header, and sent
    to the backend.

    Generated from protobuf field string jwt_audience = 7;

    • return $this
    public setMinDeadline( $var)
     

    Minimum deadline in seconds needed for this method. Calls having deadline
    value lower than this will be rejected.

    Generated from protobuf field double min_deadline = 4;

    • return $this
    public setOperationDeadline( $var)
     

    The number of seconds to wait for the completion of a long running
    operation. The default is no deadline.

    Generated from protobuf field double operation_deadline = 5;

    • return $this
    public setPathTranslation( $var)
     

    Generated from protobuf field .google.api.BackendRule.PathTranslation path_translation = 6;

    • return $this
    public setSelector( $var)
     

    Selects the methods to which this rule applies.

    Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

    Generated from protobuf field string selector = 1;

    • return $this
    Properties
    protected $authentication
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
     

    Populates the message from a user-supplied PHP array. Array keys
    correspond to Message properties and nested message properties.

    Example:

    $message->mergeFromArray([
        'name' => 'This is a message name',
        'interval' => [
             'startTime' => time() - 60,
             'endTime' => time(),
        ]
    ]);
    

    This method will trigger an error if it is passed data that cannot
    be converted to the correct type. For example, a StringValue field
    must receive data that is either a string or a StringValue object.

    • return
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
    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 $address
     

    The address of the API backend.

    Generated from protobuf field string address = 2;

    private $deadline
     

    The number of seconds to wait for a response from a request. The default
    varies based on the request protocol and deployment environment.

    Generated from protobuf field double deadline = 3;

    private $min_deadline
     

    Minimum deadline in seconds needed for this method. Calls having deadline
    value lower than this will be rejected.

    Generated from protobuf field double min_deadline = 4;

    private $operation_deadline
     

    The number of seconds to wait for the completion of a long running
    operation. The default is no deadline.

    Generated from protobuf field double operation_deadline = 5;

    private $path_translation
     

    Generated from protobuf field .google.api.BackendRule.PathTranslation path_translation = 6;

    private $selector
     

    Selects the methods to which this rule applies.

    Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

    Generated from protobuf field string selector = 1;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $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, $ignore_unknown)
    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