MaintenanceClient (Google Maintenance API 0.4.0 API)

java.lang.Object
- com.google.cloud.maintenance.api.v1beta.MaintenanceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class MaintenanceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Unified Maintenance service

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 (MaintenanceClient maintenanceClient = MaintenanceClient.create()) {
   ResourceMaintenanceName name =
       ResourceMaintenanceName.of("[PROJECT]", "[LOCATION]", "[RESOURCE_MAINTENANCE]");
   ResourceMaintenance response = maintenanceClient.getResourceMaintenance(name);
 }

Note: close() needs to be called on the MaintenanceClient 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
SummarizeMaintenances	Retrieves the statistics of a specific maintenance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. summarizeMaintenances(SummarizeMaintenancesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. summarizeMaintenances(LocationName parent) summarizeMaintenances(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. summarizeMaintenancesPagedCallable() summarizeMaintenancesCallable()
ListResourceMaintenances	Retrieve a collection of resource maintenances.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listResourceMaintenances(ListResourceMaintenancesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listResourceMaintenances(LocationName parent) listResourceMaintenances(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. listResourceMaintenancesPagedCallable() listResourceMaintenancesCallable()
GetResourceMaintenance	Retrieve a single resource maintenance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getResourceMaintenance(GetResourceMaintenanceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getResourceMaintenance(ResourceMaintenanceName name) getResourceMaintenance(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. getResourceMaintenanceCallable()
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 MaintenanceSettings 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
 MaintenanceSettings maintenanceSettings =
     MaintenanceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MaintenanceClient maintenanceClient = MaintenanceClient.create(maintenanceSettings);

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
 MaintenanceSettings maintenanceSettings =
     MaintenanceSettings.newBuilder().setEndpoint(myEndpoint).build();
 MaintenanceClient maintenanceClient = MaintenanceClient.create(maintenanceSettings);

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
 MaintenanceSettings maintenanceSettings = MaintenanceSettings.newHttpJsonBuilder().build();
 MaintenanceClient maintenanceClient = MaintenanceClient.create(maintenanceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MaintenanceClient.ListLocationsFixedSizeCollection`
`static class`	`MaintenanceClient.ListLocationsPage`
`static class`	`MaintenanceClient.ListLocationsPagedResponse`
`static class`	`MaintenanceClient.ListResourceMaintenancesFixedSizeCollection`
`static class`	`MaintenanceClient.ListResourceMaintenancesPage`
`static class`	`MaintenanceClient.ListResourceMaintenancesPagedResponse`
`static class`	`MaintenanceClient.SummarizeMaintenancesFixedSizeCollection`
`static class`	`MaintenanceClient.SummarizeMaintenancesPage`
`static class`	`MaintenanceClient.SummarizeMaintenancesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`MaintenanceClient(MaintenanceSettings settings)` Constructs an instance of MaintenanceClient, using the given settings.
`protected`	`MaintenanceClient(MaintenanceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static MaintenanceClient`	`create()` Constructs an instance of MaintenanceClient with default settings.
`static MaintenanceClient`	`create(MaintenanceSettings settings)` Constructs an instance of MaintenanceClient, using the given settings.
`static MaintenanceClient`	`create(MaintenanceStub stub)` Constructs an instance of MaintenanceClient, using the given stub for making calls.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`ResourceMaintenance`	`getResourceMaintenance(GetResourceMaintenanceRequest request)` Retrieve a single resource maintenance.
`ResourceMaintenance`	`getResourceMaintenance(ResourceMaintenanceName name)` Retrieve a single resource maintenance.
`ResourceMaintenance`	`getResourceMaintenance(String name)` Retrieve a single resource maintenance.
`com.google.api.gax.rpc.UnaryCallable<GetResourceMaintenanceRequest,ResourceMaintenance>`	`getResourceMaintenanceCallable()` Retrieve a single resource maintenance.
`MaintenanceSettings`	`getSettings()`
`MaintenanceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`MaintenanceClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,MaintenanceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`MaintenanceClient.ListResourceMaintenancesPagedResponse`	`listResourceMaintenances(ListResourceMaintenancesRequest request)` Retrieve a collection of resource maintenances.
`MaintenanceClient.ListResourceMaintenancesPagedResponse`	`listResourceMaintenances(LocationName parent)` Retrieve a collection of resource maintenances.
`MaintenanceClient.ListResourceMaintenancesPagedResponse`	`listResourceMaintenances(String parent)` Retrieve a collection of resource maintenances.
`com.google.api.gax.rpc.UnaryCallable<ListResourceMaintenancesRequest,ListResourceMaintenancesResponse>`	`listResourceMaintenancesCallable()` Retrieve a collection of resource maintenances.
`com.google.api.gax.rpc.UnaryCallable<ListResourceMaintenancesRequest,MaintenanceClient.ListResourceMaintenancesPagedResponse>`	`listResourceMaintenancesPagedCallable()` Retrieve a collection of resource maintenances.
`void`	`shutdown()`
`void`	`shutdownNow()`
`MaintenanceClient.SummarizeMaintenancesPagedResponse`	`summarizeMaintenances(LocationName parent)` Retrieves the statistics of a specific maintenance.
`MaintenanceClient.SummarizeMaintenancesPagedResponse`	`summarizeMaintenances(String parent)` Retrieves the statistics of a specific maintenance.
`MaintenanceClient.SummarizeMaintenancesPagedResponse`	`summarizeMaintenances(SummarizeMaintenancesRequest request)` Retrieves the statistics of a specific maintenance.
`com.google.api.gax.rpc.UnaryCallable<SummarizeMaintenancesRequest,SummarizeMaintenancesResponse>`	`summarizeMaintenancesCallable()` Retrieves the statistics of a specific maintenance.
`com.google.api.gax.rpc.UnaryCallable<SummarizeMaintenancesRequest,MaintenanceClient.SummarizeMaintenancesPagedResponse>`	`summarizeMaintenancesPagedCallable()` Retrieves the statistics of a specific maintenance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- MaintenanceClient
```
protected MaintenanceClient(MaintenanceSettings settings)
                     throws IOException
```
  Constructs an instance of MaintenanceClient, 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.
  
  Throws:
  
  IOException
- MaintenanceClient
```
protected MaintenanceClient(MaintenanceStub stub)
```

Method Detail

create

public static final MaintenanceClient create()
                                      throws IOException

Constructs an instance of MaintenanceClient with default settings.

Throws:: IOException

create
```
public static final MaintenanceClient create(MaintenanceSettings settings)
                                      throws IOException
```
Constructs an instance of MaintenanceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final MaintenanceClient create(MaintenanceStub stub)
```
Constructs an instance of MaintenanceClient, using the given stub for making calls. This is for advanced usage - prefer using create(MaintenanceSettings).

getSettings

public final MaintenanceSettings getSettings()

getStub
```
public MaintenanceStub getStub()
```

summarizeMaintenances

public final MaintenanceClient.SummarizeMaintenancesPagedResponse summarizeMaintenances(LocationName parent)

Retrieves the statistics of a specific maintenance.

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 (MaintenanceClient maintenanceClient = MaintenanceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (MaintenanceSummary element :
       maintenanceClient.summarizeMaintenances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The parent of the resource maintenance. eg. `projects/123/locations/*`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

summarizeMaintenances

public final MaintenanceClient.SummarizeMaintenancesPagedResponse summarizeMaintenances(String parent)

Retrieves the statistics of a specific maintenance.

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

Parameters:: parent - Required. The parent of the resource maintenance. eg. `projects/123/locations/*`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

summarizeMaintenances

public final MaintenanceClient.SummarizeMaintenancesPagedResponse summarizeMaintenances(SummarizeMaintenancesRequest request)

Retrieves the statistics of a specific maintenance.

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 (MaintenanceClient maintenanceClient = MaintenanceClient.create()) {
   SummarizeMaintenancesRequest request =
       SummarizeMaintenancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (MaintenanceSummary element :
       maintenanceClient.summarizeMaintenances(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

summarizeMaintenancesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<SummarizeMaintenancesRequest,MaintenanceClient.SummarizeMaintenancesPagedResponse> summarizeMaintenancesPagedCallable()

Retrieves the statistics of a specific maintenance.

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 (MaintenanceClient maintenanceClient = MaintenanceClient.create()) {
   SummarizeMaintenancesRequest request =
       SummarizeMaintenancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<MaintenanceSummary> future =
       maintenanceClient.summarizeMaintenancesPagedCallable().futureCall(request);
   // Do something.
   for (MaintenanceSummary element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

summarizeMaintenancesCallable

public final com.google.api.gax.rpc.UnaryCallable<SummarizeMaintenancesRequest,SummarizeMaintenancesResponse> summarizeMaintenancesCallable()

Retrieves the statistics of a specific maintenance.

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 (MaintenanceClient maintenanceClient = MaintenanceClient.create()) {
   SummarizeMaintenancesRequest request =
       SummarizeMaintenancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     SummarizeMaintenancesResponse response =
         maintenanceClient.summarizeMaintenancesCallable().call(request);
     for (MaintenanceSummary element : response.getMaintenancesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }