Class AuditManagerClient (0.3.0)

Service Description: Service describing handlers for 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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   String scope = "scope109264468";
   List<EnrollResourceRequest.EligibleDestination> destinations = new ArrayList<>();
   Enrollment response = auditManagerClient.enrollResource(scope, destinations);
 }

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

Methods
Method	Description	Method Variants
EnrollResource	Enrolls the customer resource(folder/project/organization) to the audit manager service by creating the audit managers Service Agent in customers workload and granting required permissions to the Service Agent. Please note that if enrollment request is made on the already enrolled workload then enrollment is executed overriding the existing set of destinations.	Request object method variants only take one parameter, a request object, which must be constructed before the call. enrollResource(EnrollResourceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. enrollResource(String scope, List<EnrollResourceRequest.EligibleDestination> destinations) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. enrollResourceCallable()
GenerateAuditScopeReport	Generates a demo report highlighting different responsibilities (Google/Customer/ shared) required to be fulfilled for the customer's workload to be compliant with the given standard.	Request object method variants only take one parameter, a request object, which must be constructed before the call. generateAuditScopeReport(GenerateAuditScopeReportRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. generateAuditScopeReport(String scope, String complianceStandard, GenerateAuditScopeReportRequest.AuditScopeReportFormat reportFormat) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. generateAuditScopeReportCallable()
GenerateAuditReport	Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.	Request object method variants only take one parameter, a request object, which must be constructed before the call. generateAuditReportAsync(GenerateAuditReportRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. generateAuditReportAsync(String scope, String gcsUri, String complianceStandard, GenerateAuditReportRequest.AuditReportFormat reportFormat) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. generateAuditReportOperationCallable() generateAuditReportCallable()
ListAuditReports	Lists audit reports in the selected parent scope	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAuditReports(ListAuditReportsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAuditReports(EnrollmentStatusScopeName parent) listAuditReports(LocationName parent) listAuditReports(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listAuditReportsPagedCallable() listAuditReportsCallable()
GetAuditReport	Get the overall audit report	Request object method variants only take one parameter, a request object, which must be constructed before the call. getAuditReport(GetAuditReportRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAuditReport(AuditReportName name) getAuditReport(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getAuditReportCallable()
GetResourceEnrollmentStatus	Get a resource along with its enrollment status.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getResourceEnrollmentStatus(GetResourceEnrollmentStatusRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getResourceEnrollmentStatus(ResourceEnrollmentStatusName name) getResourceEnrollmentStatus(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getResourceEnrollmentStatusCallable()
ListResourceEnrollmentStatuses	Fetches all resources under the parent along with their enrollment.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listResourceEnrollmentStatuses(ListResourceEnrollmentStatusesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listResourceEnrollmentStatuses(EnrollmentStatusScopeName parent) listResourceEnrollmentStatuses(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listResourceEnrollmentStatusesPagedCallable() listResourceEnrollmentStatusesCallable()
ListControls	Gets controls needed to be implemented to be compliant to a standard.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listControls(ListControlsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listControls(StandardName parent) listControls(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listControlsPagedCallable() listControlsCallable()
ListLocations	Lists information about the supported locations for this service.This method can be called in two ways: * List all public locations: Use the path `GET /v1/locations`.* List project-visible locations: Use the path`GET /v1/projects/{project_id}/locations`. This may include publiclocations as well as private or other locations specifically visibleto the project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

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 AuditManagerSettings 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
 AuditManagerSettings auditManagerSettings =
     AuditManagerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AuditManagerClient auditManagerClient = AuditManagerClient.create(auditManagerSettings);

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
 AuditManagerSettings auditManagerSettings =
     AuditManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
 AuditManagerClient auditManagerClient = AuditManagerClient.create(auditManagerSettings);

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
 AuditManagerSettings auditManagerSettings = AuditManagerSettings.newHttpJsonBuilder().build();
 AuditManagerClient auditManagerClient = AuditManagerClient.create(auditManagerSettings);

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

Inheritance

java.lang.Object > AuditManagerClient

Static Methods

create()

public static final AuditManagerClient create()

Constructs an instance of AuditManagerClient with default settings.

Returns
Type	Description
`AuditManagerClient`

Exceptions
Type	Description
`IOException`

create(AuditManagerSettings settings)

public static final AuditManagerClient create(AuditManagerSettings settings)

Constructs an instance of AuditManagerClient, 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`	`AuditManagerSettings`

Returns
Type	Description
`AuditManagerClient`

Exceptions
Type	Description
`IOException`

create(AuditManagerStub stub)

public static final AuditManagerClient create(AuditManagerStub stub)

Constructs an instance of AuditManagerClient, using the given stub for making calls. This is for advanced usage - prefer using create(AuditManagerSettings).

Parameter
Name	Description
`stub`	`AuditManagerStub`

Returns
Type	Description
`AuditManagerClient`

Constructors

AuditManagerClient(AuditManagerSettings settings)

protected AuditManagerClient(AuditManagerSettings settings)

Constructs an instance of AuditManagerClient, 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`	`AuditManagerSettings`

AuditManagerClient(AuditManagerStub stub)

protected AuditManagerClient(AuditManagerStub stub)

Parameter
Name	Description
`stub`	`AuditManagerStub`

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

enrollResource(EnrollResourceRequest request)

public final Enrollment enrollResource(EnrollResourceRequest request)

Enrolls the customer resource(folder/project/organization) to the audit manager service by creating the audit managers Service Agent in customers workload and granting required permissions to the Service Agent. Please note that if enrollment request is made on the already enrolled workload then enrollment is executed overriding the existing set of destinations.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   EnrollResourceRequest request =
       EnrollResourceRequest.newBuilder()
           .setScope("scope109264468")
           .addAllDestinations(new ArrayList<EnrollResourceRequest.EligibleDestination>())
           .build();
   Enrollment response = auditManagerClient.enrollResource(request);
 }

Parameter
Name	Description
`request`	`EnrollResourceRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Enrollment`

enrollResource(String scope, List<EnrollResourceRequest.EligibleDestination> destinations)

public final Enrollment enrollResource(String scope, List<EnrollResourceRequest.EligibleDestination> destinations)

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   String scope = "scope109264468";
   List<EnrollResourceRequest.EligibleDestination> destinations = new ArrayList<>();
   Enrollment response = auditManagerClient.enrollResource(scope, destinations);
 }

Parameters
Name	Description
`scope`	`String` Required. The resource to be enrolled to the audit manager. Scope format should be resource_type/resource_identifier Eg: projects/{project}/locations/{location}, folders/{folder}/locations/{location} organizations/{organization}/locations/{location}
`destinations`	`List<EligibleDestination>` Required. List of destination among which customer can choose to upload their reports during the audit process. While enrolling at a organization/folder level, customer can choose Cloud storage bucket in any project. If the audit is triggered at project level using the service agent at organization/folder level, all the destination options associated with respective organization/folder level service agent will be available to auditing projects.

Returns
Type	Description
`Enrollment`

enrollResourceCallable()

public final UnaryCallable<EnrollResourceRequest,Enrollment> enrollResourceCallable()

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   EnrollResourceRequest request =
       EnrollResourceRequest.newBuilder()
           .setScope("scope109264468")
           .addAllDestinations(new ArrayList<EnrollResourceRequest.EligibleDestination>())
           .build();
   ApiFuture<Enrollment> future =
       auditManagerClient.enrollResourceCallable().futureCall(request);
   // Do something.
   Enrollment response = future.get();
 }

Returns
Type	Description
`UnaryCallable<EnrollResourceRequest,Enrollment>`

generateAuditReportAsync(GenerateAuditReportRequest request)

public final OperationFuture<AuditReport,OperationMetadata> generateAuditReportAsync(GenerateAuditReportRequest request)

Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GenerateAuditReportRequest request =
       GenerateAuditReportRequest.newBuilder()
           .setScope("scope109264468")
           .setComplianceStandard("complianceStandard-1534269448")
           .setComplianceFramework("complianceFramework-1808314333")
           .build();
   AuditReport response = auditManagerClient.generateAuditReportAsync(request).get();
 }

Parameter
Name	Description
`request`	`GenerateAuditReportRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<AuditReport,OperationMetadata>`

generateAuditReportAsync(String scope, String gcsUri, String complianceStandard, GenerateAuditReportRequest.AuditReportFormat reportFormat)

public final OperationFuture<AuditReport,OperationMetadata> generateAuditReportAsync(String scope, String gcsUri, String complianceStandard, GenerateAuditReportRequest.AuditReportFormat reportFormat)

Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   String scope = "scope109264468";
   String gcsUri = "gcsUri-1251224875";
   String complianceStandard = "complianceStandard-1534269448";
   GenerateAuditReportRequest.AuditReportFormat reportFormat =
       GenerateAuditReportRequest.AuditReportFormat.forNumber(0);
   AuditReport response =
       auditManagerClient
           .generateAuditReportAsync(scope, gcsUri, complianceStandard, reportFormat)
           .get();
 }

Parameters
Name	Description
`scope`	`String` Required. Scope for which the AuditScopeReport is required. Must be of format resource_type/resource_identifier Eg: projects/{project}/locations/{location}, folders/{folder}/locations/{location}
`gcsUri`	`String` Destination Cloud storage bucket where report and evidence must be uploaded. The Cloud storage bucket provided here must be selected among the buckets entered during the enrollment process.
`complianceStandard`	`String` Required. Compliance Standard against which the Scope Report must be generated. Eg: FEDRAMP_MODERATE
`reportFormat`	`GenerateAuditReportRequest.AuditReportFormat` Required. The format in which the audit report should be created.

Returns
Type	Description
`OperationFuture<AuditReport,OperationMetadata>`

generateAuditReportCallable()

public final UnaryCallable<GenerateAuditReportRequest,Operation> generateAuditReportCallable()

Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GenerateAuditReportRequest request =
       GenerateAuditReportRequest.newBuilder()
           .setScope("scope109264468")
           .setComplianceStandard("complianceStandard-1534269448")
           .setComplianceFramework("complianceFramework-1808314333")
           .build();
   ApiFuture<Operation> future =
       auditManagerClient.generateAuditReportCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GenerateAuditReportRequest,Operation>`

generateAuditReportOperationCallable()

public final OperationCallable<GenerateAuditReportRequest,AuditReport,OperationMetadata> generateAuditReportOperationCallable()

Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GenerateAuditReportRequest request =
       GenerateAuditReportRequest.newBuilder()
           .setScope("scope109264468")
           .setComplianceStandard("complianceStandard-1534269448")
           .setComplianceFramework("complianceFramework-1808314333")
           .build();
   OperationFuture<AuditReport, OperationMetadata> future =
       auditManagerClient.generateAuditReportOperationCallable().futureCall(request);
   // Do something.
   AuditReport response = future.get();
 }

Returns
Type	Description
`OperationCallable<GenerateAuditReportRequest,AuditReport,OperationMetadata>`

generateAuditScopeReport(GenerateAuditScopeReportRequest request)

public final AuditScopeReport generateAuditScopeReport(GenerateAuditScopeReportRequest request)

Generates a demo report highlighting different responsibilities (Google/Customer/ shared) required to be fulfilled for the customer's workload to be compliant with the given standard.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GenerateAuditScopeReportRequest request =
       GenerateAuditScopeReportRequest.newBuilder()
           .setScope("scope109264468")
           .setComplianceStandard("complianceStandard-1534269448")
           .setComplianceFramework("complianceFramework-1808314333")
           .build();
   AuditScopeReport response = auditManagerClient.generateAuditScopeReport(request);
 }

Parameter
Name	Description
`request`	`GenerateAuditScopeReportRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AuditScopeReport`

generateAuditScopeReport(String scope, String complianceStandard, GenerateAuditScopeReportRequest.AuditScopeReportFormat reportFormat)

public final AuditScopeReport generateAuditScopeReport(String scope, String complianceStandard, GenerateAuditScopeReportRequest.AuditScopeReportFormat reportFormat)

Generates a demo report highlighting different responsibilities (Google/Customer/ shared) required to be fulfilled for the customer's workload to be compliant with the given standard.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   String scope = "scope109264468";
   String complianceStandard = "complianceStandard-1534269448";
   GenerateAuditScopeReportRequest.AuditScopeReportFormat reportFormat =
       GenerateAuditScopeReportRequest.AuditScopeReportFormat.forNumber(0);
   AuditScopeReport response =
       auditManagerClient.generateAuditScopeReport(scope, complianceStandard, reportFormat);
 }

Parameters
Name	Description
`scope`	`String` Required. Scope for which the AuditScopeReport is required. Must be of format resource_type/resource_identifier Eg: projects/{project}/locations/{location}, folders/{folder}/locations/{location}
`complianceStandard`	`String` Required. Compliance Standard against which the Scope Report must be generated. Eg: FEDRAMP_MODERATE
`reportFormat`	`GenerateAuditScopeReportRequest.AuditScopeReportFormat` Required. The format in which the Scope report bytes should be returned.

Returns
Type	Description
`AuditScopeReport`

generateAuditScopeReportCallable()

public final UnaryCallable<GenerateAuditScopeReportRequest,AuditScopeReport> generateAuditScopeReportCallable()

Generates a demo report highlighting different responsibilities (Google/Customer/ shared) required to be fulfilled for the customer's workload to be compliant with the given standard.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GenerateAuditScopeReportRequest request =
       GenerateAuditScopeReportRequest.newBuilder()
           .setScope("scope109264468")
           .setComplianceStandard("complianceStandard-1534269448")
           .setComplianceFramework("complianceFramework-1808314333")
           .build();
   ApiFuture<AuditScopeReport> future =
       auditManagerClient.generateAuditScopeReportCallable().futureCall(request);
   // Do something.
   AuditScopeReport response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GenerateAuditScopeReportRequest,AuditScopeReport>`

getAuditReport(AuditReportName name)

public final AuditReport getAuditReport(AuditReportName name)

Get the overall audit report

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   AuditReportName name =
       AuditReportName.ofFolderLocationAuditReportName(
           "[FOLDER]", "[LOCATION]", "[AUDIT_REPORT]");
   AuditReport response = auditManagerClient.getAuditReport(name);
 }

Parameter
Name	Description
`name`	`AuditReportName` Required. Format projects/{project}/locations/{location}/auditReports/{audit_report}, folders/{folder}/locations/{location}/auditReports/{audit_report}

Returns
Type	Description
`AuditReport`

getAuditReport(GetAuditReportRequest request)

public final AuditReport getAuditReport(GetAuditReportRequest request)

Get the overall audit report

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GetAuditReportRequest request =
       GetAuditReportRequest.newBuilder()
           .setName(
               AuditReportName.ofFolderLocationAuditReportName(
                       "[FOLDER]", "[LOCATION]", "[AUDIT_REPORT]")
                   .toString())
           .build();
   AuditReport response = auditManagerClient.getAuditReport(request);
 }

Parameter
Name	Description
`request`	`GetAuditReportRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AuditReport`

getAuditReport(String name)

public final AuditReport getAuditReport(String name)

Get the overall audit report

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   String name =
       AuditReportName.ofProjectLocationAuditReportName(
               "[PROJECT]", "[LOCATION]", "[AUDIT_REPORT]")
           .toString();
   AuditReport response = auditManagerClient.getAuditReport(name);
 }

Parameter
Name	Description
`name`	`String` Required. Format projects/{project}/locations/{location}/auditReports/{audit_report}, folders/{folder}/locations/{location}/auditReports/{audit_report}

Returns
Type	Description
`AuditReport`

getAuditReportCallable()

public final UnaryCallable<GetAuditReportRequest,AuditReport> getAuditReportCallable()

Get the overall audit report

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GetAuditReportRequest request =
       GetAuditReportRequest.newBuilder()
           .setName(
               AuditReportName.ofFolderLocationAuditReportName(
                       "[FOLDER]", "[LOCATION]", "[AUDIT_REPORT]")
                   .toString())
           .build();
   ApiFuture<AuditReport> future =
       auditManagerClient.getAuditReportCallable().futureCall(request);
   // Do something.
   AuditReport response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetAuditReportRequest,AuditReport>`

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
`OperationsClient`

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = auditManagerClient.getLocation(request);
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.GetLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.cloud.location.Location`

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = auditManagerClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
`OperationsClient`

getResourceEnrollmentStatus(GetResourceEnrollmentStatusRequest request)

public final ResourceEnrollmentStatus getResourceEnrollmentStatus(GetResourceEnrollmentStatusRequest request)

Get a resource along with its enrollment status.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GetResourceEnrollmentStatusRequest request =
       GetResourceEnrollmentStatusRequest.newBuilder()
           .setName(
               ResourceEnrollmentStatusName.ofProjectLocationResourceEnrollmentStatusName(
                       "[PROJECT]", "[LOCATION]", "[RESOURCE_ENROLLMENT_STATUS]")
                   .toString())
           .build();
   ResourceEnrollmentStatus response = auditManagerClient.getResourceEnrollmentStatus(request);
 }

Parameter
Name	Description
`request`	`GetResourceEnrollmentStatusRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ResourceEnrollmentStatus`

getResourceEnrollmentStatus(ResourceEnrollmentStatusName name)

public final ResourceEnrollmentStatus getResourceEnrollmentStatus(ResourceEnrollmentStatusName name)

Get a resource along with its enrollment status.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ResourceEnrollmentStatusName name =
       ResourceEnrollmentStatusName.ofProjectLocationResourceEnrollmentStatusName(
           "[PROJECT]", "[LOCATION]", "[RESOURCE_ENROLLMENT_STATUS]");
   ResourceEnrollmentStatus response = auditManagerClient.getResourceEnrollmentStatus(name);
 }

Parameter
Name	Description
`name`	`ResourceEnrollmentStatusName` Required. Format folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}, projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}, organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}

