From ed843bcbf578ff0eb0bdae29b7c18a7e66694535 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Wed, 22 Apr 2020 08:14:11 -0700 Subject: [PATCH] docs: update jsdoc annotations (#410) --- .../src/v2/cloud_tasks_client.ts | 28 +++++++++++++++---- .../src/v2beta2/cloud_tasks_client.ts | 28 +++++++++++++++---- .../src/v2beta3/cloud_tasks_client.ts | 28 +++++++++++++++---- packages/google-cloud-tasks/synth.metadata | 2 +- 4 files changed, 67 insertions(+), 19 deletions(-) diff --git a/packages/google-cloud-tasks/src/v2/cloud_tasks_client.ts b/packages/google-cloud-tasks/src/v2/cloud_tasks_client.ts index ed20a585387..681b0d89622 100644 --- a/packages/google-cloud-tasks/src/v2/cloud_tasks_client.ts +++ b/packages/google-cloud-tasks/src/v2/cloud_tasks_client.ts @@ -1012,8 +1012,12 @@ export class CloudTasksClient { * * @param {Object} request * The request object that will be sent. - * @param {} request. - * @param {} request. + * @param {string} request.resource + * REQUIRED: The resource for which the policy is being requested. + * See the operation documentation for the appropriate value for this field. + * @param {google.iam.v1.GetPolicyOptions} request.options + * OPTIONAL: A `GetPolicyOptions` object for specifying options to + * `GetIamPolicy`. This field is only used by Cloud IAM. * @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. @@ -1102,8 +1106,14 @@ export class CloudTasksClient { * * @param {Object} request * The request object that will be sent. - * @param {} request. - * @param {} request. + * @param {string} request.resource + * REQUIRED: The resource for which the policy is being specified. + * See the operation documentation for the appropriate value for this field. + * @param {google.iam.v1.Policy} request.policy + * REQUIRED: The complete policy to be applied to the `resource`. The size of + * the policy is limited to a few 10s of KB. An empty policy is a + * valid policy but certain Cloud Platform services (such as Projects) + * might reject them. * @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. @@ -1188,8 +1198,14 @@ export class CloudTasksClient { * * @param {Object} request * The request object that will be sent. - * @param {} request. - * @param {} request. + * @param {string} request.resource + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + * @param {string[]} request.permissions + * The set of permissions to check for the `resource`. Permissions with + * wildcards (such as '*' or 'storage.*') are not allowed. For more + * information see + * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @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. diff --git a/packages/google-cloud-tasks/src/v2beta2/cloud_tasks_client.ts b/packages/google-cloud-tasks/src/v2beta2/cloud_tasks_client.ts index 56ca7f61ab4..fa1b829adc8 100644 --- a/packages/google-cloud-tasks/src/v2beta2/cloud_tasks_client.ts +++ b/packages/google-cloud-tasks/src/v2beta2/cloud_tasks_client.ts @@ -1028,8 +1028,12 @@ export class CloudTasksClient { * * @param {Object} request * The request object that will be sent. - * @param {} request. - * @param {} request. + * @param {string} request.resource + * REQUIRED: The resource for which the policy is being requested. + * See the operation documentation for the appropriate value for this field. + * @param {google.iam.v1.GetPolicyOptions} request.options + * OPTIONAL: A `GetPolicyOptions` object for specifying options to + * `GetIamPolicy`. This field is only used by Cloud IAM. * @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. @@ -1118,8 +1122,14 @@ export class CloudTasksClient { * * @param {Object} request * The request object that will be sent. - * @param {} request. - * @param {} request. + * @param {string} request.resource + * REQUIRED: The resource for which the policy is being specified. + * See the operation documentation for the appropriate value for this field. + * @param {google.iam.v1.Policy} request.policy + * REQUIRED: The complete policy to be applied to the `resource`. The size of + * the policy is limited to a few 10s of KB. An empty policy is a + * valid policy but certain Cloud Platform services (such as Projects) + * might reject them. * @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. @@ -1204,8 +1214,14 @@ export class CloudTasksClient { * * @param {Object} request * The request object that will be sent. - * @param {} request. - * @param {} request. + * @param {string} request.resource + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + * @param {string[]} request.permissions + * The set of permissions to check for the `resource`. Permissions with + * wildcards (such as '*' or 'storage.*') are not allowed. For more + * information see + * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @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. diff --git a/packages/google-cloud-tasks/src/v2beta3/cloud_tasks_client.ts b/packages/google-cloud-tasks/src/v2beta3/cloud_tasks_client.ts index f8074ec395c..b1560d61e8b 100644 --- a/packages/google-cloud-tasks/src/v2beta3/cloud_tasks_client.ts +++ b/packages/google-cloud-tasks/src/v2beta3/cloud_tasks_client.ts @@ -1024,8 +1024,12 @@ export class CloudTasksClient { * * @param {Object} request * The request object that will be sent. - * @param {} request. - * @param {} request. + * @param {string} request.resource + * REQUIRED: The resource for which the policy is being requested. + * See the operation documentation for the appropriate value for this field. + * @param {google.iam.v1.GetPolicyOptions} request.options + * OPTIONAL: A `GetPolicyOptions` object for specifying options to + * `GetIamPolicy`. This field is only used by Cloud IAM. * @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. @@ -1114,8 +1118,14 @@ export class CloudTasksClient { * * @param {Object} request * The request object that will be sent. - * @param {} request. - * @param {} request. + * @param {string} request.resource + * REQUIRED: The resource for which the policy is being specified. + * See the operation documentation for the appropriate value for this field. + * @param {google.iam.v1.Policy} request.policy + * REQUIRED: The complete policy to be applied to the `resource`. The size of + * the policy is limited to a few 10s of KB. An empty policy is a + * valid policy but certain Cloud Platform services (such as Projects) + * might reject them. * @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. @@ -1200,8 +1210,14 @@ export class CloudTasksClient { * * @param {Object} request * The request object that will be sent. - * @param {} request. - * @param {} request. + * @param {string} request.resource + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + * @param {string[]} request.permissions + * The set of permissions to check for the `resource`. Permissions with + * wildcards (such as '*' or 'storage.*') are not allowed. For more + * information see + * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @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. diff --git a/packages/google-cloud-tasks/synth.metadata b/packages/google-cloud-tasks/synth.metadata index 7aa3a91b1db..53502bb3d79 100644 --- a/packages/google-cloud-tasks/synth.metadata +++ b/packages/google-cloud-tasks/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/nodejs-tasks.git", - "sha": "b6d37271e851b3b25de97cb66286b7b9fac0d924" + "sha": "0b9fc44b8e748572ae915806811e683c075c23e9" } }, {