Skip to content

Commit

Permalink
docs: modified some descriptions (googleapis#6723)
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 573936401
Source-Link: googleapis/googleapis@c1f0134
Source-Link: https://github.com/googleapis/googleapis-gen/commit/a063e1be04179c7386317bb395dea10eb38229b2
Copy-Tag: eyJwIjoiUHViU3ViLy5Pd2xCb3QueWFtbCIsImgiOiJhMDYzZTFiZTA0MTc5YzczODYzMTdiYjM5NWRlYTEwZWIzODIyOWIyIn0=
  • Loading branch information
gcf-owl-bot[bot] authored Oct 18, 2023
1 parent 5acfacc commit 827b247
Show file tree
Hide file tree
Showing 9 changed files with 56 additions and 52 deletions.
2 changes: 1 addition & 1 deletion PubSub/samples/V1/PublisherClient/create_topic.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

/**
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
*
* @param string $name The name of the topic. It must have the format
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
Expand Down
6 changes: 3 additions & 3 deletions PubSub/samples/V1/SubscriberClient/create_snapshot.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,16 @@
* the request, the server will assign a random
* name for this snapshot on the same project as the subscription, conforming
* to the [resource name format]
* (https://cloud.google.com/pubsub/docs/admin#resource_names). The
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
* generated name is populated in the returned Snapshot object. Note that for
* REST API requests, you must specify a name in the request.
*
* @param string $formattedName User-provided name for this snapshot. If the name is not provided
* in the request, the server will assign a random name for this snapshot on
* the same project as the subscription. Note that for REST API requests, you
* must specify a name. See the [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`. Please see
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`. Please see
* {@see SubscriberClient::snapshotName()} for help formatting this field.
* @param string $formattedSubscription The subscription whose backlog the snapshot retains.
* Specifically, the created snapshot is guaranteed to retain:
Expand Down
8 changes: 4 additions & 4 deletions PubSub/samples/V1/SubscriberClient/create_subscription.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@

/**
* Creates a subscription to a given topic. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* If the subscription already exists, returns `ALREADY_EXISTS`.
* If the corresponding topic doesn't exist, returns `NOT_FOUND`.
*
* If the name is not provided in the request, the server will assign a random
* name for this subscription on the same project as the topic, conforming
* to the [resource name format]
* (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
* name is populated in the returned Subscription object. Note that for REST
* API requests, you must specify a name in the request.
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
* generated name is populated in the returned Subscription object. Note that
* for REST API requests, you must specify a name in the request.
*
* @param string $name The name of the subscription. It must have the format
* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
Expand Down
2 changes: 1 addition & 1 deletion PubSub/src/V1/Client/PublisherClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ public function __call($method, $args)

/**
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
*
* The async variant is {@see PublisherClient::createTopicAsync()} .
*
Expand Down
10 changes: 5 additions & 5 deletions PubSub/src/V1/Client/SubscriberClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ public function acknowledge(AcknowledgeRequest $request, array $callOptions = []
* the request, the server will assign a random
* name for this snapshot on the same project as the subscription, conforming
* to the [resource name format]
* (https://cloud.google.com/pubsub/docs/admin#resource_names). The
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
* generated name is populated in the returned Snapshot object. Note that for
* REST API requests, you must specify a name in the request.
*
Expand All @@ -401,16 +401,16 @@ public function createSnapshot(CreateSnapshotRequest $request, array $callOption

/**
* Creates a subscription to a given topic. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* If the subscription already exists, returns `ALREADY_EXISTS`.
* If the corresponding topic doesn't exist, returns `NOT_FOUND`.
*
* If the name is not provided in the request, the server will assign a random
* name for this subscription on the same project as the topic, conforming
* to the [resource name format]
* (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
* name is populated in the returned Subscription object. Note that for REST
* API requests, you must specify a name in the request.
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
* generated name is populated in the returned Subscription object. Note that
* for REST API requests, you must specify a name in the request.
*
* The async variant is {@see SubscriberClient::createSubscriptionAsync()} .
*
Expand Down
20 changes: 10 additions & 10 deletions PubSub/src/V1/CreateSnapshotRequest.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion PubSub/src/V1/Gapic/PublisherGapicClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ public function __construct(array $options = [])

/**
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
*
* Sample code:
* ```
Expand Down
14 changes: 7 additions & 7 deletions PubSub/src/V1/Gapic/SubscriberGapicClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ public function acknowledge($subscription, $ackIds, array $optionalArgs = [])
* the request, the server will assign a random
* name for this snapshot on the same project as the subscription, conforming
* to the [resource name format]
* (https://cloud.google.com/pubsub/docs/admin#resource_names). The
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
* generated name is populated in the returned Snapshot object. Note that for
* REST API requests, you must specify a name in the request.
*
Expand All @@ -509,8 +509,8 @@ public function acknowledge($subscription, $ackIds, array $optionalArgs = [])
* in the request, the server will assign a random name for this snapshot on
* the same project as the subscription. Note that for REST API requests, you
* must specify a name. See the [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`.
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* @param string $subscription Required. The subscription whose backlog the snapshot retains.
* Specifically, the created snapshot is guaranteed to retain:
* (a) The existing backlog on the subscription. More precisely, this is
Expand Down Expand Up @@ -554,16 +554,16 @@ public function createSnapshot($name, $subscription, array $optionalArgs = [])

/**
* Creates a subscription to a given topic. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* If the subscription already exists, returns `ALREADY_EXISTS`.
* If the corresponding topic doesn't exist, returns `NOT_FOUND`.
*
* If the name is not provided in the request, the server will assign a random
* name for this subscription on the same project as the topic, conforming
* to the [resource name format]
* (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
* name is populated in the returned Subscription object. Note that for REST
* API requests, you must specify a name in the request.
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
* generated name is populated in the returned Subscription object. Note that
* for REST API requests, you must specify a name in the request.
*
* Sample code:
* ```
Expand Down
44 changes: 24 additions & 20 deletions PubSub/src/V1/MessageStoragePolicy.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 827b247

Please sign in to comment.