Bds (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BdsClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190531")
public interface Bds
extends AutoCloseable
```
REST API for Oracle Big Data Service. Use this API to build, deploy, and manage fully elastic Big Data Service clusters. Build on Hadoop, Spark and Data Science distributions, which can be fully integrated with existing enterprise data in Oracle Database and Oracle applications.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ActivateBdsMetastoreConfigurationResponse`	`activateBdsMetastoreConfiguration(ActivateBdsMetastoreConfigurationRequest request)` Activate specified metastore configuration.
`AddAutoScalingConfigurationResponse`	`addAutoScalingConfiguration(AddAutoScalingConfigurationRequest request)` Add an autoscale configuration to the cluster.
`AddBlockStorageResponse`	`addBlockStorage(AddBlockStorageRequest request)` Adds block storage to existing worker/compute only worker nodes.
`AddCloudSqlResponse`	`addCloudSql(AddCloudSqlRequest request)` Adds Cloud SQL to your cluster.
`AddWorkerNodesResponse`	`addWorkerNodes(AddWorkerNodesRequest request)` Increases the size (scales out) a cluster by adding worker nodes(data/compute).
`ChangeBdsInstanceCompartmentResponse`	`changeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest request)` Moves a Big Data Service cluster into a different compartment.
`ChangeShapeResponse`	`changeShape(ChangeShapeRequest request)` Changes the size of a cluster by scaling up or scaling down the nodes.
`CreateBdsApiKeyResponse`	`createBdsApiKey(CreateBdsApiKeyRequest request)` Create an API key on behalf of the specified user.
`CreateBdsInstanceResponse`	`createBdsInstance(CreateBdsInstanceRequest request)` Creates a Big Data Service cluster.
`CreateBdsMetastoreConfigurationResponse`	`createBdsMetastoreConfiguration(CreateBdsMetastoreConfigurationRequest request)` Create and activate external metastore configuration.
`DeleteBdsApiKeyResponse`	`deleteBdsApiKey(DeleteBdsApiKeyRequest request)` Deletes the user’s API key represented by the provided ID.
`DeleteBdsInstanceResponse`	`deleteBdsInstance(DeleteBdsInstanceRequest request)` Deletes the cluster identified by the given ID.
`DeleteBdsMetastoreConfigurationResponse`	`deleteBdsMetastoreConfiguration(DeleteBdsMetastoreConfigurationRequest request)` Delete the BDS metastore configuration represented by the provided ID.
`ExecuteBootstrapScriptResponse`	`executeBootstrapScript(ExecuteBootstrapScriptRequest request)` Execute bootstrap script.
`GetAutoScalingConfigurationResponse`	`getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request)` Returns details of the autoscale configuration identified by the given ID.
`GetBdsApiKeyResponse`	`getBdsApiKey(GetBdsApiKeyRequest request)` Returns the user’s API key information for the given ID.
`GetBdsInstanceResponse`	`getBdsInstance(GetBdsInstanceRequest request)` Returns information about the Big Data Service cluster identified by the given ID.
`GetBdsMetastoreConfigurationResponse`	`getBdsMetastoreConfiguration(GetBdsMetastoreConfigurationRequest request)` Returns the BDS Metastore configuration information for the given ID.
`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)` Returns the status of the work request identified by the given ID.
`InstallPatchResponse`	`installPatch(InstallPatchRequest request)` Install the specified patch to this cluster.
`ListAutoScalingConfigurationsResponse`	`listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)` Returns information about the autoscaling configurations for a cluster.
`ListBdsApiKeysResponse`	`listBdsApiKeys(ListBdsApiKeysRequest request)` Returns a list of all API keys associated with this Big Data Service cluster.
`ListBdsInstancesResponse`	`listBdsInstances(ListBdsInstancesRequest request)` Returns a list of all Big Data Service clusters in a compartment.
`ListBdsMetastoreConfigurationsResponse`	`listBdsMetastoreConfigurations(ListBdsMetastoreConfigurationsRequest request)` Returns a list of metastore configurations ssociated with this Big Data Service cluster.
`ListPatchesResponse`	`listPatches(ListPatchesRequest request)` List all the available patches for this cluster.
`ListPatchHistoriesResponse`	`listPatchHistories(ListPatchHistoriesRequest request)` List the patch history of this cluster.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)` Returns a paginated list of errors for a work request identified by the given ID.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)` Returns a paginated list of logs for a given work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)` Lists the work requests in a compartment.
`void`	`refreshClient()` Rebuilds the client from scratch.
`RemoveAutoScalingConfigurationResponse`	`removeAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest request)` Deletes an autoscale configuration.
`RemoveCloudSqlResponse`	`removeCloudSql(RemoveCloudSqlRequest request)` Removes Cloud SQL from the cluster.
`RemoveNodeResponse`	`removeNode(RemoveNodeRequest request)` Remove a single node of a Big Data Service cluster
`RestartNodeResponse`	`restartNode(RestartNodeRequest request)` Restarts a single node of a Big Data Service cluster
`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’).
`StartBdsInstanceResponse`	`startBdsInstance(StartBdsInstanceRequest request)` Starts the BDS cluster that was stopped earlier.
`StopBdsInstanceResponse`	`stopBdsInstance(StopBdsInstanceRequest request)` Stops the BDS cluster that can be started at later point of time.
`TestBdsMetastoreConfigurationResponse`	`testBdsMetastoreConfiguration(TestBdsMetastoreConfigurationRequest request)` Test specified metastore configuration.
`TestBdsObjectStorageConnectionResponse`	`testBdsObjectStorageConnection(TestBdsObjectStorageConnectionRequest request)` Test access to specified Object Storage bucket using the API key.
`UpdateAutoScalingConfigurationResponse`	`updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request)` Updates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale configuration is enabled.
`UpdateBdsInstanceResponse`	`updateBdsInstance(UpdateBdsInstanceRequest request)` Updates the Big Data Service cluster identified by the given ID.
`UpdateBdsMetastoreConfigurationResponse`	`updateBdsMetastoreConfiguration(UpdateBdsMetastoreConfigurationRequest request)` Update the BDS metastore configuration represented by the provided ID.
`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 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.
  - 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
  - activateBdsMetastoreConfiguration
```
ActivateBdsMetastoreConfigurationResponse activateBdsMetastoreConfiguration(ActivateBdsMetastoreConfigurationRequest request)
```
    Activate specified metastore 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ActivateBdsMetastoreConfiguration API.
  - addAutoScalingConfiguration
```
AddAutoScalingConfigurationResponse addAutoScalingConfiguration(AddAutoScalingConfigurationRequest request)
```
    Add an autoscale configuration to 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use AddAutoScalingConfiguration API.
  - addBlockStorage
```
AddBlockStorageResponse addBlockStorage(AddBlockStorageRequest request)
```
    Adds block storage to existing worker/compute only worker nodes. The same amount of storage will be added to all worker/compute only worker nodes. No change will be made to storage that is already attached. Block storage 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use AddBlockStorage API.
  - addCloudSql
```
AddCloudSqlResponse addCloudSql(AddCloudSqlRequest request)
```
    Adds Cloud SQL to your cluster. You can use Cloud SQL to query against non-relational data stored in multiple big data sources, including Apache Hive, HDFS, Oracle NoSQL Database, and Apache HBase. Adding Cloud SQL adds a query server node to the cluster and creates cell servers on all the 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use AddCloudSql API.
  - addWorkerNodes
```
AddWorkerNodesResponse addWorkerNodes(AddWorkerNodesRequest request)
```
    Increases the size (scales out) a cluster by adding worker nodes(data/compute). The added worker nodes will have the same shape and will 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use AddWorkerNodes API.
  - changeBdsInstanceCompartment
```
ChangeBdsInstanceCompartmentResponse changeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest request)
```
    Moves a Big Data Service cluster 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeBdsInstanceCompartment API.
  - changeShape
```
ChangeShapeResponse changeShape(ChangeShapeRequest request)
```
    Changes the size of a cluster by scaling up or scaling down the nodes. Nodes are scaled up or down by changing the shapes of all the nodes of the same type to the next larger or smaller shape. The node types are master, utility, worker, and Cloud SQL. Only nodes with VM-STANDARD shapes can be scaled.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeShape API.
  - createBdsApiKey
```
CreateBdsApiKeyResponse createBdsApiKey(CreateBdsApiKeyRequest request)
```
    Create an API key on behalf of the specified user.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateBdsApiKey API.
  - createBdsInstance
```
CreateBdsInstanceResponse createBdsInstance(CreateBdsInstanceRequest request)
```
    Creates a Big Data Service 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateBdsInstance API.
  - createBdsMetastoreConfiguration
```
CreateBdsMetastoreConfigurationResponse createBdsMetastoreConfiguration(CreateBdsMetastoreConfigurationRequest request)
```
    Create and activate external metastore 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateBdsMetastoreConfiguration API.
  - deleteBdsApiKey
```
DeleteBdsApiKeyResponse deleteBdsApiKey(DeleteBdsApiKeyRequest request)
```
    Deletes the user’s API key represented by the provided 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteBdsApiKey API.
  - deleteBdsInstance
```
DeleteBdsInstanceResponse deleteBdsInstance(DeleteBdsInstanceRequest request)
```
    Deletes the cluster identified by 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteBdsInstance API.
  - deleteBdsMetastoreConfiguration
```
DeleteBdsMetastoreConfigurationResponse deleteBdsMetastoreConfiguration(DeleteBdsMetastoreConfigurationRequest request)
```
    Delete the BDS metastore configuration represented by the provided 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteBdsMetastoreConfiguration API.
  - executeBootstrapScript
```
ExecuteBootstrapScriptResponse executeBootstrapScript(ExecuteBootstrapScriptRequest request)
```
    Execute bootstrap script.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ExecuteBootstrapScript API.
  - getAutoScalingConfiguration
```
GetAutoScalingConfigurationResponse getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request)
```
    Returns details of the autoscale configuration identified by 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetAutoScalingConfiguration API.
  - getBdsApiKey
```
GetBdsApiKeyResponse getBdsApiKey(GetBdsApiKeyRequest request)
```
    Returns the user’s API key information for 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetBdsApiKey API.
  - getBdsInstance
```
GetBdsInstanceResponse getBdsInstance(GetBdsInstanceRequest request)
```
    Returns information about the Big Data Service cluster identified by 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetBdsInstance API.
  - getBdsMetastoreConfiguration
```
GetBdsMetastoreConfigurationResponse getBdsMetastoreConfiguration(GetBdsMetastoreConfigurationRequest request)
```
    Returns the BDS Metastore configuration information for 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetBdsMetastoreConfiguration API.
  - getWorkRequest
```
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Returns the status of the work request identified by 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetWorkRequest API.
  - installPatch
