com.oracle.bmc.bds

Interface BdsAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BdsAsyncClient

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

API for the Big Data Service. Use this API to build, deploy, and manage fully elastic Big Data Service build on Hadoop, Spark and Data Science distribution, which can be fully integrated with existing enterprise data in Oracle Database and Oracle Applications..

Method Summary

Modifier and Type	Method and Description
Future<AddAutoScalingConfigurationResponse>	addAutoScalingConfiguration(AddAutoScalingConfigurationRequest request, AsyncHandler<AddAutoScalingConfigurationRequest,AddAutoScalingConfigurationResponse> handler) Add autoscaling configuration.
Future<AddBlockStorageResponse>	addBlockStorage(AddBlockStorageRequest request, AsyncHandler<AddBlockStorageRequest,AddBlockStorageResponse> handler) Adds storage to existing worker nodes.
Future<AddCloudSqlResponse>	addCloudSql(AddCloudSqlRequest request, AsyncHandler<AddCloudSqlRequest,AddCloudSqlResponse> handler) Adds Cloud SQL to your cluster.
Future<AddWorkerNodesResponse>	addWorkerNodes(AddWorkerNodesRequest request, AsyncHandler<AddWorkerNodesRequest,AddWorkerNodesResponse> handler) Add worker nodes to an existing cluster.
Future<ChangeBdsInstanceCompartmentResponse>	changeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest request, AsyncHandler<ChangeBdsInstanceCompartmentRequest,ChangeBdsInstanceCompartmentResponse> handler) Moves a BDS instance into a different compartment.
Future<ChangeShapeResponse>	changeShape(ChangeShapeRequest request, AsyncHandler<ChangeShapeRequest,ChangeShapeResponse> handler) Scale-up/down individial nodes (per role type) in the cluster.
Future<CreateBdsInstanceResponse>	createBdsInstance(CreateBdsInstanceRequest request, AsyncHandler<CreateBdsInstanceRequest,CreateBdsInstanceResponse> handler) Creates a new BDS instance.
Future<DeleteBdsInstanceResponse>	deleteBdsInstance(DeleteBdsInstanceRequest request, AsyncHandler<DeleteBdsInstanceRequest,DeleteBdsInstanceResponse> handler) Deletes a BDS instance by identifier
Future<GetAutoScalingConfigurationResponse>	getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request, AsyncHandler<GetAutoScalingConfigurationRequest,GetAutoScalingConfigurationResponse> handler) Gets information about the specified autoscaling configuration.
Future<GetBdsInstanceResponse>	getBdsInstance(GetBdsInstanceRequest request, AsyncHandler<GetBdsInstanceRequest,GetBdsInstanceResponse> handler) Gets a BDS instance by identifier
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the work request with the given ID.
Future<ListAutoScalingConfigurationsResponse>	listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request, AsyncHandler<ListAutoScalingConfigurationsRequest,ListAutoScalingConfigurationsResponse> handler) Gets information about the autoscaling configuration.
Future<ListBdsInstancesResponse>	listBdsInstances(ListBdsInstancesRequest request, AsyncHandler<ListBdsInstancesRequest,ListBdsInstancesResponse> handler) Returns a list of BDS instances.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Return a (paginated) list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Return a (paginated) list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in a compartment.
Future<RemoveAutoScalingConfigurationResponse>	removeAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest request, AsyncHandler<RemoveAutoScalingConfigurationRequest,RemoveAutoScalingConfigurationResponse> handler) Remove autoscaling configuration.
Future<RemoveCloudSqlResponse>	removeCloudSql(RemoveCloudSqlRequest request, AsyncHandler<RemoveCloudSqlRequest,RemoveCloudSqlResponse> handler) Remove Cloud SQL capability.
Future<RestartNodeResponse>	restartNode(RestartNodeRequest request, AsyncHandler<RestartNodeRequest,RestartNodeResponse> handler) Restarts a single node of a BDS instance.
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<UpdateAutoScalingConfigurationResponse>	updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request, AsyncHandler<UpdateAutoScalingConfigurationRequest,UpdateAutoScalingConfigurationResponse> handler) Updates certain fields on the specified autoscaling configuration, such as the name, the threshold value, and whether the autoscaling configuration is enabled.
Future<UpdateBdsInstanceResponse>	updateBdsInstance(UpdateBdsInstanceRequest request, AsyncHandler<UpdateBdsInstanceRequest,UpdateBdsInstanceResponse> handler) Update the BDS instance identified by the id

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

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.

addAutoScalingConfiguration

Future<AddAutoScalingConfigurationResponse> addAutoScalingConfiguration(AddAutoScalingConfigurationRequest request,
                                                                        AsyncHandler<AddAutoScalingConfigurationRequest,AddAutoScalingConfigurationResponse> handler)

Add autoscaling configuration.

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.

addBlockStorage

Future<AddBlockStorageResponse> addBlockStorage(AddBlockStorageRequest request,
                                                AsyncHandler<AddBlockStorageRequest,AddBlockStorageResponse> handler)

