Class OrgPolicyGrpc.OrgPolicyBlockingStub (2.42.0)

public static final class OrgPolicyGrpc.OrgPolicyBlockingStub extends 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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > OrgPolicyGrpc.OrgPolicyBlockingStub

Inherited Members

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

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

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

Returns
Type	Description
`OrgPolicyGrpc.OrgPolicyBlockingStub`

Overrides

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

createCustomConstraint(CreateCustomConstraintRequest request)

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.

Parameter
Name	Description
`request`	`CreateCustomConstraintRequest`

Returns
Type	Description
`CustomConstraint`

createPolicy(CreatePolicyRequest request)

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.

Parameter
Name	Description
`request`	`CreatePolicyRequest`

Returns
Type	Description
`Policy`

deleteCustomConstraint(DeleteCustomConstraintRequest request)

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

Parameter
Name	Description
`request`	`DeleteCustomConstraintRequest`

Returns
Type	Description
`Empty`

deletePolicy(DeletePolicyRequest request)

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

Parameter
Name	Description
`request`	`DeletePolicyRequest`

Returns
Type	Description
`Empty`

getCustomConstraint(GetCustomConstraintRequest request)

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.

Parameter
Name	Description
`request`	`GetCustomConstraintRequest`

Returns
Type	Description
`CustomConstraint`

getEffectivePolicy(GetEffectivePolicyRequest request)

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.

Parameter
Name	Description
`request`	`GetEffectivePolicyRequest`

Returns
Type	Description
`Policy`

getPolicy(GetPolicyRequest request)

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.

Parameter
Name	Description
`request`	`GetPolicyRequest`

Returns
Type	Description
`Policy`

listConstraints(ListConstraintsRequest request)

public ListConstraintsResponse listConstraints(ListConstraintsRequest request)

Lists constraints that could be applied on the specified resource.

Parameter
Name	Description
`request`	`ListConstraintsRequest`

Returns
Type	Description
`ListConstraintsResponse`

listCustomConstraints(ListCustomConstraintsRequest request)

public ListCustomConstraintsResponse listCustomConstraints(ListCustomConstraintsRequest request)

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

Parameter
Name	Description
`request`	`ListCustomConstraintsRequest`

Returns
Type	Description
`ListCustomConstraintsResponse`

listPolicies(ListPoliciesRequest request)

public ListPoliciesResponse listPolicies(ListPoliciesRequest request)

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

Parameter
Name	Description
`request`	`ListPoliciesRequest`

Returns
Type	Description
`ListPoliciesResponse`

updateCustomConstraint(UpdateCustomConstraintRequest request)

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.

Parameter
Name	Description
`request`	`UpdateCustomConstraintRequest`

Returns
Type	Description
`CustomConstraint`

updatePolicy(UpdatePolicyRequest request)

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.

Parameter
Name	Description
`request`	`UpdatePolicyRequest`

Returns
Type	Description
`Policy`