OrganizationsClient (Google Resource Manager API Parent 1.5.6 API)

java.lang.Object
- com.google.cloud.resourcemanager.v3.OrganizationsClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class OrganizationsClient
extends Object
implements BackgroundResource

Service Description: Allows users to manage their organization 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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   OrganizationName name = OrganizationName.of("[ORGANIZATION]");
   Organization response = organizationsClient.getOrganization(name);
 }

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

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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 OrganizationsSettings 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
 OrganizationsSettings organizationsSettings =
     OrganizationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);

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
 OrganizationsSettings organizationsSettings =
     OrganizationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);

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
 OrganizationsSettings organizationsSettings =
     OrganizationsSettings.newBuilder()
         .setTransportChannelProvider(
             OrganizationsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`OrganizationsClient.SearchOrganizationsFixedSizeCollection`
`static class`	`OrganizationsClient.SearchOrganizationsPage`
`static class`	`OrganizationsClient.SearchOrganizationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`OrganizationsClient(OrganizationsSettings settings)` Constructs an instance of OrganizationsClient, using the given settings.
`protected`	`OrganizationsClient(OrganizationsStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static OrganizationsClient`	`create()` Constructs an instance of OrganizationsClient with default settings.
`static OrganizationsClient`	`create(OrganizationsSettings settings)` Constructs an instance of OrganizationsClient, using the given settings.
`static OrganizationsClient`	`create(OrganizationsStub stub)` Constructs an instance of OrganizationsClient, using the given stub for making calls.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for an organization resource.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.api.resourcenames.ResourceName resource)` Gets the access control policy for an organization resource.
`com.google.iam.v1.Policy`	`getIamPolicy(String resource)` Gets the access control policy for an organization resource.
`UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for an organization resource.
`Organization`	`getOrganization(GetOrganizationRequest request)` Fetches an organization resource identified by the specified resource name.
`Organization`	`getOrganization(OrganizationName name)` Fetches an organization resource identified by the specified resource name.
`Organization`	`getOrganization(String name)` Fetches an organization resource identified by the specified resource name.
`UnaryCallable<GetOrganizationRequest,Organization>`	`getOrganizationCallable()` Fetches an organization resource identified by the specified resource name.
`OrganizationsSettings`	`getSettings()`
`OrganizationsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`OrganizationsClient.SearchOrganizationsPagedResponse`	`searchOrganizations(SearchOrganizationsRequest request)` Searches organization resources that are visible to the user and satisfy the specified filter.
`OrganizationsClient.SearchOrganizationsPagedResponse`	`searchOrganizations(String query)` Searches organization resources that are visible to the user and satisfy the specified filter.
`UnaryCallable<SearchOrganizationsRequest,SearchOrganizationsResponse>`	`searchOrganizationsCallable()` Searches organization resources that are visible to the user and satisfy the specified filter.
`UnaryCallable<SearchOrganizationsRequest,OrganizationsClient.SearchOrganizationsPagedResponse>`	`searchOrganizationsPagedCallable()` Searches organization resources that are visible to the user and satisfy the specified filter.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.api.resourcenames.ResourceName resource)` Sets the access control policy on an organization resource.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on an organization resource.
`com.google.iam.v1.Policy`	`setIamPolicy(String resource)` Sets the access control policy on an organization resource.
`UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on an organization resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.api.resourcenames.ResourceName resource, List<String> permissions)` Returns the permissions that a caller has on the specified organization.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(String resource, List<String> permissions)` Returns the permissions that a caller has on the specified organization.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns the permissions that a caller has on the specified organization.
`UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns the permissions that a caller has on the specified organization.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- OrganizationsClient
```
protected OrganizationsClient(OrganizationsSettings settings)
                       throws IOException
```
  Constructs an instance of OrganizationsClient, 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.
  
  Throws:
  
  IOException
- OrganizationsClient
```
protected OrganizationsClient(OrganizationsStub stub)
```

Method Detail

create

public static final OrganizationsClient create()
                                        throws IOException

Constructs an instance of OrganizationsClient with default settings.

Throws:: IOException

create
```
public static final OrganizationsClient create(OrganizationsSettings settings)
                                        throws IOException
