com.oracle.bmc.bds

Interface Bds

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BdsClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190531")
public interface Bds
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
AddAutoScalingConfigurationResponse	addAutoScalingConfiguration(AddAutoScalingConfigurationRequest request) Add autoscaling configuration.
AddBlockStorageResponse	addBlockStorage(AddBlockStorageRequest request) Adds storage to existing worker nodes.
AddCloudSqlResponse	addCloudSql(AddCloudSqlRequest request) Adds Cloud SQL to your cluster.
AddWorkerNodesResponse	addWorkerNodes(AddWorkerNodesRequest request) Add worker nodes to an existing cluster.
ChangeBdsInstanceCompartmentResponse	changeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest request) Moves a BDS instance into a different compartment.
ChangeShapeResponse	changeShape(ChangeShapeRequest request) Scale-up/down individial nodes (per role type) in the cluster.
CreateBdsInstanceResponse	createBdsInstance(CreateBdsInstanceRequest request) Creates a new BDS instance.
DeleteBdsInstanceResponse	deleteBdsInstance(DeleteBdsInstanceRequest request) Deletes a BDS instance by identifier
GetAutoScalingConfigurationResponse	getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request) Gets information about the specified autoscaling configuration.
GetBdsInstanceResponse	getBdsInstance(GetBdsInstanceRequest request) Gets a BDS instance by identifier
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
BdsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
BdsWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the status of the work request with the given ID.
ListAutoScalingConfigurationsResponse	listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request) Gets information about the autoscaling configuration.
ListBdsInstancesResponse	listBdsInstances(ListBdsInstancesRequest request) Returns a list of BDS instances.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Return a (paginated) list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Return a (paginated) list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Lists the work requests in a compartment.
RemoveAutoScalingConfigurationResponse	removeAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest request) Remove autoscaling configuration.
RemoveCloudSqlResponse	removeCloudSql(RemoveCloudSqlRequest request) Remove Cloud SQL capability.
RestartNodeResponse	restartNode(RestartNodeRequest request) 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’).
UpdateAutoScalingConfigurationResponse	updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request) Updates certain fields on the specified autoscaling configuration, such as the name, the threshold value, and whether the autoscaling configuration is enabled.
UpdateBdsInstanceResponse	updateBdsInstance(UpdateBdsInstanceRequest request) 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 service.

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

AddAutoScalingConfigurationResponse addAutoScalingConfiguration(AddAutoScalingConfigurationRequest request)

Add autoscaling configuration.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use AddAutoScalingConfiguration API.

addBlockStorage

AddBlockStorageResponse addBlockStorage(AddBlockStorageRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use AddBlockStorage API.

addCloudSql

AddCloudSqlResponse addCloudSql(AddCloudSqlRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use AddCloudSql API.

addWorkerNodes

AddWorkerNodesResponse addWorkerNodes(AddWorkerNodesRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use AddWorkerNodes API.

changeBdsInstanceCompartment

ChangeBdsInstanceCompartmentResponse changeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest request)

Moves a BDS instance into a different compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeBdsInstanceCompartment API.

changeShape

ChangeShapeResponse changeShape(ChangeShapeRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeShape API.

createBdsInstance

CreateBdsInstanceResponse createBdsInstance(CreateBdsInstanceRequest request)

Creates a new BDS instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateBdsInstance API.

deleteBdsInstance

DeleteBdsInstanceResponse deleteBdsInstance(DeleteBdsInstanceRequest request)

Deletes a BDS instance by identifier

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteBdsInstance API.

getAutoScalingConfiguration

GetAutoScalingConfigurationResponse getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request)

Gets information about the specified autoscaling configuration.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetAutoScalingConfiguration API.

getBdsInstance

GetBdsInstanceResponse getBdsInstance(GetBdsInstanceRequest request)

Gets a BDS instance by identifier

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetBdsInstance API.

getWorkRequest

GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetWorkRequest API.

listAutoScalingConfigurations

ListAutoScalingConfigurationsResponse listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)

Gets information about the autoscaling configuration.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListAutoScalingConfigurations API.

listBdsInstances

ListBdsInstancesResponse listBdsInstances(ListBdsInstancesRequest request)

Returns a list of BDS instances.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListBdsInstances API.

listWorkRequestErrors

ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequestErrors API.

listWorkRequestLogs

ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequestLogs API.

listWorkRequests

ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Lists the work requests in a compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequests API.

removeAutoScalingConfiguration

RemoveAutoScalingConfigurationResponse removeAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest request)

Remove autoscaling configuration.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use RemoveAutoScalingConfiguration API.

removeCloudSql

RemoveCloudSqlResponse removeCloudSql(RemoveCloudSqlRequest request)

Remove Cloud SQL capability.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use RemoveCloudSql API.

restartNode

RestartNodeResponse restartNode(RestartNodeRequest request)

Restarts a single node of a BDS instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use RestartNode API.

updateAutoScalingConfiguration

UpdateAutoScalingConfigurationResponse updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateAutoScalingConfiguration API.

updateBdsInstance

UpdateBdsInstanceResponse updateBdsInstance(UpdateBdsInstanceRequest request)

Update the BDS instance identified by the id

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateBdsInstance API.

getWaiters

BdsWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

BdsPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.