```
InstallPatchResponse installPatch(InstallPatchRequest request)
```
    Install the specified patch to this 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use InstallPatch API.
  - listAutoScalingConfigurations
```
ListAutoScalingConfigurationsResponse listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)
```
    Returns information about the autoscaling configurations for a 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListAutoScalingConfigurations API.
  - listBdsApiKeys
```
ListBdsApiKeysResponse listBdsApiKeys(ListBdsApiKeysRequest request)
```
    Returns a list of all API keys associated with this Big Data Service 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListBdsApiKeys API.
  - listBdsInstances
```
ListBdsInstancesResponse listBdsInstances(ListBdsInstancesRequest request)
```
    Returns a list of all Big Data Service clusters 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListBdsInstances API.
  - listBdsMetastoreConfigurations
```
ListBdsMetastoreConfigurationsResponse listBdsMetastoreConfigurations(ListBdsMetastoreConfigurationsRequest request)
```
    Returns a list of metastore configurations ssociated with this Big Data Service 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListBdsMetastoreConfigurations API.
  - listPatchHistories
```
ListPatchHistoriesResponse listPatchHistories(ListPatchHistoriesRequest request)
```
    List the patch history of this 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListPatchHistories API.
  - listPatches
```
ListPatchesResponse listPatches(ListPatchesRequest request)
```
    List all the available patches for this 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListPatches API.
  - listWorkRequestErrors
