com.google.cloud.orgpolicy.v2

Class OrgPolicyGrpc.OrgPolicyBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<OrgPolicyGrpc.OrgPolicyBlockingStub>

com.google.cloud.orgpolicy.v2.OrgPolicyGrpc.OrgPolicyBlockingStub

Enclosing class:

OrgPolicyGrpc

public static final class OrgPolicyGrpc.OrgPolicyBlockingStub
extends io.grpc.stub.AbstractBlockingStub<OrgPolicyGrpc.OrgPolicyBlockingStub>

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

 An interface for managing organization policies.
 The Organization Policy Service provides a simple mechanism for
 organizations to restrict the allowed configurations across their entire
 resource hierarchy.
 You can use a policy to configure restrictions on resources. For
 example, you can enforce a policy that restricts which Google
 Cloud 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

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

Method Summary

Modifier and Type	Method and Description
protected OrgPolicyGrpc.OrgPolicyBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
CustomConstraint	createCustomConstraint(CreateCustomConstraintRequest request) Creates a custom constraint.
Policy	createPolicy(CreatePolicyRequest request) Creates a policy.
com.google.protobuf.Empty	deleteCustomConstraint(DeleteCustomConstraintRequest request) Deletes a custom constraint.
com.google.protobuf.Empty	deletePolicy(DeletePolicyRequest request) Deletes a policy.
CustomConstraint	getCustomConstraint(GetCustomConstraintRequest request) Gets a custom constraint.
Policy	getEffectivePolicy(GetEffectivePolicyRequest request) Gets the effective policy on a resource.
Policy	getPolicy(GetPolicyRequest request) Gets a policy on a resource.
ListConstraintsResponse	listConstraints(ListConstraintsRequest request) Lists constraints that could be applied on the specified resource.
ListCustomConstraintsResponse	listCustomConstraints(ListCustomConstraintsRequest request) Retrieves all of the custom constraints that exist on a particular organization resource.
ListPoliciesResponse	listPolicies(ListPoliciesRequest request) Retrieves all of the policies that exist on a particular resource.
CustomConstraint	updateCustomConstraint(UpdateCustomConstraintRequest request) Updates a custom constraint.
Policy	updatePolicy(UpdatePolicyRequest request) Updates a policy.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

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.OrgPolicyBlockingStub build(io.grpc.Channel channel,
                                                    io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<OrgPolicyGrpc.OrgPolicyBlockingStub>

listConstraints

public ListConstraintsResponse listConstraints(ListConstraintsRequest request)

 Lists constraints that could be applied on the specified resource.
 

listPolicies

public ListPoliciesResponse listPolicies(ListPoliciesRequest request)

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

getPolicy

public 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 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
 an evaluated policy across multiple resources.
 Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
 not be expanded.
 

createPolicy

public 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 Google Cloud resource.
 

updatePolicy

public 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.protobuf.Empty deletePolicy(DeletePolicyRequest request)

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

createCustomConstraint

public CustomConstraint createCustomConstraint(CreateCustomConstraintRequest request)

 Creates a custom constraint.
 Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
 organization does not exist.
 Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the
 constraint already exists on the given organization.
 

updateCustomConstraint

public CustomConstraint updateCustomConstraint(UpdateCustomConstraintRequest request)

 Updates a custom constraint.
 Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
 constraint does not exist.
 Note: the supplied policy will perform a full overwrite of all
 fields.
 

getCustomConstraint

public CustomConstraint getCustomConstraint(GetCustomConstraintRequest request)

 Gets a custom constraint.
 Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
 custom constraint does not exist.
 

listCustomConstraints

public ListCustomConstraintsResponse listCustomConstraints(ListCustomConstraintsRequest request)

 Retrieves all of the custom constraints that exist on a particular
 organization resource.
 

deleteCustomConstraint

public com.google.protobuf.Empty deleteCustomConstraint(DeleteCustomConstraintRequest request)

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