From 668d9a87eb8907dc7adf2dbe1fee8db891761bda Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 25 Jan 2024 11:13:57 -0800 Subject: [PATCH] feat: add enforce_in_transit fields and optional annotations (#6998) PiperOrigin-RevId: 601205737 Source-Link: https://github.com/googleapis/googleapis/commit/27f83015e8aacb6695f56435b3185f6d45fad995 Source-Link: https://github.com/googleapis/googleapis-gen/commit/daf775c7ecd90de69e1304b840a28d201c025f08 Copy-Tag: eyJwIjoiUHViU3ViLy5Pd2xCb3QueWFtbCIsImgiOiJkYWY3NzVjN2VjZDkwZGU2OWUxMzA0Yjg0MGEyOGQyMDFjMDI1ZjA4In0= --- PubSub/metadata/V1/Pubsub.php | Bin 14949 -> 15557 bytes .../V1/PublisherClient/update_topic.php | 4 +- .../SubscriberClient/modify_ack_deadline.php | 3 +- .../V1/SubscriberClient/update_snapshot.php | 3 +- .../SubscriberClient/update_subscription.php | 5 +- PubSub/src/V1/BigQueryConfig.php | 66 +-- PubSub/src/V1/BigQueryConfig/State.php | 8 + PubSub/src/V1/Client/PublisherClient.php | 4 +- PubSub/src/V1/Client/SubscriberClient.php | 8 +- PubSub/src/V1/CloudStorageConfig.php | 138 +++--- .../src/V1/CloudStorageConfig/AvroConfig.php | 54 +-- PubSub/src/V1/CloudStorageConfig/State.php | 8 + PubSub/src/V1/CreateSchemaRequest.php | 20 +- PubSub/src/V1/CreateSnapshotRequest.php | 14 +- PubSub/src/V1/DeadLetterPolicy.php | 68 +-- PubSub/src/V1/ExpirationPolicy.php | 54 +-- PubSub/src/V1/Gapic/PublisherGapicClient.php | 31 +- .../src/V1/Gapic/SchemaServiceGapicClient.php | 4 +- PubSub/src/V1/Gapic/SubscriberGapicClient.php | 99 ++--- PubSub/src/V1/ListSnapshotsRequest.php | 44 +- PubSub/src/V1/ListSnapshotsResponse.php | 40 +- PubSub/src/V1/ListSubscriptionsRequest.php | 44 +- PubSub/src/V1/ListSubscriptionsResponse.php | 36 +- PubSub/src/V1/ListTopicSnapshotsRequest.php | 44 +- PubSub/src/V1/ListTopicSnapshotsResponse.php | 36 +- .../src/V1/ListTopicSubscriptionsRequest.php | 44 +- .../src/V1/ListTopicSubscriptionsResponse.php | 40 +- PubSub/src/V1/ListTopicsRequest.php | 44 +- PubSub/src/V1/ListTopicsResponse.php | 36 +- PubSub/src/V1/MessageStoragePolicy.php | 104 +++-- PubSub/src/V1/ModifyAckDeadlineRequest.php | 15 +- PubSub/src/V1/PublishResponse.php | 30 +- PubSub/src/V1/PubsubMessage.php | 106 ++--- PubSub/src/V1/PullResponse.php | 22 +- PubSub/src/V1/PushConfig.php | 81 ++-- PubSub/src/V1/PushConfig/NoWrapper.php | 14 +- PubSub/src/V1/PushConfig/OidcToken.php | 72 ++-- PubSub/src/V1/ReceivedMessage.php | 50 +-- PubSub/src/V1/RetryPolicy.php | 50 ++- PubSub/src/V1/SchemaSettings.php | 74 ++-- PubSub/src/V1/SeekRequest.php | 32 +- PubSub/src/V1/Snapshot.php | 60 +-- PubSub/src/V1/StreamingPullRequest.php | 232 +++++----- PubSub/src/V1/StreamingPullResponse.php | 72 ++-- .../AcknowledgeConfirmation.php | 68 +-- .../ModifyAckDeadlineConfirmation.php | 54 +-- .../SubscriptionProperties.php | 32 +- PubSub/src/V1/Subscription.php | 408 +++++++++--------- PubSub/src/V1/Topic.php | 144 ++++--- 49 files changed, 1424 insertions(+), 1295 deletions(-) diff --git a/PubSub/metadata/V1/Pubsub.php b/PubSub/metadata/V1/Pubsub.php index 4b45719ac08567d51b4a3f65a0d5baa427053faa..e3cf087b9028cd923209c8b400835d99ab0906b4 100644 GIT binary patch delta 2471 zcmb7GO>7%Q6lUzWwkLni62}|Iv7NQ!q)kg`(%^=Ewq$nV~?99_O96- zhb9DCBvhdyM5|XJT8X~{qKEP)AE*$Q9!fz#InWdT9FTxYaN-QJyOYFfFU@UsX5M?> z`{sM^?eFx)+(+NIUGF|!`PQ96ZUr~PgfED?p}~{r9&-PhMnVh=M9b?&mdL6mQ$x{A zm5Q!7>h{?eq-)Uc8A0n|!LxR^V-m$pdDSqfY>-*iRCP^ObE2DB_?`2194IJv9oH-! zSAO#RjnJp?wKsycz@OfJuVb|zqQ1S7vu?$8GeuLLA#<{(6p83rvKDs2f^TcWxfaIt zrb1OSuM$%(&6}ck3AQi z9FHULG9GrU;1=E&W> z!$jYT{ZB$uV|yzzGc~1TPV2Oq8o`dhxqqzj3-k|2fum>>%m>!<9CyO|fvtSK5B>-Y z@!OGDD?A(byOAKlBTeo6hOGd;9)v4R1M8eOPT~;Jl&J!d7vE^{iA7wkACIsj;#fS0 zSLM|LC5BkHEW}~R2s^p^EpSojk2;rw*q0+z$xf4;*tqO(HT)nX9lVwQgfSF2jcX?f zHRdMtf|{KZHp7YLKJIQaTxjk)ZM&0>;J|L8(G^suhw)sq4%yAu17iIywrsz$3r?}2h~7f&M%p9BXSNFxsjqwsHVh<_m=4cl4< zoD@e;crW&ktGR5(lD)vto5Yw^Sw~W`S-q@LnG_Y(!NoIVBrD~dO0=v~KhAczak0dY z8cL}|jBq#hkLmnFXu}Q97%H{iohnx4*V@RPqG9#?XzDK)ZWvNe9x5}|c(MZaP)jUT zNkT3ZkKW_VE?38w5QjHHZCsq!LXW%7A^6JQ1G~h5E+K(qqhoSrGCg*9G$S7vA5LdR z$H(N!J%=-sqr=uZ;E`^@g4h#_;6|o9Ce|X6O9siSr|cKx97N!{7~)j#hwsJRoZJV5 z{UEh2e{F!LT6^0aakAR8lrc3&iPJ6J_C8!~9bdZ|VtgOI_|tm8*sHNgFXk;eaPR7 iYpBY8T3ql}XWSVIto;pO-{REcgFVIYRxWhkZu%c=bEm2R delta 2028 zcma)7Uu;uV828+^tUcZO=X7mv+jZ-1|Ez34VGZcUn9z-FA(IuhfFj}Mu07qZz3px8 zy`2=)U`X(V#K5O-8i{XoQm z-|zdKj~m|`@7%I*A1ci|mJ|x@$GuNbU6)qqqM>T+C$B1Up+Vx{vc)-J9iFnyp&jt1 zZO1qXVQ)#+bVJnWnykxeRg{aoC5F-t!efsj{mo)EEy7P09D!SoNON@CZG>I}WbZ>+ z=(lG%G6PTAXL!B!&5Ngob@wwRVz|WuCACN+UU*8P7Q5OVK>82 zWPSBG)oW^1r^JVym3BK=Z8`(9uo5o7j-IC<_hLtl^+(j@bCl;;6dNHJw~h?8Osnlq z2q!R^mvv)Ft;q#_6ZiBG-02zONDyA^4_bwDI11ifQP}U=JG@2Q2JUB9czEB{6`I67 zta81e$u)zGp_6Bh1v!>VqgD(~Sc4&VKD|ZsIaqf`dzrIdm1_E`YIHE$3B&L1PtZDi zb9xl5vgt_yjd~K&zDbT`q2kN-5)ZZ)sUa0sX_0p`yPYK9hA+|l!FLpS>ezXl8d{^n z(os0yx<=V2=mx8O{L;IH5hisBLtuMLo7A;*&mGxg3g`=cC=(N zVD1qz4Ypv;I)}&v&8-z{8ZF6ZTc8f|utBevOha2IW*`@ywz5Xez{~BA4168V_z0t3MLH`kHw>!t zT`af-(vgLs1jdKfG__OIfAm4fcalr)%dtkPb)!}{#FDC2BtxiR_i2L}ep01j5vqFic-MaFzZu2ONs&uaR?W5S5J)&+&J%`i*e)+#v$ z&k3>pj23>g>#SqCAytc}Mz$wlHzy$6wPF9Fp;4*AEdNZ9BN8Oy5=T_H99KCa0+$eN z;R^@{p&Ad)KAd$+NljkJ)ip_xi<@b-%VAGTz1q@g`oLsqRT_gY6EQAahCdRqk%#*5 zKZr3{O0sJboKJ>O5?)OvITC{p*qLwstring table = 1; + * Generated from protobuf field string table = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $table = ''; /** @@ -31,23 +31,23 @@ class BigQueryConfig extends \Google\Protobuf\Internal\Message */ private $use_topic_schema = false; /** - * When true, write the subscription name, message_id, publish_time, + * Optional. When true, write the subscription name, message_id, publish_time, * attributes, and ordering_key to additional columns in the table. The * subscription name, message_id, and publish_time fields are put in their own * columns while all other message properties (other than data) are written to * a JSON object in the attributes column. * - * Generated from protobuf field bool write_metadata = 3; + * Generated from protobuf field bool write_metadata = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $write_metadata = false; /** - * When true and use_topic_schema is true, any fields that are a part of the - * topic schema that are not part of the BigQuery table schema are dropped - * when writing to BigQuery. Otherwise, the schemas must be kept in sync and - * any messages with extra fields are not written and remain in the + * Optional. When true and use_topic_schema is true, any fields that are a + * part of the topic schema that are not part of the BigQuery table schema are + * dropped when writing to BigQuery. Otherwise, the schemas must be kept in + * sync and any messages with extra fields are not written and remain in the * subscription's backlog. * - * Generated from protobuf field bool drop_unknown_fields = 4; + * Generated from protobuf field bool drop_unknown_fields = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $drop_unknown_fields = false; /** @@ -73,23 +73,23 @@ class BigQueryConfig extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $table - * The name of the table to which to write data, of the form + * Optional. The name of the table to which to write data, of the form * {projectId}.{datasetId}.{tableId} * @type bool $use_topic_schema * Optional. When true, use the topic's schema as the columns to write to in * BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be * enabled at the same time. * @type bool $write_metadata - * When true, write the subscription name, message_id, publish_time, + * Optional. When true, write the subscription name, message_id, publish_time, * attributes, and ordering_key to additional columns in the table. The * subscription name, message_id, and publish_time fields are put in their own * columns while all other message properties (other than data) are written to * a JSON object in the attributes column. * @type bool $drop_unknown_fields - * When true and use_topic_schema is true, any fields that are a part of the - * topic schema that are not part of the BigQuery table schema are dropped - * when writing to BigQuery. Otherwise, the schemas must be kept in sync and - * any messages with extra fields are not written and remain in the + * Optional. When true and use_topic_schema is true, any fields that are a + * part of the topic schema that are not part of the BigQuery table schema are + * dropped when writing to BigQuery. Otherwise, the schemas must be kept in + * sync and any messages with extra fields are not written and remain in the * subscription's backlog. * @type int $state * Output only. An output-only field that indicates whether or not the @@ -106,10 +106,10 @@ public function __construct($data = NULL) { } /** - * The name of the table to which to write data, of the form + * Optional. The name of the table to which to write data, of the form * {projectId}.{datasetId}.{tableId} * - * Generated from protobuf field string table = 1; + * Generated from protobuf field string table = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getTable() @@ -118,10 +118,10 @@ public function getTable() } /** - * The name of the table to which to write data, of the form + * Optional. The name of the table to which to write data, of the form * {projectId}.{datasetId}.{tableId} * - * Generated from protobuf field string table = 1; + * Generated from protobuf field string table = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -164,13 +164,13 @@ public function setUseTopicSchema($var) } /** - * When true, write the subscription name, message_id, publish_time, + * Optional. When true, write the subscription name, message_id, publish_time, * attributes, and ordering_key to additional columns in the table. The * subscription name, message_id, and publish_time fields are put in their own * columns while all other message properties (other than data) are written to * a JSON object in the attributes column. * - * Generated from protobuf field bool write_metadata = 3; + * Generated from protobuf field bool write_metadata = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getWriteMetadata() @@ -179,13 +179,13 @@ public function getWriteMetadata() } /** - * When true, write the subscription name, message_id, publish_time, + * Optional. When true, write the subscription name, message_id, publish_time, * attributes, and ordering_key to additional columns in the table. The * subscription name, message_id, and publish_time fields are put in their own * columns while all other message properties (other than data) are written to * a JSON object in the attributes column. * - * Generated from protobuf field bool write_metadata = 3; + * Generated from protobuf field bool write_metadata = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -198,13 +198,13 @@ public function setWriteMetadata($var) } /** - * When true and use_topic_schema is true, any fields that are a part of the - * topic schema that are not part of the BigQuery table schema are dropped - * when writing to BigQuery. Otherwise, the schemas must be kept in sync and - * any messages with extra fields are not written and remain in the + * Optional. When true and use_topic_schema is true, any fields that are a + * part of the topic schema that are not part of the BigQuery table schema are + * dropped when writing to BigQuery. Otherwise, the schemas must be kept in + * sync and any messages with extra fields are not written and remain in the * subscription's backlog. * - * Generated from protobuf field bool drop_unknown_fields = 4; + * Generated from protobuf field bool drop_unknown_fields = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getDropUnknownFields() @@ -213,13 +213,13 @@ public function getDropUnknownFields() } /** - * When true and use_topic_schema is true, any fields that are a part of the - * topic schema that are not part of the BigQuery table schema are dropped - * when writing to BigQuery. Otherwise, the schemas must be kept in sync and - * any messages with extra fields are not written and remain in the + * Optional. When true and use_topic_schema is true, any fields that are a + * part of the topic schema that are not part of the BigQuery table schema are + * dropped when writing to BigQuery. Otherwise, the schemas must be kept in + * sync and any messages with extra fields are not written and remain in the * subscription's backlog. * - * Generated from protobuf field bool drop_unknown_fields = 4; + * Generated from protobuf field bool drop_unknown_fields = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/PubSub/src/V1/BigQueryConfig/State.php b/PubSub/src/V1/BigQueryConfig/State.php index f29925666077..e92d03742eba 100644 --- a/PubSub/src/V1/BigQueryConfig/State.php +++ b/PubSub/src/V1/BigQueryConfig/State.php @@ -48,6 +48,13 @@ class State * Generated from protobuf enum SCHEMA_MISMATCH = 4; */ const SCHEMA_MISMATCH = 4; + /** + * Cannot write to the destination because enforce_in_transit is set to true + * and the destination locations are not in the allowed regions. + * + * Generated from protobuf enum IN_TRANSIT_LOCATION_RESTRICTION = 5; + */ + const IN_TRANSIT_LOCATION_RESTRICTION = 5; private static $valueToName = [ self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', @@ -55,6 +62,7 @@ class State self::PERMISSION_DENIED => 'PERMISSION_DENIED', self::NOT_FOUND => 'NOT_FOUND', self::SCHEMA_MISMATCH => 'SCHEMA_MISMATCH', + self::IN_TRANSIT_LOCATION_RESTRICTION => 'IN_TRANSIT_LOCATION_RESTRICTION', ]; public static function name($value) diff --git a/PubSub/src/V1/Client/PublisherClient.php b/PubSub/src/V1/Client/PublisherClient.php index 19884dffb27b..708b9d20cdbb 100644 --- a/PubSub/src/V1/Client/PublisherClient.php +++ b/PubSub/src/V1/Client/PublisherClient.php @@ -539,8 +539,8 @@ public function publish(PublishRequest $request, array $callOptions = []): Publi } /** - * Updates an existing topic. Note that certain properties of a - * topic are not modifiable. + * Updates an existing topic by updating the fields specified in the update + * mask. Note that certain properties of a topic are not modifiable. * * The async variant is {@see PublisherClient::updateTopicAsync()} . * diff --git a/PubSub/src/V1/Client/SubscriberClient.php b/PubSub/src/V1/Client/SubscriberClient.php index d6820789573e..7ca9aa7f4b7d 100644 --- a/PubSub/src/V1/Client/SubscriberClient.php +++ b/PubSub/src/V1/Client/SubscriberClient.php @@ -756,7 +756,8 @@ public function streamingPull(array $callOptions = []): BidiStream } /** - * Updates an existing snapshot. Snapshots are used in + * Updates an existing snapshot by updating the fields specified in the update + * mask. Snapshots are used in * [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, * which allow you to manage message acknowledgments in bulk. That is, you can * set the acknowledgment state of messages in an existing subscription to the @@ -786,8 +787,9 @@ public function updateSnapshot(UpdateSnapshotRequest $request, array $callOption } /** - * Updates an existing subscription. Note that certain properties of a - * subscription, such as its topic, are not modifiable. + * Updates an existing subscription by updating the fields specified in the + * update mask. Note that certain properties of a subscription, such as its + * topic, are not modifiable. * * The async variant is {@see SubscriberClient::updateSubscriptionAsync()} . * diff --git a/PubSub/src/V1/CloudStorageConfig.php b/PubSub/src/V1/CloudStorageConfig.php index ecafc1e53952..a0f563a6387c 100644 --- a/PubSub/src/V1/CloudStorageConfig.php +++ b/PubSub/src/V1/CloudStorageConfig.php @@ -25,34 +25,34 @@ class CloudStorageConfig extends \Google\Protobuf\Internal\Message */ private $bucket = ''; /** - * User-provided prefix for Cloud Storage filename. See the [object naming - * requirements](https://cloud.google.com/storage/docs/objects#naming). + * Optional. User-provided prefix for Cloud Storage filename. See the [object + * naming requirements](https://cloud.google.com/storage/docs/objects#naming). * - * Generated from protobuf field string filename_prefix = 2; + * Generated from protobuf field string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $filename_prefix = ''; /** - * User-provided suffix for Cloud Storage filename. See the [object naming - * requirements](https://cloud.google.com/storage/docs/objects#naming). Must - * not end in "/". + * Optional. User-provided suffix for Cloud Storage filename. See the [object + * naming requirements](https://cloud.google.com/storage/docs/objects#naming). + * Must not end in "/". * - * Generated from protobuf field string filename_suffix = 3; + * Generated from protobuf field string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $filename_suffix = ''; /** - * The maximum duration that can elapse before a new Cloud Storage file is - * created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed - * the subscription's acknowledgement deadline. + * Optional. The maximum duration that can elapse before a new Cloud Storage + * file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not + * exceed the subscription's acknowledgement deadline. * - * Generated from protobuf field .google.protobuf.Duration max_duration = 6; + * Generated from protobuf field .google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL]; */ private $max_duration = null; /** - * The maximum bytes that can be written to a Cloud Storage file before a new - * file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded - * in cases where messages are larger than the limit. + * Optional. The maximum bytes that can be written to a Cloud Storage file + * before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may + * be exceeded in cases where messages are larger than the limit. * - * Generated from protobuf field int64 max_bytes = 7; + * Generated from protobuf field int64 max_bytes = 7 [(.google.api.field_behavior) = OPTIONAL]; */ private $max_bytes = 0; /** @@ -76,24 +76,26 @@ class CloudStorageConfig extends \Google\Protobuf\Internal\Message * any prefix like "gs://". See the [bucket naming * requirements] (https://cloud.google.com/storage/docs/buckets#naming). * @type string $filename_prefix - * User-provided prefix for Cloud Storage filename. See the [object naming - * requirements](https://cloud.google.com/storage/docs/objects#naming). + * Optional. User-provided prefix for Cloud Storage filename. See the [object + * naming requirements](https://cloud.google.com/storage/docs/objects#naming). * @type string $filename_suffix - * User-provided suffix for Cloud Storage filename. See the [object naming - * requirements](https://cloud.google.com/storage/docs/objects#naming). Must - * not end in "/". + * Optional. User-provided suffix for Cloud Storage filename. See the [object + * naming requirements](https://cloud.google.com/storage/docs/objects#naming). + * Must not end in "/". * @type \Google\Cloud\PubSub\V1\CloudStorageConfig\TextConfig $text_config - * If set, message data will be written to Cloud Storage in text format. + * Optional. If set, message data will be written to Cloud Storage in text + * format. * @type \Google\Cloud\PubSub\V1\CloudStorageConfig\AvroConfig $avro_config - * If set, message data will be written to Cloud Storage in Avro format. + * Optional. If set, message data will be written to Cloud Storage in Avro + * format. * @type \Google\Protobuf\Duration $max_duration - * The maximum duration that can elapse before a new Cloud Storage file is - * created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed - * the subscription's acknowledgement deadline. + * Optional. The maximum duration that can elapse before a new Cloud Storage + * file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not + * exceed the subscription's acknowledgement deadline. * @type int|string $max_bytes - * The maximum bytes that can be written to a Cloud Storage file before a new - * file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded - * in cases where messages are larger than the limit. + * Optional. The maximum bytes that can be written to a Cloud Storage file + * before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may + * be exceeded in cases where messages are larger than the limit. * @type int $state * Output only. An output-only field that indicates whether or not the * subscription can receive messages. @@ -137,10 +139,10 @@ public function setBucket($var) } /** - * User-provided prefix for Cloud Storage filename. See the [object naming - * requirements](https://cloud.google.com/storage/docs/objects#naming). + * Optional. User-provided prefix for Cloud Storage filename. See the [object + * naming requirements](https://cloud.google.com/storage/docs/objects#naming). * - * Generated from protobuf field string filename_prefix = 2; + * Generated from protobuf field string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getFilenamePrefix() @@ -149,10 +151,10 @@ public function getFilenamePrefix() } /** - * User-provided prefix for Cloud Storage filename. See the [object naming - * requirements](https://cloud.google.com/storage/docs/objects#naming). + * Optional. User-provided prefix for Cloud Storage filename. See the [object + * naming requirements](https://cloud.google.com/storage/docs/objects#naming). * - * Generated from protobuf field string filename_prefix = 2; + * Generated from protobuf field string filename_prefix = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -165,11 +167,11 @@ public function setFilenamePrefix($var) } /** - * User-provided suffix for Cloud Storage filename. See the [object naming - * requirements](https://cloud.google.com/storage/docs/objects#naming). Must - * not end in "/". + * Optional. User-provided suffix for Cloud Storage filename. See the [object + * naming requirements](https://cloud.google.com/storage/docs/objects#naming). + * Must not end in "/". * - * Generated from protobuf field string filename_suffix = 3; + * Generated from protobuf field string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getFilenameSuffix() @@ -178,11 +180,11 @@ public function getFilenameSuffix() } /** - * User-provided suffix for Cloud Storage filename. See the [object naming - * requirements](https://cloud.google.com/storage/docs/objects#naming). Must - * not end in "/". + * Optional. User-provided suffix for Cloud Storage filename. See the [object + * naming requirements](https://cloud.google.com/storage/docs/objects#naming). + * Must not end in "/". * - * Generated from protobuf field string filename_suffix = 3; + * Generated from protobuf field string filename_suffix = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -195,9 +197,10 @@ public function setFilenameSuffix($var) } /** - * If set, message data will be written to Cloud Storage in text format. + * Optional. If set, message data will be written to Cloud Storage in text + * format. * - * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4; + * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\CloudStorageConfig\TextConfig|null */ public function getTextConfig() @@ -211,9 +214,10 @@ public function hasTextConfig() } /** - * If set, message data will be written to Cloud Storage in text format. + * Optional. If set, message data will be written to Cloud Storage in text + * format. * - * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4; + * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig.TextConfig text_config = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\CloudStorageConfig\TextConfig $var * @return $this */ @@ -226,9 +230,10 @@ public function setTextConfig($var) } /** - * If set, message data will be written to Cloud Storage in Avro format. + * Optional. If set, message data will be written to Cloud Storage in Avro + * format. * - * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5; + * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\CloudStorageConfig\AvroConfig|null */ public function getAvroConfig() @@ -242,9 +247,10 @@ public function hasAvroConfig() } /** - * If set, message data will be written to Cloud Storage in Avro format. + * Optional. If set, message data will be written to Cloud Storage in Avro + * format. * - * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5; + * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig.AvroConfig avro_config = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\CloudStorageConfig\AvroConfig $var * @return $this */ @@ -257,11 +263,11 @@ public function setAvroConfig($var) } /** - * The maximum duration that can elapse before a new Cloud Storage file is - * created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed - * the subscription's acknowledgement deadline. + * Optional. The maximum duration that can elapse before a new Cloud Storage + * file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not + * exceed the subscription's acknowledgement deadline. * - * Generated from protobuf field .google.protobuf.Duration max_duration = 6; + * Generated from protobuf field .google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Duration|null */ public function getMaxDuration() @@ -280,11 +286,11 @@ public function clearMaxDuration() } /** - * The maximum duration that can elapse before a new Cloud Storage file is - * created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed - * the subscription's acknowledgement deadline. + * Optional. The maximum duration that can elapse before a new Cloud Storage + * file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not + * exceed the subscription's acknowledgement deadline. * - * Generated from protobuf field .google.protobuf.Duration max_duration = 6; + * Generated from protobuf field .google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Duration $var * @return $this */ @@ -297,11 +303,11 @@ public function setMaxDuration($var) } /** - * The maximum bytes that can be written to a Cloud Storage file before a new - * file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded - * in cases where messages are larger than the limit. + * Optional. The maximum bytes that can be written to a Cloud Storage file + * before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may + * be exceeded in cases where messages are larger than the limit. * - * Generated from protobuf field int64 max_bytes = 7; + * Generated from protobuf field int64 max_bytes = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return int|string */ public function getMaxBytes() @@ -310,11 +316,11 @@ public function getMaxBytes() } /** - * The maximum bytes that can be written to a Cloud Storage file before a new - * file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded - * in cases where messages are larger than the limit. + * Optional. The maximum bytes that can be written to a Cloud Storage file + * before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may + * be exceeded in cases where messages are larger than the limit. * - * Generated from protobuf field int64 max_bytes = 7; + * Generated from protobuf field int64 max_bytes = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param int|string $var * @return $this */ diff --git a/PubSub/src/V1/CloudStorageConfig/AvroConfig.php b/PubSub/src/V1/CloudStorageConfig/AvroConfig.php index 60c72ba2a881..131cabf1c077 100644 --- a/PubSub/src/V1/CloudStorageConfig/AvroConfig.php +++ b/PubSub/src/V1/CloudStorageConfig/AvroConfig.php @@ -17,14 +17,14 @@ class AvroConfig extends \Google\Protobuf\Internal\Message { /** - * When true, write the subscription name, message_id, publish_time, - * attributes, and ordering_key as additional fields in the output. The - * subscription name, message_id, and publish_time fields are put in their - * own fields while all other message properties other than data (for - * example, an ordering_key, if present) are added as entries in the - * attributes map. + * Optional. When true, write the subscription name, message_id, + * publish_time, attributes, and ordering_key as additional fields in the + * output. The subscription name, message_id, and publish_time fields are + * put in their own fields while all other message properties other than + * data (for example, an ordering_key, if present) are added as entries in + * the attributes map. * - * Generated from protobuf field bool write_metadata = 1; + * Generated from protobuf field bool write_metadata = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $write_metadata = false; @@ -35,12 +35,12 @@ class AvroConfig extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $write_metadata - * When true, write the subscription name, message_id, publish_time, - * attributes, and ordering_key as additional fields in the output. The - * subscription name, message_id, and publish_time fields are put in their - * own fields while all other message properties other than data (for - * example, an ordering_key, if present) are added as entries in the - * attributes map. + * Optional. When true, write the subscription name, message_id, + * publish_time, attributes, and ordering_key as additional fields in the + * output. The subscription name, message_id, and publish_time fields are + * put in their own fields while all other message properties other than + * data (for example, an ordering_key, if present) are added as entries in + * the attributes map. * } */ public function __construct($data = NULL) { @@ -49,14 +49,14 @@ public function __construct($data = NULL) { } /** - * When true, write the subscription name, message_id, publish_time, - * attributes, and ordering_key as additional fields in the output. The - * subscription name, message_id, and publish_time fields are put in their - * own fields while all other message properties other than data (for - * example, an ordering_key, if present) are added as entries in the - * attributes map. + * Optional. When true, write the subscription name, message_id, + * publish_time, attributes, and ordering_key as additional fields in the + * output. The subscription name, message_id, and publish_time fields are + * put in their own fields while all other message properties other than + * data (for example, an ordering_key, if present) are added as entries in + * the attributes map. * - * Generated from protobuf field bool write_metadata = 1; + * Generated from protobuf field bool write_metadata = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getWriteMetadata() @@ -65,14 +65,14 @@ public function getWriteMetadata() } /** - * When true, write the subscription name, message_id, publish_time, - * attributes, and ordering_key as additional fields in the output. The - * subscription name, message_id, and publish_time fields are put in their - * own fields while all other message properties other than data (for - * example, an ordering_key, if present) are added as entries in the - * attributes map. + * Optional. When true, write the subscription name, message_id, + * publish_time, attributes, and ordering_key as additional fields in the + * output. The subscription name, message_id, and publish_time fields are + * put in their own fields while all other message properties other than + * data (for example, an ordering_key, if present) are added as entries in + * the attributes map. * - * Generated from protobuf field bool write_metadata = 1; + * Generated from protobuf field bool write_metadata = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/PubSub/src/V1/CloudStorageConfig/State.php b/PubSub/src/V1/CloudStorageConfig/State.php index 94294653873a..b9dda83eb481 100644 --- a/PubSub/src/V1/CloudStorageConfig/State.php +++ b/PubSub/src/V1/CloudStorageConfig/State.php @@ -38,12 +38,20 @@ class State * Generated from protobuf enum NOT_FOUND = 3; */ const NOT_FOUND = 3; + /** + * Cannot write to the destination because enforce_in_transit is set to true + * and the destination locations are not in the allowed regions. + * + * Generated from protobuf enum IN_TRANSIT_LOCATION_RESTRICTION = 4; + */ + const IN_TRANSIT_LOCATION_RESTRICTION = 4; private static $valueToName = [ self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', self::ACTIVE => 'ACTIVE', self::PERMISSION_DENIED => 'PERMISSION_DENIED', self::NOT_FOUND => 'NOT_FOUND', + self::IN_TRANSIT_LOCATION_RESTRICTION => 'IN_TRANSIT_LOCATION_RESTRICTION', ]; public static function name($value) diff --git a/PubSub/src/V1/CreateSchemaRequest.php b/PubSub/src/V1/CreateSchemaRequest.php index 1ae4568d1d87..5c40e30e1fea 100644 --- a/PubSub/src/V1/CreateSchemaRequest.php +++ b/PubSub/src/V1/CreateSchemaRequest.php @@ -34,8 +34,8 @@ class CreateSchemaRequest extends \Google\Protobuf\Internal\Message /** * The ID to use for the schema, which will become the final component of * the schema's resource name. - * See https://cloud.google.com/pubsub/docs/admin#resource_names for resource - * name constraints. + * See https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names for + * resource name constraints. * * Generated from protobuf field string schema_id = 3; */ @@ -53,8 +53,8 @@ class CreateSchemaRequest extends \Google\Protobuf\Internal\Message * @param string $schemaId The ID to use for the schema, which will become the final component of * the schema's resource name. * - * See https://cloud.google.com/pubsub/docs/admin#resource_names for resource - * name constraints. + * See https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names for + * resource name constraints. * * @return \Google\Cloud\PubSub\V1\CreateSchemaRequest * @@ -85,8 +85,8 @@ public static function build(string $parent, \Google\Cloud\PubSub\V1\Schema $sch * @type string $schema_id * The ID to use for the schema, which will become the final component of * the schema's resource name. - * See https://cloud.google.com/pubsub/docs/admin#resource_names for resource - * name constraints. + * See https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names for + * resource name constraints. * } */ public function __construct($data = NULL) { @@ -167,8 +167,8 @@ public function setSchema($var) /** * The ID to use for the schema, which will become the final component of * the schema's resource name. - * See https://cloud.google.com/pubsub/docs/admin#resource_names for resource - * name constraints. + * See https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names for + * resource name constraints. * * Generated from protobuf field string schema_id = 3; * @return string @@ -181,8 +181,8 @@ public function getSchemaId() /** * The ID to use for the schema, which will become the final component of * the schema's resource name. - * See https://cloud.google.com/pubsub/docs/admin#resource_names for resource - * name constraints. + * See https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names for + * resource name constraints. * * Generated from protobuf field string schema_id = 3; * @param string $var diff --git a/PubSub/src/V1/CreateSnapshotRequest.php b/PubSub/src/V1/CreateSnapshotRequest.php index 7980aeb22690..e1d9f97f9de7 100644 --- a/PubSub/src/V1/CreateSnapshotRequest.php +++ b/PubSub/src/V1/CreateSnapshotRequest.php @@ -41,10 +41,10 @@ class CreateSnapshotRequest extends \Google\Protobuf\Internal\Message */ private $subscription = ''; /** - * See [Creating and managing + * Optional. See [Creating and managing * labels](https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 3; + * Generated from protobuf field map labels = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $labels; @@ -102,7 +102,7 @@ public static function build(string $name, string $subscription): self * successful completion of the CreateSnapshot request. * Format is `projects/{project}/subscriptions/{sub}`. * @type array|\Google\Protobuf\Internal\MapField $labels - * See [Creating and managing + * Optional. See [Creating and managing * labels](https://cloud.google.com/pubsub/docs/labels). * } */ @@ -190,10 +190,10 @@ public function setSubscription($var) } /** - * See [Creating and managing + * Optional. See [Creating and managing * labels](https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 3; + * Generated from protobuf field map labels = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\MapField */ public function getLabels() @@ -202,10 +202,10 @@ public function getLabels() } /** - * See [Creating and managing + * Optional. See [Creating and managing * labels](https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 3; + * Generated from protobuf field map labels = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ diff --git a/PubSub/src/V1/DeadLetterPolicy.php b/PubSub/src/V1/DeadLetterPolicy.php index 0936fab20f48..378792b50326 100644 --- a/PubSub/src/V1/DeadLetterPolicy.php +++ b/PubSub/src/V1/DeadLetterPolicy.php @@ -19,21 +19,21 @@ class DeadLetterPolicy extends \Google\Protobuf\Internal\Message { /** - * The name of the topic to which dead letter messages should be published. - * Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service - * account associated with the enclosing subscription's parent project (i.e., - * service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have - * permission to Publish() to this topic. + * Optional. The name of the topic to which dead letter messages should be + * published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub + * service account associated with the enclosing subscription's parent project + * (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must + * have permission to Publish() to this topic. * The operation will fail if the topic does not exist. * Users should ensure that there is a subscription attached to this topic * since messages published to a topic with no subscriptions are lost. * - * Generated from protobuf field string dead_letter_topic = 1; + * Generated from protobuf field string dead_letter_topic = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $dead_letter_topic = ''; /** - * The maximum number of delivery attempts for any message. The value must be - * between 5 and 100. + * Optional. The maximum number of delivery attempts for any message. The + * value must be between 5 and 100. * The number of delivery attempts is defined as 1 + (the sum of number of * NACKs and number of times the acknowledgement deadline has been exceeded * for the message). @@ -42,7 +42,7 @@ class DeadLetterPolicy extends \Google\Protobuf\Internal\Message * This field will be honored on a best effort basis. * If this parameter is 0, a default value of 5 is used. * - * Generated from protobuf field int32 max_delivery_attempts = 2; + * Generated from protobuf field int32 max_delivery_attempts = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $max_delivery_attempts = 0; @@ -53,17 +53,17 @@ class DeadLetterPolicy extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $dead_letter_topic - * The name of the topic to which dead letter messages should be published. - * Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service - * account associated with the enclosing subscription's parent project (i.e., - * service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have - * permission to Publish() to this topic. + * Optional. The name of the topic to which dead letter messages should be + * published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub + * service account associated with the enclosing subscription's parent project + * (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must + * have permission to Publish() to this topic. * The operation will fail if the topic does not exist. * Users should ensure that there is a subscription attached to this topic * since messages published to a topic with no subscriptions are lost. * @type int $max_delivery_attempts - * The maximum number of delivery attempts for any message. The value must be - * between 5 and 100. + * Optional. The maximum number of delivery attempts for any message. The + * value must be between 5 and 100. * The number of delivery attempts is defined as 1 + (the sum of number of * NACKs and number of times the acknowledgement deadline has been exceeded * for the message). @@ -79,16 +79,16 @@ public function __construct($data = NULL) { } /** - * The name of the topic to which dead letter messages should be published. - * Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service - * account associated with the enclosing subscription's parent project (i.e., - * service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have - * permission to Publish() to this topic. + * Optional. The name of the topic to which dead letter messages should be + * published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub + * service account associated with the enclosing subscription's parent project + * (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must + * have permission to Publish() to this topic. * The operation will fail if the topic does not exist. * Users should ensure that there is a subscription attached to this topic * since messages published to a topic with no subscriptions are lost. * - * Generated from protobuf field string dead_letter_topic = 1; + * Generated from protobuf field string dead_letter_topic = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getDeadLetterTopic() @@ -97,16 +97,16 @@ public function getDeadLetterTopic() } /** - * The name of the topic to which dead letter messages should be published. - * Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service - * account associated with the enclosing subscription's parent project (i.e., - * service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have - * permission to Publish() to this topic. + * Optional. The name of the topic to which dead letter messages should be + * published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub + * service account associated with the enclosing subscription's parent project + * (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must + * have permission to Publish() to this topic. * The operation will fail if the topic does not exist. * Users should ensure that there is a subscription attached to this topic * since messages published to a topic with no subscriptions are lost. * - * Generated from protobuf field string dead_letter_topic = 1; + * Generated from protobuf field string dead_letter_topic = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -119,8 +119,8 @@ public function setDeadLetterTopic($var) } /** - * The maximum number of delivery attempts for any message. The value must be - * between 5 and 100. + * Optional. The maximum number of delivery attempts for any message. The + * value must be between 5 and 100. * The number of delivery attempts is defined as 1 + (the sum of number of * NACKs and number of times the acknowledgement deadline has been exceeded * for the message). @@ -129,7 +129,7 @@ public function setDeadLetterTopic($var) * This field will be honored on a best effort basis. * If this parameter is 0, a default value of 5 is used. * - * Generated from protobuf field int32 max_delivery_attempts = 2; + * Generated from protobuf field int32 max_delivery_attempts = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getMaxDeliveryAttempts() @@ -138,8 +138,8 @@ public function getMaxDeliveryAttempts() } /** - * The maximum number of delivery attempts for any message. The value must be - * between 5 and 100. + * Optional. The maximum number of delivery attempts for any message. The + * value must be between 5 and 100. * The number of delivery attempts is defined as 1 + (the sum of number of * NACKs and number of times the acknowledgement deadline has been exceeded * for the message). @@ -148,7 +148,7 @@ public function getMaxDeliveryAttempts() * This field will be honored on a best effort basis. * If this parameter is 0, a default value of 5 is used. * - * Generated from protobuf field int32 max_delivery_attempts = 2; + * Generated from protobuf field int32 max_delivery_attempts = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ diff --git a/PubSub/src/V1/ExpirationPolicy.php b/PubSub/src/V1/ExpirationPolicy.php index 70c850012bc3..692235cac78e 100644 --- a/PubSub/src/V1/ExpirationPolicy.php +++ b/PubSub/src/V1/ExpirationPolicy.php @@ -17,14 +17,14 @@ class ExpirationPolicy extends \Google\Protobuf\Internal\Message { /** - * Specifies the "time-to-live" duration for an associated resource. The - * resource expires if it is not active for a period of `ttl`. The definition - * of "activity" depends on the type of the associated resource. The minimum - * and maximum allowed values for `ttl` depend on the type of the associated - * resource, as well. If `ttl` is not set, the associated resource never - * expires. + * Optional. Specifies the "time-to-live" duration for an associated resource. + * The resource expires if it is not active for a period of `ttl`. The + * definition of "activity" depends on the type of the associated resource. + * The minimum and maximum allowed values for `ttl` depend on the type of the + * associated resource, as well. If `ttl` is not set, the associated resource + * never expires. * - * Generated from protobuf field .google.protobuf.Duration ttl = 1; + * Generated from protobuf field .google.protobuf.Duration ttl = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $ttl = null; @@ -35,12 +35,12 @@ class ExpirationPolicy extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Protobuf\Duration $ttl - * Specifies the "time-to-live" duration for an associated resource. The - * resource expires if it is not active for a period of `ttl`. The definition - * of "activity" depends on the type of the associated resource. The minimum - * and maximum allowed values for `ttl` depend on the type of the associated - * resource, as well. If `ttl` is not set, the associated resource never - * expires. + * Optional. Specifies the "time-to-live" duration for an associated resource. + * The resource expires if it is not active for a period of `ttl`. The + * definition of "activity" depends on the type of the associated resource. + * The minimum and maximum allowed values for `ttl` depend on the type of the + * associated resource, as well. If `ttl` is not set, the associated resource + * never expires. * } */ public function __construct($data = NULL) { @@ -49,14 +49,14 @@ public function __construct($data = NULL) { } /** - * Specifies the "time-to-live" duration for an associated resource. The - * resource expires if it is not active for a period of `ttl`. The definition - * of "activity" depends on the type of the associated resource. The minimum - * and maximum allowed values for `ttl` depend on the type of the associated - * resource, as well. If `ttl` is not set, the associated resource never - * expires. + * Optional. Specifies the "time-to-live" duration for an associated resource. + * The resource expires if it is not active for a period of `ttl`. The + * definition of "activity" depends on the type of the associated resource. + * The minimum and maximum allowed values for `ttl` depend on the type of the + * associated resource, as well. If `ttl` is not set, the associated resource + * never expires. * - * Generated from protobuf field .google.protobuf.Duration ttl = 1; + * Generated from protobuf field .google.protobuf.Duration ttl = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Duration|null */ public function getTtl() @@ -75,14 +75,14 @@ public function clearTtl() } /** - * Specifies the "time-to-live" duration for an associated resource. The - * resource expires if it is not active for a period of `ttl`. The definition - * of "activity" depends on the type of the associated resource. The minimum - * and maximum allowed values for `ttl` depend on the type of the associated - * resource, as well. If `ttl` is not set, the associated resource never - * expires. + * Optional. Specifies the "time-to-live" duration for an associated resource. + * The resource expires if it is not active for a period of `ttl`. The + * definition of "activity" depends on the type of the associated resource. + * The minimum and maximum allowed values for `ttl` depend on the type of the + * associated resource, as well. If `ttl` is not set, the associated resource + * never expires. * - * Generated from protobuf field .google.protobuf.Duration ttl = 1; + * Generated from protobuf field .google.protobuf.Duration ttl = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Duration $var * @return $this */ diff --git a/PubSub/src/V1/Gapic/PublisherGapicClient.php b/PubSub/src/V1/Gapic/PublisherGapicClient.php index 24fc93b695f7..632a71b9d510 100644 --- a/PubSub/src/V1/Gapic/PublisherGapicClient.php +++ b/PubSub/src/V1/Gapic/PublisherGapicClient.php @@ -444,27 +444,28 @@ public function __construct(array $options = []) * Optional. * * @type array $labels - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/pubsub/docs/labels). * @type MessageStoragePolicy $messageStoragePolicy - * Policy constraining the set of Google Cloud Platform regions where messages - * published to the topic may be stored. If not present, then no constraints - * are in effect. + * Optional. Policy constraining the set of Google Cloud Platform regions + * where messages published to the topic may be stored. If not present, then + * no constraints are in effect. * @type string $kmsKeyName - * The resource name of the Cloud KMS CryptoKey to be used to protect access - * to messages published on this topic. + * Optional. The resource name of the Cloud KMS CryptoKey to be used to + * protect access to messages published on this topic. * * The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. * @type SchemaSettings $schemaSettings - * Settings for validating messages published against a schema. + * Optional. Settings for validating messages published against a schema. * @type bool $satisfiesPzs - * Reserved for future use. This field is set only in responses from the - * server; it is ignored if it is set in any requests. + * Optional. Reserved for future use. This field is set only in responses from + * the server; it is ignored if it is set in any requests. * @type Duration $messageRetentionDuration - * Indicates the minimum duration to retain a message after it is published to - * the topic. If this field is set, messages published to the topic in the - * last `message_retention_duration` are always available to subscribers. For - * instance, it allows any attached subscription to [seek to a + * Optional. Indicates the minimum duration to retain a message after it is + * published to the topic. If this field is set, messages published to the + * topic in the last `message_retention_duration` are always available to + * subscribers. For instance, it allows any attached subscription to [seek to + * a * timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) * that is up to `message_retention_duration` in the past. If this field is * not set, message retention is controlled by settings on individual @@ -909,8 +910,8 @@ public function publish($topic, $messages, array $optionalArgs = []) } /** - * Updates an existing topic. Note that certain properties of a - * topic are not modifiable. + * Updates an existing topic by updating the fields specified in the update + * mask. Note that certain properties of a topic are not modifiable. * * Sample code: * ``` diff --git a/PubSub/src/V1/Gapic/SchemaServiceGapicClient.php b/PubSub/src/V1/Gapic/SchemaServiceGapicClient.php index 1a561dd8cb1f..9833b57b6fe0 100644 --- a/PubSub/src/V1/Gapic/SchemaServiceGapicClient.php +++ b/PubSub/src/V1/Gapic/SchemaServiceGapicClient.php @@ -373,8 +373,8 @@ public function commitSchema($name, $schema, array $optionalArgs = []) * The ID to use for the schema, which will become the final component of * the schema's resource name. * - * See https://cloud.google.com/pubsub/docs/admin#resource_names for resource - * name constraints. + * See https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names for + * resource name constraints. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on diff --git a/PubSub/src/V1/Gapic/SubscriberGapicClient.php b/PubSub/src/V1/Gapic/SubscriberGapicClient.php index 5a6f8ab005ee..b3aec79ffff5 100644 --- a/PubSub/src/V1/Gapic/SubscriberGapicClient.php +++ b/PubSub/src/V1/Gapic/SubscriberGapicClient.php @@ -530,7 +530,7 @@ public function acknowledge($subscription, $ackIds, array $optionalArgs = []) * Optional. * * @type array $labels - * See [Creating and managing + * Optional. See [Creating and managing * labels](https://cloud.google.com/pubsub/docs/labels). * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an @@ -596,20 +596,20 @@ public function createSnapshot($name, $subscription, array $optionalArgs = []) * Optional. * * @type PushConfig $pushConfig - * If push delivery is used with this subscription, this field is + * Optional. If push delivery is used with this subscription, this field is * used to configure it. * @type BigQueryConfig $bigqueryConfig - * If delivery to BigQuery is used with this subscription, this field is - * used to configure it. - * @type CloudStorageConfig $cloudStorageConfig - * If delivery to Google Cloud Storage is used with this subscription, this + * Optional. If delivery to BigQuery is used with this subscription, this * field is used to configure it. + * @type CloudStorageConfig $cloudStorageConfig + * Optional. If delivery to Google Cloud Storage is used with this + * subscription, this field is used to configure it. * @type int $ackDeadlineSeconds - * The approximate amount of time (on a best-effort basis) Pub/Sub waits for - * the subscriber to acknowledge receipt before resending the message. In the - * interval after the message is delivered and before it is acknowledged, it - * is considered to be _outstanding_. During that time period, the - * message will not be redelivered (on a best-effort basis). + * Optional. The approximate amount of time (on a best-effort basis) Pub/Sub + * waits for the subscriber to acknowledge receipt before resending the + * message. In the interval after the message is delivered and before it is + * acknowledged, it is considered to be _outstanding_. During that time + * period, the message will not be redelivered (on a best-effort basis). * * For pull subscriptions, this value is used as the initial value for the ack * deadline. To override this value for a given message, call @@ -626,67 +626,67 @@ public function createSnapshot($name, $subscription, array $optionalArgs = []) * If the subscriber never acknowledges the message, the Pub/Sub * system will eventually redeliver the message. * @type bool $retainAckedMessages - * Indicates whether to retain acknowledged messages. If true, then + * Optional. Indicates whether to retain acknowledged messages. If true, then * messages are not expunged from the subscription's backlog, even if they are * acknowledged, until they fall out of the `message_retention_duration` * window. This must be true if you would like to [`Seek` to a timestamp] * (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in * the past to replay previously-acknowledged messages. * @type Duration $messageRetentionDuration - * How long to retain unacknowledged messages in the subscription's backlog, - * from the moment a message is published. - * If `retain_acked_messages` is true, then this also configures the retention - * of acknowledged messages, and thus configures how far back in time a `Seek` - * can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 - * minutes. + * Optional. How long to retain unacknowledged messages in the subscription's + * backlog, from the moment a message is published. If `retain_acked_messages` + * is true, then this also configures the retention of acknowledged messages, + * and thus configures how far back in time a `Seek` can be done. Defaults to + * 7 days. Cannot be more than 7 days or less than 10 minutes. * @type array $labels - * See [Creating and managing + * Optional. See [Creating and managing * labels](https://cloud.google.com/pubsub/docs/labels). * @type bool $enableMessageOrdering - * If true, messages published with the same `ordering_key` in `PubsubMessage` - * will be delivered to the subscribers in the order in which they - * are received by the Pub/Sub system. Otherwise, they may be delivered in - * any order. + * Optional. If true, messages published with the same `ordering_key` in + * `PubsubMessage` will be delivered to the subscribers in the order in which + * they are received by the Pub/Sub system. Otherwise, they may be delivered + * in any order. * @type ExpirationPolicy $expirationPolicy - * A policy that specifies the conditions for this subscription's expiration. - * A subscription is considered active as long as any connected subscriber is - * successfully consuming messages from the subscription or is issuing - * operations on the subscription. If `expiration_policy` is not set, a - * *default policy* with `ttl` of 31 days will be used. The minimum allowed + * Optional. A policy that specifies the conditions for this subscription's + * expiration. A subscription is considered active as long as any connected + * subscriber is successfully consuming messages from the subscription or is + * issuing operations on the subscription. If `expiration_policy` is not set, + * a *default policy* with `ttl` of 31 days will be used. The minimum allowed * value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, * but `expiration_policy.ttl` is not set, the subscription never expires. * @type string $filter - * An expression written in the Pub/Sub [filter + * Optional. An expression written in the Pub/Sub [filter * language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, * then only `PubsubMessage`s whose `attributes` field matches the filter are * delivered on this subscription. If empty, then no messages are filtered * out. * @type DeadLetterPolicy $deadLetterPolicy - * A policy that specifies the conditions for dead lettering messages in - * this subscription. If dead_letter_policy is not set, dead lettering - * is disabled. + * Optional. A policy that specifies the conditions for dead lettering + * messages in this subscription. If dead_letter_policy is not set, dead + * lettering is disabled. * - * The Cloud Pub/Sub service account associated with this subscriptions's + * The Pub/Sub service account associated with this subscriptions's * parent project (i.e., * service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have * permission to Acknowledge() messages on this subscription. * @type RetryPolicy $retryPolicy - * A policy that specifies how Pub/Sub retries message delivery for this - * subscription. + * Optional. A policy that specifies how Pub/Sub retries message delivery for + * this subscription. * * If not set, the default retry policy is applied. This generally implies * that messages will be retried as soon as possible for healthy subscribers. * RetryPolicy will be triggered on NACKs or acknowledgement deadline * exceeded events for a given message. * @type bool $detached - * Indicates whether the subscription is detached from its topic. Detached - * subscriptions don't receive messages from their topic and don't retain any - * backlog. `Pull` and `StreamingPull` requests will return + * Optional. Indicates whether the subscription is detached from its topic. + * Detached subscriptions don't receive messages from their topic and don't + * retain any backlog. `Pull` and `StreamingPull` requests will return * FAILED_PRECONDITION. If the subscription is a push subscription, pushes to * the endpoint will not be made. * @type bool $enableExactlyOnceDelivery - * If true, Pub/Sub provides the following guarantees for the delivery of - * a message with a given value of `message_id` on this subscription: + * Optional. If true, Pub/Sub provides the following guarantees for the + * delivery of a message with a given value of `message_id` on this + * subscription: * * * The message sent to a subscriber is guaranteed not to be resent * before the message's acknowledgement deadline expires. @@ -1137,7 +1137,8 @@ public function listSubscriptions($project, array $optionalArgs = []) * delivery to another subscriber client. This typically results in an * increase in the rate of message redeliveries (that is, duplicates). * The minimum deadline you can specify is 0 seconds. - * The maximum deadline you can specify is 600 seconds (10 minutes). + * The maximum deadline you can specify in a single request is 600 seconds + * (10 minutes). * @param array $optionalArgs { * Optional. * @@ -1295,7 +1296,7 @@ public function pull($subscription, $maxMessages, array $optionalArgs = []) * Optional. * * @type Timestamp $time - * The time to seek to. + * Optional. The time to seek to. * Messages retained in the subscription that were published before this * time are marked as acknowledged, and messages retained in the * subscription that were published after this time are marked as @@ -1307,9 +1308,9 @@ public function pull($subscription, $maxMessages, array $optionalArgs = []) * creation time), only retained messages will be marked as unacknowledged, * and already-expunged messages will not be restored. * @type string $snapshot - * The snapshot to seek to. The snapshot's topic must be the same as that of - * the provided subscription. - * Format is `projects/{project}/snapshots/{snap}`. + * Optional. The snapshot to seek to. The snapshot's topic must be the same + * as that of the provided subscription. Format is + * `projects/{project}/snapshots/{snap}`. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on @@ -1409,7 +1410,8 @@ public function streamingPull(array $optionalArgs = []) } /** - * Updates an existing snapshot. Snapshots are used in + * Updates an existing snapshot by updating the fields specified in the update + * mask. Snapshots are used in * [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, * which allow you to manage message acknowledgments in bulk. That is, you can * set the acknowledgment state of messages in an existing subscription to the @@ -1456,8 +1458,9 @@ public function updateSnapshot($snapshot, $updateMask, array $optionalArgs = []) } /** - * Updates an existing subscription. Note that certain properties of a - * subscription, such as its topic, are not modifiable. + * Updates an existing subscription by updating the fields specified in the + * update mask. Note that certain properties of a subscription, such as its + * topic, are not modifiable. * * Sample code: * ``` diff --git a/PubSub/src/V1/ListSnapshotsRequest.php b/PubSub/src/V1/ListSnapshotsRequest.php index 8622dc5e12b4..1082fedc4d40 100644 --- a/PubSub/src/V1/ListSnapshotsRequest.php +++ b/PubSub/src/V1/ListSnapshotsRequest.php @@ -23,17 +23,17 @@ class ListSnapshotsRequest extends \Google\Protobuf\Internal\Message */ private $project = ''; /** - * Maximum number of snapshots to return. + * Optional. Maximum number of snapshots to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_size = 0; /** - * The value returned by the last `ListSnapshotsResponse`; indicates that this - * is a continuation of a prior `ListSnapshots` call, and that the system - * should return the next page of data. + * Optional. The value returned by the last `ListSnapshotsResponse`; indicates + * that this is a continuation of a prior `ListSnapshots` call, and that the + * system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_token = ''; @@ -62,11 +62,11 @@ public static function build(string $project): self * Required. The name of the project in which to list snapshots. * Format is `projects/{project-id}`. * @type int $page_size - * Maximum number of snapshots to return. + * Optional. Maximum number of snapshots to return. * @type string $page_token - * The value returned by the last `ListSnapshotsResponse`; indicates that this - * is a continuation of a prior `ListSnapshots` call, and that the system - * should return the next page of data. + * Optional. The value returned by the last `ListSnapshotsResponse`; indicates + * that this is a continuation of a prior `ListSnapshots` call, and that the + * system should return the next page of data. * } */ public function __construct($data = NULL) { @@ -103,9 +103,9 @@ public function setProject($var) } /** - * Maximum number of snapshots to return. + * Optional. Maximum number of snapshots to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getPageSize() @@ -114,9 +114,9 @@ public function getPageSize() } /** - * Maximum number of snapshots to return. + * Optional. Maximum number of snapshots to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -129,11 +129,11 @@ public function setPageSize($var) } /** - * The value returned by the last `ListSnapshotsResponse`; indicates that this - * is a continuation of a prior `ListSnapshots` call, and that the system - * should return the next page of data. + * Optional. The value returned by the last `ListSnapshotsResponse`; indicates + * that this is a continuation of a prior `ListSnapshots` call, and that the + * system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPageToken() @@ -142,11 +142,11 @@ public function getPageToken() } /** - * The value returned by the last `ListSnapshotsResponse`; indicates that this - * is a continuation of a prior `ListSnapshots` call, and that the system - * should return the next page of data. + * Optional. The value returned by the last `ListSnapshotsResponse`; indicates + * that this is a continuation of a prior `ListSnapshots` call, and that the + * system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/ListSnapshotsResponse.php b/PubSub/src/V1/ListSnapshotsResponse.php index b3a09ec0604d..bd8a28ae199f 100644 --- a/PubSub/src/V1/ListSnapshotsResponse.php +++ b/PubSub/src/V1/ListSnapshotsResponse.php @@ -16,16 +16,17 @@ class ListSnapshotsResponse extends \Google\Protobuf\Internal\Message { /** - * The resulting snapshots. + * Optional. The resulting snapshots. * - * Generated from protobuf field repeated .google.pubsub.v1.Snapshot snapshots = 1; + * Generated from protobuf field repeated .google.pubsub.v1.Snapshot snapshots = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $snapshots; /** - * If not empty, indicates that there may be more snapshot that match the - * request; this value should be passed in a new `ListSnapshotsRequest`. + * Optional. If not empty, indicates that there may be more snapshot that + * match the request; this value should be passed in a new + * `ListSnapshotsRequest`. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $next_page_token = ''; @@ -36,10 +37,11 @@ class ListSnapshotsResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\PubSub\V1\Snapshot>|\Google\Protobuf\Internal\RepeatedField $snapshots - * The resulting snapshots. + * Optional. The resulting snapshots. * @type string $next_page_token - * If not empty, indicates that there may be more snapshot that match the - * request; this value should be passed in a new `ListSnapshotsRequest`. + * Optional. If not empty, indicates that there may be more snapshot that + * match the request; this value should be passed in a new + * `ListSnapshotsRequest`. * } */ public function __construct($data = NULL) { @@ -48,9 +50,9 @@ public function __construct($data = NULL) { } /** - * The resulting snapshots. + * Optional. The resulting snapshots. * - * Generated from protobuf field repeated .google.pubsub.v1.Snapshot snapshots = 1; + * Generated from protobuf field repeated .google.pubsub.v1.Snapshot snapshots = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getSnapshots() @@ -59,9 +61,9 @@ public function getSnapshots() } /** - * The resulting snapshots. + * Optional. The resulting snapshots. * - * Generated from protobuf field repeated .google.pubsub.v1.Snapshot snapshots = 1; + * Generated from protobuf field repeated .google.pubsub.v1.Snapshot snapshots = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\PubSub\V1\Snapshot>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -74,10 +76,11 @@ public function setSnapshots($var) } /** - * If not empty, indicates that there may be more snapshot that match the - * request; this value should be passed in a new `ListSnapshotsRequest`. + * Optional. If not empty, indicates that there may be more snapshot that + * match the request; this value should be passed in a new + * `ListSnapshotsRequest`. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getNextPageToken() @@ -86,10 +89,11 @@ public function getNextPageToken() } /** - * If not empty, indicates that there may be more snapshot that match the - * request; this value should be passed in a new `ListSnapshotsRequest`. + * Optional. If not empty, indicates that there may be more snapshot that + * match the request; this value should be passed in a new + * `ListSnapshotsRequest`. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/ListSubscriptionsRequest.php b/PubSub/src/V1/ListSubscriptionsRequest.php index f80210951ed1..56246538dc0d 100644 --- a/PubSub/src/V1/ListSubscriptionsRequest.php +++ b/PubSub/src/V1/ListSubscriptionsRequest.php @@ -23,17 +23,17 @@ class ListSubscriptionsRequest extends \Google\Protobuf\Internal\Message */ private $project = ''; /** - * Maximum number of subscriptions to return. + * Optional. Maximum number of subscriptions to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_size = 0; /** - * The value returned by the last `ListSubscriptionsResponse`; indicates that - * this is a continuation of a prior `ListSubscriptions` call, and that the - * system should return the next page of data. + * Optional. The value returned by the last `ListSubscriptionsResponse`; + * indicates that this is a continuation of a prior `ListSubscriptions` call, + * and that the system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_token = ''; @@ -62,11 +62,11 @@ public static function build(string $project): self * Required. The name of the project in which to list subscriptions. * Format is `projects/{project-id}`. * @type int $page_size - * Maximum number of subscriptions to return. + * Optional. Maximum number of subscriptions to return. * @type string $page_token - * The value returned by the last `ListSubscriptionsResponse`; indicates that - * this is a continuation of a prior `ListSubscriptions` call, and that the - * system should return the next page of data. + * Optional. The value returned by the last `ListSubscriptionsResponse`; + * indicates that this is a continuation of a prior `ListSubscriptions` call, + * and that the system should return the next page of data. * } */ public function __construct($data = NULL) { @@ -103,9 +103,9 @@ public function setProject($var) } /** - * Maximum number of subscriptions to return. + * Optional. Maximum number of subscriptions to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getPageSize() @@ -114,9 +114,9 @@ public function getPageSize() } /** - * Maximum number of subscriptions to return. + * Optional. Maximum number of subscriptions to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -129,11 +129,11 @@ public function setPageSize($var) } /** - * The value returned by the last `ListSubscriptionsResponse`; indicates that - * this is a continuation of a prior `ListSubscriptions` call, and that the - * system should return the next page of data. + * Optional. The value returned by the last `ListSubscriptionsResponse`; + * indicates that this is a continuation of a prior `ListSubscriptions` call, + * and that the system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPageToken() @@ -142,11 +142,11 @@ public function getPageToken() } /** - * The value returned by the last `ListSubscriptionsResponse`; indicates that - * this is a continuation of a prior `ListSubscriptions` call, and that the - * system should return the next page of data. + * Optional. The value returned by the last `ListSubscriptionsResponse`; + * indicates that this is a continuation of a prior `ListSubscriptions` call, + * and that the system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/ListSubscriptionsResponse.php b/PubSub/src/V1/ListSubscriptionsResponse.php index 928f52c76f4d..9b9e06cc747d 100644 --- a/PubSub/src/V1/ListSubscriptionsResponse.php +++ b/PubSub/src/V1/ListSubscriptionsResponse.php @@ -16,17 +16,17 @@ class ListSubscriptionsResponse extends \Google\Protobuf\Internal\Message { /** - * The subscriptions that match the request. + * Optional. The subscriptions that match the request. * - * Generated from protobuf field repeated .google.pubsub.v1.Subscription subscriptions = 1; + * Generated from protobuf field repeated .google.pubsub.v1.Subscription subscriptions = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $subscriptions; /** - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more subscriptions that + * match the request; this value should be passed in a new * `ListSubscriptionsRequest` to get more subscriptions. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $next_page_token = ''; @@ -37,10 +37,10 @@ class ListSubscriptionsResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\PubSub\V1\Subscription>|\Google\Protobuf\Internal\RepeatedField $subscriptions - * The subscriptions that match the request. + * Optional. The subscriptions that match the request. * @type string $next_page_token - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more subscriptions that + * match the request; this value should be passed in a new * `ListSubscriptionsRequest` to get more subscriptions. * } */ @@ -50,9 +50,9 @@ public function __construct($data = NULL) { } /** - * The subscriptions that match the request. + * Optional. The subscriptions that match the request. * - * Generated from protobuf field repeated .google.pubsub.v1.Subscription subscriptions = 1; + * Generated from protobuf field repeated .google.pubsub.v1.Subscription subscriptions = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getSubscriptions() @@ -61,9 +61,9 @@ public function getSubscriptions() } /** - * The subscriptions that match the request. + * Optional. The subscriptions that match the request. * - * Generated from protobuf field repeated .google.pubsub.v1.Subscription subscriptions = 1; + * Generated from protobuf field repeated .google.pubsub.v1.Subscription subscriptions = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\PubSub\V1\Subscription>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -76,11 +76,11 @@ public function setSubscriptions($var) } /** - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more subscriptions that + * match the request; this value should be passed in a new * `ListSubscriptionsRequest` to get more subscriptions. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getNextPageToken() @@ -89,11 +89,11 @@ public function getNextPageToken() } /** - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more subscriptions that + * match the request; this value should be passed in a new * `ListSubscriptionsRequest` to get more subscriptions. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/ListTopicSnapshotsRequest.php b/PubSub/src/V1/ListTopicSnapshotsRequest.php index 2b4796b760cd..ba9e12ecd00a 100644 --- a/PubSub/src/V1/ListTopicSnapshotsRequest.php +++ b/PubSub/src/V1/ListTopicSnapshotsRequest.php @@ -23,17 +23,17 @@ class ListTopicSnapshotsRequest extends \Google\Protobuf\Internal\Message */ private $topic = ''; /** - * Maximum number of snapshot names to return. + * Optional. Maximum number of snapshot names to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_size = 0; /** - * The value returned by the last `ListTopicSnapshotsResponse`; indicates - * that this is a continuation of a prior `ListTopicSnapshots` call, and - * that the system should return the next page of data. + * Optional. The value returned by the last `ListTopicSnapshotsResponse`; + * indicates that this is a continuation of a prior `ListTopicSnapshots` call, + * and that the system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_token = ''; @@ -62,11 +62,11 @@ public static function build(string $topic): self * Required. The name of the topic that snapshots are attached to. * Format is `projects/{project}/topics/{topic}`. * @type int $page_size - * Maximum number of snapshot names to return. + * Optional. Maximum number of snapshot names to return. * @type string $page_token - * The value returned by the last `ListTopicSnapshotsResponse`; indicates - * that this is a continuation of a prior `ListTopicSnapshots` call, and - * that the system should return the next page of data. + * Optional. The value returned by the last `ListTopicSnapshotsResponse`; + * indicates that this is a continuation of a prior `ListTopicSnapshots` call, + * and that the system should return the next page of data. * } */ public function __construct($data = NULL) { @@ -103,9 +103,9 @@ public function setTopic($var) } /** - * Maximum number of snapshot names to return. + * Optional. Maximum number of snapshot names to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getPageSize() @@ -114,9 +114,9 @@ public function getPageSize() } /** - * Maximum number of snapshot names to return. + * Optional. Maximum number of snapshot names to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -129,11 +129,11 @@ public function setPageSize($var) } /** - * The value returned by the last `ListTopicSnapshotsResponse`; indicates - * that this is a continuation of a prior `ListTopicSnapshots` call, and - * that the system should return the next page of data. + * Optional. The value returned by the last `ListTopicSnapshotsResponse`; + * indicates that this is a continuation of a prior `ListTopicSnapshots` call, + * and that the system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPageToken() @@ -142,11 +142,11 @@ public function getPageToken() } /** - * The value returned by the last `ListTopicSnapshotsResponse`; indicates - * that this is a continuation of a prior `ListTopicSnapshots` call, and - * that the system should return the next page of data. + * Optional. The value returned by the last `ListTopicSnapshotsResponse`; + * indicates that this is a continuation of a prior `ListTopicSnapshots` call, + * and that the system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/ListTopicSnapshotsResponse.php b/PubSub/src/V1/ListTopicSnapshotsResponse.php index 2821cb3fc375..99cc2b9632c7 100644 --- a/PubSub/src/V1/ListTopicSnapshotsResponse.php +++ b/PubSub/src/V1/ListTopicSnapshotsResponse.php @@ -16,17 +16,17 @@ class ListTopicSnapshotsResponse extends \Google\Protobuf\Internal\Message { /** - * The names of the snapshots that match the request. + * Optional. The names of the snapshots that match the request. * - * Generated from protobuf field repeated string snapshots = 1; + * Generated from protobuf field repeated string snapshots = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $snapshots; /** - * If not empty, indicates that there may be more snapshots that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more snapshots that + * match the request; this value should be passed in a new * `ListTopicSnapshotsRequest` to get more snapshots. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $next_page_token = ''; @@ -37,10 +37,10 @@ class ListTopicSnapshotsResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array|\Google\Protobuf\Internal\RepeatedField $snapshots - * The names of the snapshots that match the request. + * Optional. The names of the snapshots that match the request. * @type string $next_page_token - * If not empty, indicates that there may be more snapshots that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more snapshots that + * match the request; this value should be passed in a new * `ListTopicSnapshotsRequest` to get more snapshots. * } */ @@ -50,9 +50,9 @@ public function __construct($data = NULL) { } /** - * The names of the snapshots that match the request. + * Optional. The names of the snapshots that match the request. * - * Generated from protobuf field repeated string snapshots = 1; + * Generated from protobuf field repeated string snapshots = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getSnapshots() @@ -61,9 +61,9 @@ public function getSnapshots() } /** - * The names of the snapshots that match the request. + * Optional. The names of the snapshots that match the request. * - * Generated from protobuf field repeated string snapshots = 1; + * Generated from protobuf field repeated string snapshots = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -76,11 +76,11 @@ public function setSnapshots($var) } /** - * If not empty, indicates that there may be more snapshots that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more snapshots that + * match the request; this value should be passed in a new * `ListTopicSnapshotsRequest` to get more snapshots. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getNextPageToken() @@ -89,11 +89,11 @@ public function getNextPageToken() } /** - * If not empty, indicates that there may be more snapshots that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more snapshots that + * match the request; this value should be passed in a new * `ListTopicSnapshotsRequest` to get more snapshots. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/ListTopicSubscriptionsRequest.php b/PubSub/src/V1/ListTopicSubscriptionsRequest.php index 874389b6a141..69694bd483b2 100644 --- a/PubSub/src/V1/ListTopicSubscriptionsRequest.php +++ b/PubSub/src/V1/ListTopicSubscriptionsRequest.php @@ -23,17 +23,17 @@ class ListTopicSubscriptionsRequest extends \Google\Protobuf\Internal\Message */ private $topic = ''; /** - * Maximum number of subscription names to return. + * Optional. Maximum number of subscription names to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_size = 0; /** - * The value returned by the last `ListTopicSubscriptionsResponse`; indicates - * that this is a continuation of a prior `ListTopicSubscriptions` call, and - * that the system should return the next page of data. + * Optional. The value returned by the last `ListTopicSubscriptionsResponse`; + * indicates that this is a continuation of a prior `ListTopicSubscriptions` + * call, and that the system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_token = ''; @@ -62,11 +62,11 @@ public static function build(string $topic): self * Required. The name of the topic that subscriptions are attached to. * Format is `projects/{project}/topics/{topic}`. * @type int $page_size - * Maximum number of subscription names to return. + * Optional. Maximum number of subscription names to return. * @type string $page_token - * The value returned by the last `ListTopicSubscriptionsResponse`; indicates - * that this is a continuation of a prior `ListTopicSubscriptions` call, and - * that the system should return the next page of data. + * Optional. The value returned by the last `ListTopicSubscriptionsResponse`; + * indicates that this is a continuation of a prior `ListTopicSubscriptions` + * call, and that the system should return the next page of data. * } */ public function __construct($data = NULL) { @@ -103,9 +103,9 @@ public function setTopic($var) } /** - * Maximum number of subscription names to return. + * Optional. Maximum number of subscription names to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getPageSize() @@ -114,9 +114,9 @@ public function getPageSize() } /** - * Maximum number of subscription names to return. + * Optional. Maximum number of subscription names to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -129,11 +129,11 @@ public function setPageSize($var) } /** - * The value returned by the last `ListTopicSubscriptionsResponse`; indicates - * that this is a continuation of a prior `ListTopicSubscriptions` call, and - * that the system should return the next page of data. + * Optional. The value returned by the last `ListTopicSubscriptionsResponse`; + * indicates that this is a continuation of a prior `ListTopicSubscriptions` + * call, and that the system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPageToken() @@ -142,11 +142,11 @@ public function getPageToken() } /** - * The value returned by the last `ListTopicSubscriptionsResponse`; indicates - * that this is a continuation of a prior `ListTopicSubscriptions` call, and - * that the system should return the next page of data. + * Optional. The value returned by the last `ListTopicSubscriptionsResponse`; + * indicates that this is a continuation of a prior `ListTopicSubscriptions` + * call, and that the system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/ListTopicSubscriptionsResponse.php b/PubSub/src/V1/ListTopicSubscriptionsResponse.php index 7859d5aeaa07..a68a16b1bd80 100644 --- a/PubSub/src/V1/ListTopicSubscriptionsResponse.php +++ b/PubSub/src/V1/ListTopicSubscriptionsResponse.php @@ -16,17 +16,18 @@ class ListTopicSubscriptionsResponse extends \Google\Protobuf\Internal\Message { /** - * The names of subscriptions attached to the topic specified in the request. + * Optional. The names of subscriptions attached to the topic specified in the + * request. * - * Generated from protobuf field repeated string subscriptions = 1 [(.google.api.resource_reference) = { + * Generated from protobuf field repeated string subscriptions = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ private $subscriptions; /** - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more subscriptions that + * match the request; this value should be passed in a new * `ListTopicSubscriptionsRequest` to get more subscriptions. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $next_page_token = ''; @@ -37,10 +38,11 @@ class ListTopicSubscriptionsResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array|\Google\Protobuf\Internal\RepeatedField $subscriptions - * The names of subscriptions attached to the topic specified in the request. + * Optional. The names of subscriptions attached to the topic specified in the + * request. * @type string $next_page_token - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more subscriptions that + * match the request; this value should be passed in a new * `ListTopicSubscriptionsRequest` to get more subscriptions. * } */ @@ -50,9 +52,10 @@ public function __construct($data = NULL) { } /** - * The names of subscriptions attached to the topic specified in the request. + * Optional. The names of subscriptions attached to the topic specified in the + * request. * - * Generated from protobuf field repeated string subscriptions = 1 [(.google.api.resource_reference) = { + * Generated from protobuf field repeated string subscriptions = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return \Google\Protobuf\Internal\RepeatedField */ public function getSubscriptions() @@ -61,9 +64,10 @@ public function getSubscriptions() } /** - * The names of subscriptions attached to the topic specified in the request. + * Optional. The names of subscriptions attached to the topic specified in the + * request. * - * Generated from protobuf field repeated string subscriptions = 1 [(.google.api.resource_reference) = { + * Generated from protobuf field repeated string subscriptions = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -76,11 +80,11 @@ public function setSubscriptions($var) } /** - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more subscriptions that + * match the request; this value should be passed in a new * `ListTopicSubscriptionsRequest` to get more subscriptions. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getNextPageToken() @@ -89,11 +93,11 @@ public function getNextPageToken() } /** - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new + * Optional. If not empty, indicates that there may be more subscriptions that + * match the request; this value should be passed in a new * `ListTopicSubscriptionsRequest` to get more subscriptions. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/ListTopicsRequest.php b/PubSub/src/V1/ListTopicsRequest.php index a2ff6ceca7e2..d54385c94d37 100644 --- a/PubSub/src/V1/ListTopicsRequest.php +++ b/PubSub/src/V1/ListTopicsRequest.php @@ -23,17 +23,17 @@ class ListTopicsRequest extends \Google\Protobuf\Internal\Message */ private $project = ''; /** - * Maximum number of topics to return. + * Optional. Maximum number of topics to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_size = 0; /** - * The value returned by the last `ListTopicsResponse`; indicates that this is - * a continuation of a prior `ListTopics` call, and that the system should - * return the next page of data. + * Optional. The value returned by the last `ListTopicsResponse`; indicates + * that this is a continuation of a prior `ListTopics` call, and that the + * system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_token = ''; @@ -62,11 +62,11 @@ public static function build(string $project): self * Required. The name of the project in which to list topics. * Format is `projects/{project-id}`. * @type int $page_size - * Maximum number of topics to return. + * Optional. Maximum number of topics to return. * @type string $page_token - * The value returned by the last `ListTopicsResponse`; indicates that this is - * a continuation of a prior `ListTopics` call, and that the system should - * return the next page of data. + * Optional. The value returned by the last `ListTopicsResponse`; indicates + * that this is a continuation of a prior `ListTopics` call, and that the + * system should return the next page of data. * } */ public function __construct($data = NULL) { @@ -103,9 +103,9 @@ public function setProject($var) } /** - * Maximum number of topics to return. + * Optional. Maximum number of topics to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getPageSize() @@ -114,9 +114,9 @@ public function getPageSize() } /** - * Maximum number of topics to return. + * Optional. Maximum number of topics to return. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -129,11 +129,11 @@ public function setPageSize($var) } /** - * The value returned by the last `ListTopicsResponse`; indicates that this is - * a continuation of a prior `ListTopics` call, and that the system should - * return the next page of data. + * Optional. The value returned by the last `ListTopicsResponse`; indicates + * that this is a continuation of a prior `ListTopics` call, and that the + * system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPageToken() @@ -142,11 +142,11 @@ public function getPageToken() } /** - * The value returned by the last `ListTopicsResponse`; indicates that this is - * a continuation of a prior `ListTopics` call, and that the system should - * return the next page of data. + * Optional. The value returned by the last `ListTopicsResponse`; indicates + * that this is a continuation of a prior `ListTopics` call, and that the + * system should return the next page of data. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/ListTopicsResponse.php b/PubSub/src/V1/ListTopicsResponse.php index 76eef0c3bd20..b3cd8f328a83 100644 --- a/PubSub/src/V1/ListTopicsResponse.php +++ b/PubSub/src/V1/ListTopicsResponse.php @@ -16,16 +16,16 @@ class ListTopicsResponse extends \Google\Protobuf\Internal\Message { /** - * The resulting topics. + * Optional. The resulting topics. * - * Generated from protobuf field repeated .google.pubsub.v1.Topic topics = 1; + * Generated from protobuf field repeated .google.pubsub.v1.Topic topics = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $topics; /** - * If not empty, indicates that there may be more topics that match the - * request; this value should be passed in a new `ListTopicsRequest`. + * Optional. If not empty, indicates that there may be more topics that match + * the request; this value should be passed in a new `ListTopicsRequest`. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $next_page_token = ''; @@ -36,10 +36,10 @@ class ListTopicsResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\PubSub\V1\Topic>|\Google\Protobuf\Internal\RepeatedField $topics - * The resulting topics. + * Optional. The resulting topics. * @type string $next_page_token - * If not empty, indicates that there may be more topics that match the - * request; this value should be passed in a new `ListTopicsRequest`. + * Optional. If not empty, indicates that there may be more topics that match + * the request; this value should be passed in a new `ListTopicsRequest`. * } */ public function __construct($data = NULL) { @@ -48,9 +48,9 @@ public function __construct($data = NULL) { } /** - * The resulting topics. + * Optional. The resulting topics. * - * Generated from protobuf field repeated .google.pubsub.v1.Topic topics = 1; + * Generated from protobuf field repeated .google.pubsub.v1.Topic topics = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getTopics() @@ -59,9 +59,9 @@ public function getTopics() } /** - * The resulting topics. + * Optional. The resulting topics. * - * Generated from protobuf field repeated .google.pubsub.v1.Topic topics = 1; + * Generated from protobuf field repeated .google.pubsub.v1.Topic topics = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\PubSub\V1\Topic>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -74,10 +74,10 @@ public function setTopics($var) } /** - * If not empty, indicates that there may be more topics that match the - * request; this value should be passed in a new `ListTopicsRequest`. + * Optional. If not empty, indicates that there may be more topics that match + * the request; this value should be passed in a new `ListTopicsRequest`. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getNextPageToken() @@ -86,10 +86,10 @@ public function getNextPageToken() } /** - * If not empty, indicates that there may be more topics that match the - * request; this value should be passed in a new `ListTopicsRequest`. + * Optional. If not empty, indicates that there may be more topics that match + * the request; this value should be passed in a new `ListTopicsRequest`. * - * Generated from protobuf field string next_page_token = 2; + * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/MessageStoragePolicy.php b/PubSub/src/V1/MessageStoragePolicy.php index 46d734edd1b4..9a3766fd201e 100644 --- a/PubSub/src/V1/MessageStoragePolicy.php +++ b/PubSub/src/V1/MessageStoragePolicy.php @@ -16,16 +16,26 @@ class MessageStoragePolicy extends \Google\Protobuf\Internal\Message { /** - * A list of IDs of Google Cloud regions where messages that are published - * to the topic may be persisted in storage. Messages published by publishers - * running in non-allowed Google Cloud regions (or running outside of Google - * Cloud altogether) are routed for storage in one of the allowed regions. - * An empty list means that no regions are allowed, and is not a valid - * configuration. + * Optional. A list of IDs of Google Cloud regions where messages that are + * published to the topic may be persisted in storage. Messages published by + * publishers running in non-allowed Google Cloud regions (or running outside + * of Google Cloud altogether) are routed for storage in one of the allowed + * regions. An empty list means that no regions are allowed, and is not a + * valid configuration. * - * Generated from protobuf field repeated string allowed_persistence_regions = 1; + * Generated from protobuf field repeated string allowed_persistence_regions = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $allowed_persistence_regions; + /** + * Optional. If true, `allowed_persistence_regions` is also used to enforce + * in-transit guarantees for messages. That is, Pub/Sub will fail + * Publish operations on this topic and subscribe operations + * on any subscription attached to this topic in any region that is + * not in `allowed_persistence_regions`. + * + * Generated from protobuf field bool enforce_in_transit = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $enforce_in_transit = false; /** * Constructor. @@ -34,12 +44,18 @@ class MessageStoragePolicy extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array|\Google\Protobuf\Internal\RepeatedField $allowed_persistence_regions - * A list of IDs of Google Cloud regions where messages that are published - * to the topic may be persisted in storage. Messages published by publishers - * running in non-allowed Google Cloud regions (or running outside of Google - * Cloud altogether) are routed for storage in one of the allowed regions. - * An empty list means that no regions are allowed, and is not a valid - * configuration. + * Optional. A list of IDs of Google Cloud regions where messages that are + * published to the topic may be persisted in storage. Messages published by + * publishers running in non-allowed Google Cloud regions (or running outside + * of Google Cloud altogether) are routed for storage in one of the allowed + * regions. An empty list means that no regions are allowed, and is not a + * valid configuration. + * @type bool $enforce_in_transit + * Optional. If true, `allowed_persistence_regions` is also used to enforce + * in-transit guarantees for messages. That is, Pub/Sub will fail + * Publish operations on this topic and subscribe operations + * on any subscription attached to this topic in any region that is + * not in `allowed_persistence_regions`. * } */ public function __construct($data = NULL) { @@ -48,14 +64,14 @@ public function __construct($data = NULL) { } /** - * A list of IDs of Google Cloud regions where messages that are published - * to the topic may be persisted in storage. Messages published by publishers - * running in non-allowed Google Cloud regions (or running outside of Google - * Cloud altogether) are routed for storage in one of the allowed regions. - * An empty list means that no regions are allowed, and is not a valid - * configuration. + * Optional. A list of IDs of Google Cloud regions where messages that are + * published to the topic may be persisted in storage. Messages published by + * publishers running in non-allowed Google Cloud regions (or running outside + * of Google Cloud altogether) are routed for storage in one of the allowed + * regions. An empty list means that no regions are allowed, and is not a + * valid configuration. * - * Generated from protobuf field repeated string allowed_persistence_regions = 1; + * Generated from protobuf field repeated string allowed_persistence_regions = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAllowedPersistenceRegions() @@ -64,14 +80,14 @@ public function getAllowedPersistenceRegions() } /** - * A list of IDs of Google Cloud regions where messages that are published - * to the topic may be persisted in storage. Messages published by publishers - * running in non-allowed Google Cloud regions (or running outside of Google - * Cloud altogether) are routed for storage in one of the allowed regions. - * An empty list means that no regions are allowed, and is not a valid - * configuration. + * Optional. A list of IDs of Google Cloud regions where messages that are + * published to the topic may be persisted in storage. Messages published by + * publishers running in non-allowed Google Cloud regions (or running outside + * of Google Cloud altogether) are routed for storage in one of the allowed + * regions. An empty list means that no regions are allowed, and is not a + * valid configuration. * - * Generated from protobuf field repeated string allowed_persistence_regions = 1; + * Generated from protobuf field repeated string allowed_persistence_regions = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -83,5 +99,39 @@ public function setAllowedPersistenceRegions($var) return $this; } + /** + * Optional. If true, `allowed_persistence_regions` is also used to enforce + * in-transit guarantees for messages. That is, Pub/Sub will fail + * Publish operations on this topic and subscribe operations + * on any subscription attached to this topic in any region that is + * not in `allowed_persistence_regions`. + * + * Generated from protobuf field bool enforce_in_transit = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getEnforceInTransit() + { + return $this->enforce_in_transit; + } + + /** + * Optional. If true, `allowed_persistence_regions` is also used to enforce + * in-transit guarantees for messages. That is, Pub/Sub will fail + * Publish operations on this topic and subscribe operations + * on any subscription attached to this topic in any region that is + * not in `allowed_persistence_regions`. + * + * Generated from protobuf field bool enforce_in_transit = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setEnforceInTransit($var) + { + GPBUtil::checkBool($var); + $this->enforce_in_transit = $var; + + return $this; + } + } diff --git a/PubSub/src/V1/ModifyAckDeadlineRequest.php b/PubSub/src/V1/ModifyAckDeadlineRequest.php index b9d6cc87c7ff..c56cbd48b06e 100644 --- a/PubSub/src/V1/ModifyAckDeadlineRequest.php +++ b/PubSub/src/V1/ModifyAckDeadlineRequest.php @@ -36,7 +36,8 @@ class ModifyAckDeadlineRequest extends \Google\Protobuf\Internal\Message * delivery to another subscriber client. This typically results in an * increase in the rate of message redeliveries (that is, duplicates). * The minimum deadline you can specify is 0 seconds. - * The maximum deadline you can specify is 600 seconds (10 minutes). + * The maximum deadline you can specify in a single request is 600 seconds + * (10 minutes). * * Generated from protobuf field int32 ack_deadline_seconds = 3 [(.google.api.field_behavior) = REQUIRED]; */ @@ -54,7 +55,8 @@ class ModifyAckDeadlineRequest extends \Google\Protobuf\Internal\Message * delivery to another subscriber client. This typically results in an * increase in the rate of message redeliveries (that is, duplicates). * The minimum deadline you can specify is 0 seconds. - * The maximum deadline you can specify is 600 seconds (10 minutes). + * The maximum deadline you can specify in a single request is 600 seconds + * (10 minutes). * * @return \Google\Cloud\PubSub\V1\ModifyAckDeadlineRequest * @@ -87,7 +89,8 @@ public static function build(string $subscription, array $ackIds, int $ackDeadli * delivery to another subscriber client. This typically results in an * increase in the rate of message redeliveries (that is, duplicates). * The minimum deadline you can specify is 0 seconds. - * The maximum deadline you can specify is 600 seconds (10 minutes). + * The maximum deadline you can specify in a single request is 600 seconds + * (10 minutes). * } */ public function __construct($data = NULL) { @@ -157,7 +160,8 @@ public function setAckIds($var) * delivery to another subscriber client. This typically results in an * increase in the rate of message redeliveries (that is, duplicates). * The minimum deadline you can specify is 0 seconds. - * The maximum deadline you can specify is 600 seconds (10 minutes). + * The maximum deadline you can specify in a single request is 600 seconds + * (10 minutes). * * Generated from protobuf field int32 ack_deadline_seconds = 3 [(.google.api.field_behavior) = REQUIRED]; * @return int @@ -175,7 +179,8 @@ public function getAckDeadlineSeconds() * delivery to another subscriber client. This typically results in an * increase in the rate of message redeliveries (that is, duplicates). * The minimum deadline you can specify is 0 seconds. - * The maximum deadline you can specify is 600 seconds (10 minutes). + * The maximum deadline you can specify in a single request is 600 seconds + * (10 minutes). * * Generated from protobuf field int32 ack_deadline_seconds = 3 [(.google.api.field_behavior) = REQUIRED]; * @param int $var diff --git a/PubSub/src/V1/PublishResponse.php b/PubSub/src/V1/PublishResponse.php index cf4a4d2f8cf4..c36633c7d984 100644 --- a/PubSub/src/V1/PublishResponse.php +++ b/PubSub/src/V1/PublishResponse.php @@ -16,11 +16,11 @@ class PublishResponse extends \Google\Protobuf\Internal\Message { /** - * The server-assigned ID of each published message, in the same order as - * the messages in the request. IDs are guaranteed to be unique within - * the topic. + * Optional. The server-assigned ID of each published message, in the same + * order as the messages in the request. IDs are guaranteed to be unique + * within the topic. * - * Generated from protobuf field repeated string message_ids = 1; + * Generated from protobuf field repeated string message_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $message_ids; @@ -31,9 +31,9 @@ class PublishResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array|\Google\Protobuf\Internal\RepeatedField $message_ids - * The server-assigned ID of each published message, in the same order as - * the messages in the request. IDs are guaranteed to be unique within - * the topic. + * Optional. The server-assigned ID of each published message, in the same + * order as the messages in the request. IDs are guaranteed to be unique + * within the topic. * } */ public function __construct($data = NULL) { @@ -42,11 +42,11 @@ public function __construct($data = NULL) { } /** - * The server-assigned ID of each published message, in the same order as - * the messages in the request. IDs are guaranteed to be unique within - * the topic. + * Optional. The server-assigned ID of each published message, in the same + * order as the messages in the request. IDs are guaranteed to be unique + * within the topic. * - * Generated from protobuf field repeated string message_ids = 1; + * Generated from protobuf field repeated string message_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getMessageIds() @@ -55,11 +55,11 @@ public function getMessageIds() } /** - * The server-assigned ID of each published message, in the same order as - * the messages in the request. IDs are guaranteed to be unique within - * the topic. + * Optional. The server-assigned ID of each published message, in the same + * order as the messages in the request. IDs are guaranteed to be unique + * within the topic. * - * Generated from protobuf field repeated string message_ids = 1; + * Generated from protobuf field repeated string message_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ diff --git a/PubSub/src/V1/PubsubMessage.php b/PubSub/src/V1/PubsubMessage.php index 76371ccee9a5..01d028828202 100644 --- a/PubSub/src/V1/PubsubMessage.php +++ b/PubSub/src/V1/PubsubMessage.php @@ -23,18 +23,18 @@ class PubsubMessage extends \Google\Protobuf\Internal\Message { /** - * The message data field. If this field is empty, the message must contain - * at least one attribute. + * Optional. The message data field. If this field is empty, the message must + * contain at least one attribute. * - * Generated from protobuf field bytes data = 1; + * Generated from protobuf field bytes data = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $data = ''; /** - * Attributes for this message. If this field is empty, the message must - * contain non-empty data. This can be used to filter messages on the + * Optional. Attributes for this message. If this field is empty, the message + * must contain non-empty data. This can be used to filter messages on the * subscription. * - * Generated from protobuf field map attributes = 2; + * Generated from protobuf field map attributes = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $attributes; /** @@ -55,16 +55,16 @@ class PubsubMessage extends \Google\Protobuf\Internal\Message */ private $publish_time = null; /** - * If non-empty, identifies related messages for which publish order should be - * respected. If a `Subscription` has `enable_message_ordering` set to `true`, - * messages published with the same non-empty `ordering_key` value will be - * delivered to subscribers in the order in which they are received by the - * Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` - * must specify the same `ordering_key` value. - * For more information, see [ordering + * Optional. If non-empty, identifies related messages for which publish order + * should be respected. If a `Subscription` has `enable_message_ordering` set + * to `true`, messages published with the same non-empty `ordering_key` value + * will be delivered to subscribers in the order in which they are received by + * the Pub/Sub system. All `PubsubMessage`s published in a given + * `PublishRequest` must specify the same `ordering_key` value. For more + * information, see [ordering * messages](https://cloud.google.com/pubsub/docs/ordering). * - * Generated from protobuf field string ordering_key = 5; + * Generated from protobuf field string ordering_key = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $ordering_key = ''; @@ -75,11 +75,11 @@ class PubsubMessage extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $data - * The message data field. If this field is empty, the message must contain - * at least one attribute. + * Optional. The message data field. If this field is empty, the message must + * contain at least one attribute. * @type array|\Google\Protobuf\Internal\MapField $attributes - * Attributes for this message. If this field is empty, the message must - * contain non-empty data. This can be used to filter messages on the + * Optional. Attributes for this message. If this field is empty, the message + * must contain non-empty data. This can be used to filter messages on the * subscription. * @type string $message_id * ID of this message, assigned by the server when the message is published. @@ -91,13 +91,13 @@ class PubsubMessage extends \Google\Protobuf\Internal\Message * it receives the `Publish` call. It must not be populated by the * publisher in a `Publish` call. * @type string $ordering_key - * If non-empty, identifies related messages for which publish order should be - * respected. If a `Subscription` has `enable_message_ordering` set to `true`, - * messages published with the same non-empty `ordering_key` value will be - * delivered to subscribers in the order in which they are received by the - * Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` - * must specify the same `ordering_key` value. - * For more information, see [ordering + * Optional. If non-empty, identifies related messages for which publish order + * should be respected. If a `Subscription` has `enable_message_ordering` set + * to `true`, messages published with the same non-empty `ordering_key` value + * will be delivered to subscribers in the order in which they are received by + * the Pub/Sub system. All `PubsubMessage`s published in a given + * `PublishRequest` must specify the same `ordering_key` value. For more + * information, see [ordering * messages](https://cloud.google.com/pubsub/docs/ordering). * } */ @@ -107,10 +107,10 @@ public function __construct($data = NULL) { } /** - * The message data field. If this field is empty, the message must contain - * at least one attribute. + * Optional. The message data field. If this field is empty, the message must + * contain at least one attribute. * - * Generated from protobuf field bytes data = 1; + * Generated from protobuf field bytes data = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getData() @@ -119,10 +119,10 @@ public function getData() } /** - * The message data field. If this field is empty, the message must contain - * at least one attribute. + * Optional. The message data field. If this field is empty, the message must + * contain at least one attribute. * - * Generated from protobuf field bytes data = 1; + * Generated from protobuf field bytes data = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -135,11 +135,11 @@ public function setData($var) } /** - * Attributes for this message. If this field is empty, the message must - * contain non-empty data. This can be used to filter messages on the + * Optional. Attributes for this message. If this field is empty, the message + * must contain non-empty data. This can be used to filter messages on the * subscription. * - * Generated from protobuf field map attributes = 2; + * Generated from protobuf field map attributes = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\MapField */ public function getAttributes() @@ -148,11 +148,11 @@ public function getAttributes() } /** - * Attributes for this message. If this field is empty, the message must - * contain non-empty data. This can be used to filter messages on the + * Optional. Attributes for this message. If this field is empty, the message + * must contain non-empty data. This can be used to filter messages on the * subscription. * - * Generated from protobuf field map attributes = 2; + * Generated from protobuf field map attributes = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ @@ -237,16 +237,16 @@ public function setPublishTime($var) } /** - * If non-empty, identifies related messages for which publish order should be - * respected. If a `Subscription` has `enable_message_ordering` set to `true`, - * messages published with the same non-empty `ordering_key` value will be - * delivered to subscribers in the order in which they are received by the - * Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` - * must specify the same `ordering_key` value. - * For more information, see [ordering + * Optional. If non-empty, identifies related messages for which publish order + * should be respected. If a `Subscription` has `enable_message_ordering` set + * to `true`, messages published with the same non-empty `ordering_key` value + * will be delivered to subscribers in the order in which they are received by + * the Pub/Sub system. All `PubsubMessage`s published in a given + * `PublishRequest` must specify the same `ordering_key` value. For more + * information, see [ordering * messages](https://cloud.google.com/pubsub/docs/ordering). * - * Generated from protobuf field string ordering_key = 5; + * Generated from protobuf field string ordering_key = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getOrderingKey() @@ -255,16 +255,16 @@ public function getOrderingKey() } /** - * If non-empty, identifies related messages for which publish order should be - * respected. If a `Subscription` has `enable_message_ordering` set to `true`, - * messages published with the same non-empty `ordering_key` value will be - * delivered to subscribers in the order in which they are received by the - * Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` - * must specify the same `ordering_key` value. - * For more information, see [ordering + * Optional. If non-empty, identifies related messages for which publish order + * should be respected. If a `Subscription` has `enable_message_ordering` set + * to `true`, messages published with the same non-empty `ordering_key` value + * will be delivered to subscribers in the order in which they are received by + * the Pub/Sub system. All `PubsubMessage`s published in a given + * `PublishRequest` must specify the same `ordering_key` value. For more + * information, see [ordering * messages](https://cloud.google.com/pubsub/docs/ordering). * - * Generated from protobuf field string ordering_key = 5; + * Generated from protobuf field string ordering_key = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/PullResponse.php b/PubSub/src/V1/PullResponse.php index 46a47253dbb4..44c90cd8571c 100644 --- a/PubSub/src/V1/PullResponse.php +++ b/PubSub/src/V1/PullResponse.php @@ -16,13 +16,13 @@ class PullResponse extends \Google\Protobuf\Internal\Message { /** - * Received Pub/Sub messages. The list will be empty if there are no more - * messages available in the backlog, or if no messages could be returned + * Optional. Received Pub/Sub messages. The list will be empty if there are no + * more messages available in the backlog, or if no messages could be returned * before the request timeout. For JSON, the response can be entirely * empty. The Pub/Sub system may return fewer than the `maxMessages` requested * even if there are more messages available in the backlog. * - * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1; + * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $received_messages; @@ -33,8 +33,8 @@ class PullResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\PubSub\V1\ReceivedMessage>|\Google\Protobuf\Internal\RepeatedField $received_messages - * Received Pub/Sub messages. The list will be empty if there are no more - * messages available in the backlog, or if no messages could be returned + * Optional. Received Pub/Sub messages. The list will be empty if there are no + * more messages available in the backlog, or if no messages could be returned * before the request timeout. For JSON, the response can be entirely * empty. The Pub/Sub system may return fewer than the `maxMessages` requested * even if there are more messages available in the backlog. @@ -46,13 +46,13 @@ public function __construct($data = NULL) { } /** - * Received Pub/Sub messages. The list will be empty if there are no more - * messages available in the backlog, or if no messages could be returned + * Optional. Received Pub/Sub messages. The list will be empty if there are no + * more messages available in the backlog, or if no messages could be returned * before the request timeout. For JSON, the response can be entirely * empty. The Pub/Sub system may return fewer than the `maxMessages` requested * even if there are more messages available in the backlog. * - * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1; + * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getReceivedMessages() @@ -61,13 +61,13 @@ public function getReceivedMessages() } /** - * Received Pub/Sub messages. The list will be empty if there are no more - * messages available in the backlog, or if no messages could be returned + * Optional. Received Pub/Sub messages. The list will be empty if there are no + * more messages available in the backlog, or if no messages could be returned * before the request timeout. For JSON, the response can be entirely * empty. The Pub/Sub system may return fewer than the `maxMessages` requested * even if there are more messages available in the backlog. * - * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1; + * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\PubSub\V1\ReceivedMessage>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ diff --git a/PubSub/src/V1/PushConfig.php b/PubSub/src/V1/PushConfig.php index e9be58137944..e08578e9f9bb 100644 --- a/PubSub/src/V1/PushConfig.php +++ b/PubSub/src/V1/PushConfig.php @@ -16,15 +16,15 @@ class PushConfig extends \Google\Protobuf\Internal\Message { /** - * A URL locating the endpoint to which messages should be pushed. + * Optional. A URL locating the endpoint to which messages should be pushed. * For example, a Webhook endpoint might use `https://example.com/push`. * - * Generated from protobuf field string push_endpoint = 1; + * Generated from protobuf field string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $push_endpoint = ''; /** - * Endpoint configuration attributes that can be used to control different - * aspects of the message delivery. + * Optional. Endpoint configuration attributes that can be used to control + * different aspects of the message delivery. * The only currently supported attribute is `x-goog-version`, which you can * use to change the format of the pushed message. This attribute * indicates the version of the data expected by the endpoint. This @@ -40,7 +40,7 @@ class PushConfig extends \Google\Protobuf\Internal\Message * For example: * `attributes { "x-goog-version": "v1" }` * - * Generated from protobuf field map attributes = 2; + * Generated from protobuf field map attributes = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $attributes; protected $authentication_method; @@ -53,11 +53,11 @@ class PushConfig extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $push_endpoint - * A URL locating the endpoint to which messages should be pushed. + * Optional. A URL locating the endpoint to which messages should be pushed. * For example, a Webhook endpoint might use `https://example.com/push`. * @type array|\Google\Protobuf\Internal\MapField $attributes - * Endpoint configuration attributes that can be used to control different - * aspects of the message delivery. + * Optional. Endpoint configuration attributes that can be used to control + * different aspects of the message delivery. * The only currently supported attribute is `x-goog-version`, which you can * use to change the format of the pushed message. This attribute * indicates the version of the data expected by the endpoint. This @@ -73,14 +73,15 @@ class PushConfig extends \Google\Protobuf\Internal\Message * For example: * `attributes { "x-goog-version": "v1" }` * @type \Google\Cloud\PubSub\V1\PushConfig\OidcToken $oidc_token - * If specified, Pub/Sub will generate and attach an OIDC JWT token as an - * `Authorization` header in the HTTP request for every pushed message. + * Optional. If specified, Pub/Sub will generate and attach an OIDC JWT + * token as an `Authorization` header in the HTTP request for every pushed + * message. * @type \Google\Cloud\PubSub\V1\PushConfig\PubsubWrapper $pubsub_wrapper - * When set, the payload to the push endpoint is in the form of the JSON - * representation of a PubsubMessage + * Optional. When set, the payload to the push endpoint is in the form of + * the JSON representation of a PubsubMessage * (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage). * @type \Google\Cloud\PubSub\V1\PushConfig\NoWrapper $no_wrapper - * When set, the payload to the push endpoint is not wrapped. + * Optional. When set, the payload to the push endpoint is not wrapped. * } */ public function __construct($data = NULL) { @@ -89,10 +90,10 @@ public function __construct($data = NULL) { } /** - * A URL locating the endpoint to which messages should be pushed. + * Optional. A URL locating the endpoint to which messages should be pushed. * For example, a Webhook endpoint might use `https://example.com/push`. * - * Generated from protobuf field string push_endpoint = 1; + * Generated from protobuf field string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPushEndpoint() @@ -101,10 +102,10 @@ public function getPushEndpoint() } /** - * A URL locating the endpoint to which messages should be pushed. + * Optional. A URL locating the endpoint to which messages should be pushed. * For example, a Webhook endpoint might use `https://example.com/push`. * - * Generated from protobuf field string push_endpoint = 1; + * Generated from protobuf field string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -117,8 +118,8 @@ public function setPushEndpoint($var) } /** - * Endpoint configuration attributes that can be used to control different - * aspects of the message delivery. + * Optional. Endpoint configuration attributes that can be used to control + * different aspects of the message delivery. * The only currently supported attribute is `x-goog-version`, which you can * use to change the format of the pushed message. This attribute * indicates the version of the data expected by the endpoint. This @@ -134,7 +135,7 @@ public function setPushEndpoint($var) * For example: * `attributes { "x-goog-version": "v1" }` * - * Generated from protobuf field map attributes = 2; + * Generated from protobuf field map attributes = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\MapField */ public function getAttributes() @@ -143,8 +144,8 @@ public function getAttributes() } /** - * Endpoint configuration attributes that can be used to control different - * aspects of the message delivery. + * Optional. Endpoint configuration attributes that can be used to control + * different aspects of the message delivery. * The only currently supported attribute is `x-goog-version`, which you can * use to change the format of the pushed message. This attribute * indicates the version of the data expected by the endpoint. This @@ -160,7 +161,7 @@ public function getAttributes() * For example: * `attributes { "x-goog-version": "v1" }` * - * Generated from protobuf field map attributes = 2; + * Generated from protobuf field map attributes = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ @@ -173,10 +174,11 @@ public function setAttributes($var) } /** - * If specified, Pub/Sub will generate and attach an OIDC JWT token as an - * `Authorization` header in the HTTP request for every pushed message. + * Optional. If specified, Pub/Sub will generate and attach an OIDC JWT + * token as an `Authorization` header in the HTTP request for every pushed + * message. * - * Generated from protobuf field .google.pubsub.v1.PushConfig.OidcToken oidc_token = 3; + * Generated from protobuf field .google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\PushConfig\OidcToken|null */ public function getOidcToken() @@ -190,10 +192,11 @@ public function hasOidcToken() } /** - * If specified, Pub/Sub will generate and attach an OIDC JWT token as an - * `Authorization` header in the HTTP request for every pushed message. + * Optional. If specified, Pub/Sub will generate and attach an OIDC JWT + * token as an `Authorization` header in the HTTP request for every pushed + * message. * - * Generated from protobuf field .google.pubsub.v1.PushConfig.OidcToken oidc_token = 3; + * Generated from protobuf field .google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\PushConfig\OidcToken $var * @return $this */ @@ -206,11 +209,11 @@ public function setOidcToken($var) } /** - * When set, the payload to the push endpoint is in the form of the JSON - * representation of a PubsubMessage + * Optional. When set, the payload to the push endpoint is in the form of + * the JSON representation of a PubsubMessage * (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage). * - * Generated from protobuf field .google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4; + * Generated from protobuf field .google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\PushConfig\PubsubWrapper|null */ public function getPubsubWrapper() @@ -224,11 +227,11 @@ public function hasPubsubWrapper() } /** - * When set, the payload to the push endpoint is in the form of the JSON - * representation of a PubsubMessage + * Optional. When set, the payload to the push endpoint is in the form of + * the JSON representation of a PubsubMessage * (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage). * - * Generated from protobuf field .google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4; + * Generated from protobuf field .google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\PushConfig\PubsubWrapper $var * @return $this */ @@ -241,9 +244,9 @@ public function setPubsubWrapper($var) } /** - * When set, the payload to the push endpoint is not wrapped. + * Optional. When set, the payload to the push endpoint is not wrapped. * - * Generated from protobuf field .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5; + * Generated from protobuf field .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\PushConfig\NoWrapper|null */ public function getNoWrapper() @@ -257,9 +260,9 @@ public function hasNoWrapper() } /** - * When set, the payload to the push endpoint is not wrapped. + * Optional. When set, the payload to the push endpoint is not wrapped. * - * Generated from protobuf field .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5; + * Generated from protobuf field .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\PushConfig\NoWrapper $var * @return $this */ diff --git a/PubSub/src/V1/PushConfig/NoWrapper.php b/PubSub/src/V1/PushConfig/NoWrapper.php index 7b1ccedf443c..50162dc9a820 100644 --- a/PubSub/src/V1/PushConfig/NoWrapper.php +++ b/PubSub/src/V1/PushConfig/NoWrapper.php @@ -16,11 +16,11 @@ class NoWrapper extends \Google\Protobuf\Internal\Message { /** - * When true, writes the Pub/Sub message metadata to + * Optional. When true, writes the Pub/Sub message metadata to * `x-goog-pubsub-:` headers of the HTTP request. Writes the * Pub/Sub message attributes to `:` headers of the HTTP request. * - * Generated from protobuf field bool write_metadata = 1; + * Generated from protobuf field bool write_metadata = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $write_metadata = false; @@ -31,7 +31,7 @@ class NoWrapper extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $write_metadata - * When true, writes the Pub/Sub message metadata to + * Optional. When true, writes the Pub/Sub message metadata to * `x-goog-pubsub-:` headers of the HTTP request. Writes the * Pub/Sub message attributes to `:` headers of the HTTP request. * } @@ -42,11 +42,11 @@ public function __construct($data = NULL) { } /** - * When true, writes the Pub/Sub message metadata to + * Optional. When true, writes the Pub/Sub message metadata to * `x-goog-pubsub-:` headers of the HTTP request. Writes the * Pub/Sub message attributes to `:` headers of the HTTP request. * - * Generated from protobuf field bool write_metadata = 1; + * Generated from protobuf field bool write_metadata = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getWriteMetadata() @@ -55,11 +55,11 @@ public function getWriteMetadata() } /** - * When true, writes the Pub/Sub message metadata to + * Optional. When true, writes the Pub/Sub message metadata to * `x-goog-pubsub-:` headers of the HTTP request. Writes the * Pub/Sub message attributes to `:` headers of the HTTP request. * - * Generated from protobuf field bool write_metadata = 1; + * Generated from protobuf field bool write_metadata = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/PubSub/src/V1/PushConfig/OidcToken.php b/PubSub/src/V1/PushConfig/OidcToken.php index 3dc16c8da7aa..4b26b795cdca 100644 --- a/PubSub/src/V1/PushConfig/OidcToken.php +++ b/PubSub/src/V1/PushConfig/OidcToken.php @@ -18,24 +18,25 @@ class OidcToken extends \Google\Protobuf\Internal\Message { /** - * [Service account + * Optional. [Service account * email](https://cloud.google.com/iam/docs/service-accounts) * used for generating the OIDC token. For more information * on setting up authentication, see * [Push subscriptions](https://cloud.google.com/pubsub/docs/push). * - * Generated from protobuf field string service_account_email = 1; + * Generated from protobuf field string service_account_email = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $service_account_email = ''; /** - * Audience to be used when generating OIDC token. The audience claim - * identifies the recipients that the JWT is intended for. The audience - * value is a single case-sensitive string. Having multiple values (array) - * for the audience field is not supported. More info about the OIDC JWT - * token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 - * Note: if not specified, the Push endpoint URL will be used. + * Optional. Audience to be used when generating OIDC token. The audience + * claim identifies the recipients that the JWT is intended for. The + * audience value is a single case-sensitive string. Having multiple values + * (array) for the audience field is not supported. More info about the OIDC + * JWT token audience here: + * https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, + * the Push endpoint URL will be used. * - * Generated from protobuf field string audience = 2; + * Generated from protobuf field string audience = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $audience = ''; @@ -46,18 +47,19 @@ class OidcToken extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $service_account_email - * [Service account + * Optional. [Service account * email](https://cloud.google.com/iam/docs/service-accounts) * used for generating the OIDC token. For more information * on setting up authentication, see * [Push subscriptions](https://cloud.google.com/pubsub/docs/push). * @type string $audience - * Audience to be used when generating OIDC token. The audience claim - * identifies the recipients that the JWT is intended for. The audience - * value is a single case-sensitive string. Having multiple values (array) - * for the audience field is not supported. More info about the OIDC JWT - * token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 - * Note: if not specified, the Push endpoint URL will be used. + * Optional. Audience to be used when generating OIDC token. The audience + * claim identifies the recipients that the JWT is intended for. The + * audience value is a single case-sensitive string. Having multiple values + * (array) for the audience field is not supported. More info about the OIDC + * JWT token audience here: + * https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, + * the Push endpoint URL will be used. * } */ public function __construct($data = NULL) { @@ -66,13 +68,13 @@ public function __construct($data = NULL) { } /** - * [Service account + * Optional. [Service account * email](https://cloud.google.com/iam/docs/service-accounts) * used for generating the OIDC token. For more information * on setting up authentication, see * [Push subscriptions](https://cloud.google.com/pubsub/docs/push). * - * Generated from protobuf field string service_account_email = 1; + * Generated from protobuf field string service_account_email = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getServiceAccountEmail() @@ -81,13 +83,13 @@ public function getServiceAccountEmail() } /** - * [Service account + * Optional. [Service account * email](https://cloud.google.com/iam/docs/service-accounts) * used for generating the OIDC token. For more information * on setting up authentication, see * [Push subscriptions](https://cloud.google.com/pubsub/docs/push). * - * Generated from protobuf field string service_account_email = 1; + * Generated from protobuf field string service_account_email = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -100,14 +102,15 @@ public function setServiceAccountEmail($var) } /** - * Audience to be used when generating OIDC token. The audience claim - * identifies the recipients that the JWT is intended for. The audience - * value is a single case-sensitive string. Having multiple values (array) - * for the audience field is not supported. More info about the OIDC JWT - * token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 - * Note: if not specified, the Push endpoint URL will be used. + * Optional. Audience to be used when generating OIDC token. The audience + * claim identifies the recipients that the JWT is intended for. The + * audience value is a single case-sensitive string. Having multiple values + * (array) for the audience field is not supported. More info about the OIDC + * JWT token audience here: + * https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, + * the Push endpoint URL will be used. * - * Generated from protobuf field string audience = 2; + * Generated from protobuf field string audience = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getAudience() @@ -116,14 +119,15 @@ public function getAudience() } /** - * Audience to be used when generating OIDC token. The audience claim - * identifies the recipients that the JWT is intended for. The audience - * value is a single case-sensitive string. Having multiple values (array) - * for the audience field is not supported. More info about the OIDC JWT - * token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 - * Note: if not specified, the Push endpoint URL will be used. + * Optional. Audience to be used when generating OIDC token. The audience + * claim identifies the recipients that the JWT is intended for. The + * audience value is a single case-sensitive string. Having multiple values + * (array) for the audience field is not supported. More info about the OIDC + * JWT token audience here: + * https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, + * the Push endpoint URL will be used. * - * Generated from protobuf field string audience = 2; + * Generated from protobuf field string audience = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/ReceivedMessage.php b/PubSub/src/V1/ReceivedMessage.php index 7b7ef1bfa311..4c49c69b60bc 100644 --- a/PubSub/src/V1/ReceivedMessage.php +++ b/PubSub/src/V1/ReceivedMessage.php @@ -16,20 +16,20 @@ class ReceivedMessage extends \Google\Protobuf\Internal\Message { /** - * This ID can be used to acknowledge the received message. + * Optional. This ID can be used to acknowledge the received message. * - * Generated from protobuf field string ack_id = 1; + * Generated from protobuf field string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $ack_id = ''; /** - * The message. + * Optional. The message. * - * Generated from protobuf field .google.pubsub.v1.PubsubMessage message = 2; + * Generated from protobuf field .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $message = null; /** - * The approximate number of times that Cloud Pub/Sub has attempted to deliver - * the associated message to a subscriber. + * Optional. The approximate number of times that Pub/Sub has attempted to + * deliver the associated message to a subscriber. * More precisely, this is 1 + (number of NACKs) + * (number of ack_deadline exceeds) for this message. * A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline @@ -41,7 +41,7 @@ class ReceivedMessage extends \Google\Protobuf\Internal\Message * value of 1. The value is calculated at best effort and is approximate. * If a DeadLetterPolicy is not set on the subscription, this will be 0. * - * Generated from protobuf field int32 delivery_attempt = 3; + * Generated from protobuf field int32 delivery_attempt = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $delivery_attempt = 0; @@ -52,12 +52,12 @@ class ReceivedMessage extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $ack_id - * This ID can be used to acknowledge the received message. + * Optional. This ID can be used to acknowledge the received message. * @type \Google\Cloud\PubSub\V1\PubsubMessage $message - * The message. + * Optional. The message. * @type int $delivery_attempt - * The approximate number of times that Cloud Pub/Sub has attempted to deliver - * the associated message to a subscriber. + * Optional. The approximate number of times that Pub/Sub has attempted to + * deliver the associated message to a subscriber. * More precisely, this is 1 + (number of NACKs) + * (number of ack_deadline exceeds) for this message. * A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline @@ -76,9 +76,9 @@ public function __construct($data = NULL) { } /** - * This ID can be used to acknowledge the received message. + * Optional. This ID can be used to acknowledge the received message. * - * Generated from protobuf field string ack_id = 1; + * Generated from protobuf field string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getAckId() @@ -87,9 +87,9 @@ public function getAckId() } /** - * This ID can be used to acknowledge the received message. + * Optional. This ID can be used to acknowledge the received message. * - * Generated from protobuf field string ack_id = 1; + * Generated from protobuf field string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -102,9 +102,9 @@ public function setAckId($var) } /** - * The message. + * Optional. The message. * - * Generated from protobuf field .google.pubsub.v1.PubsubMessage message = 2; + * Generated from protobuf field .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\PubsubMessage|null */ public function getMessage() @@ -123,9 +123,9 @@ public function clearMessage() } /** - * The message. + * Optional. The message. * - * Generated from protobuf field .google.pubsub.v1.PubsubMessage message = 2; + * Generated from protobuf field .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\PubsubMessage $var * @return $this */ @@ -138,8 +138,8 @@ public function setMessage($var) } /** - * The approximate number of times that Cloud Pub/Sub has attempted to deliver - * the associated message to a subscriber. + * Optional. The approximate number of times that Pub/Sub has attempted to + * deliver the associated message to a subscriber. * More precisely, this is 1 + (number of NACKs) + * (number of ack_deadline exceeds) for this message. * A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline @@ -151,7 +151,7 @@ public function setMessage($var) * value of 1. The value is calculated at best effort and is approximate. * If a DeadLetterPolicy is not set on the subscription, this will be 0. * - * Generated from protobuf field int32 delivery_attempt = 3; + * Generated from protobuf field int32 delivery_attempt = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getDeliveryAttempt() @@ -160,8 +160,8 @@ public function getDeliveryAttempt() } /** - * The approximate number of times that Cloud Pub/Sub has attempted to deliver - * the associated message to a subscriber. + * Optional. The approximate number of times that Pub/Sub has attempted to + * deliver the associated message to a subscriber. * More precisely, this is 1 + (number of NACKs) + * (number of ack_deadline exceeds) for this message. * A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline @@ -173,7 +173,7 @@ public function getDeliveryAttempt() * value of 1. The value is calculated at best effort and is approximate. * If a DeadLetterPolicy is not set on the subscription, this will be 0. * - * Generated from protobuf field int32 delivery_attempt = 3; + * Generated from protobuf field int32 delivery_attempt = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ diff --git a/PubSub/src/V1/RetryPolicy.php b/PubSub/src/V1/RetryPolicy.php index 7b7591ed3c36..714b923a9a0d 100644 --- a/PubSub/src/V1/RetryPolicy.php +++ b/PubSub/src/V1/RetryPolicy.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * A policy that specifies how Cloud Pub/Sub retries message delivery. + * A policy that specifies how Pub/Sub retries message delivery. * Retry delay will be exponential based on provided minimum and maximum * backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. * RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded @@ -23,17 +23,18 @@ class RetryPolicy extends \Google\Protobuf\Internal\Message { /** - * The minimum delay between consecutive deliveries of a given message. - * Value should be between 0 and 600 seconds. Defaults to 10 seconds. + * Optional. The minimum delay between consecutive deliveries of a given + * message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. * - * Generated from protobuf field .google.protobuf.Duration minimum_backoff = 1; + * Generated from protobuf field .google.protobuf.Duration minimum_backoff = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $minimum_backoff = null; /** - * The maximum delay between consecutive deliveries of a given message. - * Value should be between 0 and 600 seconds. Defaults to 600 seconds. + * Optional. The maximum delay between consecutive deliveries of a given + * message. Value should be between 0 and 600 seconds. Defaults to 600 + * seconds. * - * Generated from protobuf field .google.protobuf.Duration maximum_backoff = 2; + * Generated from protobuf field .google.protobuf.Duration maximum_backoff = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $maximum_backoff = null; @@ -44,11 +45,12 @@ class RetryPolicy extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Protobuf\Duration $minimum_backoff - * The minimum delay between consecutive deliveries of a given message. - * Value should be between 0 and 600 seconds. Defaults to 10 seconds. + * Optional. The minimum delay between consecutive deliveries of a given + * message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. * @type \Google\Protobuf\Duration $maximum_backoff - * The maximum delay between consecutive deliveries of a given message. - * Value should be between 0 and 600 seconds. Defaults to 600 seconds. + * Optional. The maximum delay between consecutive deliveries of a given + * message. Value should be between 0 and 600 seconds. Defaults to 600 + * seconds. * } */ public function __construct($data = NULL) { @@ -57,10 +59,10 @@ public function __construct($data = NULL) { } /** - * The minimum delay between consecutive deliveries of a given message. - * Value should be between 0 and 600 seconds. Defaults to 10 seconds. + * Optional. The minimum delay between consecutive deliveries of a given + * message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. * - * Generated from protobuf field .google.protobuf.Duration minimum_backoff = 1; + * Generated from protobuf field .google.protobuf.Duration minimum_backoff = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Duration|null */ public function getMinimumBackoff() @@ -79,10 +81,10 @@ public function clearMinimumBackoff() } /** - * The minimum delay between consecutive deliveries of a given message. - * Value should be between 0 and 600 seconds. Defaults to 10 seconds. + * Optional. The minimum delay between consecutive deliveries of a given + * message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. * - * Generated from protobuf field .google.protobuf.Duration minimum_backoff = 1; + * Generated from protobuf field .google.protobuf.Duration minimum_backoff = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Duration $var * @return $this */ @@ -95,10 +97,11 @@ public function setMinimumBackoff($var) } /** - * The maximum delay between consecutive deliveries of a given message. - * Value should be between 0 and 600 seconds. Defaults to 600 seconds. + * Optional. The maximum delay between consecutive deliveries of a given + * message. Value should be between 0 and 600 seconds. Defaults to 600 + * seconds. * - * Generated from protobuf field .google.protobuf.Duration maximum_backoff = 2; + * Generated from protobuf field .google.protobuf.Duration maximum_backoff = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Duration|null */ public function getMaximumBackoff() @@ -117,10 +120,11 @@ public function clearMaximumBackoff() } /** - * The maximum delay between consecutive deliveries of a given message. - * Value should be between 0 and 600 seconds. Defaults to 600 seconds. + * Optional. The maximum delay between consecutive deliveries of a given + * message. Value should be between 0 and 600 seconds. Defaults to 600 + * seconds. * - * Generated from protobuf field .google.protobuf.Duration maximum_backoff = 2; + * Generated from protobuf field .google.protobuf.Duration maximum_backoff = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Duration $var * @return $this */ diff --git a/PubSub/src/V1/SchemaSettings.php b/PubSub/src/V1/SchemaSettings.php index 8a276b3698ec..645cf1dd9cff 100644 --- a/PubSub/src/V1/SchemaSettings.php +++ b/PubSub/src/V1/SchemaSettings.php @@ -25,25 +25,25 @@ class SchemaSettings extends \Google\Protobuf\Internal\Message */ private $schema = ''; /** - * The encoding of messages validated against `schema`. + * Optional. The encoding of messages validated against `schema`. * - * Generated from protobuf field .google.pubsub.v1.Encoding encoding = 2; + * Generated from protobuf field .google.pubsub.v1.Encoding encoding = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $encoding = 0; /** - * The minimum (inclusive) revision allowed for validating messages. If empty - * or not present, allow any revision to be validated against last_revision or - * any revision created before. + * Optional. The minimum (inclusive) revision allowed for validating messages. + * If empty or not present, allow any revision to be validated against + * last_revision or any revision created before. * - * Generated from protobuf field string first_revision_id = 3; + * Generated from protobuf field string first_revision_id = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $first_revision_id = ''; /** - * The maximum (inclusive) revision allowed for validating messages. If empty - * or not present, allow any revision to be validated against first_revision - * or any revision created after. + * Optional. The maximum (inclusive) revision allowed for validating messages. + * If empty or not present, allow any revision to be validated against + * first_revision or any revision created after. * - * Generated from protobuf field string last_revision_id = 4; + * Generated from protobuf field string last_revision_id = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $last_revision_id = ''; @@ -59,15 +59,15 @@ class SchemaSettings extends \Google\Protobuf\Internal\Message * value of this field will be `_deleted-schema_` if the schema has been * deleted. * @type int $encoding - * The encoding of messages validated against `schema`. + * Optional. The encoding of messages validated against `schema`. * @type string $first_revision_id - * The minimum (inclusive) revision allowed for validating messages. If empty - * or not present, allow any revision to be validated against last_revision or - * any revision created before. + * Optional. The minimum (inclusive) revision allowed for validating messages. + * If empty or not present, allow any revision to be validated against + * last_revision or any revision created before. * @type string $last_revision_id - * The maximum (inclusive) revision allowed for validating messages. If empty - * or not present, allow any revision to be validated against first_revision - * or any revision created after. + * Optional. The maximum (inclusive) revision allowed for validating messages. + * If empty or not present, allow any revision to be validated against + * first_revision or any revision created after. * } */ public function __construct($data = NULL) { @@ -108,9 +108,9 @@ public function setSchema($var) } /** - * The encoding of messages validated against `schema`. + * Optional. The encoding of messages validated against `schema`. * - * Generated from protobuf field .google.pubsub.v1.Encoding encoding = 2; + * Generated from protobuf field .google.pubsub.v1.Encoding encoding = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getEncoding() @@ -119,9 +119,9 @@ public function getEncoding() } /** - * The encoding of messages validated against `schema`. + * Optional. The encoding of messages validated against `schema`. * - * Generated from protobuf field .google.pubsub.v1.Encoding encoding = 2; + * Generated from protobuf field .google.pubsub.v1.Encoding encoding = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -134,11 +134,11 @@ public function setEncoding($var) } /** - * The minimum (inclusive) revision allowed for validating messages. If empty - * or not present, allow any revision to be validated against last_revision or - * any revision created before. + * Optional. The minimum (inclusive) revision allowed for validating messages. + * If empty or not present, allow any revision to be validated against + * last_revision or any revision created before. * - * Generated from protobuf field string first_revision_id = 3; + * Generated from protobuf field string first_revision_id = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getFirstRevisionId() @@ -147,11 +147,11 @@ public function getFirstRevisionId() } /** - * The minimum (inclusive) revision allowed for validating messages. If empty - * or not present, allow any revision to be validated against last_revision or - * any revision created before. + * Optional. The minimum (inclusive) revision allowed for validating messages. + * If empty or not present, allow any revision to be validated against + * last_revision or any revision created before. * - * Generated from protobuf field string first_revision_id = 3; + * Generated from protobuf field string first_revision_id = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -164,11 +164,11 @@ public function setFirstRevisionId($var) } /** - * The maximum (inclusive) revision allowed for validating messages. If empty - * or not present, allow any revision to be validated against first_revision - * or any revision created after. + * Optional. The maximum (inclusive) revision allowed for validating messages. + * If empty or not present, allow any revision to be validated against + * first_revision or any revision created after. * - * Generated from protobuf field string last_revision_id = 4; + * Generated from protobuf field string last_revision_id = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getLastRevisionId() @@ -177,11 +177,11 @@ public function getLastRevisionId() } /** - * The maximum (inclusive) revision allowed for validating messages. If empty - * or not present, allow any revision to be validated against first_revision - * or any revision created after. + * Optional. The maximum (inclusive) revision allowed for validating messages. + * If empty or not present, allow any revision to be validated against + * first_revision or any revision created after. * - * Generated from protobuf field string last_revision_id = 4; + * Generated from protobuf field string last_revision_id = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/PubSub/src/V1/SeekRequest.php b/PubSub/src/V1/SeekRequest.php index 2dde08a11f12..dea37e8acf16 100644 --- a/PubSub/src/V1/SeekRequest.php +++ b/PubSub/src/V1/SeekRequest.php @@ -32,7 +32,7 @@ class SeekRequest extends \Google\Protobuf\Internal\Message * @type string $subscription * Required. The subscription to affect. * @type \Google\Protobuf\Timestamp $time - * The time to seek to. + * Optional. The time to seek to. * Messages retained in the subscription that were published before this * time are marked as acknowledged, and messages retained in the * subscription that were published after this time are marked as @@ -44,9 +44,9 @@ class SeekRequest extends \Google\Protobuf\Internal\Message * creation time), only retained messages will be marked as unacknowledged, * and already-expunged messages will not be restored. * @type string $snapshot - * The snapshot to seek to. The snapshot's topic must be the same as that of - * the provided subscription. - * Format is `projects/{project}/snapshots/{snap}`. + * Optional. The snapshot to seek to. The snapshot's topic must be the same + * as that of the provided subscription. Format is + * `projects/{project}/snapshots/{snap}`. * } */ public function __construct($data = NULL) { @@ -81,7 +81,7 @@ public function setSubscription($var) } /** - * The time to seek to. + * Optional. The time to seek to. * Messages retained in the subscription that were published before this * time are marked as acknowledged, and messages retained in the * subscription that were published after this time are marked as @@ -93,7 +93,7 @@ public function setSubscription($var) * creation time), only retained messages will be marked as unacknowledged, * and already-expunged messages will not be restored. * - * Generated from protobuf field .google.protobuf.Timestamp time = 2; + * Generated from protobuf field .google.protobuf.Timestamp time = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Timestamp|null */ public function getTime() @@ -107,7 +107,7 @@ public function hasTime() } /** - * The time to seek to. + * Optional. The time to seek to. * Messages retained in the subscription that were published before this * time are marked as acknowledged, and messages retained in the * subscription that were published after this time are marked as @@ -119,7 +119,7 @@ public function hasTime() * creation time), only retained messages will be marked as unacknowledged, * and already-expunged messages will not be restored. * - * Generated from protobuf field .google.protobuf.Timestamp time = 2; + * Generated from protobuf field .google.protobuf.Timestamp time = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Timestamp $var * @return $this */ @@ -132,11 +132,11 @@ public function setTime($var) } /** - * The snapshot to seek to. The snapshot's topic must be the same as that of - * the provided subscription. - * Format is `projects/{project}/snapshots/{snap}`. + * Optional. The snapshot to seek to. The snapshot's topic must be the same + * as that of the provided subscription. Format is + * `projects/{project}/snapshots/{snap}`. * - * Generated from protobuf field string snapshot = 3 [(.google.api.resource_reference) = { + * Generated from protobuf field string snapshot = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string */ public function getSnapshot() @@ -150,11 +150,11 @@ public function hasSnapshot() } /** - * The snapshot to seek to. The snapshot's topic must be the same as that of - * the provided subscription. - * Format is `projects/{project}/snapshots/{snap}`. + * Optional. The snapshot to seek to. The snapshot's topic must be the same + * as that of the provided subscription. Format is + * `projects/{project}/snapshots/{snap}`. * - * Generated from protobuf field string snapshot = 3 [(.google.api.resource_reference) = { + * Generated from protobuf field string snapshot = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var * @return $this */ diff --git a/PubSub/src/V1/Snapshot.php b/PubSub/src/V1/Snapshot.php index a41bd9005850..0454bb3cb4d2 100644 --- a/PubSub/src/V1/Snapshot.php +++ b/PubSub/src/V1/Snapshot.php @@ -20,19 +20,20 @@ class Snapshot extends \Google\Protobuf\Internal\Message { /** - * The name of the snapshot. + * Optional. The name of the snapshot. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $name = ''; /** - * The name of the topic from which this snapshot is retaining messages. + * Optional. The name of the topic from which this snapshot is retaining + * messages. * - * Generated from protobuf field string topic = 2 [(.google.api.resource_reference) = { + * Generated from protobuf field string topic = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ private $topic = ''; /** - * The snapshot is guaranteed to exist up until this time. + * Optional. The snapshot is guaranteed to exist up until this time. * A newly-created snapshot expires no later than 7 days from the time of its * creation. Its exact lifetime is determined at creation by the existing * backlog in the source subscription. Specifically, the lifetime of the @@ -43,14 +44,14 @@ class Snapshot extends \Google\Protobuf\Internal\Message * exists -- will expire in 4 days. The service will refuse to create a * snapshot that would expire in less than 1 hour after creation. * - * Generated from protobuf field .google.protobuf.Timestamp expire_time = 3; + * Generated from protobuf field .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $expire_time = null; /** - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 4; + * Generated from protobuf field map labels = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $labels; @@ -61,11 +62,12 @@ class Snapshot extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * The name of the snapshot. + * Optional. The name of the snapshot. * @type string $topic - * The name of the topic from which this snapshot is retaining messages. + * Optional. The name of the topic from which this snapshot is retaining + * messages. * @type \Google\Protobuf\Timestamp $expire_time - * The snapshot is guaranteed to exist up until this time. + * Optional. The snapshot is guaranteed to exist up until this time. * A newly-created snapshot expires no later than 7 days from the time of its * creation. Its exact lifetime is determined at creation by the existing * backlog in the source subscription. Specifically, the lifetime of the @@ -76,7 +78,7 @@ class Snapshot extends \Google\Protobuf\Internal\Message * exists -- will expire in 4 days. The service will refuse to create a * snapshot that would expire in less than 1 hour after creation. * @type array|\Google\Protobuf\Internal\MapField $labels - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/pubsub/docs/labels). * } */ @@ -86,9 +88,9 @@ public function __construct($data = NULL) { } /** - * The name of the snapshot. + * Optional. The name of the snapshot. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getName() @@ -97,9 +99,9 @@ public function getName() } /** - * The name of the snapshot. + * Optional. The name of the snapshot. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -112,9 +114,10 @@ public function setName($var) } /** - * The name of the topic from which this snapshot is retaining messages. + * Optional. The name of the topic from which this snapshot is retaining + * messages. * - * Generated from protobuf field string topic = 2 [(.google.api.resource_reference) = { + * Generated from protobuf field string topic = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string */ public function getTopic() @@ -123,9 +126,10 @@ public function getTopic() } /** - * The name of the topic from which this snapshot is retaining messages. + * Optional. The name of the topic from which this snapshot is retaining + * messages. * - * Generated from protobuf field string topic = 2 [(.google.api.resource_reference) = { + * Generated from protobuf field string topic = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var * @return $this */ @@ -138,7 +142,7 @@ public function setTopic($var) } /** - * The snapshot is guaranteed to exist up until this time. + * Optional. The snapshot is guaranteed to exist up until this time. * A newly-created snapshot expires no later than 7 days from the time of its * creation. Its exact lifetime is determined at creation by the existing * backlog in the source subscription. Specifically, the lifetime of the @@ -149,7 +153,7 @@ public function setTopic($var) * exists -- will expire in 4 days. The service will refuse to create a * snapshot that would expire in less than 1 hour after creation. * - * Generated from protobuf field .google.protobuf.Timestamp expire_time = 3; + * Generated from protobuf field .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Timestamp|null */ public function getExpireTime() @@ -168,7 +172,7 @@ public function clearExpireTime() } /** - * The snapshot is guaranteed to exist up until this time. + * Optional. The snapshot is guaranteed to exist up until this time. * A newly-created snapshot expires no later than 7 days from the time of its * creation. Its exact lifetime is determined at creation by the existing * backlog in the source subscription. Specifically, the lifetime of the @@ -179,7 +183,7 @@ public function clearExpireTime() * exists -- will expire in 4 days. The service will refuse to create a * snapshot that would expire in less than 1 hour after creation. * - * Generated from protobuf field .google.protobuf.Timestamp expire_time = 3; + * Generated from protobuf field .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Timestamp $var * @return $this */ @@ -192,10 +196,10 @@ public function setExpireTime($var) } /** - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 4; + * Generated from protobuf field map labels = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\MapField */ public function getLabels() @@ -204,10 +208,10 @@ public function getLabels() } /** - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 4; + * Generated from protobuf field map labels = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ diff --git a/PubSub/src/V1/StreamingPullRequest.php b/PubSub/src/V1/StreamingPullRequest.php index b515178641dd..1997aaaa5b20 100644 --- a/PubSub/src/V1/StreamingPullRequest.php +++ b/PubSub/src/V1/StreamingPullRequest.php @@ -27,17 +27,18 @@ class StreamingPullRequest extends \Google\Protobuf\Internal\Message */ 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`. + * Optional. 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; + * Generated from protobuf field repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $ack_ids; /** - * The list of new ack deadlines for the IDs listed in + * Optional. 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 @@ -49,17 +50,17 @@ class StreamingPullRequest extends \Google\Protobuf\Internal\Message * 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; + * Generated from protobuf field repeated int32 modify_deadline_seconds = 3 [(.google.api.field_behavior) = OPTIONAL]; */ 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 + * Optional. 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; + * Generated from protobuf field repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $modify_deadline_ack_ids; /** @@ -72,19 +73,19 @@ class StreamingPullRequest extends \Google\Protobuf\Internal\Message */ 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 + * Optional. 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; + * Generated from protobuf field string client_id = 6 [(.google.api.field_behavior) = OPTIONAL]; */ 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 + * Optional. Flow control settings for the maximum number of outstanding + * messages. When there are `max_outstanding_messages` 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 @@ -93,21 +94,21 @@ class StreamingPullRequest extends \Google\Protobuf\Internal\Message * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * - * Generated from protobuf field int64 max_outstanding_messages = 7; + * Generated from protobuf field int64 max_outstanding_messages = 7 [(.google.api.field_behavior) = OPTIONAL]; */ 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 + * Optional. 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; + * Generated from protobuf field int64 max_outstanding_bytes = 8 [(.google.api.field_behavior) = OPTIONAL]; */ private $max_outstanding_bytes = 0; @@ -123,13 +124,14 @@ class StreamingPullRequest extends \Google\Protobuf\Internal\Message * 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`. + * Optional. 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 + * Optional. 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 @@ -141,9 +143,9 @@ class StreamingPullRequest extends \Google\Protobuf\Internal\Message * 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 + * Optional. 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 @@ -152,15 +154,15 @@ class StreamingPullRequest extends \Google\Protobuf\Internal\Message * 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 + * Optional. 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 + * Optional. Flow control settings for the maximum number of outstanding + * messages. When there are `max_outstanding_messages` 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 @@ -169,14 +171,14 @@ class StreamingPullRequest extends \Google\Protobuf\Internal\Message * 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 + * Optional. 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`. * } */ @@ -218,13 +220,14 @@ public function setSubscription($var) } /** - * 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`. + * Optional. 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; + * Generated from protobuf field repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAckIds() @@ -233,13 +236,14 @@ public function getAckIds() } /** - * 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`. + * Optional. 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; + * Generated from protobuf field repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -252,7 +256,7 @@ public function setAckIds($var) } /** - * The list of new ack deadlines for the IDs listed in + * Optional. 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 @@ -264,7 +268,7 @@ public function setAckIds($var) * 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; + * Generated from protobuf field repeated int32 modify_deadline_seconds = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getModifyDeadlineSeconds() @@ -273,7 +277,7 @@ public function getModifyDeadlineSeconds() } /** - * The list of new ack deadlines for the IDs listed in + * Optional. 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 @@ -285,7 +289,7 @@ public function getModifyDeadlineSeconds() * 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; + * Generated from protobuf field repeated int32 modify_deadline_seconds = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -298,13 +302,13 @@ public function setModifyDeadlineSeconds($var) } /** - * 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 + * Optional. 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; + * Generated from protobuf field repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getModifyDeadlineAckIds() @@ -313,13 +317,13 @@ public function getModifyDeadlineAckIds() } /** - * 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 + * Optional. 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; + * Generated from protobuf field repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -364,14 +368,14 @@ public function setStreamAckDeadlineSeconds($var) } /** - * 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 + * Optional. 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; + * Generated from protobuf field string client_id = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getClientId() @@ -380,14 +384,14 @@ public function getClientId() } /** - * 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 + * Optional. 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; + * Generated from protobuf field string client_id = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -400,8 +404,8 @@ public function setClientId($var) } /** - * Flow control settings for the maximum number of outstanding messages. When - * there are `max_outstanding_messages` or more currently sent to the + * Optional. Flow control settings for the maximum number of outstanding + * messages. When there are `max_outstanding_messages` 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 @@ -410,7 +414,7 @@ public function setClientId($var) * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * - * Generated from protobuf field int64 max_outstanding_messages = 7; + * Generated from protobuf field int64 max_outstanding_messages = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return int|string */ public function getMaxOutstandingMessages() @@ -419,8 +423,8 @@ public function getMaxOutstandingMessages() } /** - * Flow control settings for the maximum number of outstanding messages. When - * there are `max_outstanding_messages` or more currently sent to the + * Optional. Flow control settings for the maximum number of outstanding + * messages. When there are `max_outstanding_messages` 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 @@ -429,7 +433,7 @@ public function getMaxOutstandingMessages() * on a subsequent request, the stream will be aborted with status * `INVALID_ARGUMENT`. * - * Generated from protobuf field int64 max_outstanding_messages = 7; + * Generated from protobuf field int64 max_outstanding_messages = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param int|string $var * @return $this */ @@ -442,17 +446,17 @@ public function setMaxOutstandingMessages($var) } /** - * 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 + * Optional. 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; + * Generated from protobuf field int64 max_outstanding_bytes = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return int|string */ public function getMaxOutstandingBytes() @@ -461,17 +465,17 @@ public function getMaxOutstandingBytes() } /** - * 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 + * Optional. 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; + * Generated from protobuf field int64 max_outstanding_bytes = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param int|string $var * @return $this */ diff --git a/PubSub/src/V1/StreamingPullResponse.php b/PubSub/src/V1/StreamingPullResponse.php index fb1938abd90a..940fc7c58382 100644 --- a/PubSub/src/V1/StreamingPullResponse.php +++ b/PubSub/src/V1/StreamingPullResponse.php @@ -17,29 +17,29 @@ class StreamingPullResponse extends \Google\Protobuf\Internal\Message { /** - * Received Pub/Sub messages. This will not be empty. + * Optional. Received Pub/Sub messages. This will not be empty. * - * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1; + * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $received_messages; /** - * This field will only be set if `enable_exactly_once_delivery` is set to - * `true`. + * Optional. This field will only be set if `enable_exactly_once_delivery` is + * set to `true`. * - * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5; + * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $acknowledge_confirmation = null; /** - * This field will only be set if `enable_exactly_once_delivery` is set to - * `true`. + * Optional. This field will only be set if `enable_exactly_once_delivery` is + * set to `true`. * - * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3; + * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $modify_ack_deadline_confirmation = null; /** - * Properties associated with this subscription. + * Optional. Properties associated with this subscription. * - * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4; + * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $subscription_properties = null; @@ -50,15 +50,15 @@ class StreamingPullResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\PubSub\V1\ReceivedMessage>|\Google\Protobuf\Internal\RepeatedField $received_messages - * Received Pub/Sub messages. This will not be empty. + * Optional. Received Pub/Sub messages. This will not be empty. * @type \Google\Cloud\PubSub\V1\StreamingPullResponse\AcknowledgeConfirmation $acknowledge_confirmation - * This field will only be set if `enable_exactly_once_delivery` is set to - * `true`. + * Optional. This field will only be set if `enable_exactly_once_delivery` is + * set to `true`. * @type \Google\Cloud\PubSub\V1\StreamingPullResponse\ModifyAckDeadlineConfirmation $modify_ack_deadline_confirmation - * This field will only be set if `enable_exactly_once_delivery` is set to - * `true`. + * Optional. This field will only be set if `enable_exactly_once_delivery` is + * set to `true`. * @type \Google\Cloud\PubSub\V1\StreamingPullResponse\SubscriptionProperties $subscription_properties - * Properties associated with this subscription. + * Optional. Properties associated with this subscription. * } */ public function __construct($data = NULL) { @@ -67,9 +67,9 @@ public function __construct($data = NULL) { } /** - * Received Pub/Sub messages. This will not be empty. + * Optional. Received Pub/Sub messages. This will not be empty. * - * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1; + * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getReceivedMessages() @@ -78,9 +78,9 @@ public function getReceivedMessages() } /** - * Received Pub/Sub messages. This will not be empty. + * Optional. Received Pub/Sub messages. This will not be empty. * - * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1; + * Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\PubSub\V1\ReceivedMessage>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -93,10 +93,10 @@ public function setReceivedMessages($var) } /** - * This field will only be set if `enable_exactly_once_delivery` is set to - * `true`. + * Optional. This field will only be set if `enable_exactly_once_delivery` is + * set to `true`. * - * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5; + * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\StreamingPullResponse\AcknowledgeConfirmation|null */ public function getAcknowledgeConfirmation() @@ -115,10 +115,10 @@ public function clearAcknowledgeConfirmation() } /** - * This field will only be set if `enable_exactly_once_delivery` is set to - * `true`. + * Optional. This field will only be set if `enable_exactly_once_delivery` is + * set to `true`. * - * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5; + * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\StreamingPullResponse\AcknowledgeConfirmation $var * @return $this */ @@ -131,10 +131,10 @@ public function setAcknowledgeConfirmation($var) } /** - * This field will only be set if `enable_exactly_once_delivery` is set to - * `true`. + * Optional. This field will only be set if `enable_exactly_once_delivery` is + * set to `true`. * - * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3; + * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\StreamingPullResponse\ModifyAckDeadlineConfirmation|null */ public function getModifyAckDeadlineConfirmation() @@ -153,10 +153,10 @@ public function clearModifyAckDeadlineConfirmation() } /** - * This field will only be set if `enable_exactly_once_delivery` is set to - * `true`. + * Optional. This field will only be set if `enable_exactly_once_delivery` is + * set to `true`. * - * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3; + * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\StreamingPullResponse\ModifyAckDeadlineConfirmation $var * @return $this */ @@ -169,9 +169,9 @@ public function setModifyAckDeadlineConfirmation($var) } /** - * Properties associated with this subscription. + * Optional. Properties associated with this subscription. * - * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4; + * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\StreamingPullResponse\SubscriptionProperties|null */ public function getSubscriptionProperties() @@ -190,9 +190,9 @@ public function clearSubscriptionProperties() } /** - * Properties associated with this subscription. + * Optional. Properties associated with this subscription. * - * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4; + * Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\StreamingPullResponse\SubscriptionProperties $var * @return $this */ diff --git a/PubSub/src/V1/StreamingPullResponse/AcknowledgeConfirmation.php b/PubSub/src/V1/StreamingPullResponse/AcknowledgeConfirmation.php index ec8093310006..fd94ce279a93 100644 --- a/PubSub/src/V1/StreamingPullResponse/AcknowledgeConfirmation.php +++ b/PubSub/src/V1/StreamingPullResponse/AcknowledgeConfirmation.php @@ -17,28 +17,29 @@ class AcknowledgeConfirmation extends \Google\Protobuf\Internal\Message { /** - * Successfully processed acknowledgement IDs. + * Optional. Successfully processed acknowledgement IDs. * - * Generated from protobuf field repeated string ack_ids = 1; + * Generated from protobuf field repeated string ack_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $ack_ids; /** - * List of acknowledgement IDs that were malformed or whose acknowledgement - * deadline has expired. + * Optional. List of acknowledgement IDs that were malformed or whose + * acknowledgement deadline has expired. * - * Generated from protobuf field repeated string invalid_ack_ids = 2; + * Generated from protobuf field repeated string invalid_ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $invalid_ack_ids; /** - * List of acknowledgement IDs that were out of order. + * Optional. List of acknowledgement IDs that were out of order. * - * Generated from protobuf field repeated string unordered_ack_ids = 3; + * Generated from protobuf field repeated string unordered_ack_ids = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $unordered_ack_ids; /** - * List of acknowledgement IDs that failed processing with temporary issues. + * Optional. List of acknowledgement IDs that failed processing with + * temporary issues. * - * Generated from protobuf field repeated string temporary_failed_ack_ids = 4; + * Generated from protobuf field repeated string temporary_failed_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $temporary_failed_ack_ids; @@ -49,14 +50,15 @@ class AcknowledgeConfirmation extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array|\Google\Protobuf\Internal\RepeatedField $ack_ids - * Successfully processed acknowledgement IDs. + * Optional. Successfully processed acknowledgement IDs. * @type array|\Google\Protobuf\Internal\RepeatedField $invalid_ack_ids - * List of acknowledgement IDs that were malformed or whose acknowledgement - * deadline has expired. + * Optional. List of acknowledgement IDs that were malformed or whose + * acknowledgement deadline has expired. * @type array|\Google\Protobuf\Internal\RepeatedField $unordered_ack_ids - * List of acknowledgement IDs that were out of order. + * Optional. List of acknowledgement IDs that were out of order. * @type array|\Google\Protobuf\Internal\RepeatedField $temporary_failed_ack_ids - * List of acknowledgement IDs that failed processing with temporary issues. + * Optional. List of acknowledgement IDs that failed processing with + * temporary issues. * } */ public function __construct($data = NULL) { @@ -65,9 +67,9 @@ public function __construct($data = NULL) { } /** - * Successfully processed acknowledgement IDs. + * Optional. Successfully processed acknowledgement IDs. * - * Generated from protobuf field repeated string ack_ids = 1; + * Generated from protobuf field repeated string ack_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAckIds() @@ -76,9 +78,9 @@ public function getAckIds() } /** - * Successfully processed acknowledgement IDs. + * Optional. Successfully processed acknowledgement IDs. * - * Generated from protobuf field repeated string ack_ids = 1; + * Generated from protobuf field repeated string ack_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -91,10 +93,10 @@ public function setAckIds($var) } /** - * List of acknowledgement IDs that were malformed or whose acknowledgement - * deadline has expired. + * Optional. List of acknowledgement IDs that were malformed or whose + * acknowledgement deadline has expired. * - * Generated from protobuf field repeated string invalid_ack_ids = 2; + * Generated from protobuf field repeated string invalid_ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getInvalidAckIds() @@ -103,10 +105,10 @@ public function getInvalidAckIds() } /** - * List of acknowledgement IDs that were malformed or whose acknowledgement - * deadline has expired. + * Optional. List of acknowledgement IDs that were malformed or whose + * acknowledgement deadline has expired. * - * Generated from protobuf field repeated string invalid_ack_ids = 2; + * Generated from protobuf field repeated string invalid_ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -119,9 +121,9 @@ public function setInvalidAckIds($var) } /** - * List of acknowledgement IDs that were out of order. + * Optional. List of acknowledgement IDs that were out of order. * - * Generated from protobuf field repeated string unordered_ack_ids = 3; + * Generated from protobuf field repeated string unordered_ack_ids = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getUnorderedAckIds() @@ -130,9 +132,9 @@ public function getUnorderedAckIds() } /** - * List of acknowledgement IDs that were out of order. + * Optional. List of acknowledgement IDs that were out of order. * - * Generated from protobuf field repeated string unordered_ack_ids = 3; + * Generated from protobuf field repeated string unordered_ack_ids = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -145,9 +147,10 @@ public function setUnorderedAckIds($var) } /** - * List of acknowledgement IDs that failed processing with temporary issues. + * Optional. List of acknowledgement IDs that failed processing with + * temporary issues. * - * Generated from protobuf field repeated string temporary_failed_ack_ids = 4; + * Generated from protobuf field repeated string temporary_failed_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getTemporaryFailedAckIds() @@ -156,9 +159,10 @@ public function getTemporaryFailedAckIds() } /** - * List of acknowledgement IDs that failed processing with temporary issues. + * Optional. List of acknowledgement IDs that failed processing with + * temporary issues. * - * Generated from protobuf field repeated string temporary_failed_ack_ids = 4; + * Generated from protobuf field repeated string temporary_failed_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ diff --git a/PubSub/src/V1/StreamingPullResponse/ModifyAckDeadlineConfirmation.php b/PubSub/src/V1/StreamingPullResponse/ModifyAckDeadlineConfirmation.php index c9b64bfca59c..1fd67ae753a0 100644 --- a/PubSub/src/V1/StreamingPullResponse/ModifyAckDeadlineConfirmation.php +++ b/PubSub/src/V1/StreamingPullResponse/ModifyAckDeadlineConfirmation.php @@ -17,22 +17,23 @@ class ModifyAckDeadlineConfirmation extends \Google\Protobuf\Internal\Message { /** - * Successfully processed acknowledgement IDs. + * Optional. Successfully processed acknowledgement IDs. * - * Generated from protobuf field repeated string ack_ids = 1; + * Generated from protobuf field repeated string ack_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $ack_ids; /** - * List of acknowledgement IDs that were malformed or whose acknowledgement - * deadline has expired. + * Optional. List of acknowledgement IDs that were malformed or whose + * acknowledgement deadline has expired. * - * Generated from protobuf field repeated string invalid_ack_ids = 2; + * Generated from protobuf field repeated string invalid_ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $invalid_ack_ids; /** - * List of acknowledgement IDs that failed processing with temporary issues. + * Optional. List of acknowledgement IDs that failed processing with + * temporary issues. * - * Generated from protobuf field repeated string temporary_failed_ack_ids = 3; + * Generated from protobuf field repeated string temporary_failed_ack_ids = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $temporary_failed_ack_ids; @@ -43,12 +44,13 @@ class ModifyAckDeadlineConfirmation extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array|\Google\Protobuf\Internal\RepeatedField $ack_ids - * Successfully processed acknowledgement IDs. + * Optional. Successfully processed acknowledgement IDs. * @type array|\Google\Protobuf\Internal\RepeatedField $invalid_ack_ids - * List of acknowledgement IDs that were malformed or whose acknowledgement - * deadline has expired. + * Optional. List of acknowledgement IDs that were malformed or whose + * acknowledgement deadline has expired. * @type array|\Google\Protobuf\Internal\RepeatedField $temporary_failed_ack_ids - * List of acknowledgement IDs that failed processing with temporary issues. + * Optional. List of acknowledgement IDs that failed processing with + * temporary issues. * } */ public function __construct($data = NULL) { @@ -57,9 +59,9 @@ public function __construct($data = NULL) { } /** - * Successfully processed acknowledgement IDs. + * Optional. Successfully processed acknowledgement IDs. * - * Generated from protobuf field repeated string ack_ids = 1; + * Generated from protobuf field repeated string ack_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAckIds() @@ -68,9 +70,9 @@ public function getAckIds() } /** - * Successfully processed acknowledgement IDs. + * Optional. Successfully processed acknowledgement IDs. * - * Generated from protobuf field repeated string ack_ids = 1; + * Generated from protobuf field repeated string ack_ids = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -83,10 +85,10 @@ public function setAckIds($var) } /** - * List of acknowledgement IDs that were malformed or whose acknowledgement - * deadline has expired. + * Optional. List of acknowledgement IDs that were malformed or whose + * acknowledgement deadline has expired. * - * Generated from protobuf field repeated string invalid_ack_ids = 2; + * Generated from protobuf field repeated string invalid_ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getInvalidAckIds() @@ -95,10 +97,10 @@ public function getInvalidAckIds() } /** - * List of acknowledgement IDs that were malformed or whose acknowledgement - * deadline has expired. + * Optional. List of acknowledgement IDs that were malformed or whose + * acknowledgement deadline has expired. * - * Generated from protobuf field repeated string invalid_ack_ids = 2; + * Generated from protobuf field repeated string invalid_ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -111,9 +113,10 @@ public function setInvalidAckIds($var) } /** - * List of acknowledgement IDs that failed processing with temporary issues. + * Optional. List of acknowledgement IDs that failed processing with + * temporary issues. * - * Generated from protobuf field repeated string temporary_failed_ack_ids = 3; + * Generated from protobuf field repeated string temporary_failed_ack_ids = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getTemporaryFailedAckIds() @@ -122,9 +125,10 @@ public function getTemporaryFailedAckIds() } /** - * List of acknowledgement IDs that failed processing with temporary issues. + * Optional. List of acknowledgement IDs that failed processing with + * temporary issues. * - * Generated from protobuf field repeated string temporary_failed_ack_ids = 3; + * Generated from protobuf field repeated string temporary_failed_ack_ids = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ diff --git a/PubSub/src/V1/StreamingPullResponse/SubscriptionProperties.php b/PubSub/src/V1/StreamingPullResponse/SubscriptionProperties.php index bb00a46b3c96..e26f43f59ba4 100644 --- a/PubSub/src/V1/StreamingPullResponse/SubscriptionProperties.php +++ b/PubSub/src/V1/StreamingPullResponse/SubscriptionProperties.php @@ -16,15 +16,16 @@ class SubscriptionProperties extends \Google\Protobuf\Internal\Message { /** - * True iff exactly once delivery is enabled for this subscription. + * Optional. True iff exactly once delivery is enabled for this + * subscription. * - * Generated from protobuf field bool exactly_once_delivery_enabled = 1; + * Generated from protobuf field bool exactly_once_delivery_enabled = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $exactly_once_delivery_enabled = false; /** - * True iff message ordering is enabled for this subscription. + * Optional. True iff message ordering is enabled for this subscription. * - * Generated from protobuf field bool message_ordering_enabled = 2; + * Generated from protobuf field bool message_ordering_enabled = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $message_ordering_enabled = false; @@ -35,9 +36,10 @@ class SubscriptionProperties extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $exactly_once_delivery_enabled - * True iff exactly once delivery is enabled for this subscription. + * Optional. True iff exactly once delivery is enabled for this + * subscription. * @type bool $message_ordering_enabled - * True iff message ordering is enabled for this subscription. + * Optional. True iff message ordering is enabled for this subscription. * } */ public function __construct($data = NULL) { @@ -46,9 +48,10 @@ public function __construct($data = NULL) { } /** - * True iff exactly once delivery is enabled for this subscription. + * Optional. True iff exactly once delivery is enabled for this + * subscription. * - * Generated from protobuf field bool exactly_once_delivery_enabled = 1; + * Generated from protobuf field bool exactly_once_delivery_enabled = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getExactlyOnceDeliveryEnabled() @@ -57,9 +60,10 @@ public function getExactlyOnceDeliveryEnabled() } /** - * True iff exactly once delivery is enabled for this subscription. + * Optional. True iff exactly once delivery is enabled for this + * subscription. * - * Generated from protobuf field bool exactly_once_delivery_enabled = 1; + * Generated from protobuf field bool exactly_once_delivery_enabled = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -72,9 +76,9 @@ public function setExactlyOnceDeliveryEnabled($var) } /** - * True iff message ordering is enabled for this subscription. + * Optional. True iff message ordering is enabled for this subscription. * - * Generated from protobuf field bool message_ordering_enabled = 2; + * Generated from protobuf field bool message_ordering_enabled = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getMessageOrderingEnabled() @@ -83,9 +87,9 @@ public function getMessageOrderingEnabled() } /** - * True iff message ordering is enabled for this subscription. + * Optional. True iff message ordering is enabled for this subscription. * - * Generated from protobuf field bool message_ordering_enabled = 2; + * Generated from protobuf field bool message_ordering_enabled = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/PubSub/src/V1/Subscription.php b/PubSub/src/V1/Subscription.php index 0c32d9716544..cc12a97a350d 100644 --- a/PubSub/src/V1/Subscription.php +++ b/PubSub/src/V1/Subscription.php @@ -37,32 +37,32 @@ class Subscription extends \Google\Protobuf\Internal\Message */ private $topic = ''; /** - * If push delivery is used with this subscription, this field is + * Optional. If push delivery is used with this subscription, this field is * used to configure it. * - * Generated from protobuf field .google.pubsub.v1.PushConfig push_config = 4; + * Generated from protobuf field .google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $push_config = null; /** - * If delivery to BigQuery is used with this subscription, this field is - * used to configure it. + * Optional. If delivery to BigQuery is used with this subscription, this + * field is used to configure it. * - * Generated from protobuf field .google.pubsub.v1.BigQueryConfig bigquery_config = 18; + * Generated from protobuf field .google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL]; */ private $bigquery_config = null; /** - * If delivery to Google Cloud Storage is used with this subscription, this - * field is used to configure it. + * Optional. If delivery to Google Cloud Storage is used with this + * subscription, this field is used to configure it. * - * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22; + * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22 [(.google.api.field_behavior) = OPTIONAL]; */ private $cloud_storage_config = null; /** - * The approximate amount of time (on a best-effort basis) Pub/Sub waits for - * the subscriber to acknowledge receipt before resending the message. In the - * interval after the message is delivered and before it is acknowledged, it - * is considered to be _outstanding_. During that time period, the - * message will not be redelivered (on a best-effort basis). + * Optional. The approximate amount of time (on a best-effort basis) Pub/Sub + * waits for the subscriber to acknowledge receipt before resending the + * message. In the interval after the message is delivered and before it is + * acknowledged, it is considered to be _outstanding_. During that time + * period, the message will not be redelivered (on a best-effort basis). * For pull subscriptions, this value is used as the initial value for the ack * deadline. To override this value for a given message, call * `ModifyAckDeadline` with the corresponding `ack_id` if using @@ -76,105 +76,105 @@ class Subscription extends \Google\Protobuf\Internal\Message * If the subscriber never acknowledges the message, the Pub/Sub * system will eventually redeliver the message. * - * Generated from protobuf field int32 ack_deadline_seconds = 5; + * Generated from protobuf field int32 ack_deadline_seconds = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $ack_deadline_seconds = 0; /** - * Indicates whether to retain acknowledged messages. If true, then + * Optional. Indicates whether to retain acknowledged messages. If true, then * messages are not expunged from the subscription's backlog, even if they are * acknowledged, until they fall out of the `message_retention_duration` * window. This must be true if you would like to [`Seek` to a timestamp] * (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in * the past to replay previously-acknowledged messages. * - * Generated from protobuf field bool retain_acked_messages = 7; + * Generated from protobuf field bool retain_acked_messages = 7 [(.google.api.field_behavior) = OPTIONAL]; */ private $retain_acked_messages = false; /** - * How long to retain unacknowledged messages in the subscription's backlog, - * from the moment a message is published. - * If `retain_acked_messages` is true, then this also configures the retention - * of acknowledged messages, and thus configures how far back in time a `Seek` - * can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 - * minutes. + * Optional. How long to retain unacknowledged messages in the subscription's + * backlog, from the moment a message is published. If `retain_acked_messages` + * is true, then this also configures the retention of acknowledged messages, + * and thus configures how far back in time a `Seek` can be done. Defaults to + * 7 days. Cannot be more than 7 days or less than 10 minutes. * - * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8; + * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL]; */ private $message_retention_duration = null; /** - * See [Creating and managing + * Optional. See [Creating and managing * labels](https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 9; + * Generated from protobuf field map labels = 9 [(.google.api.field_behavior) = OPTIONAL]; */ private $labels; /** - * If true, messages published with the same `ordering_key` in `PubsubMessage` - * will be delivered to the subscribers in the order in which they - * are received by the Pub/Sub system. Otherwise, they may be delivered in - * any order. + * Optional. If true, messages published with the same `ordering_key` in + * `PubsubMessage` will be delivered to the subscribers in the order in which + * they are received by the Pub/Sub system. Otherwise, they may be delivered + * in any order. * - * Generated from protobuf field bool enable_message_ordering = 10; + * Generated from protobuf field bool enable_message_ordering = 10 [(.google.api.field_behavior) = OPTIONAL]; */ private $enable_message_ordering = false; /** - * A policy that specifies the conditions for this subscription's expiration. - * A subscription is considered active as long as any connected subscriber is - * successfully consuming messages from the subscription or is issuing - * operations on the subscription. If `expiration_policy` is not set, a - * *default policy* with `ttl` of 31 days will be used. The minimum allowed + * Optional. A policy that specifies the conditions for this subscription's + * expiration. A subscription is considered active as long as any connected + * subscriber is successfully consuming messages from the subscription or is + * issuing operations on the subscription. If `expiration_policy` is not set, + * a *default policy* with `ttl` of 31 days will be used. The minimum allowed * value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, * but `expiration_policy.ttl` is not set, the subscription never expires. * - * Generated from protobuf field .google.pubsub.v1.ExpirationPolicy expiration_policy = 11; + * Generated from protobuf field .google.pubsub.v1.ExpirationPolicy expiration_policy = 11 [(.google.api.field_behavior) = OPTIONAL]; */ private $expiration_policy = null; /** - * An expression written in the Pub/Sub [filter + * Optional. An expression written in the Pub/Sub [filter * language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, * then only `PubsubMessage`s whose `attributes` field matches the filter are * delivered on this subscription. If empty, then no messages are filtered * out. * - * Generated from protobuf field string filter = 12; + * Generated from protobuf field string filter = 12 [(.google.api.field_behavior) = OPTIONAL]; */ private $filter = ''; /** - * A policy that specifies the conditions for dead lettering messages in - * this subscription. If dead_letter_policy is not set, dead lettering - * is disabled. - * The Cloud Pub/Sub service account associated with this subscriptions's + * Optional. A policy that specifies the conditions for dead lettering + * messages in this subscription. If dead_letter_policy is not set, dead + * lettering is disabled. + * The Pub/Sub service account associated with this subscriptions's * parent project (i.e., * service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have * permission to Acknowledge() messages on this subscription. * - * Generated from protobuf field .google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13; + * Generated from protobuf field .google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13 [(.google.api.field_behavior) = OPTIONAL]; */ private $dead_letter_policy = null; /** - * A policy that specifies how Pub/Sub retries message delivery for this - * subscription. + * Optional. A policy that specifies how Pub/Sub retries message delivery for + * this subscription. * If not set, the default retry policy is applied. This generally implies * that messages will be retried as soon as possible for healthy subscribers. * RetryPolicy will be triggered on NACKs or acknowledgement deadline * exceeded events for a given message. * - * Generated from protobuf field .google.pubsub.v1.RetryPolicy retry_policy = 14; + * Generated from protobuf field .google.pubsub.v1.RetryPolicy retry_policy = 14 [(.google.api.field_behavior) = OPTIONAL]; */ private $retry_policy = null; /** - * Indicates whether the subscription is detached from its topic. Detached - * subscriptions don't receive messages from their topic and don't retain any - * backlog. `Pull` and `StreamingPull` requests will return + * Optional. Indicates whether the subscription is detached from its topic. + * Detached subscriptions don't receive messages from their topic and don't + * retain any backlog. `Pull` and `StreamingPull` requests will return * FAILED_PRECONDITION. If the subscription is a push subscription, pushes to * the endpoint will not be made. * - * Generated from protobuf field bool detached = 15; + * Generated from protobuf field bool detached = 15 [(.google.api.field_behavior) = OPTIONAL]; */ private $detached = false; /** - * If true, Pub/Sub provides the following guarantees for the delivery of - * a message with a given value of `message_id` on this subscription: + * Optional. If true, Pub/Sub provides the following guarantees for the + * delivery of a message with a given value of `message_id` on this + * subscription: * * The message sent to a subscriber is guaranteed not to be resent * before the message's acknowledgement deadline expires. * * An acknowledged message will not be resent to a subscriber. @@ -183,7 +183,7 @@ class Subscription extends \Google\Protobuf\Internal\Message * multiple times by a publisher client. These copies are considered distinct * by Pub/Sub and have distinct `message_id` values. * - * Generated from protobuf field bool enable_exactly_once_delivery = 16; + * Generated from protobuf field bool enable_exactly_once_delivery = 16 [(.google.api.field_behavior) = OPTIONAL]; */ private $enable_exactly_once_delivery = false; /** @@ -216,13 +216,13 @@ class Subscription extends \Google\Protobuf\Internal\Message * messages. Format is `projects/{project}/topics/{topic}`. The value of this * field will be `_deleted-topic_` if the topic has been deleted. Please see * {@see SubscriberClient::topicName()} for help formatting this field. - * @param \Google\Cloud\PubSub\V1\PushConfig $pushConfig If push delivery is used with this subscription, this field is + * @param \Google\Cloud\PubSub\V1\PushConfig $pushConfig Optional. If push delivery is used with this subscription, this field is * used to configure it. - * @param int $ackDeadlineSeconds The approximate amount of time (on a best-effort basis) Pub/Sub waits for - * the subscriber to acknowledge receipt before resending the message. In the - * interval after the message is delivered and before it is acknowledged, it - * is considered to be _outstanding_. During that time period, the - * message will not be redelivered (on a best-effort basis). + * @param int $ackDeadlineSeconds Optional. The approximate amount of time (on a best-effort basis) Pub/Sub + * waits for the subscriber to acknowledge receipt before resending the + * message. In the interval after the message is delivered and before it is + * acknowledged, it is considered to be _outstanding_. During that time + * period, the message will not be redelivered (on a best-effort basis). * * For pull subscriptions, this value is used as the initial value for the ack * deadline. To override this value for a given message, call @@ -270,20 +270,20 @@ public static function build(string $name, string $topic, \Google\Cloud\PubSub\V * messages. Format is `projects/{project}/topics/{topic}`. The value of this * field will be `_deleted-topic_` if the topic has been deleted. * @type \Google\Cloud\PubSub\V1\PushConfig $push_config - * If push delivery is used with this subscription, this field is + * Optional. If push delivery is used with this subscription, this field is * used to configure it. * @type \Google\Cloud\PubSub\V1\BigQueryConfig $bigquery_config - * If delivery to BigQuery is used with this subscription, this field is - * used to configure it. - * @type \Google\Cloud\PubSub\V1\CloudStorageConfig $cloud_storage_config - * If delivery to Google Cloud Storage is used with this subscription, this + * Optional. If delivery to BigQuery is used with this subscription, this * field is used to configure it. + * @type \Google\Cloud\PubSub\V1\CloudStorageConfig $cloud_storage_config + * Optional. If delivery to Google Cloud Storage is used with this + * subscription, this field is used to configure it. * @type int $ack_deadline_seconds - * The approximate amount of time (on a best-effort basis) Pub/Sub waits for - * the subscriber to acknowledge receipt before resending the message. In the - * interval after the message is delivered and before it is acknowledged, it - * is considered to be _outstanding_. During that time period, the - * message will not be redelivered (on a best-effort basis). + * Optional. The approximate amount of time (on a best-effort basis) Pub/Sub + * waits for the subscriber to acknowledge receipt before resending the + * message. In the interval after the message is delivered and before it is + * acknowledged, it is considered to be _outstanding_. During that time + * period, the message will not be redelivered (on a best-effort basis). * For pull subscriptions, this value is used as the initial value for the ack * deadline. To override this value for a given message, call * `ModifyAckDeadline` with the corresponding `ack_id` if using @@ -297,65 +297,65 @@ public static function build(string $name, string $topic, \Google\Cloud\PubSub\V * If the subscriber never acknowledges the message, the Pub/Sub * system will eventually redeliver the message. * @type bool $retain_acked_messages - * Indicates whether to retain acknowledged messages. If true, then + * Optional. Indicates whether to retain acknowledged messages. If true, then * messages are not expunged from the subscription's backlog, even if they are * acknowledged, until they fall out of the `message_retention_duration` * window. This must be true if you would like to [`Seek` to a timestamp] * (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in * the past to replay previously-acknowledged messages. * @type \Google\Protobuf\Duration $message_retention_duration - * How long to retain unacknowledged messages in the subscription's backlog, - * from the moment a message is published. - * If `retain_acked_messages` is true, then this also configures the retention - * of acknowledged messages, and thus configures how far back in time a `Seek` - * can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 - * minutes. + * Optional. How long to retain unacknowledged messages in the subscription's + * backlog, from the moment a message is published. If `retain_acked_messages` + * is true, then this also configures the retention of acknowledged messages, + * and thus configures how far back in time a `Seek` can be done. Defaults to + * 7 days. Cannot be more than 7 days or less than 10 minutes. * @type array|\Google\Protobuf\Internal\MapField $labels - * See [Creating and managing + * Optional. See [Creating and managing * labels](https://cloud.google.com/pubsub/docs/labels). * @type bool $enable_message_ordering - * If true, messages published with the same `ordering_key` in `PubsubMessage` - * will be delivered to the subscribers in the order in which they - * are received by the Pub/Sub system. Otherwise, they may be delivered in - * any order. + * Optional. If true, messages published with the same `ordering_key` in + * `PubsubMessage` will be delivered to the subscribers in the order in which + * they are received by the Pub/Sub system. Otherwise, they may be delivered + * in any order. * @type \Google\Cloud\PubSub\V1\ExpirationPolicy $expiration_policy - * A policy that specifies the conditions for this subscription's expiration. - * A subscription is considered active as long as any connected subscriber is - * successfully consuming messages from the subscription or is issuing - * operations on the subscription. If `expiration_policy` is not set, a - * *default policy* with `ttl` of 31 days will be used. The minimum allowed + * Optional. A policy that specifies the conditions for this subscription's + * expiration. A subscription is considered active as long as any connected + * subscriber is successfully consuming messages from the subscription or is + * issuing operations on the subscription. If `expiration_policy` is not set, + * a *default policy* with `ttl` of 31 days will be used. The minimum allowed * value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, * but `expiration_policy.ttl` is not set, the subscription never expires. * @type string $filter - * An expression written in the Pub/Sub [filter + * Optional. An expression written in the Pub/Sub [filter * language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, * then only `PubsubMessage`s whose `attributes` field matches the filter are * delivered on this subscription. If empty, then no messages are filtered * out. * @type \Google\Cloud\PubSub\V1\DeadLetterPolicy $dead_letter_policy - * A policy that specifies the conditions for dead lettering messages in - * this subscription. If dead_letter_policy is not set, dead lettering - * is disabled. - * The Cloud Pub/Sub service account associated with this subscriptions's + * Optional. A policy that specifies the conditions for dead lettering + * messages in this subscription. If dead_letter_policy is not set, dead + * lettering is disabled. + * The Pub/Sub service account associated with this subscriptions's * parent project (i.e., * service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have * permission to Acknowledge() messages on this subscription. * @type \Google\Cloud\PubSub\V1\RetryPolicy $retry_policy - * A policy that specifies how Pub/Sub retries message delivery for this - * subscription. + * Optional. A policy that specifies how Pub/Sub retries message delivery for + * this subscription. * If not set, the default retry policy is applied. This generally implies * that messages will be retried as soon as possible for healthy subscribers. * RetryPolicy will be triggered on NACKs or acknowledgement deadline * exceeded events for a given message. * @type bool $detached - * Indicates whether the subscription is detached from its topic. Detached - * subscriptions don't receive messages from their topic and don't retain any - * backlog. `Pull` and `StreamingPull` requests will return + * Optional. Indicates whether the subscription is detached from its topic. + * Detached subscriptions don't receive messages from their topic and don't + * retain any backlog. `Pull` and `StreamingPull` requests will return * FAILED_PRECONDITION. If the subscription is a push subscription, pushes to * the endpoint will not be made. * @type bool $enable_exactly_once_delivery - * If true, Pub/Sub provides the following guarantees for the delivery of - * a message with a given value of `message_id` on this subscription: + * Optional. If true, Pub/Sub provides the following guarantees for the + * delivery of a message with a given value of `message_id` on this + * subscription: * * The message sent to a subscriber is guaranteed not to be resent * before the message's acknowledgement deadline expires. * * An acknowledged message will not be resent to a subscriber. @@ -447,10 +447,10 @@ public function setTopic($var) } /** - * If push delivery is used with this subscription, this field is + * Optional. If push delivery is used with this subscription, this field is * used to configure it. * - * Generated from protobuf field .google.pubsub.v1.PushConfig push_config = 4; + * Generated from protobuf field .google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\PushConfig|null */ public function getPushConfig() @@ -469,10 +469,10 @@ public function clearPushConfig() } /** - * If push delivery is used with this subscription, this field is + * Optional. If push delivery is used with this subscription, this field is * used to configure it. * - * Generated from protobuf field .google.pubsub.v1.PushConfig push_config = 4; + * Generated from protobuf field .google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\PushConfig $var * @return $this */ @@ -485,10 +485,10 @@ public function setPushConfig($var) } /** - * If delivery to BigQuery is used with this subscription, this field is - * used to configure it. + * Optional. If delivery to BigQuery is used with this subscription, this + * field is used to configure it. * - * Generated from protobuf field .google.pubsub.v1.BigQueryConfig bigquery_config = 18; + * Generated from protobuf field .google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\BigQueryConfig|null */ public function getBigqueryConfig() @@ -507,10 +507,10 @@ public function clearBigqueryConfig() } /** - * If delivery to BigQuery is used with this subscription, this field is - * used to configure it. + * Optional. If delivery to BigQuery is used with this subscription, this + * field is used to configure it. * - * Generated from protobuf field .google.pubsub.v1.BigQueryConfig bigquery_config = 18; + * Generated from protobuf field .google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\BigQueryConfig $var * @return $this */ @@ -523,10 +523,10 @@ public function setBigqueryConfig($var) } /** - * If delivery to Google Cloud Storage is used with this subscription, this - * field is used to configure it. + * Optional. If delivery to Google Cloud Storage is used with this + * subscription, this field is used to configure it. * - * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22; + * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\CloudStorageConfig|null */ public function getCloudStorageConfig() @@ -545,10 +545,10 @@ public function clearCloudStorageConfig() } /** - * If delivery to Google Cloud Storage is used with this subscription, this - * field is used to configure it. + * Optional. If delivery to Google Cloud Storage is used with this + * subscription, this field is used to configure it. * - * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22; + * Generated from protobuf field .google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\CloudStorageConfig $var * @return $this */ @@ -561,11 +561,11 @@ public function setCloudStorageConfig($var) } /** - * The approximate amount of time (on a best-effort basis) Pub/Sub waits for - * the subscriber to acknowledge receipt before resending the message. In the - * interval after the message is delivered and before it is acknowledged, it - * is considered to be _outstanding_. During that time period, the - * message will not be redelivered (on a best-effort basis). + * Optional. The approximate amount of time (on a best-effort basis) Pub/Sub + * waits for the subscriber to acknowledge receipt before resending the + * message. In the interval after the message is delivered and before it is + * acknowledged, it is considered to be _outstanding_. During that time + * period, the message will not be redelivered (on a best-effort basis). * For pull subscriptions, this value is used as the initial value for the ack * deadline. To override this value for a given message, call * `ModifyAckDeadline` with the corresponding `ack_id` if using @@ -579,7 +579,7 @@ public function setCloudStorageConfig($var) * If the subscriber never acknowledges the message, the Pub/Sub * system will eventually redeliver the message. * - * Generated from protobuf field int32 ack_deadline_seconds = 5; + * Generated from protobuf field int32 ack_deadline_seconds = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getAckDeadlineSeconds() @@ -588,11 +588,11 @@ public function getAckDeadlineSeconds() } /** - * The approximate amount of time (on a best-effort basis) Pub/Sub waits for - * the subscriber to acknowledge receipt before resending the message. In the - * interval after the message is delivered and before it is acknowledged, it - * is considered to be _outstanding_. During that time period, the - * message will not be redelivered (on a best-effort basis). + * Optional. The approximate amount of time (on a best-effort basis) Pub/Sub + * waits for the subscriber to acknowledge receipt before resending the + * message. In the interval after the message is delivered and before it is + * acknowledged, it is considered to be _outstanding_. During that time + * period, the message will not be redelivered (on a best-effort basis). * For pull subscriptions, this value is used as the initial value for the ack * deadline. To override this value for a given message, call * `ModifyAckDeadline` with the corresponding `ack_id` if using @@ -606,7 +606,7 @@ public function getAckDeadlineSeconds() * If the subscriber never acknowledges the message, the Pub/Sub * system will eventually redeliver the message. * - * Generated from protobuf field int32 ack_deadline_seconds = 5; + * Generated from protobuf field int32 ack_deadline_seconds = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -619,14 +619,14 @@ public function setAckDeadlineSeconds($var) } /** - * Indicates whether to retain acknowledged messages. If true, then + * Optional. Indicates whether to retain acknowledged messages. If true, then * messages are not expunged from the subscription's backlog, even if they are * acknowledged, until they fall out of the `message_retention_duration` * window. This must be true if you would like to [`Seek` to a timestamp] * (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in * the past to replay previously-acknowledged messages. * - * Generated from protobuf field bool retain_acked_messages = 7; + * Generated from protobuf field bool retain_acked_messages = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getRetainAckedMessages() @@ -635,14 +635,14 @@ public function getRetainAckedMessages() } /** - * Indicates whether to retain acknowledged messages. If true, then + * Optional. Indicates whether to retain acknowledged messages. If true, then * messages are not expunged from the subscription's backlog, even if they are * acknowledged, until they fall out of the `message_retention_duration` * window. This must be true if you would like to [`Seek` to a timestamp] * (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in * the past to replay previously-acknowledged messages. * - * Generated from protobuf field bool retain_acked_messages = 7; + * Generated from protobuf field bool retain_acked_messages = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -655,14 +655,13 @@ public function setRetainAckedMessages($var) } /** - * How long to retain unacknowledged messages in the subscription's backlog, - * from the moment a message is published. - * If `retain_acked_messages` is true, then this also configures the retention - * of acknowledged messages, and thus configures how far back in time a `Seek` - * can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 - * minutes. + * Optional. How long to retain unacknowledged messages in the subscription's + * backlog, from the moment a message is published. If `retain_acked_messages` + * is true, then this also configures the retention of acknowledged messages, + * and thus configures how far back in time a `Seek` can be done. Defaults to + * 7 days. Cannot be more than 7 days or less than 10 minutes. * - * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8; + * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Duration|null */ public function getMessageRetentionDuration() @@ -681,14 +680,13 @@ public function clearMessageRetentionDuration() } /** - * How long to retain unacknowledged messages in the subscription's backlog, - * from the moment a message is published. - * If `retain_acked_messages` is true, then this also configures the retention - * of acknowledged messages, and thus configures how far back in time a `Seek` - * can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 - * minutes. + * Optional. How long to retain unacknowledged messages in the subscription's + * backlog, from the moment a message is published. If `retain_acked_messages` + * is true, then this also configures the retention of acknowledged messages, + * and thus configures how far back in time a `Seek` can be done. Defaults to + * 7 days. Cannot be more than 7 days or less than 10 minutes. * - * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8; + * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Duration $var * @return $this */ @@ -701,10 +699,10 @@ public function setMessageRetentionDuration($var) } /** - * See [Creating and managing + * Optional. See [Creating and managing * labels](https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 9; + * Generated from protobuf field map labels = 9 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\MapField */ public function getLabels() @@ -713,10 +711,10 @@ public function getLabels() } /** - * See [Creating and managing + * Optional. See [Creating and managing * labels](https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 9; + * Generated from protobuf field map labels = 9 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ @@ -729,12 +727,12 @@ public function setLabels($var) } /** - * If true, messages published with the same `ordering_key` in `PubsubMessage` - * will be delivered to the subscribers in the order in which they - * are received by the Pub/Sub system. Otherwise, they may be delivered in - * any order. + * Optional. If true, messages published with the same `ordering_key` in + * `PubsubMessage` will be delivered to the subscribers in the order in which + * they are received by the Pub/Sub system. Otherwise, they may be delivered + * in any order. * - * Generated from protobuf field bool enable_message_ordering = 10; + * Generated from protobuf field bool enable_message_ordering = 10 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getEnableMessageOrdering() @@ -743,12 +741,12 @@ public function getEnableMessageOrdering() } /** - * If true, messages published with the same `ordering_key` in `PubsubMessage` - * will be delivered to the subscribers in the order in which they - * are received by the Pub/Sub system. Otherwise, they may be delivered in - * any order. + * Optional. If true, messages published with the same `ordering_key` in + * `PubsubMessage` will be delivered to the subscribers in the order in which + * they are received by the Pub/Sub system. Otherwise, they may be delivered + * in any order. * - * Generated from protobuf field bool enable_message_ordering = 10; + * Generated from protobuf field bool enable_message_ordering = 10 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -761,15 +759,15 @@ public function setEnableMessageOrdering($var) } /** - * A policy that specifies the conditions for this subscription's expiration. - * A subscription is considered active as long as any connected subscriber is - * successfully consuming messages from the subscription or is issuing - * operations on the subscription. If `expiration_policy` is not set, a - * *default policy* with `ttl` of 31 days will be used. The minimum allowed + * Optional. A policy that specifies the conditions for this subscription's + * expiration. A subscription is considered active as long as any connected + * subscriber is successfully consuming messages from the subscription or is + * issuing operations on the subscription. If `expiration_policy` is not set, + * a *default policy* with `ttl` of 31 days will be used. The minimum allowed * value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, * but `expiration_policy.ttl` is not set, the subscription never expires. * - * Generated from protobuf field .google.pubsub.v1.ExpirationPolicy expiration_policy = 11; + * Generated from protobuf field .google.pubsub.v1.ExpirationPolicy expiration_policy = 11 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\ExpirationPolicy|null */ public function getExpirationPolicy() @@ -788,15 +786,15 @@ public function clearExpirationPolicy() } /** - * A policy that specifies the conditions for this subscription's expiration. - * A subscription is considered active as long as any connected subscriber is - * successfully consuming messages from the subscription or is issuing - * operations on the subscription. If `expiration_policy` is not set, a - * *default policy* with `ttl` of 31 days will be used. The minimum allowed + * Optional. A policy that specifies the conditions for this subscription's + * expiration. A subscription is considered active as long as any connected + * subscriber is successfully consuming messages from the subscription or is + * issuing operations on the subscription. If `expiration_policy` is not set, + * a *default policy* with `ttl` of 31 days will be used. The minimum allowed * value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, * but `expiration_policy.ttl` is not set, the subscription never expires. * - * Generated from protobuf field .google.pubsub.v1.ExpirationPolicy expiration_policy = 11; + * Generated from protobuf field .google.pubsub.v1.ExpirationPolicy expiration_policy = 11 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\ExpirationPolicy $var * @return $this */ @@ -809,13 +807,13 @@ public function setExpirationPolicy($var) } /** - * An expression written in the Pub/Sub [filter + * Optional. An expression written in the Pub/Sub [filter * language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, * then only `PubsubMessage`s whose `attributes` field matches the filter are * delivered on this subscription. If empty, then no messages are filtered * out. * - * Generated from protobuf field string filter = 12; + * Generated from protobuf field string filter = 12 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getFilter() @@ -824,13 +822,13 @@ public function getFilter() } /** - * An expression written in the Pub/Sub [filter + * Optional. An expression written in the Pub/Sub [filter * language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, * then only `PubsubMessage`s whose `attributes` field matches the filter are * delivered on this subscription. If empty, then no messages are filtered * out. * - * Generated from protobuf field string filter = 12; + * Generated from protobuf field string filter = 12 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -843,15 +841,15 @@ public function setFilter($var) } /** - * A policy that specifies the conditions for dead lettering messages in - * this subscription. If dead_letter_policy is not set, dead lettering - * is disabled. - * The Cloud Pub/Sub service account associated with this subscriptions's + * Optional. A policy that specifies the conditions for dead lettering + * messages in this subscription. If dead_letter_policy is not set, dead + * lettering is disabled. + * The Pub/Sub service account associated with this subscriptions's * parent project (i.e., * service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have * permission to Acknowledge() messages on this subscription. * - * Generated from protobuf field .google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13; + * Generated from protobuf field .google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\DeadLetterPolicy|null */ public function getDeadLetterPolicy() @@ -870,15 +868,15 @@ public function clearDeadLetterPolicy() } /** - * A policy that specifies the conditions for dead lettering messages in - * this subscription. If dead_letter_policy is not set, dead lettering - * is disabled. - * The Cloud Pub/Sub service account associated with this subscriptions's + * Optional. A policy that specifies the conditions for dead lettering + * messages in this subscription. If dead_letter_policy is not set, dead + * lettering is disabled. + * The Pub/Sub service account associated with this subscriptions's * parent project (i.e., * service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have * permission to Acknowledge() messages on this subscription. * - * Generated from protobuf field .google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13; + * Generated from protobuf field .google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\DeadLetterPolicy $var * @return $this */ @@ -891,14 +889,14 @@ public function setDeadLetterPolicy($var) } /** - * A policy that specifies how Pub/Sub retries message delivery for this - * subscription. + * Optional. A policy that specifies how Pub/Sub retries message delivery for + * this subscription. * If not set, the default retry policy is applied. This generally implies * that messages will be retried as soon as possible for healthy subscribers. * RetryPolicy will be triggered on NACKs or acknowledgement deadline * exceeded events for a given message. * - * Generated from protobuf field .google.pubsub.v1.RetryPolicy retry_policy = 14; + * Generated from protobuf field .google.pubsub.v1.RetryPolicy retry_policy = 14 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\RetryPolicy|null */ public function getRetryPolicy() @@ -917,14 +915,14 @@ public function clearRetryPolicy() } /** - * A policy that specifies how Pub/Sub retries message delivery for this - * subscription. + * Optional. A policy that specifies how Pub/Sub retries message delivery for + * this subscription. * If not set, the default retry policy is applied. This generally implies * that messages will be retried as soon as possible for healthy subscribers. * RetryPolicy will be triggered on NACKs or acknowledgement deadline * exceeded events for a given message. * - * Generated from protobuf field .google.pubsub.v1.RetryPolicy retry_policy = 14; + * Generated from protobuf field .google.pubsub.v1.RetryPolicy retry_policy = 14 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\RetryPolicy $var * @return $this */ @@ -937,13 +935,13 @@ public function setRetryPolicy($var) } /** - * Indicates whether the subscription is detached from its topic. Detached - * subscriptions don't receive messages from their topic and don't retain any - * backlog. `Pull` and `StreamingPull` requests will return + * Optional. Indicates whether the subscription is detached from its topic. + * Detached subscriptions don't receive messages from their topic and don't + * retain any backlog. `Pull` and `StreamingPull` requests will return * FAILED_PRECONDITION. If the subscription is a push subscription, pushes to * the endpoint will not be made. * - * Generated from protobuf field bool detached = 15; + * Generated from protobuf field bool detached = 15 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getDetached() @@ -952,13 +950,13 @@ public function getDetached() } /** - * Indicates whether the subscription is detached from its topic. Detached - * subscriptions don't receive messages from their topic and don't retain any - * backlog. `Pull` and `StreamingPull` requests will return + * Optional. Indicates whether the subscription is detached from its topic. + * Detached subscriptions don't receive messages from their topic and don't + * retain any backlog. `Pull` and `StreamingPull` requests will return * FAILED_PRECONDITION. If the subscription is a push subscription, pushes to * the endpoint will not be made. * - * Generated from protobuf field bool detached = 15; + * Generated from protobuf field bool detached = 15 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -971,8 +969,9 @@ public function setDetached($var) } /** - * If true, Pub/Sub provides the following guarantees for the delivery of - * a message with a given value of `message_id` on this subscription: + * Optional. If true, Pub/Sub provides the following guarantees for the + * delivery of a message with a given value of `message_id` on this + * subscription: * * The message sent to a subscriber is guaranteed not to be resent * before the message's acknowledgement deadline expires. * * An acknowledged message will not be resent to a subscriber. @@ -981,7 +980,7 @@ public function setDetached($var) * multiple times by a publisher client. These copies are considered distinct * by Pub/Sub and have distinct `message_id` values. * - * Generated from protobuf field bool enable_exactly_once_delivery = 16; + * Generated from protobuf field bool enable_exactly_once_delivery = 16 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getEnableExactlyOnceDelivery() @@ -990,8 +989,9 @@ public function getEnableExactlyOnceDelivery() } /** - * If true, Pub/Sub provides the following guarantees for the delivery of - * a message with a given value of `message_id` on this subscription: + * Optional. If true, Pub/Sub provides the following guarantees for the + * delivery of a message with a given value of `message_id` on this + * subscription: * * The message sent to a subscriber is guaranteed not to be resent * before the message's acknowledgement deadline expires. * * An acknowledged message will not be resent to a subscriber. @@ -1000,7 +1000,7 @@ public function getEnableExactlyOnceDelivery() * multiple times by a publisher client. These copies are considered distinct * by Pub/Sub and have distinct `message_id` values. * - * Generated from protobuf field bool enable_exactly_once_delivery = 16; + * Generated from protobuf field bool enable_exactly_once_delivery = 16 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/PubSub/src/V1/Topic.php b/PubSub/src/V1/Topic.php index 7bbfb3d492a0..cc2abbc9b0f4 100644 --- a/PubSub/src/V1/Topic.php +++ b/PubSub/src/V1/Topic.php @@ -27,52 +27,53 @@ class Topic extends \Google\Protobuf\Internal\Message */ private $name = ''; /** - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 2; + * Generated from protobuf field map labels = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $labels; /** - * Policy constraining the set of Google Cloud Platform regions where messages - * published to the topic may be stored. If not present, then no constraints - * are in effect. + * Optional. Policy constraining the set of Google Cloud Platform regions + * where messages published to the topic may be stored. If not present, then + * no constraints are in effect. * - * Generated from protobuf field .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3; + * Generated from protobuf field .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $message_storage_policy = null; /** - * The resource name of the Cloud KMS CryptoKey to be used to protect access - * to messages published on this topic. + * Optional. The resource name of the Cloud KMS CryptoKey to be used to + * protect access to messages published on this topic. * The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. * - * Generated from protobuf field string kms_key_name = 5; + * Generated from protobuf field string kms_key_name = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $kms_key_name = ''; /** - * Settings for validating messages published against a schema. + * Optional. Settings for validating messages published against a schema. * - * Generated from protobuf field .google.pubsub.v1.SchemaSettings schema_settings = 6; + * Generated from protobuf field .google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL]; */ private $schema_settings = null; /** - * Reserved for future use. This field is set only in responses from the - * server; it is ignored if it is set in any requests. + * Optional. Reserved for future use. This field is set only in responses from + * the server; it is ignored if it is set in any requests. * - * Generated from protobuf field bool satisfies_pzs = 7; + * Generated from protobuf field bool satisfies_pzs = 7 [(.google.api.field_behavior) = OPTIONAL]; */ private $satisfies_pzs = false; /** - * Indicates the minimum duration to retain a message after it is published to - * the topic. If this field is set, messages published to the topic in the - * last `message_retention_duration` are always available to subscribers. For - * instance, it allows any attached subscription to [seek to a + * Optional. Indicates the minimum duration to retain a message after it is + * published to the topic. If this field is set, messages published to the + * topic in the last `message_retention_duration` are always available to + * subscribers. For instance, it allows any attached subscription to [seek to + * a * timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) * that is up to `message_retention_duration` in the past. If this field is * not set, message retention is controlled by settings on individual * subscriptions. Cannot be more than 31 days or less than 10 minutes. * - * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8; + * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL]; */ private $message_retention_duration = null; /** @@ -121,26 +122,27 @@ public static function build(string $name): self * signs (`%`). It must be between 3 and 255 characters in length, and it * must not start with `"goog"`. * @type array|\Google\Protobuf\Internal\MapField $labels - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/pubsub/docs/labels). * @type \Google\Cloud\PubSub\V1\MessageStoragePolicy $message_storage_policy - * Policy constraining the set of Google Cloud Platform regions where messages - * published to the topic may be stored. If not present, then no constraints - * are in effect. + * Optional. Policy constraining the set of Google Cloud Platform regions + * where messages published to the topic may be stored. If not present, then + * no constraints are in effect. * @type string $kms_key_name - * The resource name of the Cloud KMS CryptoKey to be used to protect access - * to messages published on this topic. + * Optional. The resource name of the Cloud KMS CryptoKey to be used to + * protect access to messages published on this topic. * The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. * @type \Google\Cloud\PubSub\V1\SchemaSettings $schema_settings - * Settings for validating messages published against a schema. + * Optional. Settings for validating messages published against a schema. * @type bool $satisfies_pzs - * Reserved for future use. This field is set only in responses from the - * server; it is ignored if it is set in any requests. + * Optional. Reserved for future use. This field is set only in responses from + * the server; it is ignored if it is set in any requests. * @type \Google\Protobuf\Duration $message_retention_duration - * Indicates the minimum duration to retain a message after it is published to - * the topic. If this field is set, messages published to the topic in the - * last `message_retention_duration` are always available to subscribers. For - * instance, it allows any attached subscription to [seek to a + * Optional. Indicates the minimum duration to retain a message after it is + * published to the topic. If this field is set, messages published to the + * topic in the last `message_retention_duration` are always available to + * subscribers. For instance, it allows any attached subscription to [seek to + * a * timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) * that is up to `message_retention_duration` in the past. If this field is * not set, message retention is controlled by settings on individual @@ -194,10 +196,10 @@ public function setName($var) } /** - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 2; + * Generated from protobuf field map labels = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\MapField */ public function getLabels() @@ -206,10 +208,10 @@ public function getLabels() } /** - * See [Creating and managing labels] + * Optional. See [Creating and managing labels] * (https://cloud.google.com/pubsub/docs/labels). * - * Generated from protobuf field map labels = 2; + * Generated from protobuf field map labels = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ @@ -222,11 +224,11 @@ public function setLabels($var) } /** - * Policy constraining the set of Google Cloud Platform regions where messages - * published to the topic may be stored. If not present, then no constraints - * are in effect. + * Optional. Policy constraining the set of Google Cloud Platform regions + * where messages published to the topic may be stored. If not present, then + * no constraints are in effect. * - * Generated from protobuf field .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3; + * Generated from protobuf field .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\MessageStoragePolicy|null */ public function getMessageStoragePolicy() @@ -245,11 +247,11 @@ public function clearMessageStoragePolicy() } /** - * Policy constraining the set of Google Cloud Platform regions where messages - * published to the topic may be stored. If not present, then no constraints - * are in effect. + * Optional. Policy constraining the set of Google Cloud Platform regions + * where messages published to the topic may be stored. If not present, then + * no constraints are in effect. * - * Generated from protobuf field .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3; + * Generated from protobuf field .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\MessageStoragePolicy $var * @return $this */ @@ -262,11 +264,11 @@ public function setMessageStoragePolicy($var) } /** - * The resource name of the Cloud KMS CryptoKey to be used to protect access - * to messages published on this topic. + * Optional. The resource name of the Cloud KMS CryptoKey to be used to + * protect access to messages published on this topic. * The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. * - * Generated from protobuf field string kms_key_name = 5; + * Generated from protobuf field string kms_key_name = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getKmsKeyName() @@ -275,11 +277,11 @@ public function getKmsKeyName() } /** - * The resource name of the Cloud KMS CryptoKey to be used to protect access - * to messages published on this topic. + * Optional. The resource name of the Cloud KMS CryptoKey to be used to + * protect access to messages published on this topic. * The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. * - * Generated from protobuf field string kms_key_name = 5; + * Generated from protobuf field string kms_key_name = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -292,9 +294,9 @@ public function setKmsKeyName($var) } /** - * Settings for validating messages published against a schema. + * Optional. Settings for validating messages published against a schema. * - * Generated from protobuf field .google.pubsub.v1.SchemaSettings schema_settings = 6; + * Generated from protobuf field .google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\PubSub\V1\SchemaSettings|null */ public function getSchemaSettings() @@ -313,9 +315,9 @@ public function clearSchemaSettings() } /** - * Settings for validating messages published against a schema. + * Optional. Settings for validating messages published against a schema. * - * Generated from protobuf field .google.pubsub.v1.SchemaSettings schema_settings = 6; + * Generated from protobuf field .google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\PubSub\V1\SchemaSettings $var * @return $this */ @@ -328,10 +330,10 @@ public function setSchemaSettings($var) } /** - * Reserved for future use. This field is set only in responses from the - * server; it is ignored if it is set in any requests. + * Optional. Reserved for future use. This field is set only in responses from + * the server; it is ignored if it is set in any requests. * - * Generated from protobuf field bool satisfies_pzs = 7; + * Generated from protobuf field bool satisfies_pzs = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getSatisfiesPzs() @@ -340,10 +342,10 @@ public function getSatisfiesPzs() } /** - * Reserved for future use. This field is set only in responses from the - * server; it is ignored if it is set in any requests. + * Optional. Reserved for future use. This field is set only in responses from + * the server; it is ignored if it is set in any requests. * - * Generated from protobuf field bool satisfies_pzs = 7; + * Generated from protobuf field bool satisfies_pzs = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -356,16 +358,17 @@ public function setSatisfiesPzs($var) } /** - * Indicates the minimum duration to retain a message after it is published to - * the topic. If this field is set, messages published to the topic in the - * last `message_retention_duration` are always available to subscribers. For - * instance, it allows any attached subscription to [seek to a + * Optional. Indicates the minimum duration to retain a message after it is + * published to the topic. If this field is set, messages published to the + * topic in the last `message_retention_duration` are always available to + * subscribers. For instance, it allows any attached subscription to [seek to + * a * timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) * that is up to `message_retention_duration` in the past. If this field is * not set, message retention is controlled by settings on individual * subscriptions. Cannot be more than 31 days or less than 10 minutes. * - * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8; + * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Duration|null */ public function getMessageRetentionDuration() @@ -384,16 +387,17 @@ public function clearMessageRetentionDuration() } /** - * Indicates the minimum duration to retain a message after it is published to - * the topic. If this field is set, messages published to the topic in the - * last `message_retention_duration` are always available to subscribers. For - * instance, it allows any attached subscription to [seek to a + * Optional. Indicates the minimum duration to retain a message after it is + * published to the topic. If this field is set, messages published to the + * topic in the last `message_retention_duration` are always available to + * subscribers. For instance, it allows any attached subscription to [seek to + * a * timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) * that is up to `message_retention_duration` in the past. If this field is * not set, message retention is controlled by settings on individual * subscriptions. Cannot be more than 31 days or less than 10 minutes. * - * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8; + * Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Duration $var * @return $this */