Skip to content

Commit 0ab034e

Browse files
yoshi-code-botyoshi-code-bot
authored
Regenerate pubsub client (#7745)
Generated in GitHub action: https://togithub.com/googleapis/googleapis/google-api-php-client-services/actions/workflows/codegen.yaml
1 parent 413b792 commit 0ab034e

6 files changed

Lines changed: 62 additions & 60 deletions

File tree

‎src/Pubsub/CreateSnapshotRequest.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class CreateSnapshotRequest extends \Google\Model
2727
*/
2828
public $labels;
2929
/**
30-
* Required. The subscription whose backlog the snapshot retains.
30+
* Required. Identifier. The subscription whose backlog the snapshot retains.
3131
* Specifically, the created snapshot is guaranteed to retain: (a) The
3232
* existing backlog on the subscription. More precisely, this is defined as
3333
* the messages in the subscription's backlog that are unacknowledged upon the
@@ -66,7 +66,7 @@ public function getLabels()
6666
return $this->labels;
6767
}
6868
/**
69-
* Required. The subscription whose backlog the snapshot retains.
69+
* Required. Identifier. The subscription whose backlog the snapshot retains.
7070
* Specifically, the created snapshot is guaranteed to retain: (a) The
7171
* existing backlog on the subscription. More precisely, this is defined as
7272
* the messages in the subscription's backlog that are unacknowledged upon the

‎src/Pubsub/Resource/ProjectsSnapshots.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ class ProjectsSnapshots extends \Google\Service\Resource
5454
* Snapshot object. Note that for REST API requests, you must specify a name in
5555
* the request. (snapshots.create)
5656
*
57-
* @param string $name Required. User-provided name for this snapshot. If the
58-
* name is not provided in the request, the server will assign a random name for
59-
* this snapshot on the same project as the subscription. Note that for REST API
60-
* requests, you must specify a name. See the [resource name
57+
* @param string $name Required. Identifier. User-provided name for this
58+
* snapshot. If the name is not provided in the request, the server will assign
59+
* a random name for this snapshot on the same project as the subscription. Note
60+
* that for REST API requests, you must specify a name. See the [resource name
6161
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
6262
* Format is `projects/{project}/snapshots/{snap}`.
6363
* @param CreateSnapshotRequest $postBody
@@ -82,8 +82,8 @@ public function create($name, CreateSnapshotRequest $postBody, $optParams = [])
8282
* with the old snapshot or its subscription, unless the same subscription is
8383
* specified. (snapshots.delete)
8484
*
85-
* @param string $snapshot Required. The name of the snapshot to delete. Format
86-
* is `projects/{project}/snapshots/{snap}`.
85+
* @param string $snapshot Required. Identifier. The name of the snapshot to
86+
* delete. Format is `projects/{project}/snapshots/{snap}`.
8787
* @param array $optParams Optional parameters.
8888
* @return PubsubEmpty
8989
* @throws \Google\Service\Exception
@@ -101,8 +101,8 @@ public function delete($snapshot, $optParams = [])
101101
* set the acknowledgment state of messages in an existing subscription to the
102102
* state captured by a snapshot. (snapshots.get)
103103
*
104-
* @param string $snapshot Required. The name of the snapshot to get. Format is
105-
* `projects/{project}/snapshots/{snap}`.
104+
* @param string $snapshot Required. Identifier. The name of the snapshot to
105+
* get. Format is `projects/{project}/snapshots/{snap}`.
106106
* @param array $optParams Optional parameters.
107107
* @return Snapshot
108108
* @throws \Google\Service\Exception
@@ -151,8 +151,8 @@ public function getIamPolicy($resource, $optParams = [])
151151
* acknowledgment state of messages in an existing subscription to the state
152152
* captured by a snapshot. (snapshots.listProjectsSnapshots)
153153
*
154-
* @param string $project Required. The name of the project in which to list
155-
* snapshots. Format is `projects/{project-id}`.
154+
* @param string $project Required. Identifier. The name of the project in which
155+
* to list snapshots. Format is `projects/{project-id}`.
156156
* @param array $optParams Optional parameters.
157157
*
158158
* @opt_param int pageSize Optional. Maximum number of snapshots to return.

‎src/Pubsub/Resource/ProjectsSubscriptions.php‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,12 @@ public function acknowledge($subscription, AcknowledgeRequest $postBody, $optPar
7777
* for REST API requests, you must specify a name in the request.
7878
* (subscriptions.create)
7979
*
80-
* @param string $name Required. The name of the subscription. It must have the
81-
* format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}`
82-
* must start with a letter, and contain only letters (`[A-Za-z]`), numbers
83-
* (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus
84-
* (`+`) or percent signs (`%`). It must be between 3 and 255 characters in
85-
* length, and it must not start with `"goog"`.
80+
* @param string $name Required. Identifier. The name of the subscription. It
81+
* must have the format `"projects/{project}/subscriptions/{subscription}"`.
82+
* `{subscription}` must start with a letter, and contain only letters
83+
* (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods
84+
* (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3
85+
* and 255 characters in length, and it must not start with `"goog"`.
8686
* @param Subscription $postBody
8787
* @param array $optParams Optional parameters.
8888
* @return Subscription
@@ -101,8 +101,8 @@ public function create($name, Subscription $postBody, $optParams = [])
101101
* the same name, but the new one has no association with the old subscription
102102
* or its topic unless the same topic is specified. (subscriptions.delete)
103103
*
104-
* @param string $subscription Required. The subscription to delete. Format is
105-
* `projects/{project}/subscriptions/{sub}`.
104+
* @param string $subscription Required. Identifier. The subscription to delete.
105+
* Format is `projects/{project}/subscriptions/{sub}`.
106106
* @param array $optParams Optional parameters.
107107
* @return PubsubEmpty
108108
* @throws \Google\Service\Exception
@@ -134,8 +134,8 @@ public function detach($subscription, $optParams = [])
134134
/**
135135
* Gets the configuration details of a subscription. (subscriptions.get)
136136
*
137-
* @param string $subscription Required. The name of the subscription to get.
138-
* Format is `projects/{project}/subscriptions/{sub}`.
137+
* @param string $subscription Required. Identifier. The name of the
138+
* subscription to get. Format is `projects/{project}/subscriptions/{sub}`.
139139
* @param array $optParams Optional parameters.
140140
* @return Subscription
141141
* @throws \Google\Service\Exception
@@ -180,8 +180,8 @@ public function getIamPolicy($resource, $optParams = [])
180180
/**
181181
* Lists matching subscriptions. (subscriptions.listProjectsSubscriptions)
182182
*
183-
* @param string $project Required. The name of the project in which to list
184-
* subscriptions. Format is `projects/{project-id}`.
183+
* @param string $project Required. Identifier. The name of the project in which
184+
* to list subscriptions. Format is `projects/{project-id}`.
185185
* @param array $optParams Optional parameters.
186186
*
187187
* @opt_param int pageSize Optional. Maximum number of subscriptions to return.
@@ -245,12 +245,12 @@ public function modifyPushConfig($subscription, ModifyPushConfigRequest $postBod
245245
* update mask. Note that certain properties of a subscription, such as its
246246
* topic, are not modifiable. (subscriptions.patch)
247247
*
248-
* @param string $name Required. The name of the subscription. It must have the
249-
* format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}`
250-
* must start with a letter, and contain only letters (`[A-Za-z]`), numbers
251-
* (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus
252-
* (`+`) or percent signs (`%`). It must be between 3 and 255 characters in
253-
* length, and it must not start with `"goog"`.
248+
* @param string $name Required. Identifier. The name of the subscription. It
249+
* must have the format `"projects/{project}/subscriptions/{subscription}"`.
250+
* `{subscription}` must start with a letter, and contain only letters
251+
* (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods
252+
* (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3
253+
* and 255 characters in length, and it must not start with `"goog"`.
254254
* @param UpdateSubscriptionRequest $postBody
255255
* @param array $optParams Optional parameters.
256256
* @return Subscription

‎src/Pubsub/Resource/ProjectsTopics.php‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ class ProjectsTopics extends \Google\Service\Resource
4343
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
4444
* (topics.create)
4545
*
46-
* @param string $name Required. The name of the topic. It must have the format
47-
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
48-
* and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
49-
* underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs
50-
* (`%`). It must be between 3 and 255 characters in length, and it must not
51-
* start with `"goog"`.
46+
* @param string $name Required. Identifier. The name of the topic. It must have
47+
* the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a
48+
* letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes
49+
* (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
50+
* signs (`%`). It must be between 3 and 255 characters in length, and it must
51+
* not start with `"goog"`.
5252
* @param Topic $postBody
5353
* @param array $optParams Optional parameters.
5454
* @return Topic
@@ -67,8 +67,8 @@ public function create($name, Topic $postBody, $optParams = [])
6767
* subscriptions. Existing subscriptions to this topic are not deleted, but
6868
* their `topic` field is set to `_deleted-topic_`. (topics.delete)
6969
*
70-
* @param string $topic Required. Name of the topic to delete. Format is
71-
* `projects/{project}/topics/{topic}`.
70+
* @param string $topic Required. Identifier. Name of the topic to delete.
71+
* Format is `projects/{project}/topics/{topic}`.
7272
* @param array $optParams Optional parameters.
7373
* @return PubsubEmpty
7474
* @throws \Google\Service\Exception
@@ -82,8 +82,8 @@ public function delete($topic, $optParams = [])
8282
/**
8383
* Gets the configuration of a topic. (topics.get)
8484
*
85-
* @param string $topic Required. The name of the topic to get. Format is
86-
* `projects/{project}/topics/{topic}`.
85+
* @param string $topic Required. Identifier. The name of the topic to get.
86+
* Format is `projects/{project}/topics/{topic}`.
8787
* @param array $optParams Optional parameters.
8888
* @return Topic
8989
* @throws \Google\Service\Exception
@@ -128,8 +128,8 @@ public function getIamPolicy($resource, $optParams = [])
128128
/**
129129
* Lists matching topics. (topics.listProjectsTopics)
130130
*
131-
* @param string $project Required. The name of the project in which to list
132-
* topics. Format is `projects/{project-id}`.
131+
* @param string $project Required. Identifier. The name of the project in which
132+
* to list topics. Format is `projects/{project-id}`.
133133
* @param array $optParams Optional parameters.
134134
*
135135
* @opt_param int pageSize Optional. Maximum number of topics to return.
@@ -150,12 +150,12 @@ public function listProjectsTopics($project, $optParams = [])
150150
* mask. Note that certain properties of a topic are not modifiable.
151151
* (topics.patch)
152152
*
153-
* @param string $name Required. The name of the topic. It must have the format
154-
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
155-
* and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
156-
* underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs
157-
* (`%`). It must be between 3 and 255 characters in length, and it must not
158-
* start with `"goog"`.
153+
* @param string $name Required. Identifier. The name of the topic. It must have
154+
* the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a
155+
* letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes
156+
* (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
157+
* signs (`%`). It must be between 3 and 255 characters in length, and it must
158+
* not start with `"goog"`.
159159
* @param UpdateTopicRequest $postBody
160160
* @param array $optParams Optional parameters.
161161
* @return Topic
@@ -171,8 +171,8 @@ public function patch($name, UpdateTopicRequest $postBody, $optParams = [])
171171
* Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does
172172
* not exist. (topics.publish)
173173
*
174-
* @param string $topic Required. The messages in the request will be published
175-
* on this topic. Format is `projects/{project}/topics/{topic}`.
174+
* @param string $topic Required. Identifier. The messages in the request will
175+
* be published on this topic. Format is `projects/{project}/topics/{topic}`.
176176
* @param PublishRequest $postBody
177177
* @param array $optParams Optional parameters.
178178
* @return PublishResponse

‎src/Pubsub/Subscription.php‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ class Subscription extends \Google\Collection
127127
protected $messageTransformsType = MessageTransform::class;
128128
protected $messageTransformsDataType = 'array';
129129
/**
130-
* Required. The name of the subscription. It must have the format
130+
* Required. Identifier. The name of the subscription. It must have the format
131131
* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
132132
* start with a letter, and contain only letters (`[A-Za-z]`), numbers
133133
* (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
@@ -168,9 +168,10 @@ class Subscription extends \Google\Collection
168168
*/
169169
public $tags;
170170
/**
171-
* Required. The name of the topic from which this subscription is receiving
172-
* messages. Format is `projects/{project}/topics/{topic}`. The value of this
173-
* field will be `_deleted-topic_` if the topic has been deleted.
171+
* Required. Identifier. The name of the topic from which this subscription is
172+
* receiving messages. Format is `projects/{project}/topics/{topic}`. The
173+
* value of this field will be `_deleted-topic_` if the topic has been
174+
* deleted.
174175
*
175176
* @var string
176177
*/
@@ -449,7 +450,7 @@ public function getMessageTransforms()
449450
return $this->messageTransforms;
450451
}
451452
/**
452-
* Required. The name of the subscription. It must have the format
453+
* Required. Identifier. The name of the subscription. It must have the format
453454
* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
454455
* start with a letter, and contain only letters (`[A-Za-z]`), numbers
455456
* (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
@@ -565,9 +566,10 @@ public function getTags()
565566
return $this->tags;
566567
}
567568
/**
568-
* Required. The name of the topic from which this subscription is receiving
569-
* messages. Format is `projects/{project}/topics/{topic}`. The value of this
570-
* field will be `_deleted-topic_` if the topic has been deleted.
569+
* Required. Identifier. The name of the topic from which this subscription is
570+
* receiving messages. Format is `projects/{project}/topics/{topic}`. The
571+
* value of this field will be `_deleted-topic_` if the topic has been
572+
* deleted.
571573
*
572574
* @param string $topic
573575
*/

‎src/Pubsub/Topic.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ class Topic extends \Google\Collection
7070
protected $messageTransformsType = MessageTransform::class;
7171
protected $messageTransformsDataType = 'array';
7272
/**
73-
* Required. The name of the topic. It must have the format
73+
* Required. Identifier. The name of the topic. It must have the format
7474
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
7575
* and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
7676
* underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs
@@ -215,7 +215,7 @@ public function getMessageTransforms()
215215
return $this->messageTransforms;
216216
}
217217
/**
218-
* Required. The name of the topic. It must have the format
218+
* Required. Identifier. The name of the topic. It must have the format
219219
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
220220
* and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
221221
* underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs

0 commit comments

Comments
 (0)