Skip to content

Commit

Permalink
docs: update jsdoc annotations (#410)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yoshi-automation
yoshi-automation authored Apr 22, 2020
1 parent 64948f8 commit ed843bc
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 19 deletions.
28 changes: 22 additions & 6 deletions packages/google-cloud-tasks/src/v2/cloud_tasks_client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
28 changes: 22 additions & 6 deletions packages/google-cloud-tasks/src/v2beta2/cloud_tasks_client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
28 changes: 22 additions & 6 deletions packages/google-cloud-tasks/src/v2beta3/cloud_tasks_client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-tasks/synth.metadata
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/nodejs-tasks.git",
"sha": "b6d37271e851b3b25de97cb66286b7b9fac0d924"
"sha": "0b9fc44b8e748572ae915806811e683c075c23e9"
}
},
{
Expand Down

0 comments on commit ed843bc

Please sign in to comment.