Class PoliciesGrpc.PoliciesFutureStub (1.5.1)

public static final class PoliciesGrpc.PoliciesFutureStub extends AbstractFutureStub<PoliciesGrpc.PoliciesFutureStub>

An interface for managing Identity and Access Management (IAM) policies.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > PoliciesGrpc.PoliciesFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected PoliciesGrpc.PoliciesFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
PoliciesGrpc.PoliciesFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createPolicy(CreatePolicyRequest request)

public ListenableFuture<Operation> createPolicy(CreatePolicyRequest request)

Creates a policy.

Parameter
NameDescription
requestCreatePolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deletePolicy(DeletePolicyRequest request)

public ListenableFuture<Operation> deletePolicy(DeletePolicyRequest request)

Deletes a policy. This action is permanent.

Parameter
NameDescription
requestDeletePolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

getPolicy(GetPolicyRequest request)

public ListenableFuture<Policy> getPolicy(GetPolicyRequest request)

Gets a policy.

Parameter
NameDescription
requestGetPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Policy>

listPolicies(ListPoliciesRequest request)

public ListenableFuture<ListPoliciesResponse> listPolicies(ListPoliciesRequest request)

Retrieves the policies of the specified kind that are attached to a resource. The response lists only policy metadata. In particular, policy rules are omitted.

Parameter
NameDescription
requestListPoliciesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListPoliciesResponse>

updatePolicy(UpdatePolicyRequest request)

public ListenableFuture<Operation> updatePolicy(UpdatePolicyRequest request)

Updates the specified policy. You can update only the rules and the display name for the policy. To update a policy, you should use a read-modify-write loop:

  1. Use GetPolicy to read the current version of the policy.
  2. Modify the policy as needed.
  3. Use UpdatePolicy to write the updated policy. This pattern helps prevent conflicts between concurrent updates.
Parameter
NameDescription
requestUpdatePolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>