Class AccessContextManagerGrpc.AccessContextManagerFutureStub (1.52.0)

public static final class AccessContextManagerGrpc.AccessContextManagerFutureStub extends AbstractFutureStub<AccessContextManagerGrpc.AccessContextManagerFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service AccessContextManager.

API for setting [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] and [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] for Google Cloud projects. Each organization has one [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] that contains the [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] and [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter]. This [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] is applicable to all resources in the organization. AccessPolicies

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > AccessContextManagerGrpc.AccessContextManagerFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected AccessContextManagerGrpc.AccessContextManagerFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
AccessContextManagerGrpc.AccessContextManagerFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

commitServicePerimeters(CommitServicePerimetersRequest request)

public ListenableFuture<Operation> commitServicePerimeters(CommitServicePerimetersRequest request)

Commits the dry-run specification for all the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] in an access policy. A commit operation on a service perimeter involves copying its spec field to the status field of the service perimeter. Only [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] with use_explicit_dry_run_spec field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The dry_run and the spec fields are cleared after a successful commit operation.

Parameter
Name Description
request CommitServicePerimetersRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createAccessLevel(CreateAccessLevelRequest request)

public ListenableFuture<Operation> createAccessLevel(CreateAccessLevelRequest request)

Creates an [access level] [google.identity.accesscontextmanager.v1.AccessLevel]. The long-running operation from this RPC has a successful status after the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] propagates to long-lasting storage. If [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] contain errors, an error response is returned for the first error encountered.

Parameter
Name Description
request CreateAccessLevelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createAccessPolicy(AccessPolicy request)

public ListenableFuture<Operation> createAccessPolicy(AccessPolicy request)

Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in metadata as a BadRequest proto.

Parameter
Name Description
request AccessPolicy
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createGcpUserAccessBinding(CreateGcpUserAccessBindingRequest request)

public ListenableFuture<Operation> createGcpUserAccessBinding(CreateGcpUserAccessBindingRequest request)

Creates a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding]. If the client specifies a [name] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.name], the server ignores it. Fails if a resource already exists with the same [group_key] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.group_key]. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.

Parameter
Name Description
request CreateGcpUserAccessBindingRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createServicePerimeter(CreateServicePerimeterRequest request)

public ListenableFuture<Operation> createServicePerimeter(CreateServicePerimeterRequest request)

Creates a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter]. The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] propagates to long-lasting storage. If a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] contains errors, an error response is returned for the first error encountered.

Parameter
Name Description
request CreateServicePerimeterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteAccessLevel(DeleteAccessLevelRequest request)

public ListenableFuture<Operation> deleteAccessLevel(DeleteAccessLevelRequest request)

Deletes an [access level] [google.identity.accesscontextmanager.v1.AccessLevel] based on the resource name. The long-running operation from this RPC has a successful status after the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] has been removed from long-lasting storage.

Parameter
Name Description
request DeleteAccessLevelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteAccessPolicy(DeleteAccessPolicyRequest request)

public ListenableFuture<Operation> deleteAccessPolicy(DeleteAccessPolicyRequest request)

Deletes an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] based on the resource name. The long-running operation has a successful status after the [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] is removed from long-lasting storage.

Parameter
Name Description
request DeleteAccessPolicyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteGcpUserAccessBinding(DeleteGcpUserAccessBindingRequest request)

public ListenableFuture<Operation> deleteGcpUserAccessBinding(DeleteGcpUserAccessBindingRequest request)

Deletes a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding]. Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time.

Parameter
Name Description
request DeleteGcpUserAccessBindingRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteServicePerimeter(DeleteServicePerimeterRequest request)

public ListenableFuture<Operation> deleteServicePerimeter(DeleteServicePerimeterRequest request)

Deletes a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] based on the resource name. The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] is removed from long-lasting storage.

Parameter
Name Description
request DeleteServicePerimeterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getAccessLevel(GetAccessLevelRequest request)

public ListenableFuture<AccessLevel> getAccessLevel(GetAccessLevelRequest request)

Gets an [access level] [google.identity.accesscontextmanager.v1.AccessLevel] based on the resource name.

Parameter
Name Description
request GetAccessLevelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AccessLevel>

getAccessPolicy(GetAccessPolicyRequest request)

public ListenableFuture<AccessPolicy> getAccessPolicy(GetAccessPolicyRequest request)

Returns an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] based on the name.

Parameter
Name Description
request GetAccessPolicyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AccessPolicy>

getGcpUserAccessBinding(GetGcpUserAccessBindingRequest request)

public ListenableFuture<GcpUserAccessBinding> getGcpUserAccessBinding(GetGcpUserAccessBindingRequest request)

