Class OrgPolicyClient (2.40.0)

GitHub RepositoryProduct Reference

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   PolicyName name = PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]");
   Policy response = orgPolicyClient.getPolicy(name);
 }

Note: close() needs to be called on the OrgPolicyClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
MethodDescriptionMethod Variants

ListConstraints

Lists constraints that could be applied on the specified resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listConstraints(ListConstraintsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listConstraints(FolderName parent)

  • listConstraints(OrganizationName parent)

  • listConstraints(ProjectName parent)

  • listConstraints(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listConstraintsPagedCallable()

  • listConstraintsCallable()

ListPolicies

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPolicies(ListPoliciesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPolicies(FolderName parent)

  • listPolicies(OrganizationName parent)

  • listPolicies(ProjectName parent)

  • listPolicies(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPoliciesPagedCallable()

  • listPoliciesCallable()

GetPolicy

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getPolicy(GetPolicyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getPolicy(PolicyName name)

  • getPolicy(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getPolicyCallable()

GetEffectivePolicy

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEffectivePolicy(GetEffectivePolicyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEffectivePolicy(PolicyName name)

  • getEffectivePolicy(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEffectivePolicyCallable()

CreatePolicy

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createPolicy(CreatePolicyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createPolicy(FolderName parent, Policy policy)

  • createPolicy(OrganizationName parent, Policy policy)

  • createPolicy(ProjectName parent, Policy policy)

  • createPolicy(String parent, Policy policy)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createPolicyCallable()

UpdatePolicy

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updatePolicy(UpdatePolicyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updatePolicy(Policy policy)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updatePolicyCallable()

DeletePolicy

Deletes a policy.

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deletePolicy(DeletePolicyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deletePolicy(PolicyName name)

  • deletePolicy(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deletePolicyCallable()

CreateCustomConstraint

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createCustomConstraint(CreateCustomConstraintRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createCustomConstraint(OrganizationName parent, CustomConstraint customConstraint)

  • createCustomConstraint(String parent, CustomConstraint customConstraint)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createCustomConstraintCallable()

UpdateCustomConstraint

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateCustomConstraint(UpdateCustomConstraintRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateCustomConstraint(CustomConstraint customConstraint)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateCustomConstraintCallable()

GetCustomConstraint

Gets a custom constraint.

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getCustomConstraint(GetCustomConstraintRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getCustomConstraint(CustomConstraintName name)

  • getCustomConstraint(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCustomConstraintCallable()

ListCustomConstraints

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listCustomConstraints(ListCustomConstraintsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listCustomConstraints(OrganizationName parent)

  • listCustomConstraints(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listCustomConstraintsPagedCallable()

  • listCustomConstraintsCallable()

DeleteCustomConstraint

Deletes a custom constraint.

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteCustomConstraint(DeleteCustomConstraintRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteCustomConstraint(CustomConstraintName name)

  • deleteCustomConstraint(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteCustomConstraintCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of OrgPolicySettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 OrgPolicySettings orgPolicySettings =
     OrgPolicySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OrgPolicyClient orgPolicyClient = OrgPolicyClient.create(orgPolicySettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 OrgPolicySettings orgPolicySettings =
     OrgPolicySettings.newBuilder().setEndpoint(myEndpoint).build();
 OrgPolicyClient orgPolicyClient = OrgPolicyClient.create(orgPolicySettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 OrgPolicySettings orgPolicySettings = OrgPolicySettings.newHttpJsonBuilder().build();
 OrgPolicyClient orgPolicyClient = OrgPolicyClient.create(orgPolicySettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > OrgPolicyClient

Static Methods

create()

public static final OrgPolicyClient create()

Constructs an instance of OrgPolicyClient with default settings.

Returns
TypeDescription
OrgPolicyClient
Exceptions
TypeDescription
IOException

create(OrgPolicySettings settings)

public static final OrgPolicyClient create(OrgPolicySettings settings)

Constructs an instance of OrgPolicyClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsOrgPolicySettings
Returns
TypeDescription
OrgPolicyClient
Exceptions
TypeDescription
IOException

create(OrgPolicyStub stub)

public static final OrgPolicyClient create(OrgPolicyStub stub)

Constructs an instance of OrgPolicyClient, using the given stub for making calls. This is for advanced usage - prefer using create(OrgPolicySettings).

Parameter
NameDescription
stubOrgPolicyStub
Returns
TypeDescription
OrgPolicyClient

Constructors

OrgPolicyClient(OrgPolicySettings settings)

protected OrgPolicyClient(OrgPolicySettings settings)

Constructs an instance of OrgPolicyClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
NameDescription
settingsOrgPolicySettings

OrgPolicyClient(OrgPolicyStub stub)

protected OrgPolicyClient(OrgPolicyStub stub)
Parameter
NameDescription
stubOrgPolicyStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

createCustomConstraint(CreateCustomConstraintRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   CreateCustomConstraintRequest request =
       CreateCustomConstraintRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setCustomConstraint(CustomConstraint.newBuilder().build())
           .build();
   CustomConstraint response = orgPolicyClient.createCustomConstraint(request);
 }
Parameter
NameDescription
requestCreateCustomConstraintRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
CustomConstraint

createCustomConstraint(OrganizationName parent, CustomConstraint customConstraint)

public final CustomConstraint createCustomConstraint(OrganizationName parent, CustomConstraint customConstraint)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   CustomConstraint customConstraint = CustomConstraint.newBuilder().build();
   CustomConstraint response = orgPolicyClient.createCustomConstraint(parent, customConstraint);
 }
Parameters
NameDescription
parentOrganizationName

Required. Must be in the following form:

  • organizations/{organization_id}

customConstraintCustomConstraint

Required. Custom constraint to create.

Returns
TypeDescription
CustomConstraint

createCustomConstraint(String parent, CustomConstraint customConstraint)

public final CustomConstraint createCustomConstraint(String parent, CustomConstraint customConstraint)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   CustomConstraint customConstraint = CustomConstraint.newBuilder().build();
   CustomConstraint response = orgPolicyClient.createCustomConstraint(parent, customConstraint);
 }
Parameters
NameDescription
parentString

Required. Must be in the following form:

  • organizations/{organization_id}

customConstraintCustomConstraint

Required. Custom constraint to create.

Returns
TypeDescription
CustomConstraint

createCustomConstraintCallable()

public final UnaryCallable<CreateCustomConstraintRequest,CustomConstraint> createCustomConstraintCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   CreateCustomConstraintRequest request =
       CreateCustomConstraintRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setCustomConstraint(CustomConstraint.newBuilder().build())
           .build();
   ApiFuture<CustomConstraint> future =
       orgPolicyClient.createCustomConstraintCallable().futureCall(request);
   // Do something.
   CustomConstraint response = future.get();
 }
Returns
TypeDescription
UnaryCallable<CreateCustomConstraintRequest,CustomConstraint>

createPolicy(CreatePolicyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   CreatePolicyRequest request =
       CreatePolicyRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPolicy(Policy.newBuilder().build())
           .build();
   Policy response = orgPolicyClient.createPolicy(request);
 }
Parameter
NameDescription
requestCreatePolicyRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Policy

createPolicy(FolderName parent, Policy policy)

public final Policy createPolicy(FolderName parent, Policy policy)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   FolderName parent = FolderName.of("[FOLDER]");
   Policy policy = Policy.newBuilder().build();
   Policy response = orgPolicyClient.createPolicy(parent, policy);
 }
Parameters
NameDescription
parentFolderName

Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

policyPolicy

Required. Policy to create.

Returns
TypeDescription
Policy

createPolicy(OrganizationName parent, Policy policy)

public final Policy createPolicy(OrganizationName parent, Policy policy)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   Policy policy = Policy.newBuilder().build();
   Policy response = orgPolicyClient.createPolicy(parent, policy);
 }
Parameters
NameDescription
parentOrganizationName

Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

policyPolicy

Required. Policy to create.

Returns
TypeDescription
Policy

createPolicy(ProjectName parent, Policy policy)

public final Policy createPolicy(ProjectName parent, Policy policy)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Policy policy = Policy.newBuilder().build();
   Policy response = orgPolicyClient.createPolicy(parent, policy);
 }
Parameters
NameDescription
parentProjectName

Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

policyPolicy

Required. Policy to create.

Returns
TypeDescription
Policy

createPolicy(String parent, Policy policy)

public final Policy createPolicy(String parent, Policy policy)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Policy policy = Policy.newBuilder().build();
   Policy response = orgPolicyClient.createPolicy(parent, policy);
 }
Parameters
NameDescription
parentString

Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

policyPolicy

Required. Policy to create.

Returns
TypeDescription
Policy

createPolicyCallable()

public final UnaryCallable<CreatePolicyRequest,Policy> createPolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   CreatePolicyRequest request =
       CreatePolicyRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPolicy(Policy.newBuilder().build())
           .build();
   ApiFuture<Policy> future = orgPolicyClient.createPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
TypeDescription
UnaryCallable<CreatePolicyRequest,Policy>

deleteCustomConstraint(CustomConstraintName name)

public final void deleteCustomConstraint(CustomConstraintName name)

Deletes a custom constraint.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   CustomConstraintName name = CustomConstraintName.of("[ORGANIZATION]", "[CUSTOM_CONSTRAINT]");
   orgPolicyClient.deleteCustomConstraint(name);
 }
Parameter
NameDescription
nameCustomConstraintName

Required. Name of the custom constraint to delete. See the custom constraint entry for naming rules.

deleteCustomConstraint(DeleteCustomConstraintRequest request)

public final void deleteCustomConstraint(DeleteCustomConstraintRequest request)

Deletes a custom constraint.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   DeleteCustomConstraintRequest request =
       DeleteCustomConstraintRequest.newBuilder()
           .setName(CustomConstraintName.of("[ORGANIZATION]", "[CUSTOM_CONSTRAINT]").toString())
           .build();
   orgPolicyClient.deleteCustomConstraint(request);
 }
Parameter
NameDescription
requestDeleteCustomConstraintRequest

The request object containing all of the parameters for the API call.

deleteCustomConstraint(String name)

public final void deleteCustomConstraint(String name)

Deletes a custom constraint.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   String name = CustomConstraintName.of("[ORGANIZATION]", "[CUSTOM_CONSTRAINT]").toString();
   orgPolicyClient.deleteCustomConstraint(name);
 }
Parameter
NameDescription
nameString

Required. Name of the custom constraint to delete. See the custom constraint entry for naming rules.

deleteCustomConstraintCallable()

public final UnaryCallable<DeleteCustomConstraintRequest,Empty> deleteCustomConstraintCallable()

Deletes a custom constraint.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   DeleteCustomConstraintRequest request =
       DeleteCustomConstraintRequest.newBuilder()
           .setName(CustomConstraintName.of("[ORGANIZATION]", "[CUSTOM_CONSTRAINT]").toString())
           .build();
   ApiFuture<Empty> future =
       orgPolicyClient.deleteCustomConstraintCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
TypeDescription
UnaryCallable<DeleteCustomConstraintRequest,Empty>

deletePolicy(DeletePolicyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   DeletePolicyRequest request =
       DeletePolicyRequest.newBuilder()
           .setName(PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]").toString())
           .setEtag("etag3123477")
           .build();
   orgPolicyClient.deletePolicy(request);
 }
Parameter
NameDescription
requestDeletePolicyRequest

The request object containing all of the parameters for the API call.

deletePolicy(PolicyName name)

public final void deletePolicy(PolicyName name)

Deletes a policy.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   PolicyName name = PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]");
   orgPolicyClient.deletePolicy(name);
 }
Parameter
NameDescription
namePolicyName

Required. Name of the policy to delete. See the policy entry for naming rules.

deletePolicy(String name)

public final void deletePolicy(String name)

Deletes a policy.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   String name = PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]").toString();
   orgPolicyClient.deletePolicy(name);
 }
Parameter
NameDescription
nameString

Required. Name of the policy to delete. See the policy entry for naming rules.

deletePolicyCallable()

public final UnaryCallable<DeletePolicyRequest,Empty> deletePolicyCallable()

Deletes a policy.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   DeletePolicyRequest request =
       DeletePolicyRequest.newBuilder()
           .setName(PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future = orgPolicyClient.deletePolicyCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
TypeDescription
UnaryCallable<DeletePolicyRequest,Empty>

getCustomConstraint(CustomConstraintName name)

public final CustomConstraint getCustomConstraint(CustomConstraintName name)

Gets a custom constraint.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   CustomConstraintName name = CustomConstraintName.of("[ORGANIZATION]", "[CUSTOM_CONSTRAINT]");
   CustomConstraint response = orgPolicyClient.getCustomConstraint(name);
 }
Parameter
NameDescription
nameCustomConstraintName

Required. Resource name of the custom constraint. See the custom constraint entry for naming requirements.

Returns
TypeDescription
CustomConstraint

getCustomConstraint(GetCustomConstraintRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   GetCustomConstraintRequest request =
       GetCustomConstraintRequest.newBuilder()
           .setName(CustomConstraintName.of("[ORGANIZATION]", "[CUSTOM_CONSTRAINT]").toString())
           .build();
   CustomConstraint response = orgPolicyClient.getCustomConstraint(request);
 }
Parameter
NameDescription
requestGetCustomConstraintRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
CustomConstraint

getCustomConstraint(String name)

public final CustomConstraint getCustomConstraint(String name)

Gets a custom constraint.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   String name = CustomConstraintName.of("[ORGANIZATION]", "[CUSTOM_CONSTRAINT]").toString();
   CustomConstraint response = orgPolicyClient.getCustomConstraint(name);
 }
Parameter
NameDescription
nameString

Required. Resource name of the custom constraint. See the custom constraint entry for naming requirements.

Returns
TypeDescription
CustomConstraint

getCustomConstraintCallable()

public final UnaryCallable<GetCustomConstraintRequest,CustomConstraint> getCustomConstraintCallable()

Gets a custom constraint.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   GetCustomConstraintRequest request =
       GetCustomConstraintRequest.newBuilder()
           .setName(CustomConstraintName.of("[ORGANIZATION]", "[CUSTOM_CONSTRAINT]").toString())
           .build();
   ApiFuture<CustomConstraint> future =
       orgPolicyClient.getCustomConstraintCallable().futureCall(request);
   // Do something.
   CustomConstraint response = future.get();
 }
Returns
TypeDescription
UnaryCallable<GetCustomConstraintRequest,CustomConstraint>

getEffectivePolicy(GetEffectivePolicyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   GetEffectivePolicyRequest request =
       GetEffectivePolicyRequest.newBuilder()
           .setName(PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]").toString())
           .build();
   Policy response = orgPolicyClient.getEffectivePolicy(request);
 }
Parameter
NameDescription
requestGetEffectivePolicyRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Policy

getEffectivePolicy(PolicyName name)

public final Policy getEffectivePolicy(PolicyName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   PolicyName name = PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]");
   Policy response = orgPolicyClient.getEffectivePolicy(name);
 }
Parameter
NameDescription
namePolicyName

Required. The effective policy to compute. See Policy for naming requirements.

Returns
TypeDescription
Policy

getEffectivePolicy(String name)

public final Policy getEffectivePolicy(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   String name = PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]").toString();
   Policy response = orgPolicyClient.getEffectivePolicy(name);
 }
Parameter
NameDescription
nameString

Required. The effective policy to compute. See Policy for naming requirements.

Returns
TypeDescription
Policy

getEffectivePolicyCallable()

public final UnaryCallable<GetEffectivePolicyRequest,Policy> getEffectivePolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   GetEffectivePolicyRequest request =
       GetEffectivePolicyRequest.newBuilder()
           .setName(PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]").toString())
           .build();
   ApiFuture<Policy> future = orgPolicyClient.getEffectivePolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
TypeDescription
UnaryCallable<GetEffectivePolicyRequest,Policy>

getPolicy(GetPolicyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   GetPolicyRequest request =
       GetPolicyRequest.newBuilder()
           .setName(PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]").toString())
           .build();
   Policy response = orgPolicyClient.getPolicy(request);
 }
Parameter
NameDescription
requestGetPolicyRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Policy

getPolicy(PolicyName name)

public final Policy getPolicy(PolicyName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   PolicyName name = PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]");
   Policy response = orgPolicyClient.getPolicy(name);
 }
Parameter
NameDescription
namePolicyName

Required. Resource name of the policy. See Policy for naming requirements.

Returns
TypeDescription
Policy

getPolicy(String name)

public final Policy getPolicy(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   String name = PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]").toString();
   Policy response = orgPolicyClient.getPolicy(name);
 }
Parameter
NameDescription
nameString

Required. Resource name of the policy. See Policy for naming requirements.

Returns
TypeDescription
Policy

getPolicyCallable()

public final UnaryCallable<GetPolicyRequest,Policy> getPolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   GetPolicyRequest request =
       GetPolicyRequest.newBuilder()
           .setName(PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]").toString())
           .build();
   ApiFuture<Policy> future = orgPolicyClient.getPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
TypeDescription
UnaryCallable<GetPolicyRequest,Policy>

getSettings()

public final OrgPolicySettings getSettings()
Returns
TypeDescription
OrgPolicySettings

getStub()

public OrgPolicyStub getStub()
Returns
TypeDescription
OrgPolicyStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listConstraints(FolderName parent)

public final OrgPolicyClient.ListConstraintsPagedResponse listConstraints(FolderName parent)

Lists constraints that could be applied on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   FolderName parent = FolderName.of("[FOLDER]");
   for (Constraint element : orgPolicyClient.listConstraints(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
parentFolderName

Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Returns
TypeDescription
OrgPolicyClient.ListConstraintsPagedResponse

listConstraints(ListConstraintsRequest request)

public final OrgPolicyClient.ListConstraintsPagedResponse listConstraints(ListConstraintsRequest request)

Lists constraints that could be applied on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ListConstraintsRequest request =
       ListConstraintsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Constraint element : orgPolicyClient.listConstraints(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
requestListConstraintsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OrgPolicyClient.ListConstraintsPagedResponse

listConstraints(OrganizationName parent)

public final OrgPolicyClient.ListConstraintsPagedResponse listConstraints(OrganizationName parent)

Lists constraints that could be applied on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (Constraint element : orgPolicyClient.listConstraints(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
parentOrganizationName

Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Returns
TypeDescription
OrgPolicyClient.ListConstraintsPagedResponse

listConstraints(ProjectName parent)

public final OrgPolicyClient.ListConstraintsPagedResponse listConstraints(ProjectName parent)

Lists constraints that could be applied on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Constraint element : orgPolicyClient.listConstraints(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
parentProjectName

Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Returns
TypeDescription
OrgPolicyClient.ListConstraintsPagedResponse

listConstraints(String parent)

public final OrgPolicyClient.ListConstraintsPagedResponse listConstraints(String parent)

Lists constraints that could be applied on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (Constraint element : orgPolicyClient.listConstraints(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
parentString

Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Returns
TypeDescription
OrgPolicyClient.ListConstraintsPagedResponse

listConstraintsCallable()

public final UnaryCallable<ListConstraintsRequest,ListConstraintsResponse> listConstraintsCallable()

Lists constraints that could be applied on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ListConstraintsRequest request =
       ListConstraintsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListConstraintsResponse response = orgPolicyClient.listConstraintsCallable().call(request);
     for (Constraint element : response.getConstraintsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
TypeDescription
UnaryCallable<ListConstraintsRequest,ListConstraintsResponse>

listConstraintsPagedCallable()

public final UnaryCallable<ListConstraintsRequest,OrgPolicyClient.ListConstraintsPagedResponse> listConstraintsPagedCallable()

Lists constraints that could be applied on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ListConstraintsRequest request =
       ListConstraintsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Constraint> future =
       orgPolicyClient.listConstraintsPagedCallable().futureCall(request);
   // Do something.
   for (Constraint element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
TypeDescription
UnaryCallable<ListConstraintsRequest,ListConstraintsPagedResponse>

listCustomConstraints(ListCustomConstraintsRequest request)

public final OrgPolicyClient.ListCustomConstraintsPagedResponse listCustomConstraints(ListCustomConstraintsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ListCustomConstraintsRequest request =
       ListCustomConstraintsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (CustomConstraint element : orgPolicyClient.listCustomConstraints(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
requestListCustomConstraintsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OrgPolicyClient.ListCustomConstraintsPagedResponse

listCustomConstraints(OrganizationName parent)

public final OrgPolicyClient.ListCustomConstraintsPagedResponse listCustomConstraints(OrganizationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (CustomConstraint element : orgPolicyClient.listCustomConstraints(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
parentOrganizationName

Required. The target Google Cloud resource that parents the set of custom constraints that will be returned from this call. Must be in one of the following forms:

  • organizations/{organization_id}

Returns
TypeDescription
OrgPolicyClient.ListCustomConstraintsPagedResponse

listCustomConstraints(String parent)

public final OrgPolicyClient.ListCustomConstraintsPagedResponse listCustomConstraints(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   for (CustomConstraint element : orgPolicyClient.listCustomConstraints(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
parentString

Required. The target Google Cloud resource that parents the set of custom constraints that will be returned from this call. Must be in one of the following forms:

  • organizations/{organization_id}

Returns
TypeDescription
OrgPolicyClient.ListCustomConstraintsPagedResponse

listCustomConstraintsCallable()

public final UnaryCallable<ListCustomConstraintsRequest,ListCustomConstraintsResponse> listCustomConstraintsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ListCustomConstraintsRequest request =
       ListCustomConstraintsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCustomConstraintsResponse response =
         orgPolicyClient.listCustomConstraintsCallable().call(request);
     for (CustomConstraint element : response.getCustomConstraintsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
TypeDescription
UnaryCallable<ListCustomConstraintsRequest,ListCustomConstraintsResponse>

listCustomConstraintsPagedCallable()

public final UnaryCallable<ListCustomConstraintsRequest,OrgPolicyClient.ListCustomConstraintsPagedResponse> listCustomConstraintsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ListCustomConstraintsRequest request =
       ListCustomConstraintsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<CustomConstraint> future =
       orgPolicyClient.listCustomConstraintsPagedCallable().futureCall(request);
   // Do something.
   for (CustomConstraint element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
TypeDescription
UnaryCallable<ListCustomConstraintsRequest,ListCustomConstraintsPagedResponse>

listPolicies(FolderName parent)

public final OrgPolicyClient.ListPoliciesPagedResponse listPolicies(FolderName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   FolderName parent = FolderName.of("[FOLDER]");
   for (Policy element : orgPolicyClient.listPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
parentFolderName

Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Returns
TypeDescription
OrgPolicyClient.ListPoliciesPagedResponse

listPolicies(ListPoliciesRequest request)

public final OrgPolicyClient.ListPoliciesPagedResponse listPolicies(ListPoliciesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ListPoliciesRequest request =
       ListPoliciesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Policy element : orgPolicyClient.listPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
requestListPoliciesRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OrgPolicyClient.ListPoliciesPagedResponse

listPolicies(OrganizationName parent)

public final OrgPolicyClient.ListPoliciesPagedResponse listPolicies(OrganizationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (Policy element : orgPolicyClient.listPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
parentOrganizationName

Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Returns
TypeDescription
OrgPolicyClient.ListPoliciesPagedResponse

listPolicies(ProjectName parent)

public final OrgPolicyClient.ListPoliciesPagedResponse listPolicies(ProjectName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Policy element : orgPolicyClient.listPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
parentProjectName

Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Returns
TypeDescription
OrgPolicyClient.ListPoliciesPagedResponse

listPolicies(String parent)

public final OrgPolicyClient.ListPoliciesPagedResponse listPolicies(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (Policy element : orgPolicyClient.listPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
parentString

Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Returns
TypeDescription
OrgPolicyClient.ListPoliciesPagedResponse

listPoliciesCallable()

public final UnaryCallable<ListPoliciesRequest,ListPoliciesResponse> listPoliciesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ListPoliciesRequest request =
       ListPoliciesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListPoliciesResponse response = orgPolicyClient.listPoliciesCallable().call(request);
     for (Policy element : response.getPoliciesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
TypeDescription
UnaryCallable<ListPoliciesRequest,ListPoliciesResponse>

listPoliciesPagedCallable()

public final UnaryCallable<ListPoliciesRequest,OrgPolicyClient.ListPoliciesPagedResponse> listPoliciesPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   ListPoliciesRequest request =
       ListPoliciesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Policy> future = orgPolicyClient.listPoliciesPagedCallable().futureCall(request);
   // Do something.
   for (Policy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
TypeDescription
UnaryCallable<ListPoliciesRequest,ListPoliciesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateCustomConstraint(CustomConstraint customConstraint)

public final CustomConstraint updateCustomConstraint(CustomConstraint customConstraint)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   CustomConstraint customConstraint = CustomConstraint.newBuilder().build();
   CustomConstraint response = orgPolicyClient.updateCustomConstraint(customConstraint);
 }
Parameter
NameDescription
customConstraintCustomConstraint

Required. CustomConstraint to update.

Returns
TypeDescription
CustomConstraint

updateCustomConstraint(UpdateCustomConstraintRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   UpdateCustomConstraintRequest request =
       UpdateCustomConstraintRequest.newBuilder()
           .setCustomConstraint(CustomConstraint.newBuilder().build())
           .build();
   CustomConstraint response = orgPolicyClient.updateCustomConstraint(request);
 }
Parameter
NameDescription
requestUpdateCustomConstraintRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
CustomConstraint

updateCustomConstraintCallable()

public final UnaryCallable<UpdateCustomConstraintRequest,CustomConstraint> updateCustomConstraintCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   UpdateCustomConstraintRequest request =
       UpdateCustomConstraintRequest.newBuilder()
           .setCustomConstraint(CustomConstraint.newBuilder().build())
           .build();
   ApiFuture<CustomConstraint> future =
       orgPolicyClient.updateCustomConstraintCallable().futureCall(request);
   // Do something.
   CustomConstraint response = future.get();
 }
Returns
TypeDescription
UnaryCallable<UpdateCustomConstraintRequest,CustomConstraint>

updatePolicy(Policy policy)

public final Policy updatePolicy(Policy policy)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   Policy policy = Policy.newBuilder().build();
   Policy response = orgPolicyClient.updatePolicy(policy);
 }
Parameter
NameDescription
policyPolicy

Required. Policy to update.

Returns
TypeDescription
Policy

updatePolicy(UpdatePolicyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   UpdatePolicyRequest request =
       UpdatePolicyRequest.newBuilder()
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = orgPolicyClient.updatePolicy(request);
 }
Parameter
NameDescription
requestUpdatePolicyRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Policy

updatePolicyCallable()

public final UnaryCallable<UpdatePolicyRequest,Policy> updatePolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
   UpdatePolicyRequest request =
       UpdatePolicyRequest.newBuilder()
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = orgPolicyClient.updatePolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
TypeDescription
UnaryCallable<UpdatePolicyRequest,Policy>