Class CloudControlsPartnerMonitoringClient (0.18.0)

GitHub RepositoryProduct Reference

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 (CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create()) {
   ViolationName name =
       ViolationName.of(
           "[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]", "[VIOLATION]");
   Violation response = cloudControlsPartnerMonitoringClient.getViolation(name);
 }

Note: close() needs to be called on the CloudControlsPartnerMonitoringClient 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

ListViolations

Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listViolations(ListViolationsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listViolations(WorkloadName parent)

  • listViolations(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.

  • listViolationsPagedCallable()

  • listViolationsCallable()

GetViolation

Gets details of a single Violation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getViolation(GetViolationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getViolation(ViolationName name)

  • getViolation(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.

  • getViolationCallable()

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 CloudControlsPartnerMonitoringSettings 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
 CloudControlsPartnerMonitoringSettings cloudControlsPartnerMonitoringSettings =
     CloudControlsPartnerMonitoringSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create(cloudControlsPartnerMonitoringSettings);

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
 CloudControlsPartnerMonitoringSettings cloudControlsPartnerMonitoringSettings =
     CloudControlsPartnerMonitoringSettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create(cloudControlsPartnerMonitoringSettings);

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
 CloudControlsPartnerMonitoringSettings cloudControlsPartnerMonitoringSettings =
     CloudControlsPartnerMonitoringSettings.newHttpJsonBuilder().build();
 CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create(cloudControlsPartnerMonitoringSettings);

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

Inheritance

java.lang.Object > CloudControlsPartnerMonitoringClient

Static Methods

create()

public static final CloudControlsPartnerMonitoringClient create()

Constructs an instance of CloudControlsPartnerMonitoringClient with default settings.

Returns
Type Description
CloudControlsPartnerMonitoringClient
Exceptions
Type Description
IOException

create(CloudControlsPartnerMonitoringSettings settings)

public static final CloudControlsPartnerMonitoringClient create(CloudControlsPartnerMonitoringSettings settings)

Constructs an instance of CloudControlsPartnerMonitoringClient, 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 CloudControlsPartnerMonitoringSettings
Returns
Type Description
CloudControlsPartnerMonitoringClient
Exceptions
Type Description
IOException

create(CloudControlsPartnerMonitoringStub stub)

public static final CloudControlsPartnerMonitoringClient create(CloudControlsPartnerMonitoringStub stub)

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

Parameter
Name Description
stub CloudControlsPartnerMonitoringStub
Returns
Type Description
CloudControlsPartnerMonitoringClient

Constructors

CloudControlsPartnerMonitoringClient(CloudControlsPartnerMonitoringSettings settings)

protected CloudControlsPartnerMonitoringClient(CloudControlsPartnerMonitoringSettings settings)

Constructs an instance of CloudControlsPartnerMonitoringClient, 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 CloudControlsPartnerMonitoringSettings

CloudControlsPartnerMonitoringClient(CloudControlsPartnerMonitoringStub stub)

protected CloudControlsPartnerMonitoringClient(CloudControlsPartnerMonitoringStub stub)
Parameter
Name Description
stub CloudControlsPartnerMonitoringStub

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

getSettings()

public final CloudControlsPartnerMonitoringSettings getSettings()
Returns
Type Description
CloudControlsPartnerMonitoringSettings

getStub()

public CloudControlsPartnerMonitoringStub getStub()
Returns
Type Description
CloudControlsPartnerMonitoringStub

getViolation(GetViolationRequest request)

public final Violation getViolation(GetViolationRequest request)

Gets details of a single Violation.

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 (CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create()) {
   GetViolationRequest request =
       GetViolationRequest.newBuilder()
           .setName(
               ViolationName.of(
                       "[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]", "[VIOLATION]")
                   .toString())
           .build();
   Violation response = cloudControlsPartnerMonitoringClient.getViolation(request);
 }
Parameter
Name Description
request GetViolationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Violation

getViolation(ViolationName name)

public final Violation getViolation(ViolationName name)

Gets details of a single Violation.

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 (CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create()) {
   ViolationName name =
       ViolationName.of(
           "[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]", "[VIOLATION]");
   Violation response = cloudControlsPartnerMonitoringClient.getViolation(name);
 }
Parameter
Name Description
name ViolationName

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}
Returns
Type Description
Violation

getViolation(String name)

public final Violation getViolation(String name)

Gets details of a single Violation.

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 (CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create()) {
   String name =
       ViolationName.of(
               "[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]", "[VIOLATION]")
           .toString();
   Violation response = cloudControlsPartnerMonitoringClient.getViolation(name);
 }
Parameter
Name Description
name String

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}
Returns
Type Description
Violation

getViolationCallable()

public final UnaryCallable<GetViolationRequest,Violation> getViolationCallable()

Gets details of a single Violation.

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 (CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create()) {
   GetViolationRequest request =
       GetViolationRequest.newBuilder()
           .setName(
               ViolationName.of(
                       "[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]", "[VIOLATION]")
                   .toString())
           .build();
   ApiFuture<Violation> future =
       cloudControlsPartnerMonitoringClient.getViolationCallable().futureCall(request);
   // Do something.
   Violation response = future.get();
 }
Returns
Type Description
UnaryCallable<GetViolationRequest,Violation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listViolations(ListViolationsRequest request)

public final CloudControlsPartnerMonitoringClient.ListViolationsPagedResponse listViolations(ListViolationsRequest request)

Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

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 (CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create()) {
   ListViolationsRequest request =
       ListViolationsRequest.newBuilder()
           .setParent(
               WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setInterval(Interval.newBuilder().build())
           .build();
   for (Violation element :
       cloudControlsPartnerMonitoringClient.listViolations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListViolationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CloudControlsPartnerMonitoringClient.ListViolationsPagedResponse

listViolations(WorkloadName parent)

public final CloudControlsPartnerMonitoringClient.ListViolationsPagedResponse listViolations(WorkloadName parent)

Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

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 (CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create()) {
   WorkloadName parent =
       WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
   for (Violation element :
       cloudControlsPartnerMonitoringClient.listViolations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent WorkloadName

Required. Parent resource Format organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
Returns
Type Description
CloudControlsPartnerMonitoringClient.ListViolationsPagedResponse

listViolations(String parent)

public final CloudControlsPartnerMonitoringClient.ListViolationsPagedResponse listViolations(String parent)

Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

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 (CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create()) {
   String parent =
       WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]").toString();
   for (Violation element :
       cloudControlsPartnerMonitoringClient.listViolations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Parent resource Format organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
Returns
Type Description
CloudControlsPartnerMonitoringClient.ListViolationsPagedResponse

listViolationsCallable()

public final UnaryCallable<ListViolationsRequest,ListViolationsResponse> listViolationsCallable()

Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

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 (CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create()) {
   ListViolationsRequest request =
       ListViolationsRequest.newBuilder()
           .setParent(
               WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setInterval(Interval.newBuilder().build())
           .build();
   while (true) {
     ListViolationsResponse response =
         cloudControlsPartnerMonitoringClient.listViolationsCallable().call(request);
     for (Violation element : response.getViolationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListViolationsRequest,ListViolationsResponse>

listViolationsPagedCallable()

public final UnaryCallable<ListViolationsRequest,CloudControlsPartnerMonitoringClient.ListViolationsPagedResponse> listViolationsPagedCallable()

Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

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 (CloudControlsPartnerMonitoringClient cloudControlsPartnerMonitoringClient =
     CloudControlsPartnerMonitoringClient.create()) {
   ListViolationsRequest request =
       ListViolationsRequest.newBuilder()
           .setParent(
               WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setInterval(Interval.newBuilder().build())
           .build();
   ApiFuture<Violation> future =
       cloudControlsPartnerMonitoringClient.listViolationsPagedCallable().futureCall(request);
   // Do something.
   for (Violation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListViolationsRequest,ListViolationsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()