PHPFUI/InstaDoc

Describes the generator configuration for a method.

Generated from protobuf message google.api.MethodSettings

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type string $selector
      The fully qualified name of the method, for which the options below apply.
      This is used to find the method to apply the options.
      Example:
         publishing:
           method_settings:
           - selector: google.storage.control.v2.StorageControl.CreateFolder
             # method settings for CreateFolder...
@type \Google\Api\MethodSettings\LongRunning $long_running
      Describes settings to use for long-running operations when generating
      API methods for RPCs. Complements RPCs that use the annotations in
      google/longrunning/operations.proto.
      Example of a YAML configuration::
         publishing:
           method_settings:
           - selector: google.cloud.speech.v2.Speech.BatchRecognize
             long_running:
               initial_poll_delay: 60s # 1 minute
               poll_delay_multiplier: 1.5
               max_poll_delay: 360s # 6 minutes
               total_poll_timeout: 54000s # 90 minutes
@type array<string>|\Google\Protobuf\Internal\RepeatedField $auto_populated_fields
      List of top-level fields of the request message, that should be
      automatically populated by the client libraries based on their
      (google.api.field_info).format. Currently supported format: UUID4.
      Example of a YAML configuration:
         publishing:
           method_settings:
           - selector: google.example.v1.ExampleService.CreateExample
             auto_populated_fields:
             - request_id

}

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 clearLongRunning()

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

Clear all unknown fields previously parsed.

return null

public getAutoPopulatedFields()

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id

Generated from protobuf field repeated string auto_populated_fields = 3;

return \Google\Protobuf\Internal\RepeatedField

public getLongRunning()

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 minutes

Generated from protobuf field .google.api.MethodSettings.LongRunning long_running = 2;

return \Google\Api\MethodSettings\LongRunning|null

public getSelector()

The fully qualified name of the method, for which the options below apply.

This is used to find the method to apply the options. Example: publishing: method_settings: - selector: google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder...

Generated from protobuf field string selector = 1;

return string

public hasLongRunning()

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

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id

Generated from protobuf field repeated string auto_populated_fields = 3;

param string[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setLongRunning( $var)

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Generated from protobuf field .google.api.MethodSettings.LongRunning long_running = 2;

param \Google\Api\MethodSettings\LongRunning $var
return $this

public setSelector( $var)

The fully qualified name of the method, for which the options below apply.

This is used to find the method to apply the options. Example: publishing: method_settings: - selector: google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder...

Generated from protobuf field string selector = 1;

param string $var
return $this

Properties

protected $long_running = NULL

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Generated from protobuf field .google.api.MethodSettings.LongRunning long_running = 2;

protected $selector = ''

The fully qualified name of the method, for which the options below apply.

This is used to find the method to apply the options. Example: publishing: method_settings: - selector: google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder...

Generated from protobuf field string selector = 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)

Properties

private $auto_populated_fields = NULL

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id

Generated from protobuf field repeated string auto_populated_fields = 3;