Package com.google.iam.v1

Class IAMPolicyGrpc.IAMPolicyFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<IAMPolicyGrpc.IAMPolicyFutureStub>
com.google.iam.v1.IAMPolicyGrpc.IAMPolicyFutureStub
Enclosing class:
IAMPolicyGrpc
public static final class IAMPolicyGrpc.IAMPolicyFutureStub extends io.grpc.stub.AbstractFutureStub<IAMPolicyGrpc.IAMPolicyFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service IAMPolicy. 
 API Overview
 Manages Identity and Access Management (IAM) policies.
 Any implementation of an API that offers access control features
 implements the google.iam.v1.IAMPolicy interface.
 ## Data model
 Access control is applied when a principal (user or service account), takes
 some action on a resource exposed by a service. Resources, identified by
 URI-like names, are the unit of access control specification. Service
 implementations can choose the granularity of access control and the
 supported permissions for their resources.
 For example one database service may allow access control to be
 specified only at the Table level, whereas another might allow access control
 to also be specified at the Column level.
 ## Policy Structure
 See google.iam.v1.Policy
 This is intentionally not a CRUD style API because access control policies
 are created and deleted implicitly with the resources to which they are
 attached.

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

    io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

  • Method Summary

    Modifier and Type
    Method
    Description
    protected IAMPolicyGrpc.IAMPolicyFutureStub
    build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
     
    com.google.common.util.concurrent.ListenableFuture<Policy>
    getIamPolicy(GetIamPolicyRequest request)
    Gets the access control policy for a resource.
    com.google.common.util.concurrent.ListenableFuture<Policy>
    setIamPolicy(SetIamPolicyRequest request)
    Sets the access control policy on the specified resource.
    com.google.common.util.concurrent.ListenableFuture<TestIamPermissionsResponse>
    testIamPermissions(TestIamPermissionsRequest request)
    Returns permissions that a caller has on the specified resource.

    Methods inherited from class io.grpc.stub.AbstractFutureStub

    newStub, newStub

    Methods inherited from class io.grpc.stub.AbstractStub

    getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • build

      protected IAMPolicyGrpc.IAMPolicyFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<IAMPolicyGrpc.IAMPolicyFutureStub>

    • setIamPolicy

      public com.google.common.util.concurrent.ListenableFuture<Policy> setIamPolicy(SetIamPolicyRequest request)
       Sets the access control policy on the specified resource. Replaces any
 existing policy.
 Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

    • getIamPolicy

      public com.google.common.util.concurrent.ListenableFuture<Policy> getIamPolicy(GetIamPolicyRequest request)
       Gets the access control policy for a resource.
 Returns an empty policy if the resource exists and does not have a policy
 set.

    • testIamPermissions

      public com.google.common.util.concurrent.ListenableFuture<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request)
       Returns permissions that a caller has on the specified resource.
 If the resource does not exist, this will return an empty set of
 permissions, not a `NOT_FOUND` error.
 Note: This operation is designed to be used for building permission-aware
 UIs and command-line tools, not for authorization checking. This operation
 may "fail open" without warning.