Returns
Type	Description
`ResourceEnrollmentStatus`

getResourceEnrollmentStatus(String name)

public final ResourceEnrollmentStatus getResourceEnrollmentStatus(String name)

Get a resource along with its enrollment status.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   String name =
       ResourceEnrollmentStatusName.ofFolderLocationResourceEnrollmentStatusName(
               "[FOLDER]", "[LOCATION]", "[RESOURCE_ENROLLMENT_STATUS]")
           .toString();
   ResourceEnrollmentStatus response = auditManagerClient.getResourceEnrollmentStatus(name);
 }

Parameter
Name	Description
`name`	`String` Required. Format folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}, projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}, organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}

Returns
Type	Description
`ResourceEnrollmentStatus`

getResourceEnrollmentStatusCallable()

public final UnaryCallable<GetResourceEnrollmentStatusRequest,ResourceEnrollmentStatus> getResourceEnrollmentStatusCallable()

Get a resource along with its enrollment status.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   GetResourceEnrollmentStatusRequest request =
       GetResourceEnrollmentStatusRequest.newBuilder()
           .setName(
               ResourceEnrollmentStatusName.ofProjectLocationResourceEnrollmentStatusName(
                       "[PROJECT]", "[LOCATION]", "[RESOURCE_ENROLLMENT_STATUS]")
                   .toString())
           .build();
   ApiFuture<ResourceEnrollmentStatus> future =
       auditManagerClient.getResourceEnrollmentStatusCallable().futureCall(request);
   // Do something.
   ResourceEnrollmentStatus response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetResourceEnrollmentStatusRequest,ResourceEnrollmentStatus>`

getSettings()

public final AuditManagerSettings getSettings()

Returns
Type	Description
`AuditManagerSettings`

getStub()

public AuditManagerStub getStub()

Returns
Type	Description
`AuditManagerStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listAuditReports(EnrollmentStatusScopeName parent)

