- 1.50.0 (latest)
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.6
- 1.4.0
- 1.3.2
- 1.2.12
GitHub Repository | Product Reference |
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.newHttpJsonBuilder().build();
OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final OrganizationsClient create()
Constructs an instance of OrganizationsClient with default settings.
Returns | |
---|---|
Type | Description |
OrganizationsClient |
Exceptions | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
settings | OrganizationsSettings |
Returns | |
---|---|
Type | Description |
OrganizationsClient |
Exceptions | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
stub | OrganizationsStub |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
settings | OrganizationsSettings |
OrganizationsClient(OrganizationsStub stub)
protected OrganizationsClient(OrganizationsStub stub)
Parameter | |
---|---|
Name | Description |
stub | OrganizationsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
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:
// 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);
}
Parameter | |
---|---|
Name | Description |
resource | com.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 | |
---|---|
Type | Description |
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:
// 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);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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:
// 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);
}
Parameter | |
---|---|
Name | Description |
resource | String REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
Returns | |
---|---|
Type | Description |
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:
// 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();
}
Returns | |
---|---|
Type | Description |
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:
// 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);
}
Parameter | |
---|---|
Name | Description |
request | GetOrganizationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Organization |
getOrganization(OrganizationName name)
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);
}
Parameter | |
---|---|
Name | Description |
name | OrganizationName 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 | |
---|---|
Type | Description |
Organization |
getOrganization(String name)
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);
}
Parameter | |
---|---|
Name | Description |
name | String 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 | |
---|---|
Type | Description |
Organization |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetOrganizationRequest,Organization> |
getSettings()
public final OrganizationsSettings getSettings()
Returns | |
---|---|
Type | Description |
OrganizationsSettings |
getStub()
public OrganizationsStub getStub()
Returns | |
---|---|
Type | Description |
OrganizationsStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
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:
// 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);
}
}
Parameter | |
---|---|
Name | Description |
request | SearchOrganizationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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:
// 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);
}
}
Parameter | |
---|---|
Name | Description |
query | String Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive.
returns Organization resources with
owner.directory_customer_id equal to 123456789.
domain:google.com returns Organization resources corresponding to the domain
google.com`.
|
Returns | |
---|---|
Type | Description |
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:
// 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;
}
}
}
Returns | |
---|---|
Type | Description |
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:
// 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);
}
}
Returns | |
---|---|
Type | Description |
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:
// 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);
}
Parameter | |
---|---|
Name | Description |
resource | com.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 | |
---|---|
Type | Description |
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:
// 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);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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:
// 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);
}
Parameter | |
---|---|
Name | Description |
resource | String REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
Returns | |
---|---|
Type | Description |
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:
// 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();
}
Returns | |
---|---|
Type | Description |
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:
// 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 | |
---|---|
Name | Description |
resource | com.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. |
permissions | List<String> The set of permissions to check for the |
Returns | |
---|---|
Type | Description |
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:
// 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);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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:
// 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 | |
---|---|
Name | Description |
resource | String REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | List<String> The set of permissions to check for the |
Returns | |
---|---|
Type | Description |
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:
// 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |