PHPFUI/InstaDoc
 
Copied!

BatchingConfigProto defines the batching configuration for an API method.

Generated from protobuf message google.api.BatchingConfigProto

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type \Google\Api\BatchingSettingsProto $thresholds
      The thresholds which trigger a batched request to be sent.
@type \Google\Api\BatchingDescriptorProto $batch_descriptor
      The request and response fields used in batching.
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

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

Clear all unknown fields previously parsed.

  • return null
public getBatchDescriptor()
 

The request and response fields used in batching.

Generated from protobuf field .google.api.BatchingDescriptorProto batch_descriptor = 2;

  • return \Google\Api\BatchingDescriptorProto|null
public getThresholds()
 

The thresholds which trigger a batched request to be sent.

Generated from protobuf field .google.api.BatchingSettingsProto thresholds = 1;

  • return \Google\Api\BatchingSettingsProto|null
public hasBatchDescriptor()
public hasThresholds()
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • 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.

  • param object $msg Protobuf message to be merged from.
  • return null
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.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • 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.

  • param string $data Binary protobuf data.
  • return null
  • 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( $options = 0)
 

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 setBatchDescriptor( $var)
 

The request and response fields used in batching.

Generated from protobuf field .google.api.BatchingDescriptorProto batch_descriptor = 2;

  • param \Google\Api\BatchingDescriptorProto $var
  • return $this
public setThresholds( $var)
 

The thresholds which trigger a batched request to be sent.

Generated from protobuf field .google.api.BatchingSettingsProto thresholds = 1;

  • param \Google\Api\BatchingSettingsProto $var
  • return $this
Properties
protected $batch_descriptor = NULL
 

The request and response fields used in batching.

Generated from protobuf field .google.api.BatchingDescriptorProto batch_descriptor = 2;

protected $thresholds = NULL
 

The thresholds which trigger a batched request to be sent.

Generated from protobuf field .google.api.BatchingSettingsProto thresholds = 1;

Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
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.

  • param array $array An array containing message properties and values.
  • return null
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)
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration