@Generated(value="by gapic-generator-java") public class OrganizationsClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
| Method | Description | Method Variants |
|---|---|---|
GetOrganization |
Fetches an organization resource identified by the specified resource name. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SearchOrganizations |
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` |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy |
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. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
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. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
TestIamPermissions |
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. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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.newHttpJsonBuilder().build();
OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
| Modifier and Type | Class and Description |
|---|---|
static class |
OrganizationsClient.SearchOrganizationsFixedSizeCollection |
static class |
OrganizationsClient.SearchOrganizationsPage |
static class |
OrganizationsClient.SearchOrganizationsPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
OrganizationsClient(OrganizationsSettings settings)
Constructs an instance of OrganizationsClient, using the given settings.
|
protected |
OrganizationsClient(OrganizationsStub stub) |
| 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.
|
com.google.api.gax.rpc.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.
|
com.google.api.gax.rpc.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.
|
com.google.api.gax.rpc.UnaryCallable<SearchOrganizationsRequest,SearchOrganizationsResponse> |
searchOrganizationsCallable()
Searches organization resources that are visible to the user and satisfy the specified filter.
|
com.google.api.gax.rpc.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.
|
com.google.api.gax.rpc.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.
|
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
testIamPermissionsCallable()
Returns the permissions that a caller has on the specified organization.
|
protected OrganizationsClient(OrganizationsSettings settings) throws IOException
IOExceptionprotected OrganizationsClient(OrganizationsStub stub)
public static final OrganizationsClient create() throws IOException
IOExceptionpublic static final OrganizationsClient create(OrganizationsSettings settings) throws IOException
IOExceptionpublic static final OrganizationsClient create(OrganizationsStub stub)
public final OrganizationsSettings getSettings()
public OrganizationsStub getStub()
public final Organization getOrganization(OrganizationName 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);
}
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".com.google.api.gax.rpc.ApiException - if the remote call failspublic final Organization getOrganization(String 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);
}
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".com.google.api.gax.rpc.ApiException - if the remote call failspublic final Organization getOrganization(GetOrganizationRequest request)
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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetOrganizationRequest,Organization> getOrganizationCallable()
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();
}
public final OrganizationsClient.SearchOrganizationsPagedResponse searchOrganizations(String query)
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);
}
}
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:
com.google.api.gax.rpc.ApiException - if the remote call failspublic final OrganizationsClient.SearchOrganizationsPagedResponse searchOrganizations(SearchOrganizationsRequest request)
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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.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);
}
}
public final com.google.api.gax.rpc.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;
}
}
}
public final com.google.iam.v1.Policy getIamPolicy(com.google.api.resourcenames.ResourceName 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()) {
ResourceName resource = OrganizationName.of("[ORGANIZATION]");
Policy response = organizationsClient.getIamPolicy(resource);
}
resource - REQUIRED: The resource for which the policy is being requested. See the
operation documentation for the appropriate value for this field.com.google.api.gax.rpc.ApiException - if the remote call failspublic 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);
}
resource - REQUIRED: The resource for which the policy is being requested. See the
operation documentation for the appropriate value for this field.com.google.api.gax.rpc.ApiException - if the remote call failspublic 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.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();
}
public final com.google.iam.v1.Policy setIamPolicy(com.google.api.resourcenames.ResourceName resource)
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);
}
resource - REQUIRED: The resource for which the policy is being specified. See the
operation documentation for the appropriate value for this field.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.Policy setIamPolicy(String resource)
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);
}
resource - REQUIRED: The resource for which the policy is being specified. See the
operation documentation for the appropriate value for this field.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()
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();
}
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.api.resourcenames.ResourceName resource,
List<String> permissions)
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);
}
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).com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(String resource, List<String> permissions)
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);
}
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).com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()
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();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2025 Google LLC. All rights reserved.