```
Constructs an instance of OrganizationsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final OrganizationsClient create(OrganizationsStub stub)
```
Constructs an instance of OrganizationsClient, using the given stub for making calls. This is for advanced usage - prefer using create(OrganizationsSettings).

getSettings

public final OrganizationsSettings getSettings()

getStub
```
public OrganizationsStub getStub()
```

getOrganization

public final Organization getOrganization(OrganizationName name)

Fetches an organization resource identified by the specified resource name.

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   OrganizationName name = OrganizationName.of("[ORGANIZATION]");
   Organization response = organizationsClient.getOrganization(name);
 }

Parameters:: name - Required. The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as "organizations/[organizationId]". For example, "organizations/1234".
Throws:: ApiException - if the remote call fails

getOrganization

public final Organization getOrganization(String name)

Fetches an organization resource identified by the specified resource name.

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   String name = OrganizationName.of("[ORGANIZATION]").toString();
   Organization response = organizationsClient.getOrganization(name);
 }

Parameters:: name - Required. The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as "organizations/[organizationId]". For example, "organizations/1234".
Throws:: ApiException - if the remote call fails

getOrganization

public final Organization getOrganization(GetOrganizationRequest request)

Fetches an organization resource identified by the specified resource name.

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   GetOrganizationRequest request =
       GetOrganizationRequest.newBuilder()
           .setName(OrganizationName.of("[ORGANIZATION]").toString())
           .build();
   Organization response = organizationsClient.getOrganization(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getOrganizationCallable

public final UnaryCallable<GetOrganizationRequest,Organization> getOrganizationCallable()

Fetches an organization resource identified by the specified resource name.

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   GetOrganizationRequest request =
       GetOrganizationRequest.newBuilder()
           .setName(OrganizationName.of("[ORGANIZATION]").toString())
           .build();
   ApiFuture<Organization> future =
       organizationsClient.getOrganizationCallable().futureCall(request);
   // Do something.
   Organization response = future.get();
 }

