com.google.cloud.gaming.v1alpha

Class RealmsServiceClient

java.lang.Object

com.google.cloud.gaming.v1alpha.RealmsServiceClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class RealmsServiceClient
extends Object
implements BackgroundResource

Service Description: Realm provides grouping of game server clusters that are serving a particular gamer population.

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:

 
 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedName = RealmsServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   Realm response = realmsServiceClient.getRealm(formattedName);
 }
 
 

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

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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 RealmsServiceSettings to create(). For example:

To customize credentials:

 
 RealmsServiceSettings realmsServiceSettings =
     RealmsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RealmsServiceClient realmsServiceClient =
     RealmsServiceClient.create(realmsServiceSettings);
 
 

To customize the endpoint:

 
 RealmsServiceSettings realmsServiceSettings =
     RealmsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RealmsServiceClient realmsServiceClient =
     RealmsServiceClient.create(realmsServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RealmsServiceClient.ListRealmsFixedSizeCollection
static class	RealmsServiceClient.ListRealmsPage
static class	RealmsServiceClient.ListRealmsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RealmsServiceClient(RealmsServiceSettings settings) Constructs an instance of RealmsServiceClient, using the given settings.
protected	RealmsServiceClient(RealmsServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RealmsServiceClient	create() Constructs an instance of RealmsServiceClient with default settings.
static RealmsServiceClient	create(RealmsServiceSettings settings) Constructs an instance of RealmsServiceClient, using the given settings.
static RealmsServiceClient	create(RealmsServiceStub stub) Constructs an instance of RealmsServiceClient, using the given stub for making calls.
OperationFuture<Realm,Empty>	createRealmAsync(CreateRealmRequest request) Creates a new Realm in a given project and location.
OperationFuture<Realm,Empty>	createRealmAsync(String parent, String realmId, Realm realm) Creates a new Realm in a given project and location.
UnaryCallable<CreateRealmRequest,Operation>	createRealmCallable() Creates a new Realm in a given project and location.
OperationCallable<CreateRealmRequest,Realm,Empty>	createRealmOperationCallable() Creates a new Realm in a given project and location.
OperationFuture<Empty,Empty>	deleteRealmAsync(DeleteRealmRequest request) Deletes a single realm.
OperationFuture<Empty,Empty>	deleteRealmAsync(String name) Deletes a single realm.
UnaryCallable<DeleteRealmRequest,Operation>	deleteRealmCallable() Deletes a single realm.
OperationCallable<DeleteRealmRequest,Empty,Empty>	deleteRealmOperationCallable() Deletes a single realm.
static String	formatLocationName(String project, String location) Deprecated. Use the LocationName class instead.
static String	formatRealmName(String project, String location, String realm) Deprecated. Use the RealmName class instead.
OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Realm	getRealm(GetRealmRequest request) Gets details of a single realm.
Realm	getRealm(String name) Gets details of a single realm.
UnaryCallable<GetRealmRequest,Realm>	getRealmCallable() Gets details of a single realm.
RealmsServiceSettings	getSettings()
RealmsServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
RealmsServiceClient.ListRealmsPagedResponse	listRealms(ListRealmsRequest request) Lists realms in a given project and location.
RealmsServiceClient.ListRealmsPagedResponse	listRealms(String parent) Lists realms in a given project and location.
UnaryCallable<ListRealmsRequest,ListRealmsResponse>	listRealmsCallable() Lists realms in a given project and location.
UnaryCallable<ListRealmsRequest,RealmsServiceClient.ListRealmsPagedResponse>	listRealmsPagedCallable() Lists realms in a given project and location.
static String	parseLocationFromLocationName(String locationName) Deprecated. Use the LocationName class instead.
static String	parseLocationFromRealmName(String realmName) Deprecated. Use the RealmName class instead.
static String	parseProjectFromLocationName(String locationName) Deprecated. Use the LocationName class instead.
static String	parseProjectFromRealmName(String realmName) Deprecated. Use the RealmName class instead.
static String	parseRealmFromRealmName(String realmName) Deprecated. Use the RealmName class instead.
PreviewRealmUpdateResponse	previewRealmUpdate(PreviewRealmUpdateRequest request) Previews patches to a single Realm.
UnaryCallable<PreviewRealmUpdateRequest,PreviewRealmUpdateResponse>	previewRealmUpdateCallable() Previews patches to a single Realm.
void	shutdown()
void	shutdownNow()
OperationFuture<Realm,Empty>	updateRealmAsync(Realm realm, FieldMask updateMask) Patches a single Realm.
OperationFuture<Realm,Empty>	updateRealmAsync(UpdateRealmRequest request) Patches a single Realm.
UnaryCallable<UpdateRealmRequest,Operation>	updateRealmCallable() Patches a single Realm.
OperationCallable<UpdateRealmRequest,Realm,Empty>	updateRealmOperationCallable() Patches a single Realm.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RealmsServiceClient

protected RealmsServiceClient(RealmsServiceSettings settings)
                       throws IOException

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

RealmsServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected RealmsServiceClient(RealmsServiceStub stub)

Method Detail

formatLocationName

@Deprecated
public static final String formatLocationName(String project,
                                                          String location)

Deprecated. Use the LocationName class instead.

Formats a string containing the fully-qualified path to represent a location resource.

formatRealmName

@Deprecated
public static final String formatRealmName(String project,
                                                       String location,
                                                       String realm)

Deprecated. Use the RealmName class instead.

Formats a string containing the fully-qualified path to represent a realm resource.

parseProjectFromLocationName

@Deprecated
public static final String parseProjectFromLocationName(String locationName)

Deprecated. Use the LocationName class instead.

Parses the project from the given fully-qualified path which represents a location resource.

parseLocationFromLocationName

@Deprecated
public static final String parseLocationFromLocationName(String locationName)

Deprecated. Use the LocationName class instead.

Parses the location from the given fully-qualified path which represents a location resource.

parseProjectFromRealmName

@Deprecated
public static final String parseProjectFromRealmName(String realmName)

Deprecated. Use the RealmName class instead.

Parses the project from the given fully-qualified path which represents a realm resource.

parseLocationFromRealmName

@Deprecated
public static final String parseLocationFromRealmName(String realmName)

Deprecated. Use the RealmName class instead.

Parses the location from the given fully-qualified path which represents a realm resource.

parseRealmFromRealmName

@Deprecated
public static final String parseRealmFromRealmName(String realmName)

Deprecated. Use the RealmName class instead.

Parses the realm from the given fully-qualified path which represents a realm resource.

create

public static final RealmsServiceClient create()
                                        throws IOException

Constructs an instance of RealmsServiceClient with default settings.

Throws:

IOException

create

public static final RealmsServiceClient create(RealmsServiceSettings settings)
                                        throws IOException

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final RealmsServiceClient create(RealmsServiceStub stub)

Constructs an instance of RealmsServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use RealmsServiceSettings}.

getSettings

public final RealmsServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public RealmsServiceStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

listRealms

public final RealmsServiceClient.ListRealmsPagedResponse listRealms(String parent)

Lists realms in a given project and location.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedParent = RealmsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   for (Realm element : realmsServiceClient.listRealms(formattedParent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent resource name, using the form: `projects/{project}/locations/{location}`.

Throws:

ApiException - if the remote call fails

listRealms

public final RealmsServiceClient.ListRealmsPagedResponse listRealms(ListRealmsRequest request)

Lists realms in a given project and location.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedParent = RealmsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   ListRealmsRequest request = ListRealmsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (Realm element : realmsServiceClient.listRealms(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

listRealmsPagedCallable

public final UnaryCallable<ListRealmsRequest,RealmsServiceClient.ListRealmsPagedResponse> listRealmsPagedCallable()

Lists realms in a given project and location.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedParent = RealmsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   ListRealmsRequest request = ListRealmsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListRealmsPagedResponse> future = realmsServiceClient.listRealmsPagedCallable().futureCall(request);
   // Do something
   for (Realm element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listRealmsCallable

public final UnaryCallable<ListRealmsRequest,ListRealmsResponse> listRealmsCallable()

Lists realms in a given project and location.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedParent = RealmsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   ListRealmsRequest request = ListRealmsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     ListRealmsResponse response = realmsServiceClient.listRealmsCallable().call(request);
     for (Realm element : response.getRealmsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getRealm

public final Realm getRealm(String name)

Gets details of a single realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedName = RealmsServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   Realm response = realmsServiceClient.getRealm(formattedName);
 }
 

Parameters:

name - Required. The name of the realm to retrieve, using the form: `projects/{project}/locations/{location}/realms/{realm}`

Throws:

ApiException - if the remote call fails

getRealm

public final Realm getRealm(GetRealmRequest request)

Gets details of a single realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedName = RealmsServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   GetRealmRequest request = GetRealmRequest.newBuilder()
     .setName(formattedName)
     .build();
   Realm response = realmsServiceClient.getRealm(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getRealmCallable

public final UnaryCallable<GetRealmRequest,Realm> getRealmCallable()

Gets details of a single realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedName = RealmsServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   GetRealmRequest request = GetRealmRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Realm> future = realmsServiceClient.getRealmCallable().futureCall(request);
   // Do something
   Realm response = future.get();
 }
 

createRealmAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Realm,Empty> createRealmAsync(String parent,
                                                                                                                                                                     String realmId,
                                                                                                                                                                     Realm realm)

Creates a new Realm in a given project and location.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedParent = RealmsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String realmId = "";
   Realm realm = Realm.newBuilder().build();
   Realm response = realmsServiceClient.createRealmAsync(formattedParent, realmId, realm).get();
 }
 

Parameters:

parent - Required. The parent resource name, using the form: `projects/{project}/locations/{location}`.

realmId - Required. The ID of the realm resource to be created.

realm - Required. The realm resource to be created.

Throws:

ApiException - if the remote call fails

createRealmAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Realm,Empty> createRealmAsync(CreateRealmRequest request)

Creates a new Realm in a given project and location.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedParent = RealmsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String realmId = "";
   Realm realm = Realm.newBuilder().build();
   CreateRealmRequest request = CreateRealmRequest.newBuilder()
     .setParent(formattedParent)
     .setRealmId(realmId)
     .setRealm(realm)
     .build();
   Realm response = realmsServiceClient.createRealmAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

createRealmOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<CreateRealmRequest,Realm,Empty> createRealmOperationCallable()

Creates a new Realm in a given project and location.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedParent = RealmsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String realmId = "";
   Realm realm = Realm.newBuilder().build();
   CreateRealmRequest request = CreateRealmRequest.newBuilder()
     .setParent(formattedParent)
     .setRealmId(realmId)
     .setRealm(realm)
     .build();
   OperationFuture<Realm, Empty> future = realmsServiceClient.createRealmOperationCallable().futureCall(request);
   // Do something
   Realm response = future.get();
 }
 

createRealmCallable

public final UnaryCallable<CreateRealmRequest,Operation> createRealmCallable()

Creates a new Realm in a given project and location.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedParent = RealmsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String realmId = "";
   Realm realm = Realm.newBuilder().build();
   CreateRealmRequest request = CreateRealmRequest.newBuilder()
     .setParent(formattedParent)
     .setRealmId(realmId)
     .setRealm(realm)
     .build();
   ApiFuture<Operation> future = realmsServiceClient.createRealmCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

deleteRealmAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Empty> deleteRealmAsync(String name)

Deletes a single realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedName = RealmsServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   realmsServiceClient.deleteRealmAsync(formattedName).get();
 }
 

Parameters:

name - Required. The name of the realm to delete, using the form: `projects/{project}/locations/{location}/realms/{realm}`

Throws:

ApiException - if the remote call fails

deleteRealmAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Empty> deleteRealmAsync(DeleteRealmRequest request)

Deletes a single realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedName = RealmsServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   DeleteRealmRequest request = DeleteRealmRequest.newBuilder()
     .setName(formattedName)
     .build();
   realmsServiceClient.deleteRealmAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

deleteRealmOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<DeleteRealmRequest,Empty,Empty> deleteRealmOperationCallable()

Deletes a single realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedName = RealmsServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   DeleteRealmRequest request = DeleteRealmRequest.newBuilder()
     .setName(formattedName)
     .build();
   OperationFuture<Empty, Empty> future = realmsServiceClient.deleteRealmOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

deleteRealmCallable

public final UnaryCallable<DeleteRealmRequest,Operation> deleteRealmCallable()

Deletes a single realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   String formattedName = RealmsServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   DeleteRealmRequest request = DeleteRealmRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Operation> future = realmsServiceClient.deleteRealmCallable().futureCall(request);
   // Do something
   future.get();
 }
 

updateRealmAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Realm,Empty> updateRealmAsync(Realm realm,
                                                                                                                                                                     FieldMask updateMask)

Patches a single Realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   Realm realm = Realm.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Realm response = realmsServiceClient.updateRealmAsync(realm, updateMask).get();
 }
 

Parameters:

realm - Required. The realm to be updated. Only fields specified in update_mask are updated.

updateMask - Required. The update mask applies to the resource. For the `FieldMask` definition, see

https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

Throws:

ApiException - if the remote call fails

updateRealmAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Realm,Empty> updateRealmAsync(UpdateRealmRequest request)

Patches a single Realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   Realm realm = Realm.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateRealmRequest request = UpdateRealmRequest.newBuilder()
     .setRealm(realm)
     .setUpdateMask(updateMask)
     .build();
   Realm response = realmsServiceClient.updateRealmAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

updateRealmOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<UpdateRealmRequest,Realm,Empty> updateRealmOperationCallable()

Patches a single Realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   Realm realm = Realm.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateRealmRequest request = UpdateRealmRequest.newBuilder()
     .setRealm(realm)
     .setUpdateMask(updateMask)
     .build();
   OperationFuture<Realm, Empty> future = realmsServiceClient.updateRealmOperationCallable().futureCall(request);
   // Do something
   Realm response = future.get();
 }
 

updateRealmCallable

public final UnaryCallable<UpdateRealmRequest,Operation> updateRealmCallable()

Patches a single Realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   Realm realm = Realm.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateRealmRequest request = UpdateRealmRequest.newBuilder()
     .setRealm(realm)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<Operation> future = realmsServiceClient.updateRealmCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

previewRealmUpdate

public final PreviewRealmUpdateResponse previewRealmUpdate(PreviewRealmUpdateRequest request)

Previews patches to a single Realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   PreviewRealmUpdateRequest request = PreviewRealmUpdateRequest.newBuilder().build();
   PreviewRealmUpdateResponse response = realmsServiceClient.previewRealmUpdate(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

previewRealmUpdateCallable

public final UnaryCallable<PreviewRealmUpdateRequest,PreviewRealmUpdateResponse> previewRealmUpdateCallable()

Previews patches to a single Realm.

Sample code:

 try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
   PreviewRealmUpdateRequest request = PreviewRealmUpdateRequest.newBuilder().build();
   ApiFuture<PreviewRealmUpdateResponse> future = realmsServiceClient.previewRealmUpdateCallable().futureCall(request);
   // Do something
   PreviewRealmUpdateResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException