@google-cloud/tasks 1.1.1 » Namespace: v1

Abstract types

static

Binding

Associates members with a role.

Properties

Name Type Optional Description

Name	Type	Description
role	string	Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
members	Array of string	Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
condition	Object	The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. This object should have the same structure as Expr

role

string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

members

Array of string

Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

condition

Object

The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.

This object should have the same structure as Expr

See also: google.iam.v1.Binding definition in proto format

static

Binding

Associates members with a role.

Properties

Name Type Optional Description

Name	Type	Description
role	string	Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
members	Array of string	Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
condition	Object	The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. This object should have the same structure as Expr

role

string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

members

Array of string

Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

condition

Object

This object should have the same structure as Expr

See also: google.iam.v1.Binding definition in proto format

static

Binding

Associates members with a role.

Properties

Name Type Optional Description

Name	Type	Description
role	string	Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
members	Array of string	Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
condition	Object	The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. This object should have the same structure as Expr

role

string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

members

Array of string

Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

condition

Object

This object should have the same structure as Expr

See also: google.iam.v1.Binding definition in proto format

static

GetIamPolicyRequest

Request message for GetIamPolicy method.

Property

Name	Type	Optional	Description
resource	string		REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

See also: google.iam.v1.GetIamPolicyRequest definition in proto format

static

GetIamPolicyRequest

Request message for GetIamPolicy method.

Property

Name	Type	Optional	Description
resource	string		REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

See also: google.iam.v1.GetIamPolicyRequest definition in proto format

static

GetIamPolicyRequest

Request message for GetIamPolicy method.

Property

Name	Type	Optional	Description
resource	string		REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

See also: google.iam.v1.GetIamPolicyRequest definition in proto format

static

Policy

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.

JSON Example

{
  "bindings": [
    {
      "role": "roles/owner",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",
        "serviceAccount:my-other-app@appspot.gserviceaccount.com"
      ]
    },
    {
      "role": "roles/viewer",
      "members": ["user:sean@example.com"]
    }
  ]
}

YAML Example

bindings:
- members:
  - user:mike@example.com
  - group:admins@example.com
  - domain:google.com
  - serviceAccount:my-other-app@appspot.gserviceaccount.com
  role: roles/owner
- members:
  - user:sean@example.com
  role: roles/viewer

For a description of IAM and its features, see the IAM developer's guide.

Properties

Name Type Optional Description

Name	Type	Description
version	number	Deprecated.
bindings	Array of Object	Associates a list of `members` to a `role`. `bindings` with no members will result in an error. This object should have the same structure as Binding
etag	Buffer	`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.

version

number

Deprecated.

bindings

Array of Object

Associates a list of members to a role. bindings with no members will result in an error.

This object should have the same structure as Binding

etag

Buffer

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.

If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.

See also: google.iam.v1.Policy definition in proto format

static

Policy

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

JSON Example

{
  "bindings": [
    {
      "role": "roles/owner",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",
        "serviceAccount:my-other-app@appspot.gserviceaccount.com"
      ]
    },
    {
      "role": "roles/viewer",
      "members": ["user:sean@example.com"]
    }
  ]
}

YAML Example

bindings:
- members:
  - user:mike@example.com
  - group:admins@example.com
  - domain:google.com
  - serviceAccount:my-other-app@appspot.gserviceaccount.com
  role: roles/owner
- members:
  - user:sean@example.com
  role: roles/viewer

For a description of IAM and its features, see the IAM developer's guide.

Properties

Name Type Optional Description

Name	Type	Description
version	number	Deprecated.
bindings	Array of Object	Associates a list of `members` to a `role`. `bindings` with no members will result in an error. This object should have the same structure as Binding
etag	Buffer	`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.

version

number

Deprecated.

bindings

Array of Object

Associates a list of members to a role. bindings with no members will result in an error.

This object should have the same structure as Binding

etag

Buffer

If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.

See also: google.iam.v1.Policy definition in proto format

static

Policy

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

JSON Example

{
  "bindings": [
    {
      "role": "roles/owner",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",
        "serviceAccount:my-other-app@appspot.gserviceaccount.com"
      ]
    },
    {
      "role": "roles/viewer",
      "members": ["user:sean@example.com"]
    }
  ]
}

YAML Example

bindings:
- members:
  - user:mike@example.com
  - group:admins@example.com
  - domain:google.com
  - serviceAccount:my-other-app@appspot.gserviceaccount.com
  role: roles/owner
- members:
  - user:sean@example.com
  role: roles/viewer

For a description of IAM and its features, see the IAM developer's guide.

Properties

Name Type Optional Description

Name	Type	Description
version	number	Deprecated.
bindings	Array of Object	Associates a list of `members` to a `role`. `bindings` with no members will result in an error. This object should have the same structure as Binding
etag	Buffer	`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.

version

number

Deprecated.

bindings

Array of Object

Associates a list of members to a role. bindings with no members will result in an error.

This object should have the same structure as Binding

etag

Buffer

If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.

See also: google.iam.v1.Policy definition in proto format

static

SetIamPolicyRequest

Request message for SetIamPolicy method.

Properties

Name Type Optional Description

Name	Type	Optional	Description
resource	string		REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy	Object		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. This object should have the same structure as Policy

resource

string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy

Object

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.

This object should have the same structure as Policy

See also: google.iam.v1.SetIamPolicyRequest definition in proto format

static

SetIamPolicyRequest

Request message for SetIamPolicy method.

Properties

Name Type Optional Description

Name	Type	Optional	Description
resource	string		REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy	Object		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. This object should have the same structure as Policy

resource

string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy

Object

This object should have the same structure as Policy

See also: google.iam.v1.SetIamPolicyRequest definition in proto format

static

SetIamPolicyRequest

Request message for SetIamPolicy method.

Properties

Name Type Optional Description

Name	Type	Optional	Description
resource	string		REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy	Object		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. This object should have the same structure as Policy

resource

string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy

Object

This object should have the same structure as Policy

See also: google.iam.v1.SetIamPolicyRequest definition in proto format

static

TestIamPermissionsRequest

Request message for TestIamPermissions method.

Properties

Name	Type	Optional	Description
resource	string		REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions	Array of string		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.

See also: google.iam.v1.TestIamPermissionsRequest definition in proto format

static

TestIamPermissionsRequest

Request message for TestIamPermissions method.

Properties

Name	Type	Optional	Description
resource	string		REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions	Array of string		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.

See also: google.iam.v1.TestIamPermissionsRequest definition in proto format

static

TestIamPermissionsRequest

Request message for TestIamPermissions method.

Properties

Name	Type	Optional	Description
resource	string		REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions	Array of string		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.

See also: google.iam.v1.TestIamPermissionsRequest definition in proto format

static

TestIamPermissionsResponse

Response message for TestIamPermissions method.

Property

Name	Type	Optional	Description
permissions	Array of string		A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

See also: google.iam.v1.TestIamPermissionsResponse definition in proto format

static

TestIamPermissionsResponse

Response message for TestIamPermissions method.

Property

Name	Type	Optional	Description
permissions	Array of string		A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

See also: google.iam.v1.TestIamPermissionsResponse definition in proto format

static

TestIamPermissionsResponse

Response message for TestIamPermissions method.

Property

Name	Type	Optional	Description
permissions	Array of string		A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

See also: google.iam.v1.TestIamPermissionsResponse definition in proto format