```
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Returns a paginated list of errors for a work request identified by 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestErrors API.
  - listWorkRequestLogs
```
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Returns 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequests API.
  - removeAutoScalingConfiguration
```
RemoveAutoScalingConfigurationResponse removeAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest request)
```
    Deletes an autoscale 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RemoveAutoScalingConfiguration API.
  - removeCloudSql
```
RemoveCloudSqlResponse removeCloudSql(RemoveCloudSqlRequest request)
```
    Removes Cloud SQL from 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RemoveCloudSql API.
  - removeNode
```
RemoveNodeResponse removeNode(RemoveNodeRequest request)
```
    Remove a single node of a Big Data Service 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RemoveNode API.
  - restartNode
```
RestartNodeResponse restartNode(RestartNodeRequest request)
```
    Restarts a single node of a Big Data Service 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RestartNode API.
  - startBdsInstance
```
StartBdsInstanceResponse startBdsInstance(StartBdsInstanceRequest request)
```
    Starts the BDS cluster that was stopped earlier.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use StartBdsInstance API.
  - stopBdsInstance
```
StopBdsInstanceResponse stopBdsInstance(StopBdsInstanceRequest request)
```
    Stops the BDS cluster that can be started at later point of time.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use StopBdsInstance API.
  - testBdsMetastoreConfiguration
