Class OrganizationsClient (1.2.12)

public class OrganizationsClient 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:


 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:

  1. 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.
  2. 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.
  3. 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:


 OrganizationsSettings organizationsSettings =
     OrganizationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);
 

To customize the endpoint:


 OrganizationsSettings organizationsSettings =
     OrganizationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);
 

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

Inheritance

java.lang.Object > OrganizationsClient

Implements

BackgroundResource

Static Methods

create()

public static final OrganizationsClient create()

Constructs an instance of OrganizationsClient with default settings.

Returns
TypeDescription
OrganizationsClient
Exceptions
TypeDescription
IOException

create(OrganizationsSettings settings)

public static final OrganizationsClient create(OrganizationsSettings settings)

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.

Parameter
NameDescription
settingsOrganizationsSettings
Returns
TypeDescription
OrganizationsClient
Exceptions
TypeDescription
IOException

create(OrganizationsStub stub)

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

Parameter
NameDescription
stubOrganizationsStub
Returns
TypeDescription
OrganizationsClient

Constructors

OrganizationsClient(OrganizationsSettings settings)

protected OrganizationsClient(OrganizationsSettings settings)

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.

Parameter
NameDescription
settingsOrganizationsSettings

OrganizationsClient(OrganizationsStub stub)

protected OrganizationsClient(OrganizationsStub stub)
Parameter
NameDescription
stubOrganizationsStub

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()

getIamPolicy(ResourceName resource)

public final Policy getIamPolicy(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:


 try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   ResourceName resource = FolderName.of("[FOLDER]");
   Policy response = organizationsClient.getIamPolicy(resource);
 }
 
Parameter
NameDescription
resourcecom.google.api.resourcenames.ResourceName

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns
TypeDescription
com.google.iam.v1.Policy

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

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:


 try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(FolderName.of("[FOLDER]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = organizationsClient.getIamPolicy(request);
 }
 
Parameter
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest

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

Returns
TypeDescription
com.google.iam.v1.Policy

getIamPolicy(String resource)

public final Policy getIamPolicy(String 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:


 try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   String resource = FolderName.of("[FOLDER]").toString();
   Policy response = organizationsClient.getIamPolicy(resource);
 }
 
Parameter
NameDescription
resourceString

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns
TypeDescription
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

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:


 try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(FolderName.of("[FOLDER]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = organizationsClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getOrganization(GetOrganizationRequest request)

public final Organization getOrganization(GetOrganizationRequest request)

Fetches an organization resource identified by the specified resource name.

Sample code:


 try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   GetOrganizationRequest request =
       GetOrganizationRequest.newBuilder()
           .setName(OrganizationName.of("[ORGANIZATION]").toString())
           .build();
   Organization response = organizationsClient.getOrganization(request);
 }
 
Parameter
NameDescription
requestGetOrganizationRequest

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

Returns
TypeDescription
Organization

getOrganization(OrganizationName name)

public final Organization getOrganization(OrganizationName name)

Fetches an organization resource identified by the specified resource name.

Sample code:


 try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   OrganizationName name = OrganizationName.of("[ORGANIZATION]");
   Organization response = organizationsClient.getOrganization(name);
 }
 
Parameter
NameDescription
nameOrganizationName

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

Returns
TypeDescription
Organization

getOrganization(String name)

public final Organization getOrganization(String name)

Fetches an organization resource identified by the specified resource name.

Sample code:


 try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   String name = OrganizationName.of("[ORGANIZATION]").toString();
   Organization response = organizationsClient.getOrganization(name);
 }
 
Parameter
NameDescription
nameString

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

Returns
TypeDescription
Organization

getOrganizationCallable()

public final UnaryCallable<GetOrganizationRequest,Organization> getOrganizationCallable()

Fetches an organization resource identified by the specified resource name.

Sample code:


 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();
 }
 
Returns
TypeDescription
UnaryCallable<GetOrganizationRequest,Organization>

getSettings()

public final OrganizationsSettings getSettings()
Returns
TypeDescription
OrganizationsSettings

getStub()

public OrganizationsStub getStub()
Returns
TypeDescription
OrganizationsStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

searchOrganizations(SearchOrganizationsRequest request)

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:


 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);
   }
 }
 
Parameter
NameDescription
requestSearchOrganizationsRequest

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

Returns
TypeDescription
OrganizationsClient.SearchOrganizationsPagedResponse

searchOrganizations(String query)

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:


 try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   String query = "query107944136";
   for (Organization element : organizationsClient.searchOrganizations(query).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
queryString

Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive.

`<code> | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | </code>

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

    Returns
    TypeDescription
    OrganizationsClient.SearchOrganizationsPagedResponse

    searchOrganizationsCallable()

    public final UnaryCallable<SearchOrganizationsRequest,SearchOrganizationsResponse> searchOrganizationsCallable()

    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:

    
     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.getResponsesList()) {
           // doThingsWith(element);
         }
         String nextPageToken = response.getNextPageToken();
         if (!Strings.isNullOrEmpty(nextPageToken)) {
           request = request.toBuilder().setPageToken(nextPageToken).build();
         } else {
           break;
         }
       }
     }
     
    Returns
    TypeDescription
    UnaryCallable<SearchOrganizationsRequest,SearchOrganizationsResponse>

    searchOrganizationsPagedCallable()

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

    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:

    
     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);
       }
     }
     
    Returns
    TypeDescription
    UnaryCallable<SearchOrganizationsRequest,SearchOrganizationsPagedResponse>

    setIamPolicy(ResourceName resource)

    public final Policy setIamPolicy(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:

    
     try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
       ResourceName resource = FolderName.of("[FOLDER]");
       Policy response = organizationsClient.setIamPolicy(resource);
     }
     
    Parameter
    NameDescription
    resourcecom.google.api.resourcenames.ResourceName

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

    Returns
    TypeDescription
    com.google.iam.v1.Policy

    setIamPolicy(SetIamPolicyRequest request)

    public final Policy setIamPolicy(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:

    
     try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
       SetIamPolicyRequest request =
           SetIamPolicyRequest.newBuilder()
               .setResource(FolderName.of("[FOLDER]").toString())
               .setPolicy(Policy.newBuilder().build())
               .build();
       Policy response = organizationsClient.setIamPolicy(request);
     }
     
    Parameter
    NameDescription
    requestcom.google.iam.v1.SetIamPolicyRequest

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

    Returns
    TypeDescription
    com.google.iam.v1.Policy

    setIamPolicy(String resource)

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

    
     try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
       String resource = FolderName.of("[FOLDER]").toString();
       Policy response = organizationsClient.setIamPolicy(resource);
     }
     
    Parameter
    NameDescription
    resourceString

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

    Returns
    TypeDescription
    com.google.iam.v1.Policy

    setIamPolicyCallable()

    public final UnaryCallable<SetIamPolicyRequest,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:

    
     try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
       SetIamPolicyRequest request =
           SetIamPolicyRequest.newBuilder()
               .setResource(FolderName.of("[FOLDER]").toString())
               .setPolicy(Policy.newBuilder().build())
               .build();
       ApiFuture<Policy> future = organizationsClient.setIamPolicyCallable().futureCall(request);
       // Do something.
       Policy response = future.get();
     }
     
    Returns
    TypeDescription
    UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

    shutdown()

    public void shutdown()

    shutdownNow()

    public void shutdownNow()

    testIamPermissions(ResourceName resource, List<String> permissions)

    public final TestIamPermissionsResponse testIamPermissions(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:

    
     try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
       ResourceName resource = FolderName.of("[FOLDER]");
       List<String> permissions = new ArrayList<>();
       TestIamPermissionsResponse response =
           organizationsClient.testIamPermissions(resource, permissions);
     }
     
    Parameters
    NameDescription
    resourcecom.google.api.resourcenames.ResourceName

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

    permissionsList<String>

    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.

    Returns
    TypeDescription
    com.google.iam.v1.TestIamPermissionsResponse

    testIamPermissions(TestIamPermissionsRequest request)

    public final TestIamPermissionsResponse testIamPermissions(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:

    
     try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
       TestIamPermissionsRequest request =
           TestIamPermissionsRequest.newBuilder()
               .setResource(FolderName.of("[FOLDER]").toString())
               .addAllPermissions(new ArrayList<String>())
               .build();
       TestIamPermissionsResponse response = organizationsClient.testIamPermissions(request);
     }
     
    Parameter
    NameDescription
    requestcom.google.iam.v1.TestIamPermissionsRequest

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

    Returns
    TypeDescription
    com.google.iam.v1.TestIamPermissionsResponse

    testIamPermissions(String resource, List<String> permissions)

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

    
     try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
       String resource = FolderName.of("[FOLDER]").toString();
       List<String> permissions = new ArrayList<>();
       TestIamPermissionsResponse response =
           organizationsClient.testIamPermissions(resource, permissions);
     }
     
    Parameters
    NameDescription
    resourceString

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

    permissionsList<String>

    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.

    Returns
    TypeDescription
    com.google.iam.v1.TestIamPermissionsResponse

    testIamPermissionsCallable()

    public final UnaryCallable<TestIamPermissionsRequest,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:

    
     try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
       TestIamPermissionsRequest request =
           TestIamPermissionsRequest.newBuilder()
               .setResource(FolderName.of("[FOLDER]").toString())
               .addAllPermissions(new ArrayList<String>())
               .build();
       ApiFuture<TestIamPermissionsResponse> future =
           organizationsClient.testIamPermissionsCallable().futureCall(request);
       // Do something.
       TestIamPermissionsResponse response = future.get();
     }
     
    Returns
    TypeDescription
    UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>