com.google.cloud.orgpolicy.v2

Class OrgPolicyGrpc.OrgPolicyFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<OrgPolicyGrpc.OrgPolicyFutureStub>

com.google.cloud.orgpolicy.v2.OrgPolicyGrpc.OrgPolicyFutureStub

Enclosing class:

OrgPolicyGrpc

public static final class OrgPolicyGrpc.OrgPolicyFutureStub
extends AbstractFutureStub<OrgPolicyGrpc.OrgPolicyFutureStub>

 An interface for managing organization policies.
 The Cloud Org Policy service provides a simple mechanism for organizations to
 restrict the allowed configurations across their entire Cloud Resource
 hierarchy.
 You can use a `policy` to configure restrictions in Cloud resources. For
 example, you can enforce a `policy` that restricts which Google
 Cloud Platform APIs can be activated in a certain part of your resource
 hierarchy, or prevents serial port access to VM instances in a particular
 folder.
 `Policies` are inherited down through the resource hierarchy. A `policy`
 applied to a parent resource automatically applies to all its child resources
 unless overridden with a `policy` lower in the hierarchy.
 A `constraint` defines an aspect of a resource's configuration that can be
 controlled by an organization's policy administrator. `Policies` are a
 collection of `constraints` that defines their allowable configuration on a
 particular resource and its child resources.
 

Nested Class Summary

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

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected OrgPolicyGrpc.OrgPolicyFutureStub	build(Channel channel, CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Policy>	createPolicy(CreatePolicyRequest request) Creates a Policy.
com.google.common.util.concurrent.ListenableFuture<Empty>	deletePolicy(DeletePolicyRequest request) Deletes a Policy.
com.google.common.util.concurrent.ListenableFuture<Policy>	getEffectivePolicy(GetEffectivePolicyRequest request) Gets the effective `Policy` on a resource.
com.google.common.util.concurrent.ListenableFuture<Policy>	getPolicy(GetPolicyRequest request) Gets a `Policy` on a resource.
com.google.common.util.concurrent.ListenableFuture<ListConstraintsResponse>	listConstraints(ListConstraintsRequest request) Lists `Constraints` that could be applied on the specified resource.
com.google.common.util.concurrent.ListenableFuture<ListPoliciesResponse>	listPolicies(ListPoliciesRequest request) Retrieves all of the `Policies` that exist on a particular resource.
com.google.common.util.concurrent.ListenableFuture<Policy>	updatePolicy(UpdatePolicyRequest request) Updates a Policy.

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, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected OrgPolicyGrpc.OrgPolicyFutureStub build(Channel channel,
                                                  CallOptions callOptions)

Specified by:

build in class AbstractStub<OrgPolicyGrpc.OrgPolicyFutureStub>

listConstraints

public com.google.common.util.concurrent.ListenableFuture<ListConstraintsResponse> listConstraints(ListConstraintsRequest request)

 Lists `Constraints` that could be applied on the specified resource.
 

listPolicies

public com.google.common.util.concurrent.ListenableFuture<ListPoliciesResponse> listPolicies(ListPoliciesRequest request)

 Retrieves all of the `Policies` that exist on a particular resource.
 

getPolicy

public com.google.common.util.concurrent.ListenableFuture<Policy> getPolicy(GetPolicyRequest request)

 Gets a `Policy` on a resource.
 If no `Policy` is set on the resource, NOT_FOUND is returned. The
 `etag` value can be used with `UpdatePolicy()` to update a
 `Policy` during read-modify-write.
 

getEffectivePolicy

public com.google.common.util.concurrent.ListenableFuture<Policy> getEffectivePolicy(GetEffectivePolicyRequest request)

 Gets the effective `Policy` on a resource. This is the result of merging
 `Policies` in the resource hierarchy and evaluating conditions. The
 returned `Policy` will not have an `etag` or `condition` set because it is
 a computed `Policy` across multiple resources.
 Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
 not be expanded.
 

createPolicy

public com.google.common.util.concurrent.ListenableFuture<Policy> createPolicy(CreatePolicyRequest request)

 Creates a Policy.
 Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
 constraint does not exist.
 Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the
 policy already exists on the given Cloud resource.
 

updatePolicy

public com.google.common.util.concurrent.ListenableFuture<Policy> updatePolicy(UpdatePolicyRequest request)

 Updates a Policy.
 Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
 constraint or the policy do not exist.
 Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag
 supplied in the request does not match the persisted etag of the policy
 Note: the supplied policy will perform a full overwrite of all
 fields.
 

deletePolicy

public com.google.common.util.concurrent.ListenableFuture<Empty> deletePolicy(DeletePolicyRequest request)

 Deletes a Policy.
 Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
 constraint or Org Policy does not exist.