```
TestBdsMetastoreConfigurationResponse testBdsMetastoreConfiguration(TestBdsMetastoreConfigurationRequest request)
```
    Test specified metastore 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use TestBdsMetastoreConfiguration API.
  - testBdsObjectStorageConnection
```
TestBdsObjectStorageConnectionResponse testBdsObjectStorageConnection(TestBdsObjectStorageConnectionRequest request)
```
    Test access to specified Object Storage bucket using the API key.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use TestBdsObjectStorageConnection API.
  - updateAutoScalingConfiguration
```
UpdateAutoScalingConfigurationResponse updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request)
```
    Updates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateAutoScalingConfiguration API.
  - updateBdsInstance
```
UpdateBdsInstanceResponse updateBdsInstance(UpdateBdsInstanceRequest request)
```
    Updates the Big Data Service cluster identified by 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateBdsInstance API.
  - updateBdsMetastoreConfiguration
```
UpdateBdsMetastoreConfigurationResponse updateBdsMetastoreConfiguration(UpdateBdsMetastoreConfigurationRequest request)
```
    Update the BDS metastore configuration represented by the provided 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateBdsMetastoreConfiguration 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.

Interface Bds

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

activateBdsMetastoreConfiguration

addAutoScalingConfiguration

addBlockStorage

addCloudSql

addWorkerNodes

changeBdsInstanceCompartment

changeShape

createBdsApiKey

createBdsInstance

createBdsMetastoreConfiguration

deleteBdsApiKey

deleteBdsInstance

deleteBdsMetastoreConfiguration

executeBootstrapScript

getAutoScalingConfiguration

getBdsApiKey

getBdsInstance

getBdsMetastoreConfiguration

getWorkRequest

installPatch

listAutoScalingConfigurations

listBdsApiKeys

listBdsInstances

listBdsMetastoreConfigurations

listPatchHistories

listPatches

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

removeAutoScalingConfiguration

removeCloudSql

removeNode

restartNode

startBdsInstance

stopBdsInstance

testBdsMetastoreConfiguration

testBdsObjectStorageConnection

updateAutoScalingConfiguration

updateBdsInstance

updateBdsMetastoreConfiguration

getWaiters

getPaginators