Adds storage to existing worker nodes. The same amount of storage will be added to all workers. No change will be made to already attached storage. Block Storage once added cannot be removed.

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.

addCloudSql

Future<AddCloudSqlResponse> addCloudSql(AddCloudSqlRequest request,
                                        AsyncHandler<AddCloudSqlRequest,AddCloudSqlResponse> handler)

Adds Cloud SQL to your cluster. This will add a query server node to the cluster and create cell servers on all your worker nodes.

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.

addWorkerNodes

Future<AddWorkerNodesResponse> addWorkerNodes(AddWorkerNodesRequest request,
                                              AsyncHandler<AddWorkerNodesRequest,AddWorkerNodesResponse> handler)

Add worker nodes to an existing cluster. The worker nodes added will be based on an identical shape and have the same amount of attached block storage as other worker nodes in the cluster.

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.

changeBdsInstanceCompartment

Future<ChangeBdsInstanceCompartmentResponse> changeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest request,
                                                                          AsyncHandler<ChangeBdsInstanceCompartmentRequest,ChangeBdsInstanceCompartmentResponse> handler)

Moves a BDS instance into a different compartment.

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.

changeShape

Future<ChangeShapeResponse> changeShape(ChangeShapeRequest request,
                                        AsyncHandler<ChangeShapeRequest,ChangeShapeResponse> handler)

Scale-up/down individial nodes (per role type) in the cluster. Customer can choose arbitrarty VM_STANDARD shape to scale-up/down the instance. Only VM_STANDARD nodes can be re-shaped.

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.

createBdsInstance

Future<CreateBdsInstanceResponse> createBdsInstance(CreateBdsInstanceRequest request,
                                                    AsyncHandler<CreateBdsInstanceRequest,CreateBdsInstanceResponse> handler)

Creates a new BDS 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.

deleteBdsInstance

Future<DeleteBdsInstanceResponse> deleteBdsInstance(DeleteBdsInstanceRequest request,
                                                    AsyncHandler<DeleteBdsInstanceRequest,DeleteBdsInstanceResponse> handler)

Deletes a BDS instance by identifier

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.

getAutoScalingConfiguration

Future<GetAutoScalingConfigurationResponse> getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request,
                                                                        AsyncHandler<GetAutoScalingConfigurationRequest,GetAutoScalingConfigurationResponse> handler)

Gets information about the specified autoscaling configuration.

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.

getBdsInstance

Future<GetBdsInstanceResponse> getBdsInstance(GetBdsInstanceRequest request,
                                              AsyncHandler<GetBdsInstanceRequest,GetBdsInstanceResponse> handler)

Gets a BDS instance by identifier

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

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

Gets the status of the work request with the given ID.

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.

listAutoScalingConfigurations

Future<ListAutoScalingConfigurationsResponse> listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request,
                                                                            AsyncHandler<ListAutoScalingConfigurationsRequest,ListAutoScalingConfigurationsResponse> handler)

Gets information about the autoscaling configuration.

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.

listBdsInstances

Future<ListBdsInstancesResponse> listBdsInstances(ListBdsInstancesRequest request,
                                                  AsyncHandler<ListBdsInstancesRequest,ListBdsInstancesResponse> handler)

Returns a list of BDS instances.

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

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

Return a (paginated) list of errors for a given work request.

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

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

Return a (paginated) list of logs for a given work request.

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

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

Lists the work requests in a compartment.

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.

removeAutoScalingConfiguration

Future<RemoveAutoScalingConfigurationResponse> removeAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest request,
                                                                              AsyncHandler<RemoveAutoScalingConfigurationRequest,RemoveAutoScalingConfigurationResponse> handler)

Remove autoscaling configuration.

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.

removeCloudSql

Future<RemoveCloudSqlResponse> removeCloudSql(RemoveCloudSqlRequest request,
                                              AsyncHandler<RemoveCloudSqlRequest,RemoveCloudSqlResponse> handler)

Remove Cloud SQL capability.

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.

restartNode

Future<RestartNodeResponse> restartNode(RestartNodeRequest request,
                                        AsyncHandler<RestartNodeRequest,RestartNodeResponse> handler)

Restarts a single node of a BDS 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.

updateAutoScalingConfiguration

Future<UpdateAutoScalingConfigurationResponse> updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request,
                                                                              AsyncHandler<UpdateAutoScalingConfigurationRequest,UpdateAutoScalingConfigurationResponse> handler)

Updates certain fields on the specified autoscaling configuration, such as the name, the threshold value, and whether the autoscaling configuration is enabled.

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.

updateBdsInstance

Future<UpdateBdsInstanceResponse> updateBdsInstance(UpdateBdsInstanceRequest request,
                                                    AsyncHandler<UpdateBdsInstanceRequest,UpdateBdsInstanceResponse> handler)

Update the BDS instance identified by the id

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.