IAMPolicy

google.iam.v1. IAMPolicy

Represents a IAMPolicy

Constructor

new IAMPolicy(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new IAMPolicy service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {IAMPolicy}

Creates new IAMPolicy service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
IAMPolicy

RPC service. Useful where requests and/or responses are streamed.

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object
callback google.iam.v1.IAMPolicy.GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy
Returns:
Type Description
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object
Returns:
Type Description
Promise.<google.iam.v1.Policy>

Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object
callback google.iam.v1.IAMPolicy.SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy
Returns:
Type Description
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object
Returns:
Type Description
Promise.<google.iam.v1.Policy>

Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object
callback google.iam.v1.IAMPolicy.TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestIamPermissionsResponse
Returns:
Type Description
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object
Returns:
Type Description
Promise.<google.iam.v1.TestIamPermissionsResponse>

Promise

Type Definitions

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.iam.v1.Policy <optional>

Policy

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.iam.v1.Policy <optional>

Policy

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.iam.v1.TestIamPermissionsResponse <optional>

TestIamPermissionsResponse