Class CmEnrollmentServiceClient (0.7.0)

Service Description: Service describing CmEnrollment related RPCs for complianceManager.

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 (CmEnrollmentServiceClient cmEnrollmentServiceClient = CmEnrollmentServiceClient.create()) {
   CmEnrollment cmEnrollment = CmEnrollment.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CmEnrollment response =
       cmEnrollmentServiceClient.updateCmEnrollment(cmEnrollment, updateMask);
 }

Note: close() needs to be called on the CmEnrollmentServiceClient 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
UpdateCmEnrollment	Updates the Compliance Manager enrollment for a resource to facilitate an audit. Use this method to enroll a resource in Compliance Manager or to create or update feature-specific configurations.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCmEnrollment(UpdateCmEnrollmentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateCmEnrollment(CmEnrollment cmEnrollment, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateCmEnrollmentCallable()
CalculateEffectiveCmEnrollment	Calculates the effective Compliance Manager enrollment for a resource. An effective enrollment is either a direct enrollment of a resource (if it exists), or an enrollment of the closest parent of a resource that's enrolled in Compliance Manager.	Request object method variants only take one parameter, a request object, which must be constructed before the call. calculateEffectiveCmEnrollment(CalculateEffectiveCmEnrollmentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. calculateEffectiveCmEnrollment(CmEnrollmentName name) calculateEffectiveCmEnrollment(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. calculateEffectiveCmEnrollmentCallable()
ListLocations	Lists information about the supported locations for this service.	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 CmEnrollmentServiceSettings 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
 CmEnrollmentServiceSettings cmEnrollmentServiceSettings =
     CmEnrollmentServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CmEnrollmentServiceClient cmEnrollmentServiceClient =
     CmEnrollmentServiceClient.create(cmEnrollmentServiceSettings);

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
 CmEnrollmentServiceSettings cmEnrollmentServiceSettings =
     CmEnrollmentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CmEnrollmentServiceClient cmEnrollmentServiceClient =
     CmEnrollmentServiceClient.create(cmEnrollmentServiceSettings);

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
 CmEnrollmentServiceSettings cmEnrollmentServiceSettings =
     CmEnrollmentServiceSettings.newHttpJsonBuilder().build();
 CmEnrollmentServiceClient cmEnrollmentServiceClient =
     CmEnrollmentServiceClient.create(cmEnrollmentServiceSettings);

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

Inheritance

java.lang.Object > CmEnrollmentServiceClient

Static Methods

create()

public static final CmEnrollmentServiceClient create()

Constructs an instance of CmEnrollmentServiceClient with default settings.

Returns
Type	Description
`CmEnrollmentServiceClient`

Exceptions
Type	Description
`IOException`

create(CmEnrollmentServiceSettings settings)

public static final CmEnrollmentServiceClient create(CmEnrollmentServiceSettings settings)

Constructs an instance of CmEnrollmentServiceClient, 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`	`CmEnrollmentServiceSettings`

Returns
Type	Description
`CmEnrollmentServiceClient`

Exceptions
Type	Description
`IOException`

create(CmEnrollmentServiceStub stub)

public static final CmEnrollmentServiceClient create(CmEnrollmentServiceStub stub)

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

Parameter
Name	Description
`stub`	`CmEnrollmentServiceStub`

Returns
Type	Description
`CmEnrollmentServiceClient`

Constructors

CmEnrollmentServiceClient(CmEnrollmentServiceSettings settings)

protected CmEnrollmentServiceClient(CmEnrollmentServiceSettings settings)

Constructs an instance of CmEnrollmentServiceClient, 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`	`CmEnrollmentServiceSettings`

CmEnrollmentServiceClient(CmEnrollmentServiceStub stub)

protected CmEnrollmentServiceClient(CmEnrollmentServiceStub stub)

Parameter
Name	Description
`stub`	`CmEnrollmentServiceStub`

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`

calculateEffectiveCmEnrollment(CalculateEffectiveCmEnrollmentRequest request)

public final CalculateEffectiveCmEnrollmentResponse calculateEffectiveCmEnrollment(CalculateEffectiveCmEnrollmentRequest request)

Calculates the effective Compliance Manager enrollment for a resource. An effective enrollment is either a direct enrollment of a resource (if it exists), or an enrollment of the closest parent of a resource that's enrolled in Compliance Manager.

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 (CmEnrollmentServiceClient cmEnrollmentServiceClient = CmEnrollmentServiceClient.create()) {
   CalculateEffectiveCmEnrollmentRequest request =
       CalculateEffectiveCmEnrollmentRequest.newBuilder()
           .setName(
               CmEnrollmentName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]")
                   .toString())
           .build();
   CalculateEffectiveCmEnrollmentResponse response =
       cmEnrollmentServiceClient.calculateEffectiveCmEnrollment(request);
 }

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

Returns
Type	Description
`CalculateEffectiveCmEnrollmentResponse`

calculateEffectiveCmEnrollment(CmEnrollmentName name)

public final CalculateEffectiveCmEnrollmentResponse calculateEffectiveCmEnrollment(CmEnrollmentName name)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CmEnrollmentServiceClient cmEnrollmentServiceClient = CmEnrollmentServiceClient.create()) {
   CmEnrollmentName name =
       CmEnrollmentName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]");
   CalculateEffectiveCmEnrollmentResponse response =
       cmEnrollmentServiceClient.calculateEffectiveCmEnrollment(name);
 }

Parameter

Name Description

name

CmEnrollmentName

Required. The name of the Compliance Manager enrollment to calculate.

Supported formats are the following:

organizations/{organization_id}/locations/{location}/cmEnrollment
folders/{folder_id}/locations/{location}/cmEnrollment
projects/{project_id}/locations/{location}/cmEnrollment

Returns
Type	Description
`CalculateEffectiveCmEnrollmentResponse`

calculateEffectiveCmEnrollment(String name)

public final CalculateEffectiveCmEnrollmentResponse calculateEffectiveCmEnrollment(String name)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CmEnrollmentServiceClient cmEnrollmentServiceClient = CmEnrollmentServiceClient.create()) {
   String name =
       CmEnrollmentName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]").toString();
   CalculateEffectiveCmEnrollmentResponse response =
       cmEnrollmentServiceClient.calculateEffectiveCmEnrollment(name);
 }

Parameter

Name Description

name

String

Required. The name of the Compliance Manager enrollment to calculate.

Supported formats are the following:

organizations/{organization_id}/locations/{location}/cmEnrollment
folders/{folder_id}/locations/{location}/cmEnrollment
projects/{project_id}/locations/{location}/cmEnrollment

Returns
Type	Description
`CalculateEffectiveCmEnrollmentResponse`

calculateEffectiveCmEnrollmentCallable()

public final UnaryCallable<CalculateEffectiveCmEnrollmentRequest,CalculateEffectiveCmEnrollmentResponse> calculateEffectiveCmEnrollmentCallable()

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 (CmEnrollmentServiceClient cmEnrollmentServiceClient = CmEnrollmentServiceClient.create()) {
   CalculateEffectiveCmEnrollmentRequest request =
       CalculateEffectiveCmEnrollmentRequest.newBuilder()
           .setName(
               CmEnrollmentName.ofOrganizationLocationName("[ORGANIZATION]", "[LOCATION]")
                   .toString())
           .build();
   ApiFuture<CalculateEffectiveCmEnrollmentResponse> future =
       cmEnrollmentServiceClient.calculateEffectiveCmEnrollmentCallable().futureCall(request);
   // Do something.
   CalculateEffectiveCmEnrollmentResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CalculateEffectiveCmEnrollmentRequest,CalculateEffectiveCmEnrollmentResponse>`

close()

public final void close()

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

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

getSettings()

public final CmEnrollmentServiceSettings getSettings()

Returns
Type	Description
`CmEnrollmentServiceSettings`

getStub()

public CmEnrollmentServiceStub getStub()

Returns
Type	Description
`CmEnrollmentServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listLocations(ListLocationsRequest request)

public final CmEnrollmentServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (CmEnrollmentServiceClient cmEnrollmentServiceClient = CmEnrollmentServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : cmEnrollmentServiceClient.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
`CmEnrollmentServiceClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (CmEnrollmentServiceClient cmEnrollmentServiceClient = CmEnrollmentServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         cmEnrollmentServiceClient.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,CmEnrollmentServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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

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

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateCmEnrollment(CmEnrollment cmEnrollment, FieldMask updateMask)

public final CmEnrollment updateCmEnrollment(CmEnrollment cmEnrollment, FieldMask updateMask)

Updates the Compliance Manager enrollment for a resource to facilitate an audit. Use this method to enroll a resource in Compliance Manager or to create or update feature-specific configurations.

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 (CmEnrollmentServiceClient cmEnrollmentServiceClient = CmEnrollmentServiceClient.create()) {
   CmEnrollment cmEnrollment = CmEnrollment.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CmEnrollment response =
       cmEnrollmentServiceClient.updateCmEnrollment(cmEnrollment, updateMask);
 }

Parameters
Name	Description
`cmEnrollment`	`CmEnrollment` Required. The Compliance Manager enrollment to update. The `name` field is used to identify the settings that you want to update.
`updateMask`	`FieldMask` Optional. The list of fields that you want to update.

Returns
Type	Description
`CmEnrollment`

updateCmEnrollment(UpdateCmEnrollmentRequest request)

public final CmEnrollment updateCmEnrollment(UpdateCmEnrollmentRequest request)

Updates the Compliance Manager enrollment for a resource to facilitate an audit. Use this method to enroll a resource in Compliance Manager or to create or update feature-specific configurations.

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 (CmEnrollmentServiceClient cmEnrollmentServiceClient = CmEnrollmentServiceClient.create()) {
   UpdateCmEnrollmentRequest request =
       UpdateCmEnrollmentRequest.newBuilder()
           .setCmEnrollment(CmEnrollment.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   CmEnrollment response = cmEnrollmentServiceClient.updateCmEnrollment(request);
 }

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

Returns
Type	Description
`CmEnrollment`

updateCmEnrollmentCallable()

public final UnaryCallable<UpdateCmEnrollmentRequest,CmEnrollment> updateCmEnrollmentCallable()

Updates the Compliance Manager enrollment for a resource to facilitate an audit. Use this method to enroll a resource in Compliance Manager or to create or update feature-specific configurations.

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 (CmEnrollmentServiceClient cmEnrollmentServiceClient = CmEnrollmentServiceClient.create()) {
   UpdateCmEnrollmentRequest request =
       UpdateCmEnrollmentRequest.newBuilder()
           .setCmEnrollment(CmEnrollment.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<CmEnrollment> future =
       cmEnrollmentServiceClient.updateCmEnrollmentCallable().futureCall(request);
   // Do something.
   CmEnrollment response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateCmEnrollmentRequest,CmEnrollment>`

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

Inheritance

Static Methods

create()

create(CmEnrollmentServiceSettings settings)

create(CmEnrollmentServiceStub stub)

Constructors

CmEnrollmentServiceClient(CmEnrollmentServiceSettings settings)

CmEnrollmentServiceClient(CmEnrollmentServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

calculateEffectiveCmEnrollment(CalculateEffectiveCmEnrollmentRequest request)

calculateEffectiveCmEnrollment(CmEnrollmentName name)

calculateEffectiveCmEnrollment(String name)

calculateEffectiveCmEnrollmentCallable()

close()

getLocation(GetLocationRequest request)

getLocationCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listLocations(ListLocationsRequest request)

listLocationsCallable()

listLocationsPagedCallable()

shutdown()

shutdownNow()

updateCmEnrollment(CmEnrollment cmEnrollment, FieldMask updateMask)

updateCmEnrollment(UpdateCmEnrollmentRequest request)

updateCmEnrollmentCallable()

Class CmEnrollmentServiceClient (0.7.0)