Interface OrgPolicyGrpc.AsyncService (2.27.0)

Version 2.27.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 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 interface OrgPolicyGrpc.AsyncService

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.

Methods

createPolicy(CreatePolicyRequest request, StreamObserver<Policy> responseObserver)

public default void createPolicy(CreatePolicyRequest request, StreamObserver<Policy> responseObserver)

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.

Parameters
Name	Description
request	CreatePolicyRequest
responseObserver	io.grpc.stub.StreamObserver<Policy>

deletePolicy(DeletePolicyRequest request, StreamObserver<Empty> responseObserver)

public default void deletePolicy(DeletePolicyRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name	Description
request	DeletePolicyRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

getEffectivePolicy(GetEffectivePolicyRequest request, StreamObserver<Policy> responseObserver)

public default void getEffectivePolicy(GetEffectivePolicyRequest request, StreamObserver<Policy> responseObserver)

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.

Parameters
Name	Description
request	GetEffectivePolicyRequest
responseObserver	io.grpc.stub.StreamObserver<Policy>

getPolicy(GetPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void getPolicy(GetPolicyRequest request, StreamObserver<Policy> responseObserver)

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.

Parameters
Name	Description
request	GetPolicyRequest
responseObserver	io.grpc.stub.StreamObserver<Policy>

listConstraints(ListConstraintsRequest request, StreamObserver<ListConstraintsResponse> responseObserver)

public default void listConstraints(ListConstraintsRequest request, StreamObserver<ListConstraintsResponse> responseObserver)

Lists Constraints that could be applied on the specified resource.

Parameters
Name	Description
request	ListConstraintsRequest
responseObserver	io.grpc.stub.StreamObserver<ListConstraintsResponse>

listPolicies(ListPoliciesRequest request, StreamObserver<ListPoliciesResponse> responseObserver)

public default void listPolicies(ListPoliciesRequest request, StreamObserver<ListPoliciesResponse> responseObserver)

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

Parameters
Name	Description
request	ListPoliciesRequest
responseObserver	io.grpc.stub.StreamObserver<ListPoliciesResponse>

updatePolicy(UpdatePolicyRequest request, StreamObserver<Policy> responseObserver)

public default void updatePolicy(UpdatePolicyRequest request, StreamObserver<Policy> responseObserver)

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.

Parameters
Name	Description
request	UpdatePolicyRequest
responseObserver	io.grpc.stub.StreamObserver<Policy>