Skip to content

Commit 055516f

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
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 (googleapis#32251)
PiperOrigin-RevId: 840763233 Source-Link: googleapis/googleapis@d89bb8a Source-Link: https://github.com/googleapis/googleapis-gen/commit/c7c907274d6164cdf86edcf8de70f3db572b00a6 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLXB1YnN1Yi12MS8uT3dsQm90LnlhbWwiLCJoIjoiYzdjOTA3Mjc0ZDYxNjRjZGY4NmVkY2Y4ZGU3MGYzZGI1NzJiMDBhNiJ9 * 🦉 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 8a45f1e commit 055516f

4 files changed

Lines changed: 37 additions & 37 deletions

File tree

‎google-cloud-pubsub-v1/lib/google/cloud/pubsub/v1/subscription_admin/client.rb‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ def logger
310310
# the default parameter values, pass an empty Hash as a request object (see above).
311311
#
312312
# @param name [::String]
313-
# Required. The name of the subscription. It must have the format
313+
# Required. Identifier. The name of the subscription. It must have the format
314314
# `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
315315
# start with a letter, and contain only letters (`[A-Za-z]`), numbers
316316
# (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
@@ -513,7 +513,7 @@ def create_subscription request, options = nil
513513
# the default parameter values, pass an empty Hash as a request object (see above).
514514
#
515515
# @param subscription [::String]
516-
# Required. The name of the subscription to get.
516+
# Required. Identifier. The name of the subscription to get.
517517
# Format is `projects/{project}/subscriptions/{sub}`.
518518
#
519519
# @yield [response, operation] Access the result along with the RPC operation
@@ -689,8 +689,8 @@ def update_subscription request, options = nil
689689
# the default parameter values, pass an empty Hash as a request object (see above).
690690
#
691691
# @param project [::String]
692-
# Required. The name of the project in which to list subscriptions.
693-
# Format is `projects/{project-id}`.
692+
# Required. Identifier. The name of the project in which to list
693+
# subscriptions. Format is `projects/{project-id}`.
694694
# @param page_size [::Integer]
695695
# Optional. Maximum number of subscriptions to return.
696696
# @param page_token [::String]
@@ -791,7 +791,7 @@ def list_subscriptions request, options = nil
791791
# the default parameter values, pass an empty Hash as a request object (see above).
792792
#
793793
# @param subscription [::String]
794-
# Required. The subscription to delete.
794+
# Required. Identifier. The subscription to delete.
795795
# Format is `projects/{project}/subscriptions/{sub}`.
796796
#
797797
# @yield [response, operation] Access the result along with the RPC operation
@@ -1359,7 +1359,7 @@ def modify_push_config request, options = nil
13591359
# the default parameter values, pass an empty Hash as a request object (see above).
13601360
#
13611361
# @param snapshot [::String]
1362-
# Required. The name of the snapshot to get.
1362+
# Required. Identifier. The name of the snapshot to get.
13631363
# Format is `projects/{project}/snapshots/{snap}`.
13641364
#
13651365
# @yield [response, operation] Access the result along with the RPC operation
@@ -1449,7 +1449,7 @@ def get_snapshot request, options = nil
14491449
# the default parameter values, pass an empty Hash as a request object (see above).
14501450
#
14511451
# @param project [::String]
1452-
# Required. The name of the project in which to list snapshots.
1452+
# Required. Identifier. The name of the project in which to list snapshots.
14531453
# Format is `projects/{project-id}`.
14541454
# @param page_size [::Integer]
14551455
# Optional. Maximum number of snapshots to return.
@@ -1562,10 +1562,10 @@ def list_snapshots request, options = nil
15621562
# the default parameter values, pass an empty Hash as a request object (see above).
15631563
#
15641564
# @param name [::String]
1565-
# Required. User-provided name for this snapshot. If the name is not provided
1566-
# in the request, the server will assign a random name for this snapshot on
1567-
# the same project as the subscription. Note that for REST API requests, you
1568-
# must specify a name. See the [resource name
1565+
# Required. Identifier. User-provided name for this snapshot. If the name is
1566+
# not provided in the request, the server will assign a random name for this
1567+
# snapshot on the same project as the subscription. Note that for REST API
1568+
# requests, you must specify a name. See the [resource name
15691569
# rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
15701570
# Format is `projects/{project}/snapshots/{snap}`.
15711571
# @param subscription [::String]
@@ -1771,7 +1771,7 @@ def update_snapshot request, options = nil
17711771
# the default parameter values, pass an empty Hash as a request object (see above).
17721772
#
17731773
# @param snapshot [::String]
1774-
# Required. The name of the snapshot to delete.
1774+
# Required. Identifier. The name of the snapshot to delete.
17751775
# Format is `projects/{project}/snapshots/{snap}`.
17761776
#
17771777
# @yield [response, operation] Access the result along with the RPC operation

‎google-cloud-pubsub-v1/lib/google/cloud/pubsub/v1/topic_admin/client.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ def logger
265265
# the default parameter values, pass an empty Hash as a request object (see above).
266266
#
267267
# @param name [::String]
268-
# Required. The name of the topic. It must have the format
268+
# Required. Identifier. The name of the topic. It must have the format
269269
# `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
270270
# and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
271271
# underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
@@ -485,8 +485,8 @@ def update_topic request, options = nil
485485
# the default parameter values, pass an empty Hash as a request object (see above).
486486
#
487487
# @param topic [::String]
488-
# Required. The messages in the request will be published on this topic.
489-
# Format is `projects/{project}/topics/{topic}`.
488+
# Required. Identifier. The messages in the request will be published on this
489+
# topic. Format is `projects/{project}/topics/{topic}`.
490490
# @param messages [::Array<::Google::Cloud::PubSub::V1::PubsubMessage, ::Hash>]
491491
# Required. The messages to publish.
492492
#
@@ -573,7 +573,7 @@ def publish request, options = nil
573573
# the default parameter values, pass an empty Hash as a request object (see above).
574574
#
575575
# @param topic [::String]
576-
# Required. The name of the topic to get.
576+
# Required. Identifier. The name of the topic to get.
577577
# Format is `projects/{project}/topics/{topic}`.
578578
#
579579
# @yield [response, operation] Access the result along with the RPC operation
@@ -659,7 +659,7 @@ def get_topic request, options = nil
659659
# the default parameter values, pass an empty Hash as a request object (see above).
660660
#
661661
# @param project [::String]
662-
# Required. The name of the project in which to list topics.
662+
# Required. Identifier. The name of the project in which to list topics.
663663
# Format is `projects/{project-id}`.
664664
# @param page_size [::Integer]
665665
# Optional. Maximum number of topics to return.
@@ -949,7 +949,7 @@ def list_topic_snapshots request, options = nil
949949
# the default parameter values, pass an empty Hash as a request object (see above).
950950
#
951951
# @param topic [::String]
952-
# Required. Name of the topic to delete.
952+
# Required. Identifier. Name of the topic to delete.
953953
# Format is `projects/{project}/topics/{topic}`.
954954
#
955955
# @yield [response, operation] Access the result along with the RPC operation

‎google-cloud-pubsub-v1/lib/google/pubsub/v1/pubsub_pb.rb‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎google-cloud-pubsub-v1/proto_docs/google/pubsub/v1/pubsub.rb‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,7 @@ class MessageTransform
775775
# A topic resource.
776776
# @!attribute [rw] name
777777
# @return [::String]
778-
# Required. The name of the topic. It must have the format
778+
# Required. Identifier. The name of the topic. It must have the format
779779
# `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
780780
# and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
781781
# underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
@@ -922,7 +922,7 @@ class AttributesEntry
922922
# Request for the GetTopic method.
923923
# @!attribute [rw] topic
924924
# @return [::String]
925-
# Required. The name of the topic to get.
925+
# Required. Identifier. The name of the topic to get.
926926
# Format is `projects/{project}/topics/{topic}`.
927927
class GetTopicRequest
928928
include ::Google::Protobuf::MessageExts
@@ -948,8 +948,8 @@ class UpdateTopicRequest
948948
# Request for the Publish method.
949949
# @!attribute [rw] topic
950950
# @return [::String]
951-
# Required. The messages in the request will be published on this topic.
952-
# Format is `projects/{project}/topics/{topic}`.
951+
# Required. Identifier. The messages in the request will be published on this
952+
# topic. Format is `projects/{project}/topics/{topic}`.
953953
# @!attribute [rw] messages
954954
# @return [::Array<::Google::Cloud::PubSub::V1::PubsubMessage>]
955955
# Required. The messages to publish.
@@ -972,7 +972,7 @@ class PublishResponse
972972
# Request for the `ListTopics` method.
973973
# @!attribute [rw] project
974974
# @return [::String]
975-
# Required. The name of the project in which to list topics.
975+
# Required. Identifier. The name of the project in which to list topics.
976976
# Format is `projects/{project-id}`.
977977
# @!attribute [rw] page_size
978978
# @return [::Integer]
@@ -1068,7 +1068,7 @@ class ListTopicSnapshotsResponse
10681068
# Request for the `DeleteTopic` method.
10691069
# @!attribute [rw] topic
10701070
# @return [::String]
1071-
# Required. Name of the topic to delete.
1071+
# Required. Identifier. Name of the topic to delete.
10721072
# Format is `projects/{project}/topics/{topic}`.
10731073
class DeleteTopicRequest
10741074
include ::Google::Protobuf::MessageExts
@@ -1097,7 +1097,7 @@ class DetachSubscriptionResponse
10971097
# using API methods. At most one of these fields may be set.
10981098
# @!attribute [rw] name
10991099
# @return [::String]
1100-
# Required. The name of the subscription. It must have the format
1100+
# Required. Identifier. The name of the subscription. It must have the format
11011101
# `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
11021102
# start with a letter, and contain only letters (`[A-Za-z]`), numbers
11031103
# (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
@@ -1702,7 +1702,7 @@ class ReceivedMessage
17021702
# Request for the GetSubscription method.
17031703
# @!attribute [rw] subscription
17041704
# @return [::String]
1705-
# Required. The name of the subscription to get.
1705+
# Required. Identifier. The name of the subscription to get.
17061706
# Format is `projects/{project}/subscriptions/{sub}`.
17071707
class GetSubscriptionRequest
17081708
include ::Google::Protobuf::MessageExts
@@ -1725,8 +1725,8 @@ class UpdateSubscriptionRequest
17251725
# Request for the `ListSubscriptions` method.
17261726
# @!attribute [rw] project
17271727
# @return [::String]
1728-
# Required. The name of the project in which to list subscriptions.
1729-
# Format is `projects/{project-id}`.
1728+
# Required. Identifier. The name of the project in which to list
1729+
# subscriptions. Format is `projects/{project-id}`.
17301730
# @!attribute [rw] page_size
17311731
# @return [::Integer]
17321732
# Optional. Maximum number of subscriptions to return.
@@ -1757,7 +1757,7 @@ class ListSubscriptionsResponse
17571757
# Request for the DeleteSubscription method.
17581758
# @!attribute [rw] subscription
17591759
# @return [::String]
1760-
# Required. The subscription to delete.
1760+
# Required. Identifier. The subscription to delete.
17611761
# Format is `projects/{project}/subscriptions/{sub}`.
17621762
class DeleteSubscriptionRequest
17631763
include ::Google::Protobuf::MessageExts
@@ -2017,10 +2017,10 @@ class SubscriptionProperties
20172017
# Request for the `CreateSnapshot` method.
20182018
# @!attribute [rw] name
20192019
# @return [::String]
2020-
# Required. User-provided name for this snapshot. If the name is not provided
2021-
# in the request, the server will assign a random name for this snapshot on
2022-
# the same project as the subscription. Note that for REST API requests, you
2023-
# must specify a name. See the [resource name
2020+
# Required. Identifier. User-provided name for this snapshot. If the name is
2021+
# not provided in the request, the server will assign a random name for this
2022+
# snapshot on the same project as the subscription. Note that for REST API
2023+
# requests, you must specify a name. See the [resource name
20242024
# rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
20252025
# Format is `projects/{project}/snapshots/{snap}`.
20262026
# @!attribute [rw] subscription
@@ -2125,7 +2125,7 @@ class LabelsEntry
21252125
# Request for the GetSnapshot method.
21262126
# @!attribute [rw] snapshot
21272127
# @return [::String]
2128-
# Required. The name of the snapshot to get.
2128+
# Required. Identifier. The name of the snapshot to get.
21292129
# Format is `projects/{project}/snapshots/{snap}`.
21302130
class GetSnapshotRequest
21312131
include ::Google::Protobuf::MessageExts
@@ -2135,7 +2135,7 @@ class GetSnapshotRequest
21352135
# Request for the `ListSnapshots` method.
21362136
# @!attribute [rw] project
21372137
# @return [::String]
2138-
# Required. The name of the project in which to list snapshots.
2138+
# Required. Identifier. The name of the project in which to list snapshots.
21392139
# Format is `projects/{project-id}`.
21402140
# @!attribute [rw] page_size
21412141
# @return [::Integer]
@@ -2167,7 +2167,7 @@ class ListSnapshotsResponse
21672167
# Request for the `DeleteSnapshot` method.
21682168
# @!attribute [rw] snapshot
21692169
# @return [::String]
2170-
# Required. The name of the snapshot to delete.
2170+
# Required. Identifier. The name of the snapshot to delete.
21712171
# Format is `projects/{project}/snapshots/{snap}`.
21722172
class DeleteSnapshotRequest
21732173
include ::Google::Protobuf::MessageExts

0 commit comments

Comments
 (0)