google.pubsub.v1.StreamingPullRequest */ class StreamingPullRequest extends \Google\Protobuf\Internal\Message { /** * Required. The subscription for which to initialize the new stream. This * must be provided in the first request on the stream, and must not be set in * subsequent requests from client to server. * Format is `projects/{project}/subscriptions/{sub}`. * * Generated from protobuf field string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $subscription = ''; /** * List of acknowledgement IDs for acknowledging previously received messages * (received on this stream or a different stream). If an ack ID has expired, * the corresponding message may be redelivered later. Acknowledging a message * more than once will not result in an error. If the acknowledgement ID is * malformed, the stream will be aborted with status `INVALID_ARGUMENT`. * * Generated from protobuf field repeated string ack_ids = 2; */ private $ack_ids; /** * The list of new ack deadlines for the IDs listed in * `modify_deadline_ack_ids`. The size of this list must be the same as the * size of `modify_deadline_ack_ids`. If it differs the stream will be aborted * with `INVALID_ARGUMENT`. Each element in this list is applied to the * element in the same position in `modify_deadline_ack_ids`. The new ack * deadline is with respect to the time this request was sent to the Pub/Sub * system. Must be >= 0. For example, if the value is 10, the new ack deadline * will expire 10 seconds after this request is received. If the value is 0, * the message is immediately made available for another streaming or * non-streaming pull request. If the value is < 0 (an error), the stream will * be aborted with status `INVALID_ARGUMENT`. * * Generated from protobuf field repeated int32 modify_deadline_seconds = 3; */ private $modify_deadline_seconds; /** * List of acknowledgement IDs whose deadline will be modified based on the * corresponding element in `modify_deadline_seconds`. This field can be used * to indicate that more time is needed to process a message by the * subscriber, or to make the message available for redelivery if the * processing was interrupted. * * Generated from protobuf field repeated string modify_deadline_ack_ids = 4; */ private $modify_deadline_ack_ids; /** * Required. The ack deadline to use for the stream. This must be provided in * the first request on the stream, but it can also be updated on subsequent * requests from client to server. The minimum deadline you can specify is 10 * seconds. The maximum deadline you can specify is 600 seconds (10 minutes). * * Generated from protobuf field int32 stream_ack_deadline_seconds = 5 [(.google.api.field_behavior) = REQUIRED]; */ private $stream_ack_deadline_seconds = 0; /** * A unique identifier that is used to distinguish client instances from each * other. Only needs to be provided on the initial request. When a stream * disconnects and reconnects for the same stream, the client_id should be set * to the same value so that state associated with the old stream can be * transferred to the new stream. The same client_id should not be used for * different client instances. * * Generated from protobuf field string client_id = 6; */ private $client_id = ''; /** * Flow control settings for the maximum number of outstanding messages. When * there are `max_outstanding_messages` or more currently sent to the * streaming pull client that have not yet been acked or nacked, the server * stops sending more messages. The sending of messages resumes once the * number of outstanding messages is less than this value. If the value is * <= 0, there is no limit to the number of outstanding messages. This * property can only be set on the initial StreamingPullRequest. If it is set * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * * Generated from protobuf field int64 max_outstanding_messages = 7; */ private $max_outstanding_messages = 0; /** * Flow control settings for the maximum number of outstanding bytes. When * there are `max_outstanding_bytes` or more worth of messages currently sent * to the streaming pull client that have not yet been acked or nacked, the * server will stop sending more messages. The sending of messages resumes * once the number of outstanding bytes is less than this value. If the value * is <= 0, there is no limit to the number of outstanding bytes. This * property can only be set on the initial StreamingPullRequest. If it is set * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * * Generated from protobuf field int64 max_outstanding_bytes = 8; */ private $max_outstanding_bytes = 0; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $subscription * Required. The subscription for which to initialize the new stream. This * must be provided in the first request on the stream, and must not be set in * subsequent requests from client to server. * Format is `projects/{project}/subscriptions/{sub}`. * @type array|\Google\Protobuf\Internal\RepeatedField $ack_ids * List of acknowledgement IDs for acknowledging previously received messages * (received on this stream or a different stream). If an ack ID has expired, * the corresponding message may be redelivered later. Acknowledging a message * more than once will not result in an error. If the acknowledgement ID is * malformed, the stream will be aborted with status `INVALID_ARGUMENT`. * @type array|\Google\Protobuf\Internal\RepeatedField $modify_deadline_seconds * The list of new ack deadlines for the IDs listed in * `modify_deadline_ack_ids`. The size of this list must be the same as the * size of `modify_deadline_ack_ids`. If it differs the stream will be aborted * with `INVALID_ARGUMENT`. Each element in this list is applied to the * element in the same position in `modify_deadline_ack_ids`. The new ack * deadline is with respect to the time this request was sent to the Pub/Sub * system. Must be >= 0. For example, if the value is 10, the new ack deadline * will expire 10 seconds after this request is received. If the value is 0, * the message is immediately made available for another streaming or * non-streaming pull request. If the value is < 0 (an error), the stream will * be aborted with status `INVALID_ARGUMENT`. * @type array|\Google\Protobuf\Internal\RepeatedField $modify_deadline_ack_ids * List of acknowledgement IDs whose deadline will be modified based on the * corresponding element in `modify_deadline_seconds`. This field can be used * to indicate that more time is needed to process a message by the * subscriber, or to make the message available for redelivery if the * processing was interrupted. * @type int $stream_ack_deadline_seconds * Required. The ack deadline to use for the stream. This must be provided in * the first request on the stream, but it can also be updated on subsequent * requests from client to server. The minimum deadline you can specify is 10 * seconds. The maximum deadline you can specify is 600 seconds (10 minutes). * @type string $client_id * A unique identifier that is used to distinguish client instances from each * other. Only needs to be provided on the initial request. When a stream * disconnects and reconnects for the same stream, the client_id should be set * to the same value so that state associated with the old stream can be * transferred to the new stream. The same client_id should not be used for * different client instances. * @type int|string $max_outstanding_messages * Flow control settings for the maximum number of outstanding messages. When * there are `max_outstanding_messages` or more currently sent to the * streaming pull client that have not yet been acked or nacked, the server * stops sending more messages. The sending of messages resumes once the * number of outstanding messages is less than this value. If the value is * <= 0, there is no limit to the number of outstanding messages. This * property can only be set on the initial StreamingPullRequest. If it is set * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * @type int|string $max_outstanding_bytes * Flow control settings for the maximum number of outstanding bytes. When * there are `max_outstanding_bytes` or more worth of messages currently sent * to the streaming pull client that have not yet been acked or nacked, the * server will stop sending more messages. The sending of messages resumes * once the number of outstanding bytes is less than this value. If the value * is <= 0, there is no limit to the number of outstanding bytes. This * property can only be set on the initial StreamingPullRequest. If it is set * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Pubsub\V1\Pubsub::initOnce(); parent::__construct($data); } /** * Required. The subscription for which to initialize the new stream. This * must be provided in the first request on the stream, and must not be set in * subsequent requests from client to server. * Format is `projects/{project}/subscriptions/{sub}`. * * Generated from protobuf field string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getSubscription() { return $this->subscription; } /** * Required. The subscription for which to initialize the new stream. This * must be provided in the first request on the stream, and must not be set in * subsequent requests from client to server. * Format is `projects/{project}/subscriptions/{sub}`. * * Generated from protobuf field string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ public function setSubscription($var) { GPBUtil::checkString($var, True); $this->subscription = $var; return $this; } /** * List of acknowledgement IDs for acknowledging previously received messages * (received on this stream or a different stream). If an ack ID has expired, * the corresponding message may be redelivered later. Acknowledging a message * more than once will not result in an error. If the acknowledgement ID is * malformed, the stream will be aborted with status `INVALID_ARGUMENT`. * * Generated from protobuf field repeated string ack_ids = 2; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAckIds() { return $this->ack_ids; } /** * List of acknowledgement IDs for acknowledging previously received messages * (received on this stream or a different stream). If an ack ID has expired, * the corresponding message may be redelivered later. Acknowledging a message * more than once will not result in an error. If the acknowledgement ID is * malformed, the stream will be aborted with status `INVALID_ARGUMENT`. * * Generated from protobuf field repeated string ack_ids = 2; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setAckIds($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->ack_ids = $arr; return $this; } /** * The list of new ack deadlines for the IDs listed in * `modify_deadline_ack_ids`. The size of this list must be the same as the * size of `modify_deadline_ack_ids`. If it differs the stream will be aborted * with `INVALID_ARGUMENT`. Each element in this list is applied to the * element in the same position in `modify_deadline_ack_ids`. The new ack * deadline is with respect to the time this request was sent to the Pub/Sub * system. Must be >= 0. For example, if the value is 10, the new ack deadline * will expire 10 seconds after this request is received. If the value is 0, * the message is immediately made available for another streaming or * non-streaming pull request. If the value is < 0 (an error), the stream will * be aborted with status `INVALID_ARGUMENT`. * * Generated from protobuf field repeated int32 modify_deadline_seconds = 3; * @return \Google\Protobuf\Internal\RepeatedField */ public function getModifyDeadlineSeconds() { return $this->modify_deadline_seconds; } /** * The list of new ack deadlines for the IDs listed in * `modify_deadline_ack_ids`. The size of this list must be the same as the * size of `modify_deadline_ack_ids`. If it differs the stream will be aborted * with `INVALID_ARGUMENT`. Each element in this list is applied to the * element in the same position in `modify_deadline_ack_ids`. The new ack * deadline is with respect to the time this request was sent to the Pub/Sub * system. Must be >= 0. For example, if the value is 10, the new ack deadline * will expire 10 seconds after this request is received. If the value is 0, * the message is immediately made available for another streaming or * non-streaming pull request. If the value is < 0 (an error), the stream will * be aborted with status `INVALID_ARGUMENT`. * * Generated from protobuf field repeated int32 modify_deadline_seconds = 3; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setModifyDeadlineSeconds($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT32); $this->modify_deadline_seconds = $arr; return $this; } /** * List of acknowledgement IDs whose deadline will be modified based on the * corresponding element in `modify_deadline_seconds`. This field can be used * to indicate that more time is needed to process a message by the * subscriber, or to make the message available for redelivery if the * processing was interrupted. * * Generated from protobuf field repeated string modify_deadline_ack_ids = 4; * @return \Google\Protobuf\Internal\RepeatedField */ public function getModifyDeadlineAckIds() { return $this->modify_deadline_ack_ids; } /** * List of acknowledgement IDs whose deadline will be modified based on the * corresponding element in `modify_deadline_seconds`. This field can be used * to indicate that more time is needed to process a message by the * subscriber, or to make the message available for redelivery if the * processing was interrupted. * * Generated from protobuf field repeated string modify_deadline_ack_ids = 4; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setModifyDeadlineAckIds($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->modify_deadline_ack_ids = $arr; return $this; } /** * Required. The ack deadline to use for the stream. This must be provided in * the first request on the stream, but it can also be updated on subsequent * requests from client to server. The minimum deadline you can specify is 10 * seconds. The maximum deadline you can specify is 600 seconds (10 minutes). * * Generated from protobuf field int32 stream_ack_deadline_seconds = 5 [(.google.api.field_behavior) = REQUIRED]; * @return int */ public function getStreamAckDeadlineSeconds() { return $this->stream_ack_deadline_seconds; } /** * Required. The ack deadline to use for the stream. This must be provided in * the first request on the stream, but it can also be updated on subsequent * requests from client to server. The minimum deadline you can specify is 10 * seconds. The maximum deadline you can specify is 600 seconds (10 minutes). * * Generated from protobuf field int32 stream_ack_deadline_seconds = 5 [(.google.api.field_behavior) = REQUIRED]; * @param int $var * @return $this */ public function setStreamAckDeadlineSeconds($var) { GPBUtil::checkInt32($var); $this->stream_ack_deadline_seconds = $var; return $this; } /** * A unique identifier that is used to distinguish client instances from each * other. Only needs to be provided on the initial request. When a stream * disconnects and reconnects for the same stream, the client_id should be set * to the same value so that state associated with the old stream can be * transferred to the new stream. The same client_id should not be used for * different client instances. * * Generated from protobuf field string client_id = 6; * @return string */ public function getClientId() { return $this->client_id; } /** * A unique identifier that is used to distinguish client instances from each * other. Only needs to be provided on the initial request. When a stream * disconnects and reconnects for the same stream, the client_id should be set * to the same value so that state associated with the old stream can be * transferred to the new stream. The same client_id should not be used for * different client instances. * * Generated from protobuf field string client_id = 6; * @param string $var * @return $this */ public function setClientId($var) { GPBUtil::checkString($var, True); $this->client_id = $var; return $this; } /** * Flow control settings for the maximum number of outstanding messages. When * there are `max_outstanding_messages` or more currently sent to the * streaming pull client that have not yet been acked or nacked, the server * stops sending more messages. The sending of messages resumes once the * number of outstanding messages is less than this value. If the value is * <= 0, there is no limit to the number of outstanding messages. This * property can only be set on the initial StreamingPullRequest. If it is set * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * * Generated from protobuf field int64 max_outstanding_messages = 7; * @return int|string */ public function getMaxOutstandingMessages() { return $this->max_outstanding_messages; } /** * Flow control settings for the maximum number of outstanding messages. When * there are `max_outstanding_messages` or more currently sent to the * streaming pull client that have not yet been acked or nacked, the server * stops sending more messages. The sending of messages resumes once the * number of outstanding messages is less than this value. If the value is * <= 0, there is no limit to the number of outstanding messages. This * property can only be set on the initial StreamingPullRequest. If it is set * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * * Generated from protobuf field int64 max_outstanding_messages = 7; * @param int|string $var * @return $this */ public function setMaxOutstandingMessages($var) { GPBUtil::checkInt64($var); $this->max_outstanding_messages = $var; return $this; } /** * Flow control settings for the maximum number of outstanding bytes. When * there are `max_outstanding_bytes` or more worth of messages currently sent * to the streaming pull client that have not yet been acked or nacked, the * server will stop sending more messages. The sending of messages resumes * once the number of outstanding bytes is less than this value. If the value * is <= 0, there is no limit to the number of outstanding bytes. This * property can only be set on the initial StreamingPullRequest. If it is set * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * * Generated from protobuf field int64 max_outstanding_bytes = 8; * @return int|string */ public function getMaxOutstandingBytes() { return $this->max_outstanding_bytes; } /** * Flow control settings for the maximum number of outstanding bytes. When * there are `max_outstanding_bytes` or more worth of messages currently sent * to the streaming pull client that have not yet been acked or nacked, the * server will stop sending more messages. The sending of messages resumes * once the number of outstanding bytes is less than this value. If the value * is <= 0, there is no limit to the number of outstanding bytes. This * property can only be set on the initial StreamingPullRequest. If it is set * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * * Generated from protobuf field int64 max_outstanding_bytes = 8; * @param int|string $var * @return $this */ public function setMaxOutstandingBytes($var) { GPBUtil::checkInt64($var); $this->max_outstanding_bytes = $var; return $this; } }