Class OrgPolicyGrpc.OrgPolicyFutureStub (2.4.0)

Version 2.4.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.7-SNAPSHOT
• 2.2.1
• 2.1.2
• 2.0.10

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > OrgPolicyGrpc.OrgPolicyFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

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

Parameters

Name	Description
channel	io.grpc.Channel
callOptions	io.grpc.CallOptions

Returns

Type	Description
OrgPolicyGrpc.OrgPolicyFutureStub

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createPolicy(CreatePolicyRequest request)

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

Parameter

Name	Description
request	CreatePolicyRequest

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Policy>

deletePolicy(DeletePolicyRequest request)

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

Parameter

Name	Description
request	DeletePolicyRequest

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getEffectivePolicy(GetEffectivePolicyRequest request)

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

Parameter

Name	Description
request	GetEffectivePolicyRequest

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Policy>

getPolicy(GetPolicyRequest request)

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

Parameter

Name	Description
request	GetPolicyRequest

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Policy>

listConstraints(ListConstraintsRequest request)

public ListenableFuture<ListConstraintsResponse> listConstraints(ListConstraintsRequest request)

Lists Constraints that could be applied on the specified resource.

Parameter

Name	Description
request	ListConstraintsRequest

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListConstraintsResponse>

listPolicies(ListPoliciesRequest request)

public ListenableFuture<ListPoliciesResponse> listPolicies(ListPoliciesRequest request)

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

Parameter

Name	Description
request	ListPoliciesRequest

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListPoliciesResponse>

updatePolicy(UpdatePolicyRequest request)

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

Parameter

Name	Description
request	UpdatePolicyRequest

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Policy>