Gets the [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding] with the given name.

Parameter
Name Description
request GetGcpUserAccessBindingRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GcpUserAccessBinding>

getIamPolicy(GetIamPolicyRequest request)

public ListenableFuture<Policy> getIamPolicy(GetIamPolicyRequest request)

Gets the IAM policy for the specified Access Context Manager access policy.

Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>

getServicePerimeter(GetServicePerimeterRequest request)

public ListenableFuture<ServicePerimeter> getServicePerimeter(GetServicePerimeterRequest request)

Gets a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] based on the resource name.

Parameter
Name Description
request GetServicePerimeterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ServicePerimeter>

listAccessLevels(ListAccessLevelsRequest request)

public ListenableFuture<ListAccessLevelsResponse> listAccessLevels(ListAccessLevelsRequest request)

Lists all [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] for an access policy.

Parameter
Name Description
request ListAccessLevelsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListAccessLevelsResponse>

listAccessPolicies(ListAccessPoliciesRequest request)

public ListenableFuture<ListAccessPoliciesResponse> listAccessPolicies(ListAccessPoliciesRequest request)

Lists all [access policies] [google.identity.accesscontextmanager.v1.AccessPolicy] in an organization.

Parameter
Name Description
request ListAccessPoliciesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListAccessPoliciesResponse>

listGcpUserAccessBindings(ListGcpUserAccessBindingsRequest request)

public ListenableFuture<ListGcpUserAccessBindingsResponse> listGcpUserAccessBindings(ListGcpUserAccessBindingsRequest request)

Lists all [GcpUserAccessBindings] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding] for a Google Cloud organization.

Parameter
Name Description
request ListGcpUserAccessBindingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListGcpUserAccessBindingsResponse>

listServicePerimeters(ListServicePerimetersRequest request)

public ListenableFuture<ListServicePerimetersResponse> listServicePerimeters(ListServicePerimetersRequest request)

Lists all [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] for an access policy.

Parameter
Name Description
request ListServicePerimetersRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListServicePerimetersResponse>

replaceAccessLevels(ReplaceAccessLevelsRequest request)

public ListenableFuture<Operation> replaceAccessLevels(ReplaceAccessLevelsRequest request)

Replaces all existing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] in an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with the [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] contained in existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] result in an error.

Parameter
Name Description
request ReplaceAccessLevelsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

replaceServicePerimeters(ReplaceServicePerimetersRequest request)

public ListenableFuture<Operation> replaceServicePerimeters(ReplaceServicePerimetersRequest request)

Replace all existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] in an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] are not affected. The Operation.response field contains ReplaceServicePerimetersResponse.

Parameter
Name Description
request ReplaceServicePerimetersRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

setIamPolicy(SetIamPolicyRequest request)

public ListenableFuture<Policy> setIamPolicy(SetIamPolicyRequest request)

Sets the IAM policy for the specified Access Context Manager access policy. This method replaces the existing IAM policy on the access policy. The IAM policy controls the set of users who can perform specific operations on the Access Context Manager access policy.

Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>

testIamPermissions(TestIamPermissionsRequest request)

public ListenableFuture<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request)

Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.

Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse>

updateAccessLevel(UpdateAccessLevelRequest request)

public ListenableFuture<Operation> updateAccessLevel(UpdateAccessLevelRequest request)

Updates an [access level] [google.identity.accesscontextmanager.v1.AccessLevel]. The long-running operation from this RPC has a successful status after the changes to the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] propagate to long-lasting storage. If [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] contain errors, an error response is returned for the first error encountered.

Parameter
Name Description
request UpdateAccessLevelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateAccessPolicy(UpdateAccessPolicyRequest request)

public ListenableFuture<Operation> updateAccessPolicy(UpdateAccessPolicyRequest request)

Updates an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy]. The long-running operation from this RPC has a successful status after the changes to the [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] propagate to long-lasting storage.

Parameter
Name Description
request UpdateAccessPolicyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateGcpUserAccessBinding(UpdateGcpUserAccessBindingRequest request)

public ListenableFuture<Operation> updateGcpUserAccessBinding(UpdateGcpUserAccessBindingRequest request)

Updates a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding]. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time.

Parameter
Name Description
request UpdateGcpUserAccessBindingRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateServicePerimeter(UpdateServicePerimeterRequest request)

public ListenableFuture<Operation> updateServicePerimeter(UpdateServicePerimeterRequest request)

Updates a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter]. The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] propagates to long-lasting storage. If a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] contains errors, an error response is returned for the first error encountered.

Parameter
Name Description
request UpdateServicePerimeterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>