public final AuditManagerClient.ListAuditReportsPagedResponse listAuditReports(EnrollmentStatusScopeName parent)

Lists audit reports in the selected parent scope

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   EnrollmentStatusScopeName parent =
       EnrollmentStatusScopeName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]");
   for (AuditReport element : auditManagerClient.listAuditReports(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`EnrollmentStatusScopeName` Required. The parent scope for which to list the reports.

Returns
Type	Description
`AuditManagerClient.ListAuditReportsPagedResponse`

listAuditReports(ListAuditReportsRequest request)

public final AuditManagerClient.ListAuditReportsPagedResponse listAuditReports(ListAuditReportsRequest request)

Lists audit reports in the selected parent scope

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListAuditReportsRequest request =
       ListAuditReportsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AuditReport element : auditManagerClient.listAuditReports(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListAuditReportsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AuditManagerClient.ListAuditReportsPagedResponse`

listAuditReports(LocationName parent)

public final AuditManagerClient.ListAuditReportsPagedResponse listAuditReports(LocationName parent)

Lists audit reports in the selected parent scope

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (AuditReport element : auditManagerClient.listAuditReports(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`LocationName` Required. The parent scope for which to list the reports.

Returns
Type	Description
`AuditManagerClient.ListAuditReportsPagedResponse`

listAuditReports(String parent)

public final AuditManagerClient.ListAuditReportsPagedResponse listAuditReports(String parent)

Lists audit reports in the selected parent scope

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (AuditReport element : auditManagerClient.listAuditReports(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent scope for which to list the reports.

Returns
Type	Description
`AuditManagerClient.ListAuditReportsPagedResponse`

listAuditReportsCallable()

public final UnaryCallable<ListAuditReportsRequest,ListAuditReportsResponse> listAuditReportsCallable()

Lists audit reports in the selected parent scope

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListAuditReportsRequest request =
       ListAuditReportsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAuditReportsResponse response =
         auditManagerClient.listAuditReportsCallable().call(request);
     for (AuditReport element : response.getAuditReportsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListAuditReportsRequest,ListAuditReportsResponse>`

listAuditReportsPagedCallable()

public final UnaryCallable<ListAuditReportsRequest,AuditManagerClient.ListAuditReportsPagedResponse> listAuditReportsPagedCallable()

Lists audit reports in the selected parent scope

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListAuditReportsRequest request =
       ListAuditReportsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AuditReport> future =
       auditManagerClient.listAuditReportsPagedCallable().futureCall(request);
   // Do something.
   for (AuditReport element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListAuditReportsRequest,ListAuditReportsPagedResponse>`

listControls(ListControlsRequest request)

public final AuditManagerClient.ListControlsPagedResponse listControls(ListControlsRequest request)

Gets controls needed to be implemented to be compliant to a standard.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListControlsRequest request =
       ListControlsRequest.newBuilder()
           .setParent(
               StandardName.ofOrganizationLocationStandardName(
                       "[ORGANIZATION]", "[LOCATION]", "[STANDARD]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Control element : auditManagerClient.listControls(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListControlsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AuditManagerClient.ListControlsPagedResponse`

listControls(StandardName parent)

public final AuditManagerClient.ListControlsPagedResponse listControls(StandardName parent)

Gets controls needed to be implemented to be compliant to a standard.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   StandardName parent =
       StandardName.ofOrganizationLocationStandardName(
           "[ORGANIZATION]", "[LOCATION]", "[STANDARD]");
   for (Control element : auditManagerClient.listControls(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`StandardName` Required. Format projects/{project}/locations/{location}/standards/{standard}, folders/{folder}/locations/{location}/standards/{standard}

Returns
Type	Description
`AuditManagerClient.ListControlsPagedResponse`

listControls(String parent)

public final AuditManagerClient.ListControlsPagedResponse listControls(String parent)

Gets controls needed to be implemented to be compliant to a standard.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   String parent =
       StandardName.ofProjectLocationStandardName("[PROJECT]", "[LOCATION]", "[STANDARD]")
           .toString();
   for (Control element : auditManagerClient.listControls(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. Format projects/{project}/locations/{location}/standards/{standard}, folders/{folder}/locations/{location}/standards/{standard}

Returns
Type	Description
`AuditManagerClient.ListControlsPagedResponse`

listControlsCallable()

public final UnaryCallable<ListControlsRequest,ListControlsResponse> listControlsCallable()

Gets controls needed to be implemented to be compliant to a standard.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListControlsRequest request =
       ListControlsRequest.newBuilder()
           .setParent(
               StandardName.ofOrganizationLocationStandardName(
                       "[ORGANIZATION]", "[LOCATION]", "[STANDARD]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListControlsResponse response = auditManagerClient.listControlsCallable().call(request);
     for (Control element : response.getControlsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListControlsRequest,ListControlsResponse>`

listControlsPagedCallable()

public final UnaryCallable<ListControlsRequest,AuditManagerClient.ListControlsPagedResponse> listControlsPagedCallable()

Gets controls needed to be implemented to be compliant to a standard.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListControlsRequest request =
       ListControlsRequest.newBuilder()
           .setParent(
               StandardName.ofOrganizationLocationStandardName(
                       "[ORGANIZATION]", "[LOCATION]", "[STANDARD]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Control> future =
       auditManagerClient.listControlsPagedCallable().futureCall(request);
   // Do something.
   for (Control element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListControlsRequest,ListControlsPagedResponse>`

listLocations(ListLocationsRequest request)

public final AuditManagerClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.This method can be called in two ways:

* **List all public locations:** Use the path GET /v1/locations.* **List project-visible locations:** Use the pathGET /v1/projects/{project_id}/locations. This may include publiclocations as well as private or other locations specifically visibleto the project.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : auditManagerClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AuditManagerClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.This method can be called in two ways:

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = auditManagerClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,AuditManagerClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.This method can be called in two ways:

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       auditManagerClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

listResourceEnrollmentStatuses(EnrollmentStatusScopeName parent)

public final AuditManagerClient.ListResourceEnrollmentStatusesPagedResponse listResourceEnrollmentStatuses(EnrollmentStatusScopeName parent)

Fetches all resources under the parent along with their enrollment.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   EnrollmentStatusScopeName parent =
       EnrollmentStatusScopeName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]");
   for (ResourceEnrollmentStatus element :
       auditManagerClient.listResourceEnrollmentStatuses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`EnrollmentStatusScopeName` Required. The parent scope for which the list of resources with enrollments are required.

Returns
Type	Description
`AuditManagerClient.ListResourceEnrollmentStatusesPagedResponse`

listResourceEnrollmentStatuses(ListResourceEnrollmentStatusesRequest request)

public final AuditManagerClient.ListResourceEnrollmentStatusesPagedResponse listResourceEnrollmentStatuses(ListResourceEnrollmentStatusesRequest request)

Fetches all resources under the parent along with their enrollment.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListResourceEnrollmentStatusesRequest request =
       ListResourceEnrollmentStatusesRequest.newBuilder()
           .setParent(
               EnrollmentStatusScopeName.ofOrganizationLocationName(
                       "[ORGANIZATION]", "[LOCATION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ResourceEnrollmentStatus element :
       auditManagerClient.listResourceEnrollmentStatuses(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListResourceEnrollmentStatusesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AuditManagerClient.ListResourceEnrollmentStatusesPagedResponse`

listResourceEnrollmentStatuses(String parent)

public final AuditManagerClient.ListResourceEnrollmentStatusesPagedResponse listResourceEnrollmentStatuses(String parent)

Fetches all resources under the parent along with their enrollment.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   String parent =
       EnrollmentStatusScopeName.ofFolderLocationName("[FOLDER]", "[LOCATION]").toString();
   for (ResourceEnrollmentStatus element :
       auditManagerClient.listResourceEnrollmentStatuses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent scope for which the list of resources with enrollments are required.

Returns
Type	Description
`AuditManagerClient.ListResourceEnrollmentStatusesPagedResponse`

listResourceEnrollmentStatusesCallable()

public final UnaryCallable<ListResourceEnrollmentStatusesRequest,ListResourceEnrollmentStatusesResponse> listResourceEnrollmentStatusesCallable()

Fetches all resources under the parent along with their enrollment.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListResourceEnrollmentStatusesRequest request =
       ListResourceEnrollmentStatusesRequest.newBuilder()
           .setParent(
               EnrollmentStatusScopeName.ofOrganizationLocationName(
                       "[ORGANIZATION]", "[LOCATION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListResourceEnrollmentStatusesResponse response =
         auditManagerClient.listResourceEnrollmentStatusesCallable().call(request);
     for (ResourceEnrollmentStatus element : response.getResourceEnrollmentStatusesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListResourceEnrollmentStatusesRequest,ListResourceEnrollmentStatusesResponse>`

listResourceEnrollmentStatusesPagedCallable()

public final UnaryCallable<ListResourceEnrollmentStatusesRequest,AuditManagerClient.ListResourceEnrollmentStatusesPagedResponse> listResourceEnrollmentStatusesPagedCallable()

Fetches all resources under the parent along with their enrollment.

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 (AuditManagerClient auditManagerClient = AuditManagerClient.create()) {
   ListResourceEnrollmentStatusesRequest request =
       ListResourceEnrollmentStatusesRequest.newBuilder()
           .setParent(
               EnrollmentStatusScopeName.ofOrganizationLocationName(
                       "[ORGANIZATION]", "[LOCATION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ResourceEnrollmentStatus> future =
       auditManagerClient.listResourceEnrollmentStatusesPagedCallable().futureCall(request);
   // Do something.
   for (ResourceEnrollmentStatus element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListResourceEnrollmentStatusesRequest,ListResourceEnrollmentStatusesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

Class AuditManagerClient (0.3.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(AuditManagerSettings settings)

create(AuditManagerStub stub)

Constructors

AuditManagerClient(AuditManagerSettings settings)

AuditManagerClient(AuditManagerStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

enrollResource(EnrollResourceRequest request)

enrollResource(String scope, List<EnrollResourceRequest.EligibleDestination> destinations)

enrollResourceCallable()

generateAuditReportAsync(GenerateAuditReportRequest request)

generateAuditReportAsync(String scope, String gcsUri, String complianceStandard, GenerateAuditReportRequest.AuditReportFormat reportFormat)

generateAuditReportCallable()

generateAuditReportOperationCallable()

generateAuditScopeReport(GenerateAuditScopeReportRequest request)

generateAuditScopeReport(String scope, String complianceStandard, GenerateAuditScopeReportRequest.AuditScopeReportFormat reportFormat)

generateAuditScopeReportCallable()

getAuditReport(AuditReportName name)

getAuditReport(GetAuditReportRequest request)

getAuditReport(String name)

getAuditReportCallable()

getHttpJsonOperationsClient()

getLocation(GetLocationRequest request)

getLocationCallable()

getOperationsClient()

getResourceEnrollmentStatus(GetResourceEnrollmentStatusRequest request)

getResourceEnrollmentStatus(ResourceEnrollmentStatusName name)

getResourceEnrollmentStatus(String name)

getResourceEnrollmentStatusCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listAuditReports(EnrollmentStatusScopeName parent)

listAuditReports(ListAuditReportsRequest request)

listAuditReports(LocationName parent)

listAuditReports(String parent)

listAuditReportsCallable()

listAuditReportsPagedCallable()

listControls(ListControlsRequest request)

listControls(StandardName parent)

listControls(String parent)

listControlsCallable()

listControlsPagedCallable()

listLocations(ListLocationsRequest request)

listLocationsCallable()

listLocationsPagedCallable()

listResourceEnrollmentStatuses(EnrollmentStatusScopeName parent)

listResourceEnrollmentStatuses(ListResourceEnrollmentStatusesRequest request)

listResourceEnrollmentStatuses(String parent)

listResourceEnrollmentStatusesCallable()

listResourceEnrollmentStatusesPagedCallable()

shutdown()

shutdownNow()

Class AuditManagerClient (0.3.0)