searchOrganizations
```
public final OrganizationsClient.SearchOrganizationsPagedResponse searchOrganizations(String query)
```
Searches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New organizations do not necessarily appear at the end of the results, and may take a small amount of time to appear.
Search will only return organizations on which the user has the permission `resourcemanager.organizations.get`
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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   String query = "query107944136";
   for (Organization element : organizationsClient.searchOrganizations(query).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:
query - Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive.
``` | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | ```
Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example:
- Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`.
- Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.
Throws:

ApiException - if the remote call fails

searchOrganizations

public final OrganizationsClient.SearchOrganizationsPagedResponse searchOrganizations(SearchOrganizationsRequest request)

Searches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New organizations do not necessarily appear at the end of the results, and may take a small amount of time to appear.

Search will only return organizations on which the user has the permission `resourcemanager.organizations.get`

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   SearchOrganizationsRequest request =
       SearchOrganizationsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setQuery("query107944136")
           .build();
   for (Organization element : organizationsClient.searchOrganizations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

searchOrganizationsPagedCallable

public final UnaryCallable<SearchOrganizationsRequest,OrganizationsClient.SearchOrganizationsPagedResponse> searchOrganizationsPagedCallable()

Search will only return organizations on which the user has the permission `resourcemanager.organizations.get`

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   SearchOrganizationsRequest request =
       SearchOrganizationsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setQuery("query107944136")
           .build();
   ApiFuture<Organization> future =
       organizationsClient.searchOrganizationsPagedCallable().futureCall(request);
   // Do something.
   for (Organization element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

searchOrganizationsCallable

public final UnaryCallable<SearchOrganizationsRequest,SearchOrganizationsResponse> searchOrganizationsCallable()

Search will only return organizations on which the user has the permission `resourcemanager.organizations.get`

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   SearchOrganizationsRequest request =
       SearchOrganizationsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setQuery("query107944136")
           .build();
   while (true) {
     SearchOrganizationsResponse response =
         organizationsClient.searchOrganizationsCallable().call(request);
     for (Organization element : response.getOrganizationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(com.google.api.resourcenames.ResourceName resource)

Gets the access control policy for an organization resource. The policy may be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, for example: "organizations/123".

Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on the specified 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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   ResourceName resource = OrganizationName.of("[ORGANIZATION]");
   Policy response = organizationsClient.getIamPolicy(resource);
 }

Parameters:: resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Throws:: ApiException - if the remote call fails

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(String resource)

Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on the specified 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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   String resource = FolderName.of("[FOLDER]").toString();
   Policy response = organizationsClient.getIamPolicy(resource);
 }

Parameters:: resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Throws:: ApiException - if the remote call fails

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on the specified 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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(OrganizationName.of("[ORGANIZATION]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = organizationsClient.getIamPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getIamPolicyCallable

public final UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()

Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on the specified 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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(OrganizationName.of("[ORGANIZATION]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = organizationsClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(com.google.api.resourcenames.ResourceName resource)

Sets the access control policy on an organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, for example: "organizations/123".

Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on the specified 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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   ResourceName resource = OrganizationName.of("[ORGANIZATION]");
   Policy response = organizationsClient.setIamPolicy(resource);
 }

Parameters:: resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Throws:: ApiException - if the remote call fails

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(String resource)

Sets the access control policy on an organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, for example: "organizations/123".

Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on the specified 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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   String resource = FolderName.of("[FOLDER]").toString();
   Policy response = organizationsClient.setIamPolicy(resource);
 }

Parameters:: resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Throws:: ApiException - if the remote call fails

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

Sets the access control policy on an organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, for example: "organizations/123".

Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on the specified 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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(OrganizationName.of("[ORGANIZATION]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = organizationsClient.setIamPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

setIamPolicyCallable

public final UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()

Sets the access control policy on an organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, for example: "organizations/123".

Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on the specified 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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(OrganizationName.of("[ORGANIZATION]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = organizationsClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.api.resourcenames.ResourceName resource,
                                                                             List<String> permissions)

Returns the permissions that a caller has on the specified organization. The `resource` field should be the organization's resource name, for example: "organizations/123".

There are no permissions required for making this API call.

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   ResourceName resource = OrganizationName.of("[ORGANIZATION]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response =
       organizationsClient.testIamPermissions(resource, permissions);
 }

Parameters:: resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.; permissions - The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Throws:: ApiException - if the remote call fails

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(String resource,
                                                                             List<String> permissions)

Returns the permissions that a caller has on the specified organization. The `resource` field should be the organization's resource name, for example: "organizations/123".

There are no permissions required for making this API call.

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   String resource = FolderName.of("[FOLDER]").toString();
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response =
       organizationsClient.testIamPermissions(resource, permissions);
 }

Parameters:: resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.; permissions - The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Throws:: ApiException - if the remote call fails

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

Returns the permissions that a caller has on the specified organization. The `resource` field should be the organization's resource name, for example: "organizations/123".

There are no permissions required for making this API call.

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(OrganizationName.of("[ORGANIZATION]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = organizationsClient.testIamPermissions(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

testIamPermissionsCallable

public final UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()

Returns the permissions that a caller has on the specified organization. The `resource` field should be the organization's resource name, for example: "organizations/123".

There are no permissions required for making this API call.

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(OrganizationName.of("[ORGANIZATION]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       organizationsClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface BackgroundResource
Throws:: InterruptedException

Class OrganizationsClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrganizationsClient

OrganizationsClient

Method Detail

create

create

create

getSettings

getStub

getOrganization

getOrganization

getOrganization

getOrganizationCallable

searchOrganizations

searchOrganizations

searchOrganizationsPagedCallable

searchOrganizationsCallable

getIamPolicy

getIamPolicy

getIamPolicy

getIamPolicyCallable

setIamPolicy

setIamPolicy

setIamPolicy

setIamPolicyCallable

testIamPermissions

testIamPermissions

testIamPermissions

testIamPermissionsCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination