Skip to content

Commit

Permalink
fix(docs): link to correct gaxOptions docs (#999)
Browse files Browse the repository at this point in the history
  • Loading branch information
@stephenplusplus
stephenplusplus authored May 19, 2020
1 parent 7b242a3 commit 312e318
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 20 deletions.
6 changes: 3 additions & 3 deletions src/iam.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ export class IAM {
* Get the IAM policy
*
* @param {object} [gaxOptions] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {GetPolicyCallback} [callback] Callback function.
* @returns {Promise<GetPolicyResponse>}
*
Expand Down Expand Up @@ -193,7 +193,7 @@ export class IAM {
* @param {Array<object>} [policy.rules] Rules to be applied to the policy.
* @param {string} [policy.etag] Etags are used to perform a read-modify-write.
* @param {object} [gaxOptions] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {SetPolicyCallback} callback Callback function.
* @returns {Promise<SetPolicyResponse>}
*
Expand Down Expand Up @@ -297,7 +297,7 @@ export class IAM {
*
* @param {string|string[]} permissions The permission(s) to test for.
* @param {object} [gaxOptions] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {TestIamPermissionsCallback} [callback] Callback function.
* @returns {Promise<TestIamPermissionsResponse>}
*
Expand Down
10 changes: 5 additions & 5 deletions src/pubsub.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ export class PubSub {
* of un-acked messages to allow before the subscription pauses incoming
* messages.
* @property {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @property {number|google.protobuf.Duration} [messageRetentionDuration] Set
* this to override the default duration of 7 days. This value is expected
* in seconds. Acceptable values are in the range of 10 minutes and 7
Expand Down Expand Up @@ -489,7 +489,7 @@ export class PubSub {
*
* @param {string} name Name of the topic.
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {CreateTopicCallback} [callback] Callback function.
* @returns {Promise<CreateTopicResponse>}
*
Expand Down Expand Up @@ -583,7 +583,7 @@ export class PubSub {
* @property {boolean} [autoPaginate=true] Have pagination handled
* automatically.
* @property {object} [options.gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @property {number} [options.pageSize] Maximum number of results to return.
* @property {string} [options.pageToken] Page token.
*/
Expand Down Expand Up @@ -689,7 +689,7 @@ export class PubSub {
* @property {boolean} [autoPaginate=true] Have pagination handled
* automatically.
* @property {object} [options.gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @property {number} [options.pageSize] Maximum number of results to return.
* @property {string} [options.pageToken] Page token.
* @param {string|Topic} options.topic - The name of the topic to
Expand Down Expand Up @@ -808,7 +808,7 @@ export class PubSub {
* @property {boolean} [autoPaginate=true] Have pagination handled
* automatically.
* @property {object} [options.gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @property {number} [options.pageSize] Maximum number of results to return.
* @property {string} [options.pageToken] Page token.
*/
Expand Down
14 changes: 7 additions & 7 deletions src/subscription.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ export class Subscription extends EventEmitter {
*
* @param {string} name Name of the snapshot.
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {CreateSnapshotCallback} [callback] Callback function.
* @returns {Promise<CreateSnapshotResponse>}
*
Expand Down Expand Up @@ -480,7 +480,7 @@ export class Subscription extends EventEmitter {
* @see [Subscriptions: delete API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/delete}
*
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {function} [callback] The callback function.
* @param {?error} callback.err An error returned while making this
* request.
Expand Down Expand Up @@ -594,7 +594,7 @@ export class Subscription extends EventEmitter {
* Get a subscription if it exists.
*
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {boolean} [gaxOpts.autoCreate=false] Automatically create the
* subscription if it does not already exist.
* @param {GetSubscriptionCallback} [callback] Callback function.
Expand Down Expand Up @@ -663,7 +663,7 @@ export class Subscription extends EventEmitter {
* Fetches the subscriptions metadata.
*
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {GetSubscriptionMetadataCallback} [callback] Callback function.
* @returns {Promise<GetSubscriptionMetadataResponse>}
*
Expand Down Expand Up @@ -745,7 +745,7 @@ export class Subscription extends EventEmitter {
* request for every pushed message. This object should have the same
* structure as [OidcToken]{@link google.pubsub.v1.OidcToken}
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {ModifyPushConfigCallback} [callback] Callback function.
* @returns {Promise<ModifyPushConfigResponse>}
*
Expand Down Expand Up @@ -853,7 +853,7 @@ export class Subscription extends EventEmitter {
* @param {string|date} snapshot The point to seek to. This will accept the
* name of the snapshot or a Date object.
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {SeekCallback} [callback] Callback function.
* @returns {Promise<SeekResponse>}
*
Expand Down Expand Up @@ -937,7 +937,7 @@ export class Subscription extends EventEmitter {
*
* @param {object} metadata The subscription metadata.
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {SetSubscriptionMetadataCallback} [callback] Callback function.
* @returns {Promise<SetSubscriptionMetadataResponse>}
*
Expand Down
10 changes: 5 additions & 5 deletions src/topic.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ export class Topic {
* Create a topic.
*
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {CreateTopicCallback} [callback] Callback function.
* @returns {Promise<CreateTopicResponse>}
*
Expand Down Expand Up @@ -304,7 +304,7 @@ export class Topic {
* @see [Topics: delete API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/delete}
*
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {function} [callback] The callback function.
* @param {?error} callback.err An error returned while making this
* request.
Expand Down Expand Up @@ -411,7 +411,7 @@ export class Topic {
* Get a topic if it exists.
*
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {boolean} [gaxOpts.autoCreate=false] Automatically create the topic
* does not already exist.
* @param {GetTopicCallback} [callback] Callback function.
Expand Down Expand Up @@ -476,7 +476,7 @@ export class Topic {
* @see [Topics: get API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/get}
*
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {GetTopicMetadataCallback} [callback] Callback function.
* @returns {Promise<GetTopicMetadataResponse>}
*
Expand Down Expand Up @@ -851,7 +851,7 @@ export class Topic {
* https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic|Topic
* object}.
* @param {object} [gaxOpts] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {SetTopicMetadataCallback} [callback] Callback function.
* @returns {Promise<SetTopicMetadataResponse>}
*
Expand Down

0 comments on commit 312e318

Please sign in to comment.