Package com.oracle.bmc.lustrefilestorage

Class LustreFileStorageAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.lustrefilestorage.LustreFileStorageAsyncClient

All Implemented Interfaces:

LustreFileStorageAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20250228")
public class LustreFileStorageAsyncClient
extends BaseAsyncClient
implements LustreFileStorageAsync

Async client implementation for LustreFileStorage service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LustreFileStorageAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for LustreFileStorage.

Constructor Summary

Constructors

Constructor	Description
LustreFileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
LustreFileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
LustreFileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
LustreFileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
LustreFileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
LustreFileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
LustreFileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static LustreFileStorageAsyncClient.Builder	builder()	Create a builder for this client.
Future<CancelWorkRequestResponse>	cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)	Cancels a work request.
Future<ChangeLustreFileSystemCompartmentResponse>	changeLustreFileSystemCompartment(ChangeLustreFileSystemCompartmentRequest request, AsyncHandler<ChangeLustreFileSystemCompartmentRequest,ChangeLustreFileSystemCompartmentResponse> handler)	Moves a Lustre file system into a different compartment within the same tenancy.
Future<ChangeObjectStorageLinkCompartmentResponse>	changeObjectStorageLinkCompartment(ChangeObjectStorageLinkCompartmentRequest request, AsyncHandler<ChangeObjectStorageLinkCompartmentRequest,ChangeObjectStorageLinkCompartmentResponse> handler)	Moves an Object Storage link into a different compartment within the same tenancy.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateLustreFileSystemResponse>	createLustreFileSystem(CreateLustreFileSystemRequest request, AsyncHandler<CreateLustreFileSystemRequest,CreateLustreFileSystemResponse> handler)	Creates a Lustre file system.
Future<CreateObjectStorageLinkResponse>	createObjectStorageLink(CreateObjectStorageLinkRequest request, AsyncHandler<CreateObjectStorageLinkRequest,CreateObjectStorageLinkResponse> handler)	Creates an Object Storage link.
Future<DeleteLustreFileSystemResponse>	deleteLustreFileSystem(DeleteLustreFileSystemRequest request, AsyncHandler<DeleteLustreFileSystemRequest,DeleteLustreFileSystemResponse> handler)	Deletes a Lustre file system.
Future<DeleteObjectStorageLinkResponse>	deleteObjectStorageLink(DeleteObjectStorageLinkRequest request, AsyncHandler<DeleteObjectStorageLinkRequest,DeleteObjectStorageLinkResponse> handler)	Deletes an Object Storage link.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetLustreFileSystemResponse>	getLustreFileSystem(GetLustreFileSystemRequest request, AsyncHandler<GetLustreFileSystemRequest,GetLustreFileSystemResponse> handler)	Gets information about a Lustre file system.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetObjectStorageLinkResponse>	getObjectStorageLink(GetObjectStorageLinkRequest request, AsyncHandler<GetObjectStorageLinkRequest,GetObjectStorageLinkResponse> handler)	Gets information about an Object Storage link.
Future<GetSyncJobResponse>	getSyncJob(GetSyncJobRequest request, AsyncHandler<GetSyncJobRequest,GetSyncJobResponse> handler)	Gets details of a sync job associated with an Object Storage link when objectStorageLink and a unique ID are provided.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)	Gets the details of a work request.
Future<ListLustreFileSystemsResponse>	listLustreFileSystems(ListLustreFileSystemsRequest request, AsyncHandler<ListLustreFileSystemsRequest,ListLustreFileSystemsResponse> handler)	Gets a list of Lustre file systems.
Future<ListObjectStorageLinksResponse>	listObjectStorageLinks(ListObjectStorageLinksRequest request, AsyncHandler<ListObjectStorageLinksRequest,ListObjectStorageLinksResponse> handler)	Gets a list of Object Storage links.
Future<ListSyncJobsResponse>	listSyncJobs(ListSyncJobsRequest request, AsyncHandler<ListSyncJobsRequest,ListSyncJobsResponse> handler)	Lists all sync jobs associated with the Object Storage link.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)	Lists the errors for a work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)	Lists the logs for a work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)	Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
Future<StartExportToObjectResponse>	startExportToObject(StartExportToObjectRequest request, AsyncHandler<StartExportToObjectRequest,StartExportToObjectResponse> handler)	Starts the export of data from the Lustre file system to Object Storage.
Future<StartImportFromObjectResponse>	startImportFromObject(StartImportFromObjectRequest request, AsyncHandler<StartImportFromObjectRequest,StartImportFromObjectResponse> handler)	Starts the import of data from Object Storage to the Lustre file system.
Future<StopExportToObjectResponse>	stopExportToObject(StopExportToObjectRequest request, AsyncHandler<StopExportToObjectRequest,StopExportToObjectResponse> handler)	Stops the export of data from the Lustre file system to Object Storage.
Future<StopImportFromObjectResponse>	stopImportFromObject(StopImportFromObjectRequest request, AsyncHandler<StopImportFromObjectRequest,StopImportFromObjectResponse> handler)	Stops the import of data from Object Storage to the Lustre file system.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateLustreFileSystemResponse>	updateLustreFileSystem(UpdateLustreFileSystemRequest request, AsyncHandler<UpdateLustreFileSystemRequest,UpdateLustreFileSystemResponse> handler)	Updates a Lustre file system.
Future<UpdateObjectStorageLinkResponse>	updateObjectStorageLink(UpdateObjectStorageLinkRequest request, AsyncHandler<UpdateObjectStorageLinkRequest,UpdateObjectStorageLinkResponse> handler)	Updates an Object Storage link.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.lustrefilestorage.LustreFileStorageAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for LustreFileStorage.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

