Skip to content

Commit b550805

Browse files
docs: [PubSub] Add the IDENTIFIER field behavior annotation to fields of Cloud Pub/Sub methods that represent a specific identity and need to be sourced with additional care (#8780)
* docs: Add the IDENTIFIER field behavior annotation to fields of Cloud Pub/Sub methods that represent a specific identity and need to be sourced with additional care PiperOrigin-RevId: 840763233 Source-Link: googleapis/googleapis@d89bb8a Source-Link: googleapis/googleapis-gen@c7c9072 Copy-Tag: eyJwIjoiUHViU3ViLy5Pd2xCb3QueWFtbCIsImgiOiJjN2M5MDcyNzRkNjE2NGNkZjg2ZWRjZjhkZTcwZjNkYjU3MmIwMGE2In0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 31b7690 commit b550805

29 files changed

Lines changed: 149 additions & 149 deletions

PubSub/metadata/V1/Pubsub.php

39 Bytes
Binary file not shown.

PubSub/samples/V1/PublisherClient/create_topic.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* Creates the given topic with the given name. See the [resource name rules]
3232
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
3333
*
34-
* @param string $name The name of the topic. It must have the format
34+
* @param string $name Identifier. The name of the topic. It must have the format
3535
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
3636
* and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
3737
* underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent

PubSub/samples/V1/PublisherClient/delete_topic.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
* configuration or subscriptions. Existing subscriptions to this topic are
3535
* not deleted, but their `topic` field is set to `_deleted-topic_`.
3636
*
37-
* @param string $formattedTopic Name of the topic to delete.
37+
* @param string $formattedTopic Identifier. Name of the topic to delete.
3838
* Format is `projects/{project}/topics/{topic}`. Please see
3939
* {@see PublisherClient::topicName()} for help formatting this field.
4040
*/

PubSub/samples/V1/PublisherClient/get_topic.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
/**
3232
* Gets the configuration of a topic.
3333
*
34-
* @param string $formattedTopic The name of the topic to get.
34+
* @param string $formattedTopic Identifier. The name of the topic to get.
3535
* Format is `projects/{project}/topics/{topic}`. Please see
3636
* {@see PublisherClient::topicName()} for help formatting this field.
3737
*/

PubSub/samples/V1/PublisherClient/list_topics.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
/**
3333
* Lists matching topics.
3434
*
35-
* @param string $formattedProject The name of the project in which to list topics.
35+
* @param string $formattedProject Identifier. The name of the project in which to list topics.
3636
* Format is `projects/{project-id}`. Please see
3737
* {@see PublisherClient::projectName()} for help formatting this field.
3838
*/

PubSub/samples/V1/PublisherClient/publish.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
* Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
3434
* does not exist.
3535
*
36-
* @param string $formattedTopic The messages in the request will be published on this topic.
37-
* Format is `projects/{project}/topics/{topic}`. Please see
36+
* @param string $formattedTopic Identifier. The messages in the request will be published on this
37+
* topic. Format is `projects/{project}/topics/{topic}`. Please see
3838
* {@see PublisherClient::topicName()} for help formatting this field.
3939
*/
4040
function publish_sample(string $formattedTopic): void

PubSub/samples/V1/PublisherClient/update_topic.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* Updates an existing topic by updating the fields specified in the update
3434
* mask. Note that certain properties of a topic are not modifiable.
3535
*
36-
* @param string $topicName The name of the topic. It must have the format
36+
* @param string $topicName Identifier. The name of the topic. It must have the format
3737
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
3838
* and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
3939
* underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent

PubSub/samples/V1/SubscriberClient/create_snapshot.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@
4646
* generated name is populated in the returned Snapshot object. Note that for
4747
* REST API requests, you must specify a name in the request.
4848
*
49-
* @param string $formattedName User-provided name for this snapshot. If the name is not provided
50-
* in the request, the server will assign a random name for this snapshot on
51-
* the same project as the subscription. Note that for REST API requests, you
52-
* must specify a name. See the [resource name
49+
* @param string $formattedName Identifier. User-provided name for this snapshot. If the name is
50+
* not provided in the request, the server will assign a random name for this
51+
* snapshot on the same project as the subscription. Note that for REST API
52+
* requests, you must specify a name. See the [resource name
5353
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
5454
* Format is `projects/{project}/snapshots/{snap}`. Please see
5555
* {@see SubscriberClient::snapshotName()} for help formatting this field.

PubSub/samples/V1/SubscriberClient/create_subscription.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
* generated name is populated in the returned Subscription object. Note that
4141
* for REST API requests, you must specify a name in the request.
4242
*
43-
* @param string $name The name of the subscription. It must have the format
43+
* @param string $name Identifier. The name of the subscription. It must have the format
4444
* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
4545
* start with a letter, and contain only letters (`[A-Za-z]`), numbers
4646
* (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),

PubSub/samples/V1/SubscriberClient/delete_snapshot.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
* created with the same name, but the new one has no association with the old
3939
* snapshot or its subscription, unless the same subscription is specified.
4040
*
41-
* @param string $formattedSnapshot The name of the snapshot to delete.
41+
* @param string $formattedSnapshot Identifier. The name of the snapshot to delete.
4242
* Format is `projects/{project}/snapshots/{snap}`. Please see
4343
* {@see SubscriberClient::snapshotName()} for help formatting this field.
4444
*/

0 commit comments

Comments
 (0)