Represents information regarding a quota operation.

Generated from protobuf message google.api.servicecontrol.v1.QuotaOperation

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 getConsumerId()
     
    Identity of the consumer for whom this quota operation is being performed.

    This can be in one of the following formats:
    project:,
    project_number:,
    api_key:.

    Generated from protobuf field string consumer_id = 3;

    • return string
    public getLabels()
     
    Labels describing the operation.

    Generated from protobuf field map<string, string> labels = 4;

    public getMethodName()
     
    Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration. This field is not required if the quota operation is performed on non-API resources.

    Example of an RPC method name:

    google.example.library.v1.LibraryService.CreateShelf
    

    Generated from protobuf field string method_name = 2;

    • return string
    public getOperationId()
     
    Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

    UUID version 4 is recommended, though not required. In scenarios where an
    operation is computed from existing information and an idempotent id is
    desirable for deduplication purpose, UUID version 5 is recommended. See
    RFC 4122 for details.

    Generated from protobuf field string operation_id = 1;

    • return string
    public getQuotaMetrics()
     
    Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration.

    The data type used in the MetricValueSet must agree with
    the data type specified in the metric definition.
    Within a single operation, it is not allowed to have more than one
    MetricValue instances that have the same metric names and identical
    label value combinations. If a request has such duplicated MetricValue
    instances, the entire request is rejected with
    an invalid argument error.

    Generated from protobuf field repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

    public getQuotaMode()
     
    Quota mode for this operation.

    Generated from protobuf field .google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;

    • return int
    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 setConsumerId( $var)
     
    Identity of the consumer for whom this quota operation is being performed.

    This can be in one of the following formats:
    project:,
    project_number:,
    api_key:.

    Generated from protobuf field string consumer_id = 3;

    • return $this
    public setLabels( $var)
     
    Labels describing the operation.

    Generated from protobuf field map<string, string> labels = 4;

    • return $this
    public setMethodName( $var)
     
    Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration. This field is not required if the quota operation is performed on non-API resources.

    Example of an RPC method name:

    google.example.library.v1.LibraryService.CreateShelf
    

    Generated from protobuf field string method_name = 2;

    • return $this
    public setOperationId( $var)
     
    Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

    UUID version 4 is recommended, though not required. In scenarios where an
    operation is computed from existing information and an idempotent id is
    desirable for deduplication purpose, UUID version 5 is recommended. See
    RFC 4122 for details.

    Generated from protobuf field string operation_id = 1;

    • return $this
    public setQuotaMetrics( $var)
     
    Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration.

    The data type used in the MetricValueSet must agree with
    the data type specified in the metric definition.
    Within a single operation, it is not allowed to have more than one
    MetricValue instances that have the same metric names and identical
    label value combinations. If a request has such duplicated MetricValue
    instances, the entire request is rejected with
    an invalid argument error.

    Generated from protobuf field repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

    • return $this
    public setQuotaMode( $var)
     
    Quota mode for this operation.

    Generated from protobuf field .google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;

    • 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 $consumer_id
     
    Identity of the consumer for whom this quota operation is being performed.

    This can be in one of the following formats:
    project:,
    project_number:,
    api_key:.

    Generated from protobuf field string consumer_id = 3;

    private $labels
     
    Labels describing the operation.

    Generated from protobuf field map<string, string> labels = 4;

    private $method_name
     
    Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration. This field is not required if the quota operation is performed on non-API resources.

    Example of an RPC method name:

    google.example.library.v1.LibraryService.CreateShelf
    

    Generated from protobuf field string method_name = 2;

    private $operation_id
     
    Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

    UUID version 4 is recommended, though not required. In scenarios where an
    operation is computed from existing information and an idempotent id is
    desirable for deduplication purpose, UUID version 5 is recommended. See
    RFC 4122 for details.

    Generated from protobuf field string operation_id = 1;

    private $quota_metrics
     
    Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration.

    The data type used in the MetricValueSet must agree with
    the data type specified in the metric definition.
    Within a single operation, it is not allowed to have more than one
    MetricValue instances that have the same metric names and identical
    label value combinations. If a request has such duplicated MetricValue
    instances, the entire request is rejected with
    an invalid argument error.

    Generated from protobuf field repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

    private $quota_mode
     
    Quota mode for this operation.

    Generated from protobuf field .google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;

    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