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: * *
{@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);
* }
* }
*
* 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: * *
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: * *
{@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
* OrganizationsSettings organizationsSettings =
* OrganizationsSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);
* }
*
* To customize the endpoint: * *
{@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
* 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: * *
{@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
* OrganizationsSettings organizationsSettings =
* OrganizationsSettings.newHttpJsonBuilder().build();
* OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets. */ @Generated("by gapic-generator-java") public class OrganizationsClient implements BackgroundResource { private final OrganizationsSettings settings; private final OrganizationsStub stub; /** Constructs an instance of OrganizationsClient with default settings. */ public static final OrganizationsClient create() throws IOException { return create(OrganizationsSettings.newBuilder().build()); } /** * 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. */ public static final OrganizationsClient create(OrganizationsSettings settings) throws IOException { return new OrganizationsClient(settings); } /** * Constructs an instance of OrganizationsClient, using the given stub for making calls. This is * for advanced usage - prefer using create(OrganizationsSettings). */ public static final OrganizationsClient create(OrganizationsStub stub) { return new OrganizationsClient(stub); } /** * 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. */ protected OrganizationsClient(OrganizationsSettings settings) throws IOException { this.settings = settings; this.stub = ((OrganizationsStubSettings) settings.getStubSettings()).createStub(); } protected OrganizationsClient(OrganizationsStub stub) { this.settings = null; this.stub = stub; } public final OrganizationsSettings getSettings() { return settings; } public OrganizationsStub getStub() { return stub; } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Fetches an organization resource identified by the specified resource name. * *
Sample code: * *
{@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);
* }
* }
*
* @param name Required. The resource name of the Organization to fetch. This is the
* organization's relative path in the API, formatted as "organizations/[organizationId]". For
* example, "organizations/1234".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Organization getOrganization(OrganizationName name) {
GetOrganizationRequest request =
GetOrganizationRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getOrganization(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Fetches an organization resource identified by the specified resource name.
*
* Sample code: * *
{@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);
* }
* }
*
* @param name Required. The resource name of the Organization to fetch. This is the
* organization's relative path in the API, formatted as "organizations/[organizationId]". For
* example, "organizations/1234".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Organization getOrganization(String name) {
GetOrganizationRequest request = GetOrganizationRequest.newBuilder().setName(name).build();
return getOrganization(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Fetches an organization resource identified by the specified resource name.
*
* Sample code: * *
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Organization getOrganization(GetOrganizationRequest request) {
return getOrganizationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Fetches an organization resource identified by the specified resource name.
*
* Sample code: * *
{@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 future =
* organizationsClient.getOrganizationCallable().futureCall(request);
* // Do something.
* Organization response = future.get();
* }
* }
*/
public final UnaryCallableSearch will only return organizations on which the user has the permission * `resourcemanager.organizations.get` * *
Sample code: * *
{@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);
* }
* }
* }
*
* @param 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: *
Search will only return organizations on which the user has the permission * `resourcemanager.organizations.get` * *
Sample code: * *
{@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);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchOrganizationsPagedResponse searchOrganizations(
SearchOrganizationsRequest request) {
return searchOrganizationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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: * *
{@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 future =
* organizationsClient.searchOrganizationsPagedCallable().futureCall(request);
* // Do something.
* for (Organization element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallableSearch will only return organizations on which the user has the permission * `resourcemanager.organizations.get` * *
Sample code: * *
{@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 UnaryCallableAuthorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on * the specified organization. * *
Sample code: * *
{@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);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(ResourceName resource) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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: * *
{@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);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(String resource) {
GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder().setResource(resource).build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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: * *
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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: * *
{@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 future = organizationsClient.getIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallableAuthorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on * the specified organization. * *
Sample code: * *
{@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);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(ResourceName resource) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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: * *
{@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);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(String resource) {
SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder().setResource(resource).build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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: * *
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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: * *
{@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 future = organizationsClient.setIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallableThere are no permissions required for making this API call. * *
Sample code: * *
{@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 permissions = new ArrayList<>();
* TestIamPermissionsResponse response =
* organizationsClient.testIamPermissions(resource, permissions);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(
ResourceName resource, ListThere are no permissions required for making this API call. * *
Sample code: * *
{@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 permissions = new ArrayList<>();
* TestIamPermissionsResponse response =
* organizationsClient.testIamPermissions(resource, permissions);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(
String resource, ListThere are no permissions required for making this API call. * *
Sample code: * *
{@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())
* .build();
* TestIamPermissionsResponse response = organizationsClient.testIamPermissions(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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: * *
{@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())
* .build();
* ApiFuture future =
* organizationsClient.testIamPermissionsCallable().futureCall(request);
* // Do something.
* TestIamPermissionsResponse response = future.get();
* }
* }
*/
public final UnaryCallable