LustreFileStorageAsyncClient

@Deprecated
public LustreFileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LustreFileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

LustreFileStorageAsyncClient

@Deprecated
public LustreFileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LustreFileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

LustreFileStorageAsyncClient

@Deprecated
public LustreFileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LustreFileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

LustreFileStorageAsyncClient

@Deprecated
public LustreFileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LustreFileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

LustreFileStorageAsyncClient

@Deprecated
public LustreFileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LustreFileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

LustreFileStorageAsyncClient

@Deprecated
public LustreFileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LustreFileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

LustreFileStorageAsyncClient

@Deprecated
public LustreFileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LustreFileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static LustreFileStorageAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: LustreFileStorageAsync

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface LustreFileStorageAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: LustreFileStorageAsync

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface LustreFileStorageAsync

Parameters:

regionId - The public region ID.

cancelWorkRequest

public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request,
                                                           AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)

Description copied from interface: LustreFileStorageAsync

Cancels a work request.

Specified by:

cancelWorkRequest in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeLustreFileSystemCompartment

public Future<ChangeLustreFileSystemCompartmentResponse> changeLustreFileSystemCompartment(ChangeLustreFileSystemCompartmentRequest request,
                                                                                           AsyncHandler<ChangeLustreFileSystemCompartmentRequest,ChangeLustreFileSystemCompartmentResponse> handler)

Description copied from interface: LustreFileStorageAsync

Moves a Lustre file system into a different compartment within the same tenancy.

For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeLustreFileSystemCompartment in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeObjectStorageLinkCompartment

public Future<ChangeObjectStorageLinkCompartmentResponse> changeObjectStorageLinkCompartment(ChangeObjectStorageLinkCompartmentRequest request,
                                                                                             AsyncHandler<ChangeObjectStorageLinkCompartmentRequest,ChangeObjectStorageLinkCompartmentResponse> handler)

Description copied from interface: LustreFileStorageAsync

Moves an Object Storage link into a different compartment within the same tenancy.

For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeObjectStorageLinkCompartment in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createLustreFileSystem

public Future<CreateLustreFileSystemResponse> createLustreFileSystem(CreateLustreFileSystemRequest request,
                                                                     AsyncHandler<CreateLustreFileSystemRequest,CreateLustreFileSystemResponse> handler)

Description copied from interface: LustreFileStorageAsync

Creates a Lustre file system.

Specified by:

createLustreFileSystem in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createObjectStorageLink

public Future<CreateObjectStorageLinkResponse> createObjectStorageLink(CreateObjectStorageLinkRequest request,
                                                                       AsyncHandler<CreateObjectStorageLinkRequest,CreateObjectStorageLinkResponse> handler)

Description copied from interface: LustreFileStorageAsync

Creates an Object Storage link.

Specified by:

createObjectStorageLink in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteLustreFileSystem

public Future<DeleteLustreFileSystemResponse> deleteLustreFileSystem(DeleteLustreFileSystemRequest request,
                                                                     AsyncHandler<DeleteLustreFileSystemRequest,DeleteLustreFileSystemResponse> handler)

Description copied from interface: LustreFileStorageAsync

Deletes a Lustre file system.

Specified by:

deleteLustreFileSystem in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteObjectStorageLink

public Future<DeleteObjectStorageLinkResponse> deleteObjectStorageLink(DeleteObjectStorageLinkRequest request,
                                                                       AsyncHandler<DeleteObjectStorageLinkRequest,DeleteObjectStorageLinkResponse> handler)

Description copied from interface: LustreFileStorageAsync

Deletes an Object Storage link.

Specified by:

deleteObjectStorageLink in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getLustreFileSystem

public Future<GetLustreFileSystemResponse> getLustreFileSystem(GetLustreFileSystemRequest request,
                                                               AsyncHandler<GetLustreFileSystemRequest,GetLustreFileSystemResponse> handler)

Description copied from interface: LustreFileStorageAsync

Gets information about a Lustre file system.

Specified by:

getLustreFileSystem in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getObjectStorageLink

public Future<GetObjectStorageLinkResponse> getObjectStorageLink(GetObjectStorageLinkRequest request,
                                                                 AsyncHandler<GetObjectStorageLinkRequest,GetObjectStorageLinkResponse> handler)

Description copied from interface: LustreFileStorageAsync

Gets information about an Object Storage link.

Specified by:

getObjectStorageLink in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSyncJob

public Future<GetSyncJobResponse> getSyncJob(GetSyncJobRequest request,
                                             AsyncHandler<GetSyncJobRequest,GetSyncJobResponse> handler)

Description copied from interface: LustreFileStorageAsync

Gets details of a sync job associated with an Object Storage link when objectStorageLink and a unique ID are provided.

Specified by:

getSyncJob in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: LustreFileStorageAsync

Gets the details of a work request.

Specified by:

getWorkRequest in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listLustreFileSystems

public Future<ListLustreFileSystemsResponse> listLustreFileSystems(ListLustreFileSystemsRequest request,
                                                                   AsyncHandler<ListLustreFileSystemsRequest,ListLustreFileSystemsResponse> handler)

Description copied from interface: LustreFileStorageAsync

Gets a list of Lustre file systems.

Specified by:

listLustreFileSystems in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listObjectStorageLinks

public Future<ListObjectStorageLinksResponse> listObjectStorageLinks(ListObjectStorageLinksRequest request,
                                                                     AsyncHandler<ListObjectStorageLinksRequest,ListObjectStorageLinksResponse> handler)

Description copied from interface: LustreFileStorageAsync

Gets a list of Object Storage links.

Specified by:

listObjectStorageLinks in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSyncJobs

public Future<ListSyncJobsResponse> listSyncJobs(ListSyncJobsRequest request,
                                                 AsyncHandler<ListSyncJobsRequest,ListSyncJobsResponse> handler)

Description copied from interface: LustreFileStorageAsync

Lists all sync jobs associated with the Object Storage link.

Contains a unique ID for each sync job.

Specified by:

listSyncJobs in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: LustreFileStorageAsync

Lists the errors for a work request.

Specified by:

listWorkRequestErrors in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: LustreFileStorageAsync

Lists the logs for a work request.

Specified by:

listWorkRequestLogs in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: LustreFileStorageAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

startExportToObject

public Future<StartExportToObjectResponse> startExportToObject(StartExportToObjectRequest request,
                                                               AsyncHandler<StartExportToObjectRequest,StartExportToObjectResponse> handler)

Description copied from interface: LustreFileStorageAsync

Starts the export of data from the Lustre file system to Object Storage.

The Lustre file system path and Object Storage object prefix are defined in the Object Storage link resource.

Specified by:

startExportToObject in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

startImportFromObject

public Future<StartImportFromObjectResponse> startImportFromObject(StartImportFromObjectRequest request,
                                                                   AsyncHandler<StartImportFromObjectRequest,StartImportFromObjectResponse> handler)

Description copied from interface: LustreFileStorageAsync

Starts the import of data from Object Storage to the Lustre file system.

The Lustre file system path and Object Storage object prefix are defined in the Object Storage link resource.

Specified by:

startImportFromObject in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

stopExportToObject

public Future<StopExportToObjectResponse> stopExportToObject(StopExportToObjectRequest request,
                                                             AsyncHandler<StopExportToObjectRequest,StopExportToObjectResponse> handler)

Description copied from interface: LustreFileStorageAsync

Stops the export of data from the Lustre file system to Object Storage.

The Lustre file system path and Object Storage object prefix are defined in the Object Storage link resource.

Specified by:

stopExportToObject in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

stopImportFromObject

public Future<StopImportFromObjectResponse> stopImportFromObject(StopImportFromObjectRequest request,
                                                                 AsyncHandler<StopImportFromObjectRequest,StopImportFromObjectResponse> handler)

Description copied from interface: LustreFileStorageAsync

Stops the import of data from Object Storage to the Lustre file system.

The Lustre file system path and Object Storage object prefix are defined in the Object Storage link resource.

Specified by:

stopImportFromObject in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateLustreFileSystem

public Future<UpdateLustreFileSystemResponse> updateLustreFileSystem(UpdateLustreFileSystemRequest request,
                                                                     AsyncHandler<UpdateLustreFileSystemRequest,UpdateLustreFileSystemResponse> handler)

Description copied from interface: LustreFileStorageAsync

Updates a Lustre file system.

Specified by:

updateLustreFileSystem in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateObjectStorageLink

public Future<UpdateObjectStorageLinkResponse> updateObjectStorageLink(UpdateObjectStorageLinkRequest request,
                                                                       AsyncHandler<UpdateObjectStorageLinkRequest,UpdateObjectStorageLinkResponse> handler)

Description copied from interface: LustreFileStorageAsync

Updates an Object Storage link.

Specified by:

updateObjectStorageLink in interface LustreFileStorageAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)