com.oracle.bmc.oda

Interface OdapackageAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

OdapackageAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190506")
public interface OdapackageAsync
extends AutoCloseable

API to create and maintain Oracle Digital Assistant service instances.

Method Summary

Modifier and Type	Method and Description
Future<CreateImportedPackageResponse>	createImportedPackage(CreateImportedPackageRequest request, AsyncHandler<CreateImportedPackageRequest,CreateImportedPackageResponse> handler) Starts an asynchronous job to import a package into a Digital Assistant instance.
Future<DeleteImportedPackageResponse>	deleteImportedPackage(DeleteImportedPackageRequest request, AsyncHandler<DeleteImportedPackageRequest,DeleteImportedPackageResponse> handler) Starts an asynchronous job to delete a package from a Digital Assistant instance.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetImportedPackageResponse>	getImportedPackage(GetImportedPackageRequest request, AsyncHandler<GetImportedPackageRequest,GetImportedPackageResponse> handler) Returns a list of summaries for imported packages in the instance.
Future<GetPackageResponse>	getPackage(GetPackageRequest request, AsyncHandler<GetPackageRequest,GetPackageResponse> handler) Returns details about a package, and how to import it.
Future<ListImportedPackagesResponse>	listImportedPackages(ListImportedPackagesRequest request, AsyncHandler<ListImportedPackagesRequest,ListImportedPackagesResponse> handler) Returns a list of summaries for imported packages in the instance.
Future<ListPackagesResponse>	listPackages(ListPackagesRequest request, AsyncHandler<ListPackagesRequest,ListPackagesResponse> handler) Returns a page of summaries for packages that are available for import.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
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<UpdateImportedPackageResponse>	updateImportedPackage(UpdateImportedPackageRequest request, AsyncHandler<UpdateImportedPackageRequest,UpdateImportedPackageResponse> handler) Starts an asynchronous job to update a package within a Digital Assistant instance.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

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.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

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.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

createImportedPackage

Future<CreateImportedPackageResponse> createImportedPackage(CreateImportedPackageRequest request,
                                                            AsyncHandler<CreateImportedPackageRequest,CreateImportedPackageResponse> handler)

Starts an asynchronous job to import a package into a Digital Assistant instance.

To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.

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.

deleteImportedPackage

Future<DeleteImportedPackageResponse> deleteImportedPackage(DeleteImportedPackageRequest request,
                                                            AsyncHandler<DeleteImportedPackageRequest,DeleteImportedPackageResponse> handler)

Starts an asynchronous job to delete a package from a Digital Assistant instance.

To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.

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.

getImportedPackage

Future<GetImportedPackageResponse> getImportedPackage(GetImportedPackageRequest request,
                                                      AsyncHandler<GetImportedPackageRequest,GetImportedPackageResponse> handler)

Returns a list of summaries for imported packages in the instance.

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.

getPackage

Future<GetPackageResponse> getPackage(GetPackageRequest request,
                                      AsyncHandler<GetPackageRequest,GetPackageResponse> handler)

Returns details about a package, and how to import it.

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.

listImportedPackages

Future<ListImportedPackagesResponse> listImportedPackages(ListImportedPackagesRequest request,
                                                          AsyncHandler<ListImportedPackagesRequest,ListImportedPackagesResponse> handler)

Returns a list of summaries for imported packages in the instance.

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.

listPackages

Future<ListPackagesResponse> listPackages(ListPackagesRequest request,
                                          AsyncHandler<ListPackagesRequest,ListPackagesResponse> handler)

Returns a page of summaries for packages that are available for import. The optional odaInstanceId query parameter can be used to filter packages that are available for import by a specific instance. If odaInstanceId query parameter is not provided, the returned list will include packages available within the region indicated by the request URL. The optional resourceType query param may be specified to filter packages that contain the indicated resource type. If no resourceType query param is given, packages containing all resource types will be returned. The optional name query parameter can be used to limit the list to packages whose name matches the given name. The optional displayName query parameter can be used to limit the list to packages whose displayName matches the given name. The optional isLatestVersionOnly query parameter can be used to limit the returned list to include only the latest version of any given package. If not specified, all versions of any otherwise matching package will be returned.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

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.

updateImportedPackage

Future<UpdateImportedPackageResponse> updateImportedPackage(UpdateImportedPackageRequest request,
                                                            AsyncHandler<UpdateImportedPackageRequest,UpdateImportedPackageResponse> handler)

Starts an asynchronous job to update a package within a Digital Assistant instance.

To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.

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.