Class PoliciesGrpc.PoliciesBlockingStub (1.20.0)

public static final class PoliciesGrpc.PoliciesBlockingStub extends AbstractBlockingStub<PoliciesGrpc.PoliciesBlockingStub>

A stub to allow clients to do synchronous rpc calls to service Policies.

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > PoliciesGrpc.PoliciesBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

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

createPolicy(CreatePolicyRequest request)

public Operation createPolicy(CreatePolicyRequest request)

Creates a policy.

Parameter
NameDescription
requestCreatePolicyRequest
Returns
TypeDescription
Operation

deletePolicy(DeletePolicyRequest request)

public Operation deletePolicy(DeletePolicyRequest request)

Deletes a policy. This action is permanent.

Parameter
NameDescription
requestDeletePolicyRequest
Returns
TypeDescription
Operation

getPolicy(GetPolicyRequest request)

public Policy getPolicy(GetPolicyRequest request)

Gets a policy.

Parameter
NameDescription
requestGetPolicyRequest
Returns
TypeDescription
Policy

listPolicies(ListPoliciesRequest request)

public 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
ListPoliciesResponse

updatePolicy(UpdatePolicyRequest request)

public 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
Operation