PHPFUI/InstaDoc

Describes settings to use when generating API methods that use the long-running operation pattern.

All default values below are from those used in the client library generators (e.g. Java).

Generated from protobuf message google.api.MethodSettings.LongRunning

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

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

@type \Google\Protobuf\Duration $initial_poll_delay
      Initial delay after which the first poll request will be made.
      Default value: 5 seconds.
@type float $poll_delay_multiplier
      Multiplier to gradually increase delay between subsequent polls until it
      reaches max_poll_delay.
      Default value: 1.5.
@type \Google\Protobuf\Duration $max_poll_delay
      Maximum time between two subsequent poll requests.
      Default value: 45 seconds.
@type \Google\Protobuf\Duration $total_poll_timeout
      Total polling timeout.
      Default value: 5 minutes.

}

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

public clearMaxPollDelay()

public clearTotalPollTimeout()

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

Clear all unknown fields previously parsed.

return null

public getInitialPollDelay()

Initial delay after which the first poll request will be made.

Default value: 5 seconds.

Generated from protobuf field .google.protobuf.Duration initial_poll_delay = 1;

return \Google\Protobuf\Duration|null

public getMaxPollDelay()

Maximum time between two subsequent poll requests.

Default value: 45 seconds.

Generated from protobuf field .google.protobuf.Duration max_poll_delay = 3;

return \Google\Protobuf\Duration|null

public getPollDelayMultiplier()

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.

Default value: 1.5.

Generated from protobuf field float poll_delay_multiplier = 2;

return float

public getTotalPollTimeout()

Total polling timeout.

Default value: 5 minutes.

Generated from protobuf field .google.protobuf.Duration total_poll_timeout = 4;

return \Google\Protobuf\Duration|null

public hasInitialPollDelay()

public hasMaxPollDelay()

public hasTotalPollTimeout()

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

Initial delay after which the first poll request will be made.

Default value: 5 seconds.

Generated from protobuf field .google.protobuf.Duration initial_poll_delay = 1;

param \Google\Protobuf\Duration $var
return $this

public setMaxPollDelay( $var)

Maximum time between two subsequent poll requests.

Default value: 45 seconds.

Generated from protobuf field .google.protobuf.Duration max_poll_delay = 3;

param \Google\Protobuf\Duration $var
return $this

public setPollDelayMultiplier( $var)

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.

Default value: 1.5.

Generated from protobuf field float poll_delay_multiplier = 2;

param float $var
return $this

public setTotalPollTimeout( $var)

Total polling timeout.

Default value: 5 minutes.

Generated from protobuf field .google.protobuf.Duration total_poll_timeout = 4;

param \Google\Protobuf\Duration $var
return $this

Properties

protected $initial_poll_delay = NULL

Initial delay after which the first poll request will be made.

Default value: 5 seconds.

Generated from protobuf field .google.protobuf.Duration initial_poll_delay = 1;

protected $max_poll_delay = NULL

Maximum time between two subsequent poll requests.

Default value: 45 seconds.

Generated from protobuf field .google.protobuf.Duration max_poll_delay = 3;

protected $poll_delay_multiplier = 0

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.

Default value: 1.5.

Generated from protobuf field float poll_delay_multiplier = 2;

protected $total_poll_timeout = NULL

Total polling timeout.

Default value: 5 minutes.

Generated from protobuf field .google.protobuf.Duration total_poll_timeout = 4;

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)

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only