diff --git a/.gitignore b/.gitignore index 5d32b2378..d4f03a0df 100644 --- a/.gitignore +++ b/.gitignore @@ -1,11 +1,11 @@ **/*.log **/node_modules -.coverage -coverage -.nyc_output -docs/ -out/ -build/ +/.coverage +/coverage +/.nyc_output +/docs/ +/out/ +/build/ system-test/secrets.js system-test/*key.json *.lock diff --git a/protos/google/pubsub/v1/pubsub.proto b/protos/google/pubsub/v1/pubsub.proto index 661633b61..61656056c 100644 --- a/protos/google/pubsub/v1/pubsub.proto +++ b/protos/google/pubsub/v1/pubsub.proto @@ -60,6 +60,7 @@ service Publisher { patch: "/v1/{topic.name=projects/*/topics/*}" body: "*" }; + option (google.api.method_signature) = "topic,update_mask"; } // Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic @@ -214,7 +215,7 @@ message Topic { // timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) // that is up to `message_retention_duration` in the past. If this field is // not set, message retention is controlled by settings on individual - // subscriptions. Cannot be more than 7 days or less than 10 minutes. + // subscriptions. Cannot be more than 31 days or less than 10 minutes. google.protobuf.Duration message_retention_duration = 8; } @@ -461,6 +462,7 @@ service Subscriber { patch: "/v1/{subscription.name=projects/*/subscriptions/*}" body: "*" }; + option (google.api.method_signature) = "subscription,update_mask"; } // Lists matching subscriptions. @@ -515,9 +517,7 @@ service Subscriber { option (google.api.method_signature) = "subscription,ack_ids"; } - // Pulls messages from the server. The server may return `UNAVAILABLE` if - // there are too many concurrent pull requests pending for the given - // subscription. + // Pulls messages from the server. rpc Pull(PullRequest) returns (PullResponse) { option (google.api.http) = { post: "/v1/{subscription=projects/*/subscriptions/*}:pull" @@ -554,10 +554,10 @@ service Subscriber { } // Gets the configuration details of a snapshot. Snapshots are used in - // Seek - // operations, which allow you to manage message acknowledgments in bulk. That - // is, you can set the acknowledgment state of messages in an existing - // subscription to the state captured by a snapshot. + // [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, + // which allow you to manage message acknowledgments in bulk. That is, you can + // set the acknowledgment state of messages in an existing subscription to the + // state captured by a snapshot. rpc GetSnapshot(GetSnapshotRequest) returns (Snapshot) { option (google.api.http) = { get: "/v1/{snapshot=projects/*/snapshots/*}" @@ -602,16 +602,16 @@ service Subscriber { } // Updates an existing snapshot. Snapshots are used in - // Seek - // operations, which allow - // you to manage message acknowledgments in bulk. That is, you can set the - // acknowledgment state of messages in an existing subscription to the state - // captured by a snapshot. + // [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, + // which allow you to manage message acknowledgments in bulk. That is, you can + // set the acknowledgment state of messages in an existing subscription to the + // state captured by a snapshot. rpc UpdateSnapshot(UpdateSnapshotRequest) returns (Snapshot) { option (google.api.http) = { patch: "/v1/{snapshot.name=projects/*/snapshots/*}" body: "*" }; + option (google.api.method_signature) = "snapshot,update_mask"; } // Removes an existing snapshot. Snapshots are used in [Seek] @@ -645,7 +645,9 @@ service Subscriber { } } -// A subscription resource. +// A subscription resource. If none of `push_config` or `bigquery_config` is +// set, then the subscriber will pull and ack messages using API methods. At +// most one of these fields may be set. message Subscription { option (google.api.resource) = { type: "pubsub.googleapis.com/Subscription" @@ -683,21 +685,17 @@ message Subscription { ]; // If push delivery is used with this subscription, this field is - // used to configure it. Either `pushConfig` or `bigQueryConfig` can be set, - // but not both. If both are empty, then the subscriber will pull and ack - // messages using API methods. + // used to configure it. PushConfig push_config = 4; // If delivery to BigQuery is used with this subscription, this field is - // used to configure it. Either `pushConfig` or `bigQueryConfig` can be set, - // but not both. If both are empty, then the subscriber will pull and ack - // messages using API methods. + // used to configure it. BigQueryConfig bigquery_config = 18; // The approximate amount of time (on a best-effort basis) Pub/Sub waits for // the subscriber to acknowledge receipt before resending the message. In the // interval after the message is delivered and before it is acknowledged, it - // is considered to be outstanding. During that time period, the + // is considered to be _outstanding_. During that time period, the // message will not be redelivered (on a best-effort basis). // // For pull subscriptions, this value is used as the initial value for the ack @@ -732,8 +730,8 @@ message Subscription { // minutes. google.protobuf.Duration message_retention_duration = 8; - // See Creating and - // managing labels. + // See [Creating and managing + // labels](https://cloud.google.com/pubsub/docs/labels). map labels = 9; // If true, messages published with the same `ordering_key` in `PubsubMessage` @@ -922,7 +920,7 @@ message PushConfig { // * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. // // For example: - // 
attributes { "x-goog-version": "v1" }
+ // `attributes { "x-goog-version": "v1" }` map attributes = 2; // An authentication method used by push endpoints to verify the source of @@ -948,6 +946,11 @@ message BigQueryConfig { ACTIVE = 1; // Cannot write to the BigQuery table because of permission denied errors. + // This can happen if + // - Pub/Sub SA has not been granted the [appropriate BigQuery IAM + // permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account) + // - bigquery.googleapis.com API is not enabled for the project + // ([instructions](https://cloud.google.com/service-usage/docs/enable-disable)) PERMISSION_DENIED = 2; // Cannot write to the BigQuery table because it does not exist. @@ -958,7 +961,7 @@ message BigQueryConfig { } // The name of the table to which to write data, of the form - // {projectId}:{datasetId}.{tableId} + // {projectId}.{datasetId}.{tableId} string table = 1; // When true, use the topic's schema as the columns to write to in BigQuery, @@ -1127,7 +1130,8 @@ message PullRequest { // Response for the `Pull` method. message PullResponse { // Received Pub/Sub messages. The list will be empty if there are no more - // messages available in the backlog. For JSON, the response can be entirely + // messages available in the backlog, or if no messages could be returned + // before the request timeout. For JSON, the response can be entirely // empty. The Pub/Sub system may return fewer than the `maxMessages` requested // even if there are more messages available in the backlog. repeated ReceivedMessage received_messages = 1; @@ -1270,6 +1274,9 @@ message StreamingPullResponse { // List of acknowledgement IDs that were out of order. repeated string unordered_ack_ids = 3; + + // List of acknowledgement IDs that failed processing with temporary issues. + repeated string temporary_failed_ack_ids = 4; } // Acknowledgement IDs sent in one or more previous requests to modify the @@ -1281,12 +1288,16 @@ message StreamingPullResponse { // List of acknowledgement IDs that were malformed or whose acknowledgement // deadline has expired. repeated string invalid_ack_ids = 2; + + // List of acknowledgement IDs that failed processing with temporary issues. + repeated string temporary_failed_ack_ids = 3; } // Subscription properties sent as part of the response. message SubscriptionProperties { // True iff exactly once delivery is enabled for this subscription. bool exactly_once_delivery_enabled = 1; + // True iff message ordering is enabled for this subscription. bool message_ordering_enabled = 2; } @@ -1294,8 +1305,6 @@ message StreamingPullResponse { // Received Pub/Sub messages. This will not be empty. repeated ReceivedMessage received_messages = 1; - reserved 2; - // This field will only be set if `enable_exactly_once_delivery` is set to // `true`. AcknowledgeConfirmation acknowledge_confirmation = 5; @@ -1313,9 +1322,9 @@ message CreateSnapshotRequest { // Required. 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. Format is `projects/{project}/snapshots/{snap}`. + // must specify a name. See the [resource name + // rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format + // is `projects/{project}/snapshots/{snap}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "pubsub.googleapis.com/Snapshot" } @@ -1337,8 +1346,8 @@ message CreateSnapshotRequest { } ]; - // See Creating and - // managing labels. + // See [Creating and managing + // labels](https://cloud.google.com/pubsub/docs/labels). map labels = 3; } diff --git a/protos/google/pubsub/v1/schema.proto b/protos/google/pubsub/v1/schema.proto index 1b1483b87..8c674df13 100644 --- a/protos/google/pubsub/v1/schema.proto +++ b/protos/google/pubsub/v1/schema.proto @@ -320,17 +320,17 @@ message DeleteSchemaRevisionRequest { // Required. The name of the schema revision to be deleted, with a revision ID // explicitly included. // - // Example: projects/123/schemas/my-schema@c7cfa2a8 + // Example: `projects/123/schemas/my-schema@c7cfa2a8` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "pubsub.googleapis.com/Schema" } ]; - // Required. The revision ID to roll back to. - // It must be a revision of the same schema. - // - // Example: c7cfa2a8 - string revision_id = 2 [(google.api.field_behavior) = REQUIRED]; + // Optional. This field is deprecated and should not be used for specifying + // the revision ID. The revision ID should be specified via the `name` + // parameter. + string revision_id = 2 + [deprecated = true, (google.api.field_behavior) = OPTIONAL]; } // Request for the `DeleteSchema` method. diff --git a/protos/protos.d.ts b/protos/protos.d.ts index e40d0e65e..d1a8d63b8 100644 --- a/protos/protos.d.ts +++ b/protos/protos.d.ts @@ -4646,6 +4646,9 @@ export namespace google { /** AcknowledgeConfirmation unorderedAckIds */ unorderedAckIds?: (string[]|null); + + /** AcknowledgeConfirmation temporaryFailedAckIds */ + temporaryFailedAckIds?: (string[]|null); } /** Represents an AcknowledgeConfirmation. */ @@ -4666,6 +4669,9 @@ export namespace google { /** AcknowledgeConfirmation unorderedAckIds. */ public unorderedAckIds: string[]; + /** AcknowledgeConfirmation temporaryFailedAckIds. */ + public temporaryFailedAckIds: string[]; + /** * Creates a new AcknowledgeConfirmation instance using the specified properties. * @param [properties] Properties to set @@ -4752,6 +4758,9 @@ export namespace google { /** ModifyAckDeadlineConfirmation invalidAckIds */ invalidAckIds?: (string[]|null); + + /** ModifyAckDeadlineConfirmation temporaryFailedAckIds */ + temporaryFailedAckIds?: (string[]|null); } /** Represents a ModifyAckDeadlineConfirmation. */ @@ -4769,6 +4778,9 @@ export namespace google { /** ModifyAckDeadlineConfirmation invalidAckIds. */ public invalidAckIds: string[]; + /** ModifyAckDeadlineConfirmation temporaryFailedAckIds. */ + public temporaryFailedAckIds: string[]; + /** * Creates a new ModifyAckDeadlineConfirmation instance using the specified properties. * @param [properties] Properties to set diff --git a/protos/protos.js b/protos/protos.js index fc79a0564..0d3b5446c 100644 --- a/protos/protos.js +++ b/protos/protos.js @@ -10800,6 +10800,7 @@ * @property {Array.|null} [ackIds] AcknowledgeConfirmation ackIds * @property {Array.|null} [invalidAckIds] AcknowledgeConfirmation invalidAckIds * @property {Array.|null} [unorderedAckIds] AcknowledgeConfirmation unorderedAckIds + * @property {Array.|null} [temporaryFailedAckIds] AcknowledgeConfirmation temporaryFailedAckIds */ /** @@ -10814,6 +10815,7 @@ this.ackIds = []; this.invalidAckIds = []; this.unorderedAckIds = []; + this.temporaryFailedAckIds = []; if (properties) for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) if (properties[keys[i]] != null) @@ -10844,6 +10846,14 @@ */ AcknowledgeConfirmation.prototype.unorderedAckIds = $util.emptyArray; + /** + * AcknowledgeConfirmation temporaryFailedAckIds. + * @member {Array.} temporaryFailedAckIds + * @memberof google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation + * @instance + */ + AcknowledgeConfirmation.prototype.temporaryFailedAckIds = $util.emptyArray; + /** * Creates a new AcknowledgeConfirmation instance using the specified properties. * @function create @@ -10877,6 +10887,9 @@ if (message.unorderedAckIds != null && message.unorderedAckIds.length) for (var i = 0; i < message.unorderedAckIds.length; ++i) writer.uint32(/* id 3, wireType 2 =*/26).string(message.unorderedAckIds[i]); + if (message.temporaryFailedAckIds != null && message.temporaryFailedAckIds.length) + for (var i = 0; i < message.temporaryFailedAckIds.length; ++i) + writer.uint32(/* id 4, wireType 2 =*/34).string(message.temporaryFailedAckIds[i]); return writer; }; @@ -10929,6 +10942,12 @@ message.unorderedAckIds.push(reader.string()); break; } + case 4: { + if (!(message.temporaryFailedAckIds && message.temporaryFailedAckIds.length)) + message.temporaryFailedAckIds = []; + message.temporaryFailedAckIds.push(reader.string()); + break; + } default: reader.skipType(tag & 7); break; @@ -10985,6 +11004,13 @@ if (!$util.isString(message.unorderedAckIds[i])) return "unorderedAckIds: string[] expected"; } + if (message.temporaryFailedAckIds != null && message.hasOwnProperty("temporaryFailedAckIds")) { + if (!Array.isArray(message.temporaryFailedAckIds)) + return "temporaryFailedAckIds: array expected"; + for (var i = 0; i < message.temporaryFailedAckIds.length; ++i) + if (!$util.isString(message.temporaryFailedAckIds[i])) + return "temporaryFailedAckIds: string[] expected"; + } return null; }; @@ -11021,6 +11047,13 @@ for (var i = 0; i < object.unorderedAckIds.length; ++i) message.unorderedAckIds[i] = String(object.unorderedAckIds[i]); } + if (object.temporaryFailedAckIds) { + if (!Array.isArray(object.temporaryFailedAckIds)) + throw TypeError(".google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation.temporaryFailedAckIds: array expected"); + message.temporaryFailedAckIds = []; + for (var i = 0; i < object.temporaryFailedAckIds.length; ++i) + message.temporaryFailedAckIds[i] = String(object.temporaryFailedAckIds[i]); + } return message; }; @@ -11041,6 +11074,7 @@ object.ackIds = []; object.invalidAckIds = []; object.unorderedAckIds = []; + object.temporaryFailedAckIds = []; } if (message.ackIds && message.ackIds.length) { object.ackIds = []; @@ -11057,6 +11091,11 @@ for (var j = 0; j < message.unorderedAckIds.length; ++j) object.unorderedAckIds[j] = message.unorderedAckIds[j]; } + if (message.temporaryFailedAckIds && message.temporaryFailedAckIds.length) { + object.temporaryFailedAckIds = []; + for (var j = 0; j < message.temporaryFailedAckIds.length; ++j) + object.temporaryFailedAckIds[j] = message.temporaryFailedAckIds[j]; + } return object; }; @@ -11097,6 +11136,7 @@ * @interface IModifyAckDeadlineConfirmation * @property {Array.|null} [ackIds] ModifyAckDeadlineConfirmation ackIds * @property {Array.|null} [invalidAckIds] ModifyAckDeadlineConfirmation invalidAckIds + * @property {Array.|null} [temporaryFailedAckIds] ModifyAckDeadlineConfirmation temporaryFailedAckIds */ /** @@ -11110,6 +11150,7 @@ function ModifyAckDeadlineConfirmation(properties) { this.ackIds = []; this.invalidAckIds = []; + this.temporaryFailedAckIds = []; if (properties) for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) if (properties[keys[i]] != null) @@ -11132,6 +11173,14 @@ */ ModifyAckDeadlineConfirmation.prototype.invalidAckIds = $util.emptyArray; + /** + * ModifyAckDeadlineConfirmation temporaryFailedAckIds. + * @member {Array.} temporaryFailedAckIds + * @memberof google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation + * @instance + */ + ModifyAckDeadlineConfirmation.prototype.temporaryFailedAckIds = $util.emptyArray; + /** * Creates a new ModifyAckDeadlineConfirmation instance using the specified properties. * @function create @@ -11162,6 +11211,9 @@ if (message.invalidAckIds != null && message.invalidAckIds.length) for (var i = 0; i < message.invalidAckIds.length; ++i) writer.uint32(/* id 2, wireType 2 =*/18).string(message.invalidAckIds[i]); + if (message.temporaryFailedAckIds != null && message.temporaryFailedAckIds.length) + for (var i = 0; i < message.temporaryFailedAckIds.length; ++i) + writer.uint32(/* id 3, wireType 2 =*/26).string(message.temporaryFailedAckIds[i]); return writer; }; @@ -11208,6 +11260,12 @@ message.invalidAckIds.push(reader.string()); break; } + case 3: { + if (!(message.temporaryFailedAckIds && message.temporaryFailedAckIds.length)) + message.temporaryFailedAckIds = []; + message.temporaryFailedAckIds.push(reader.string()); + break; + } default: reader.skipType(tag & 7); break; @@ -11257,6 +11315,13 @@ if (!$util.isString(message.invalidAckIds[i])) return "invalidAckIds: string[] expected"; } + if (message.temporaryFailedAckIds != null && message.hasOwnProperty("temporaryFailedAckIds")) { + if (!Array.isArray(message.temporaryFailedAckIds)) + return "temporaryFailedAckIds: array expected"; + for (var i = 0; i < message.temporaryFailedAckIds.length; ++i) + if (!$util.isString(message.temporaryFailedAckIds[i])) + return "temporaryFailedAckIds: string[] expected"; + } return null; }; @@ -11286,6 +11351,13 @@ for (var i = 0; i < object.invalidAckIds.length; ++i) message.invalidAckIds[i] = String(object.invalidAckIds[i]); } + if (object.temporaryFailedAckIds) { + if (!Array.isArray(object.temporaryFailedAckIds)) + throw TypeError(".google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation.temporaryFailedAckIds: array expected"); + message.temporaryFailedAckIds = []; + for (var i = 0; i < object.temporaryFailedAckIds.length; ++i) + message.temporaryFailedAckIds[i] = String(object.temporaryFailedAckIds[i]); + } return message; }; @@ -11305,6 +11377,7 @@ if (options.arrays || options.defaults) { object.ackIds = []; object.invalidAckIds = []; + object.temporaryFailedAckIds = []; } if (message.ackIds && message.ackIds.length) { object.ackIds = []; @@ -11316,6 +11389,11 @@ for (var j = 0; j < message.invalidAckIds.length; ++j) object.invalidAckIds[j] = message.invalidAckIds[j]; } + if (message.temporaryFailedAckIds && message.temporaryFailedAckIds.length) { + object.temporaryFailedAckIds = []; + for (var j = 0; j < message.temporaryFailedAckIds.length; ++j) + object.temporaryFailedAckIds[j] = message.temporaryFailedAckIds[j]; + } return object; }; diff --git a/protos/protos.json b/protos/protos.json index 2d55ee337..52e573117 100644 --- a/protos/protos.json +++ b/protos/protos.json @@ -47,7 +47,8 @@ "responseType": "Topic", "options": { "(google.api.http).patch": "/v1/{topic.name=projects/*/topics/*}", - "(google.api.http).body": "*" + "(google.api.http).body": "*", + "(google.api.method_signature)": "topic,update_mask" }, "parsedOptions": [ { @@ -55,6 +56,9 @@ "patch": "/v1/{topic.name=projects/*/topics/*}", "body": "*" } + }, + { + "(google.api.method_signature)": "topic,update_mask" } ] }, @@ -519,7 +523,8 @@ "responseType": "Subscription", "options": { "(google.api.http).patch": "/v1/{subscription.name=projects/*/subscriptions/*}", - "(google.api.http).body": "*" + "(google.api.http).body": "*", + "(google.api.method_signature)": "subscription,update_mask" }, "parsedOptions": [ { @@ -527,6 +532,9 @@ "patch": "/v1/{subscription.name=projects/*/subscriptions/*}", "body": "*" } + }, + { + "(google.api.method_signature)": "subscription,update_mask" } ] }, @@ -716,7 +724,8 @@ "responseType": "Snapshot", "options": { "(google.api.http).patch": "/v1/{snapshot.name=projects/*/snapshots/*}", - "(google.api.http).body": "*" + "(google.api.http).body": "*", + "(google.api.method_signature)": "snapshot,update_mask" }, "parsedOptions": [ { @@ -724,6 +733,9 @@ "patch": "/v1/{snapshot.name=projects/*/snapshots/*}", "body": "*" } + }, + { + "(google.api.method_signature)": "snapshot,update_mask" } ] }, @@ -1229,12 +1241,6 @@ "id": 4 } }, - "reserved": [ - [ - 2, - 2 - ] - ], "nested": { "AcknowledgeConfirmation": { "fields": { @@ -1252,6 +1258,11 @@ "rule": "repeated", "type": "string", "id": 3 + }, + "temporaryFailedAckIds": { + "rule": "repeated", + "type": "string", + "id": 4 } } }, @@ -1266,6 +1277,11 @@ "rule": "repeated", "type": "string", "id": 2 + }, + "temporaryFailedAckIds": { + "rule": "repeated", + "type": "string", + "id": 3 } } }, @@ -1857,7 +1873,8 @@ "type": "string", "id": 2, "options": { - "(google.api.field_behavior)": "REQUIRED" + "deprecated": true, + "(google.api.field_behavior)": "OPTIONAL" } } } diff --git a/src/v1/publisher_client.ts b/src/v1/publisher_client.ts index 27b0ee243..c1dcd61fb 100644 --- a/src/v1/publisher_client.ts +++ b/src/v1/publisher_client.ts @@ -423,11 +423,11 @@ export class PublisherClient { * timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) * that is up to `message_retention_duration` in the past. If this field is * not set, message retention is controlled by settings on individual - * subscriptions. Cannot be more than 7 days or less than 10 minutes. + * subscriptions. Cannot be more than 31 days or less than 10 minutes. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Topic]{@link google.pubsub.v1.Topic}. + * The first element of the array is an object representing {@link google.pubsub.v1.Topic | Topic}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -515,7 +515,7 @@ export class PublisherClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Topic]{@link google.pubsub.v1.Topic}. + * The first element of the array is an object representing {@link google.pubsub.v1.Topic | Topic}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -600,7 +600,7 @@ export class PublisherClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [PublishResponse]{@link google.pubsub.v1.PublishResponse}. + * The first element of the array is an object representing {@link google.pubsub.v1.PublishResponse | PublishResponse}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -682,7 +682,7 @@ export class PublisherClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Topic]{@link google.pubsub.v1.Topic}. + * The first element of the array is an object representing {@link google.pubsub.v1.Topic | Topic}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -768,7 +768,7 @@ export class PublisherClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}. + * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -853,7 +853,7 @@ export class PublisherClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [DetachSubscriptionResponse]{@link google.pubsub.v1.DetachSubscriptionResponse}. + * The first element of the array is an object representing {@link google.pubsub.v1.DetachSubscriptionResponse | DetachSubscriptionResponse}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -942,7 +942,7 @@ export class PublisherClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of [Topic]{@link google.pubsub.v1.Topic}. + * The first element of the array is Array of {@link google.pubsub.v1.Topic | Topic}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. @@ -1035,7 +1035,7 @@ export class PublisherClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing [Topic]{@link google.pubsub.v1.Topic} on 'data' event. + * An object stream which emits an object representing {@link google.pubsub.v1.Topic | Topic} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTopicsAsync()` @@ -1086,7 +1086,7 @@ export class PublisherClient { * @returns {Object} * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). * When you iterate the returned iterable, each element will be an object representing - * [Topic]{@link google.pubsub.v1.Topic}. The API will be called under the hood as needed, once per the page, + * {@link google.pubsub.v1.Topic | Topic}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) @@ -1520,16 +1520,16 @@ export class PublisherClient { * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. This field is only used by Cloud IAM. * - * This object should have the same structure as [GetPolicyOptions]{@link google.iam.v1.GetPolicyOptions} + * This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, - * retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details. + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * - * The second parameter to the callback is an object representing [Policy]{@link google.iam.v1.Policy}. + * The second parameter to the callback is an object representing {@link google.iam.v1.Policy | Policy}. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Policy]{@link google.iam.v1.Policy}. + * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}. * The promise has a method named "cancel" which cancels the ongoing API call. */ getIamPolicy( @@ -1571,13 +1571,13 @@ export class PublisherClient { * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, - * retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details. + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * - * The second parameter to the callback is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. */ setIamPolicy( @@ -1619,13 +1619,13 @@ export class PublisherClient { * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, - * retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details. + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * - * The second parameter to the callback is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. * */ diff --git a/src/v1/schema_service_client.ts b/src/v1/schema_service_client.ts index 407534903..3d96239ab 100644 --- a/src/v1/schema_service_client.ts +++ b/src/v1/schema_service_client.ts @@ -384,7 +384,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Schema]{@link google.pubsub.v1.Schema}. + * The first element of the array is an object representing {@link google.pubsub.v1.Schema | Schema}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -469,7 +469,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Schema]{@link google.pubsub.v1.Schema}. + * The first element of the array is an object representing {@link google.pubsub.v1.Schema | Schema}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -553,7 +553,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Schema]{@link google.pubsub.v1.Schema}. + * The first element of the array is an object representing {@link google.pubsub.v1.Schema | Schema}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -639,7 +639,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Schema]{@link google.pubsub.v1.Schema}. + * The first element of the array is an object representing {@link google.pubsub.v1.Schema | Schema}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -719,16 +719,15 @@ export class SchemaServiceClient { * Required. The name of the schema revision to be deleted, with a revision ID * explicitly included. * - * Example: projects/123/schemas/my-schema@c7cfa2a8 - * @param {string} request.revisionId - * Required. The revision ID to roll back to. - * It must be a revision of the same schema. - * - * Example: c7cfa2a8 + * Example: `projects/123/schemas/my-schema@c7cfa2a8` + * @param {string} [request.revisionId] + * Optional. This field is deprecated and should not be used for specifying + * the revision ID. The revision ID should be specified via the `name` + * parameter. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Schema]{@link google.pubsub.v1.Schema}. + * The first element of the array is an object representing {@link google.pubsub.v1.Schema | Schema}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -812,7 +811,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}. + * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -896,7 +895,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [ValidateSchemaResponse]{@link google.pubsub.v1.ValidateSchemaResponse}. + * The first element of the array is an object representing {@link google.pubsub.v1.ValidateSchemaResponse | ValidateSchemaResponse}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -988,7 +987,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [ValidateMessageResponse]{@link google.pubsub.v1.ValidateMessageResponse}. + * The first element of the array is an object representing {@link google.pubsub.v1.ValidateMessageResponse | ValidateMessageResponse}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -1081,7 +1080,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of [Schema]{@link google.pubsub.v1.Schema}. + * The first element of the array is Array of {@link google.pubsub.v1.Schema | Schema}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. @@ -1178,7 +1177,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing [Schema]{@link google.pubsub.v1.Schema} on 'data' event. + * An object stream which emits an object representing {@link google.pubsub.v1.Schema | Schema} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSchemasAsync()` @@ -1233,7 +1232,7 @@ export class SchemaServiceClient { * @returns {Object} * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). * When you iterate the returned iterable, each element will be an object representing - * [Schema]{@link google.pubsub.v1.Schema}. The API will be called under the hood as needed, once per the page, + * {@link google.pubsub.v1.Schema | Schema}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) @@ -1279,7 +1278,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of [Schema]{@link google.pubsub.v1.Schema}. + * The first element of the array is Array of {@link google.pubsub.v1.Schema | Schema}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. @@ -1376,7 +1375,7 @@ export class SchemaServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing [Schema]{@link google.pubsub.v1.Schema} on 'data' event. + * An object stream which emits an object representing {@link google.pubsub.v1.Schema | Schema} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSchemaRevisionsAsync()` @@ -1429,7 +1428,7 @@ export class SchemaServiceClient { * @returns {Object} * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). * When you iterate the returned iterable, each element will be an object representing - * [Schema]{@link google.pubsub.v1.Schema}. The API will be called under the hood as needed, once per the page, + * {@link google.pubsub.v1.Schema | Schema}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) @@ -1469,16 +1468,16 @@ export class SchemaServiceClient { * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. This field is only used by Cloud IAM. * - * This object should have the same structure as [GetPolicyOptions]{@link google.iam.v1.GetPolicyOptions} + * This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, - * retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details. + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * - * The second parameter to the callback is an object representing [Policy]{@link google.iam.v1.Policy}. + * The second parameter to the callback is an object representing {@link google.iam.v1.Policy | Policy}. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Policy]{@link google.iam.v1.Policy}. + * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}. * The promise has a method named "cancel" which cancels the ongoing API call. */ getIamPolicy( @@ -1520,13 +1519,13 @@ export class SchemaServiceClient { * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, - * retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details. + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * - * The second parameter to the callback is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. */ setIamPolicy( @@ -1568,13 +1567,13 @@ export class SchemaServiceClient { * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, - * retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details. + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * - * The second parameter to the callback is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. * */ diff --git a/src/v1/subscriber_client.ts b/src/v1/subscriber_client.ts index 4b007c86c..c13dd9777 100644 --- a/src/v1/subscriber_client.ts +++ b/src/v1/subscriber_client.ts @@ -421,19 +421,15 @@ export class SubscriberClient { * field will be `_deleted-topic_` if the topic has been deleted. * @param {google.pubsub.v1.PushConfig} request.pushConfig * If push delivery is used with this subscription, this field is - * used to configure it. Either `pushConfig` or `bigQueryConfig` can be set, - * but not both. If both are empty, then the subscriber will pull and ack - * messages using API methods. + * used to configure it. * @param {google.pubsub.v1.BigQueryConfig} request.bigqueryConfig * If delivery to BigQuery is used with this subscription, this field is - * used to configure it. Either `pushConfig` or `bigQueryConfig` can be set, - * but not both. If both are empty, then the subscriber will pull and ack - * messages using API methods. + * used to configure it. * @param {number} request.ackDeadlineSeconds * The approximate amount of time (on a best-effort basis) Pub/Sub waits for * the subscriber to acknowledge receipt before resending the message. In the * interval after the message is delivered and before it is acknowledged, it - * is considered to be outstanding. During that time period, the + * is considered to be _outstanding_. During that time period, the * message will not be redelivered (on a best-effort basis). * * For pull subscriptions, this value is used as the initial value for the ack @@ -465,8 +461,8 @@ export class SubscriberClient { * can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 * minutes. * @param {number[]} request.labels - * See Creating and - * managing labels. + * See [Creating and managing + * labels](https://cloud.google.com/pubsub/docs/labels). * @param {boolean} request.enableMessageOrdering * If true, messages published with the same `ordering_key` in `PubsubMessage` * will be delivered to the subscribers in the order in which they @@ -533,7 +529,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Subscription]{@link google.pubsub.v1.Subscription}. + * The first element of the array is an object representing {@link google.pubsub.v1.Subscription | Subscription}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -615,7 +611,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Subscription]{@link google.pubsub.v1.Subscription}. + * The first element of the array is an object representing {@link google.pubsub.v1.Subscription | Subscription}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -700,7 +696,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Subscription]{@link google.pubsub.v1.Subscription}. + * The first element of the array is an object representing {@link google.pubsub.v1.Subscription | Subscription}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -786,7 +782,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}. + * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -883,7 +879,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}. + * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -975,7 +971,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}. + * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -1047,9 +1043,7 @@ export class SubscriberClient { return this.innerApiCalls.acknowledge(request, options, callback); } /** - * Pulls messages from the server. The server may return `UNAVAILABLE` if - * there are too many concurrent pull requests pending for the given - * subscription. + * Pulls messages from the server. * * @param {Object} request * The request object that will be sent. @@ -1071,7 +1065,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [PullResponse]{@link google.pubsub.v1.PullResponse}. + * The first element of the array is an object representing {@link google.pubsub.v1.PullResponse | PullResponse}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -1165,7 +1159,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}. + * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -1238,10 +1232,10 @@ export class SubscriberClient { } /** * Gets the configuration details of a snapshot. Snapshots are used in - * Seek - * operations, which allow you to manage message acknowledgments in bulk. That - * is, you can set the acknowledgment state of messages in an existing - * subscription to the state captured by a snapshot. + * [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, + * which allow you to manage message acknowledgments in bulk. That is, you can + * set the acknowledgment state of messages in an existing subscription to the + * state captured by a snapshot. * * @param {Object} request * The request object that will be sent. @@ -1251,7 +1245,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Snapshot]{@link google.pubsub.v1.Snapshot}. + * The first element of the array is an object representing {@link google.pubsub.v1.Snapshot | Snapshot}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -1346,9 +1340,9 @@ export class SubscriberClient { * Required. 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. Format is `projects/{project}/snapshots/{snap}`. + * must specify a name. See the [resource name + * rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format + * is `projects/{project}/snapshots/{snap}`. * @param {string} request.subscription * Required. The subscription whose backlog the snapshot retains. * Specifically, the created snapshot is guaranteed to retain: @@ -1360,12 +1354,12 @@ export class SubscriberClient { * successful completion of the CreateSnapshot request. * Format is `projects/{project}/subscriptions/{sub}`. * @param {number[]} request.labels - * See Creating and - * managing labels. + * See [Creating and managing + * labels](https://cloud.google.com/pubsub/docs/labels). * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Snapshot]{@link google.pubsub.v1.Snapshot}. + * The first element of the array is an object representing {@link google.pubsub.v1.Snapshot | Snapshot}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -1438,11 +1432,10 @@ export class SubscriberClient { } /** * Updates an existing snapshot. Snapshots are used in - * Seek - * operations, which allow - * you to manage message acknowledgments in bulk. That is, you can set the - * acknowledgment state of messages in an existing subscription to the state - * captured by a snapshot. + * [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, + * which allow you to manage message acknowledgments in bulk. That is, you can + * set the acknowledgment state of messages in an existing subscription to the + * state captured by a snapshot. * * @param {Object} request * The request object that will be sent. @@ -1454,7 +1447,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Snapshot]{@link google.pubsub.v1.Snapshot}. + * The first element of the array is an object representing {@link google.pubsub.v1.Snapshot | Snapshot}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -1544,7 +1537,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}. + * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -1647,7 +1640,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [SeekResponse]{@link google.pubsub.v1.SeekResponse}. + * The first element of the array is an object representing {@link google.pubsub.v1.SeekResponse | SeekResponse}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. @@ -1732,8 +1725,8 @@ export class SubscriberClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which is both readable and writable. It accepts objects - * representing [StreamingPullRequest]{@link google.pubsub.v1.StreamingPullRequest} for write() method, and - * will emit objects representing [StreamingPullResponse]{@link google.pubsub.v1.StreamingPullResponse} on 'data' event asynchronously. + * representing {@link google.pubsub.v1.StreamingPullRequest | StreamingPullRequest} for write() method, and + * will emit objects representing {@link google.pubsub.v1.StreamingPullResponse | StreamingPullResponse} on 'data' event asynchronously. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming) * for more details and examples. @@ -1760,7 +1753,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of [Subscription]{@link google.pubsub.v1.Subscription}. + * The first element of the array is Array of {@link google.pubsub.v1.Subscription | Subscription}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. @@ -1853,7 +1846,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing [Subscription]{@link google.pubsub.v1.Subscription} on 'data' event. + * An object stream which emits an object representing {@link google.pubsub.v1.Subscription | Subscription} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSubscriptionsAsync()` @@ -1904,7 +1897,7 @@ export class SubscriberClient { * @returns {Object} * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). * When you iterate the returned iterable, each element will be an object representing - * [Subscription]{@link google.pubsub.v1.Subscription}. The API will be called under the hood as needed, once per the page, + * {@link google.pubsub.v1.Subscription | Subscription}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) @@ -1952,7 +1945,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of [Snapshot]{@link google.pubsub.v1.Snapshot}. + * The first element of the array is Array of {@link google.pubsub.v1.Snapshot | Snapshot}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. @@ -2045,7 +2038,7 @@ export class SubscriberClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing [Snapshot]{@link google.pubsub.v1.Snapshot} on 'data' event. + * An object stream which emits an object representing {@link google.pubsub.v1.Snapshot | Snapshot} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSnapshotsAsync()` @@ -2096,7 +2089,7 @@ export class SubscriberClient { * @returns {Object} * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). * When you iterate the returned iterable, each element will be an object representing - * [Snapshot]{@link google.pubsub.v1.Snapshot}. The API will be called under the hood as needed, once per the page, + * {@link google.pubsub.v1.Snapshot | Snapshot}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) @@ -2136,16 +2129,16 @@ export class SubscriberClient { * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. This field is only used by Cloud IAM. * - * This object should have the same structure as [GetPolicyOptions]{@link google.iam.v1.GetPolicyOptions} + * This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, - * retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details. + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * - * The second parameter to the callback is an object representing [Policy]{@link google.iam.v1.Policy}. + * The second parameter to the callback is an object representing {@link google.iam.v1.Policy | Policy}. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [Policy]{@link google.iam.v1.Policy}. + * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}. * The promise has a method named "cancel" which cancels the ongoing API call. */ getIamPolicy( @@ -2187,13 +2180,13 @@ export class SubscriberClient { * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, - * retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details. + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * - * The second parameter to the callback is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. */ setIamPolicy( @@ -2235,13 +2228,13 @@ export class SubscriberClient { * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, - * retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details. + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * - * The second parameter to the callback is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}. + * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. * */ diff --git a/src/v1/subscriber_client_config.json b/src/v1/subscriber_client_config.json index aad28643d..f47919883 100644 --- a/src/v1/subscriber_client_config.json +++ b/src/v1/subscriber_client_config.json @@ -15,6 +15,12 @@ "unavailable": [ "UNAVAILABLE" ], + "unknown_aborted_internal_unavailable": [ + "UNKNOWN", + "ABORTED", + "INTERNAL", + "UNAVAILABLE" + ], "deadline_exceeded_resource_exhausted_aborted_internal_unavailable": [ "DEADLINE_EXCEEDED", "RESOURCE_EXHAUSTED", @@ -72,7 +78,7 @@ }, "Pull": { "timeout_millis": 60000, - "retry_codes_name": "unknown_aborted_unavailable", + "retry_codes_name": "unknown_aborted_internal_unavailable", "retry_params_name": "default" }, "StreamingPull": {