Class protos.google.iam.v2.Policies (0.3.2)

Represents a Policies

Inheritance

$protobuf.rpc.Service > protos.google.iam.v2.Policies

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Policies service.

Parameters
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Policies;

Creates new Policies service using the specified rpc implementation.

Parameters
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` Whether responses are length-delimited

Returns
Type	Description
`Policies`	RPC service. Useful where requests and/or responses are streamed.

createPolicy(request, callback)

public createPolicy(request: google.iam.v2.ICreatePolicyRequest, callback: google.iam.v2.Policies.CreatePolicyCallback): void;

Calls CreatePolicy.

Parameters
Name	Description
`request`	`ICreatePolicyRequest` CreatePolicyRequest message or plain object
`callback`	`google.iam.v2.Policies.CreatePolicyCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

createPolicy(request)

public createPolicy(request: google.iam.v2.ICreatePolicyRequest): Promise<google.longrunning.Operation>;

Calls CreatePolicy.

Parameter
Name	Description
`request`	`ICreatePolicyRequest` CreatePolicyRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

deletePolicy(request, callback)

public deletePolicy(request: google.iam.v2.IDeletePolicyRequest, callback: google.iam.v2.Policies.DeletePolicyCallback): void;

Calls DeletePolicy.

Parameters
Name	Description
`request`	`IDeletePolicyRequest` DeletePolicyRequest message or plain object
`callback`	`google.iam.v2.Policies.DeletePolicyCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

deletePolicy(request)

public deletePolicy(request: google.iam.v2.IDeletePolicyRequest): Promise<google.longrunning.Operation>;

Calls DeletePolicy.

Parameter
Name	Description
`request`	`IDeletePolicyRequest` DeletePolicyRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

getPolicy(request, callback)

public getPolicy(request: google.iam.v2.IGetPolicyRequest, callback: google.iam.v2.Policies.GetPolicyCallback): void;

Calls GetPolicy.

Parameters
Name	Description
`request`	`google.iam.v2.IGetPolicyRequest` GetPolicyRequest message or plain object
`callback`	`google.iam.v2.Policies.GetPolicyCallback` Node-style callback called with the error, if any, and Policy

Returns
Type	Description
`void`

getPolicy(request)

public getPolicy(request: google.iam.v2.IGetPolicyRequest): Promise<google.iam.v2.Policy>;

Calls GetPolicy.

Parameter
Name	Description
`request`	`google.iam.v2.IGetPolicyRequest` GetPolicyRequest message or plain object

Returns
Type	Description
`Promise<google.iam.v2.Policy>`	Promise

listPolicies(request, callback)

public listPolicies(request: google.iam.v2.IListPoliciesRequest, callback: google.iam.v2.Policies.ListPoliciesCallback): void;

Calls ListPolicies.

Parameters
Name	Description
`request`	`google.iam.v2.IListPoliciesRequest` ListPoliciesRequest message or plain object
`callback`	`google.iam.v2.Policies.ListPoliciesCallback` Node-style callback called with the error, if any, and ListPoliciesResponse

Returns
Type	Description
`void`

listPolicies(request)

public listPolicies(request: google.iam.v2.IListPoliciesRequest): Promise<google.iam.v2.ListPoliciesResponse>;

Calls ListPolicies.

Parameter
Name	Description
`request`	`google.iam.v2.IListPoliciesRequest` ListPoliciesRequest message or plain object

Returns
Type	Description
`Promise<google.iam.v2.ListPoliciesResponse>`	Promise

updatePolicy(request, callback)

public updatePolicy(request: google.iam.v2.IUpdatePolicyRequest, callback: google.iam.v2.Policies.UpdatePolicyCallback): void;

Calls UpdatePolicy.

Parameters
Name	Description
`request`	`google.iam.v2.IUpdatePolicyRequest` UpdatePolicyRequest message or plain object
`callback`	`google.iam.v2.Policies.UpdatePolicyCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

updatePolicy(request)

public updatePolicy(request: google.iam.v2.IUpdatePolicyRequest): Promise<google.longrunning.Operation>;

Calls UpdatePolicy.

Parameter
Name	Description
`request`	`google.iam.v2.IUpdatePolicyRequest` UpdatePolicyRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise