Class BdsClient
- java.lang.Object
- 
- com.oracle.bmc.http.internal.BaseSyncClient
- 
- com.oracle.bmc.bds.BdsClient
 
 
- 
- All Implemented Interfaces:
- Bds,- AutoCloseable
 
 @Generated(value="OracleSDKGenerator", comments="API Version: 20190531") public class BdsClient extends BaseSyncClient implements Bds
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classBdsClient.BuilderBuilder class for this client.
 - 
Field SummaryFields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Bds.
 - 
Constructor SummaryConstructors Constructor Description BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
 - 
Method Summary- 
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClientclientCall
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface java.lang.AutoCloseableclose
 - 
Methods inherited from interface com.oracle.bmc.bds.BdsgetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
 
- 
 
- 
- 
- 
Constructor Detail- 
BdsClient@Deprecated public BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- BdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
 
 - 
BdsClient@Deprecated public BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- BdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
 
 - 
BdsClient@Deprecated public BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- BdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
 
 - 
BdsClient@Deprecated public BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- BdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
 
 - 
BdsClient@Deprecated public BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- BdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
 
 - 
BdsClient@Deprecated public BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- BdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
- endpoint-- ClientBuilderBase.endpoint(java.lang.String)
 
 - 
BdsClient@Deprecated public BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- BdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
- endpoint-- ClientBuilderBase.endpoint(java.lang.String)
- signingStrategyRequestSignerFactories-- ClientBuilderBase.signingStrategyRequestSignerFactories
 
 - 
BdsClient@Deprecated public BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- BdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
- endpoint-- ClientBuilderBase.endpoint(java.lang.String)
- signingStrategyRequestSignerFactories-- ClientBuilderBase.signingStrategyRequestSignerFactories
- executorService-- BdsClient.Builder.executorService
 
 
- 
 - 
Method Detail- 
builderpublic static BdsClient.Builder builder() Create a builder for this client.- Returns:
- builder
 
 - 
setRegionpublic void setRegion(Region region) Description copied from interface:BdsSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
 - 
setRegionpublic void setRegion(String regionId) Description copied from interface:BdsSets 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 callsetEndpoint.
 - 
activateBdsMetastoreConfigurationpublic ActivateBdsMetastoreConfigurationResponse activateBdsMetastoreConfiguration(ActivateBdsMetastoreConfigurationRequest request) Description copied from interface:BdsActivate specified metastore configuration.- Specified by:
- activateBdsMetastoreConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
activateIamUserSyncConfigurationpublic ActivateIamUserSyncConfigurationResponse activateIamUserSyncConfiguration(ActivateIamUserSyncConfigurationRequest request) Description copied from interface:BdsActivate IAM user sync configuration for the given identity configuration- Specified by:
- activateIamUserSyncConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
activateUpstConfigurationpublic ActivateUpstConfigurationResponse activateUpstConfiguration(ActivateUpstConfigurationRequest request) Description copied from interface:BdsActivate UPST configuration for the given identity configuration- Specified by:
- activateUpstConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
addAutoScalingConfigurationpublic AddAutoScalingConfigurationResponse addAutoScalingConfiguration(AddAutoScalingConfigurationRequest request) Description copied from interface:BdsAdd an autoscale configuration to the cluster.- Specified by:
- addAutoScalingConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
addBlockStoragepublic AddBlockStorageResponse addBlockStorage(AddBlockStorageRequest request) Description copied from interface:BdsAdds 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. - Specified by:
- addBlockStoragein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
addCloudSqlpublic AddCloudSqlResponse addCloudSql(AddCloudSqlRequest request) Description copied from interface:BdsAdds 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. - Specified by:
- addCloudSqlin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
addKafkapublic AddKafkaResponse addKafka(AddKafkaRequest request) Description copied from interface:BdsAdds Kafka to a cluster.
 - 
addMasterNodespublic AddMasterNodesResponse addMasterNodes(AddMasterNodesRequest request) Description copied from interface:BdsIncreases the size (scales out) of a cluster by adding master nodes.The added master nodes will have the same shape and will have the same amount of attached block storage as other master nodes in the cluster. - Specified by:
- addMasterNodesin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
addUtilityNodespublic AddUtilityNodesResponse addUtilityNodes(AddUtilityNodesRequest request) Description copied from interface:BdsIncreases the size (scales out) of a cluster by adding utility nodes.The added utility nodes will have the same shape and will have the same amount of attached block storage as other utility nodes in the cluster. - Specified by:
- addUtilityNodesin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
addWorkerNodespublic AddWorkerNodesResponse addWorkerNodes(AddWorkerNodesRequest request) Description copied from interface:BdsIncreases 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. - Specified by:
- addWorkerNodesin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
backupNodepublic BackupNodeResponse backupNode(BackupNodeRequest request) Description copied from interface:BdsTakes a backup of of given nodes.- Specified by:
- backupNodein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
certificateServiceInfopublic CertificateServiceInfoResponse certificateServiceInfo(CertificateServiceInfoRequest request) Description copied from interface:BdsA list of services and their certificate details.- Specified by:
- certificateServiceInfoin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
changeBdsInstanceCompartmentpublic ChangeBdsInstanceCompartmentResponse changeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest request) Description copied from interface:BdsMoves a Big Data Service cluster into a different compartment.- Specified by:
- changeBdsInstanceCompartmentin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
changeShapepublic ChangeShapeResponse changeShape(ChangeShapeRequest request) Description copied from interface:BdsChanges 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. - Specified by:
- changeShapein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createBdsApiKeypublic CreateBdsApiKeyResponse createBdsApiKey(CreateBdsApiKeyRequest request) Description copied from interface:BdsCreate an API key on behalf of the specified user.- Specified by:
- createBdsApiKeyin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createBdsCapacityReportpublic CreateBdsCapacityReportResponse createBdsCapacityReport(CreateBdsCapacityReportRequest request) Description copied from interface:BdsCreate a detailed capacity report for BDS service- Specified by:
- createBdsCapacityReportin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createBdsInstancepublic CreateBdsInstanceResponse createBdsInstance(CreateBdsInstanceRequest request) Description copied from interface:BdsCreates a Big Data Service cluster.- Specified by:
- createBdsInstancein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createBdsMetastoreConfigurationpublic CreateBdsMetastoreConfigurationResponse createBdsMetastoreConfiguration(CreateBdsMetastoreConfigurationRequest request) Description copied from interface:BdsCreate and activate external metastore configuration.- Specified by:
- createBdsMetastoreConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createIdentityConfigurationpublic CreateIdentityConfigurationResponse createIdentityConfiguration(CreateIdentityConfigurationRequest request) Description copied from interface:BdsCreate an identity configuration for the cluster- Specified by:
- createIdentityConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createNodeBackupConfigurationpublic CreateNodeBackupConfigurationResponse createNodeBackupConfiguration(CreateNodeBackupConfigurationRequest request) Description copied from interface:BdsAdd a node volume backup configuration to the cluster for an indicated node type or node.- Specified by:
- createNodeBackupConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createNodeReplaceConfigurationpublic CreateNodeReplaceConfigurationResponse createNodeReplaceConfiguration(CreateNodeReplaceConfigurationRequest request) Description copied from interface:BdsAdd a nodeReplaceConfigurations to the cluster.- Specified by:
- createNodeReplaceConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createResourcePrincipalConfigurationpublic CreateResourcePrincipalConfigurationResponse createResourcePrincipalConfiguration(CreateResourcePrincipalConfigurationRequest request) Description copied from interface:BdsCreate a resource principal session token configuration.- Specified by:
- createResourcePrincipalConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deactivateIamUserSyncConfigurationpublic DeactivateIamUserSyncConfigurationResponse deactivateIamUserSyncConfiguration(DeactivateIamUserSyncConfigurationRequest request) Description copied from interface:BdsDeactivate the IAM user sync configuration.- Specified by:
- deactivateIamUserSyncConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deactivateUpstConfigurationpublic DeactivateUpstConfigurationResponse deactivateUpstConfiguration(DeactivateUpstConfigurationRequest request) Description copied from interface:BdsDeactivate the UPST configuration represented by the provided ID.- Specified by:
- deactivateUpstConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteBdsApiKeypublic DeleteBdsApiKeyResponse deleteBdsApiKey(DeleteBdsApiKeyRequest request) Description copied from interface:BdsDeletes the user’s API key represented by the provided ID.- Specified by:
- deleteBdsApiKeyin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteBdsInstancepublic DeleteBdsInstanceResponse deleteBdsInstance(DeleteBdsInstanceRequest request) Description copied from interface:BdsDeletes the cluster identified by the given ID.- Specified by:
- deleteBdsInstancein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteBdsMetastoreConfigurationpublic DeleteBdsMetastoreConfigurationResponse deleteBdsMetastoreConfiguration(DeleteBdsMetastoreConfigurationRequest request) Description copied from interface:BdsDelete the BDS metastore configuration represented by the provided ID.- Specified by:
- deleteBdsMetastoreConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteIdentityConfigurationpublic DeleteIdentityConfigurationResponse deleteIdentityConfiguration(DeleteIdentityConfigurationRequest request) Description copied from interface:BdsDelete the identity configuration represented by the provided ID.Deletion is only allowed if this identity configuration is not associated with any active IAM user sync configuration or UPST configuration. - Specified by:
- deleteIdentityConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteNodeBackuppublic DeleteNodeBackupResponse deleteNodeBackup(DeleteNodeBackupRequest request) Description copied from interface:BdsDelete the NodeBackup represented by the provided ID.- Specified by:
- deleteNodeBackupin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteNodeBackupConfigurationpublic DeleteNodeBackupConfigurationResponse deleteNodeBackupConfiguration(DeleteNodeBackupConfigurationRequest request) Description copied from interface:BdsDelete the NodeBackupConfiguration represented by the provided ID.- Specified by:
- deleteNodeBackupConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
disableCertificatepublic DisableCertificateResponse disableCertificate(DisableCertificateRequest request) Description copied from interface:BdsDisabling TLS/SSL for various ODH services running on the BDS cluster.- Specified by:
- disableCertificatein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
enableCertificatepublic EnableCertificateResponse enableCertificate(EnableCertificateRequest request) Description copied from interface:BdsConfiguring TLS/SSL for various ODH services running on the BDS cluster.- Specified by:
- enableCertificatein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
executeBootstrapScriptpublic ExecuteBootstrapScriptResponse executeBootstrapScript(ExecuteBootstrapScriptRequest request) Description copied from interface:BdsExecute bootstrap script.- Specified by:
- executeBootstrapScriptin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
forceRefreshResourcePrincipalpublic ForceRefreshResourcePrincipalResponse forceRefreshResourcePrincipal(ForceRefreshResourcePrincipalRequest request) Description copied from interface:BdsForce Refresh Resource Principal for the cluster.- Specified by:
- forceRefreshResourcePrincipalin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getAutoScalingConfigurationpublic GetAutoScalingConfigurationResponse getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request) Description copied from interface:BdsReturns details of the autoscale configuration identified by the given ID.- Specified by:
- getAutoScalingConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getBdsApiKeypublic GetBdsApiKeyResponse getBdsApiKey(GetBdsApiKeyRequest request) Description copied from interface:BdsReturns the user’s API key information for the given ID.- Specified by:
- getBdsApiKeyin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getBdsInstancepublic GetBdsInstanceResponse getBdsInstance(GetBdsInstanceRequest request) Description copied from interface:BdsReturns information about the Big Data Service cluster identified by the given ID.- Specified by:
- getBdsInstancein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getBdsMetastoreConfigurationpublic GetBdsMetastoreConfigurationResponse getBdsMetastoreConfiguration(GetBdsMetastoreConfigurationRequest request) Description copied from interface:BdsReturns the BDS Metastore configuration information for the given ID.- Specified by:
- getBdsMetastoreConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getIdentityConfigurationpublic GetIdentityConfigurationResponse getIdentityConfiguration(GetIdentityConfigurationRequest request) Description copied from interface:BdsGet details of one identity config on the cluster- Specified by:
- getIdentityConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getNodeBackuppublic GetNodeBackupResponse getNodeBackup(GetNodeBackupRequest request) Description copied from interface:BdsReturns details of NodeBackup identified by the given ID.- Specified by:
- getNodeBackupin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getNodeBackupConfigurationpublic GetNodeBackupConfigurationResponse getNodeBackupConfiguration(GetNodeBackupConfigurationRequest request) Description copied from interface:BdsReturns details of the NodeBackupConfiguration identified by the given ID.- Specified by:
- getNodeBackupConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getNodeReplaceConfigurationpublic GetNodeReplaceConfigurationResponse getNodeReplaceConfiguration(GetNodeReplaceConfigurationRequest request) Description copied from interface:BdsReturns details of the nodeReplaceConfiguration identified by the given ID.- Specified by:
- getNodeReplaceConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getOsPatchDetailspublic GetOsPatchDetailsResponse getOsPatchDetails(GetOsPatchDetailsRequest request) Description copied from interface:BdsGet the details of an os patch- Specified by:
- getOsPatchDetailsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getResourcePrincipalConfigurationpublic GetResourcePrincipalConfigurationResponse getResourcePrincipalConfiguration(GetResourcePrincipalConfigurationRequest request) Description copied from interface:BdsReturns details of the resourcePrincipalConfiguration identified by the given ID.- Specified by:
- getResourcePrincipalConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getSoftwareUpdatepublic GetSoftwareUpdateResponse getSoftwareUpdate(GetSoftwareUpdateRequest request) Description copied from interface:BdsGet the details of the software update of the given SoftwareUpdateId- Specified by:
- getSoftwareUpdatein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getWorkRequestpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request) Description copied from interface:BdsReturns the status of the work request identified by the given ID.- Specified by:
- getWorkRequestin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
installOsPatchpublic InstallOsPatchResponse installOsPatch(InstallOsPatchRequest request) Description copied from interface:BdsInstall an os patch on a cluster- Specified by:
- installOsPatchin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
installPatchpublic InstallPatchResponse installPatch(InstallPatchRequest request) Description copied from interface:BdsInstall the specified patch to this cluster.- Specified by:
- installPatchin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
installSoftwareUpdatespublic InstallSoftwareUpdatesResponse installSoftwareUpdates(InstallSoftwareUpdatesRequest request) Description copied from interface:BdsInstall the specified software update to this cluster.- Specified by:
- installSoftwareUpdatesin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listAutoScalingConfigurationspublic ListAutoScalingConfigurationsResponse listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request) Description copied from interface:BdsReturns information about the autoscaling configurations for a cluster.- Specified by:
- listAutoScalingConfigurationsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listBdsApiKeyspublic ListBdsApiKeysResponse listBdsApiKeys(ListBdsApiKeysRequest request) Description copied from interface:BdsReturns a list of all API keys associated with this Big Data Service cluster.- Specified by:
- listBdsApiKeysin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listBdsClusterVersionspublic ListBdsClusterVersionsResponse listBdsClusterVersions(ListBdsClusterVersionsRequest request) Description copied from interface:BdsReturns a list of cluster versions with associated odh and bds versions.- Specified by:
- listBdsClusterVersionsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listBdsInstancespublic ListBdsInstancesResponse listBdsInstances(ListBdsInstancesRequest request) Description copied from interface:BdsReturns a list of all Big Data Service clusters in a compartment.- Specified by:
- listBdsInstancesin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listBdsMetastoreConfigurationspublic ListBdsMetastoreConfigurationsResponse listBdsMetastoreConfigurations(ListBdsMetastoreConfigurationsRequest request) Description copied from interface:BdsReturns a list of metastore configurations ssociated with this Big Data Service cluster.- Specified by:
- listBdsMetastoreConfigurationsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listIdentityConfigurationspublic ListIdentityConfigurationsResponse listIdentityConfigurations(ListIdentityConfigurationsRequest request) Description copied from interface:BdsReturns a list of all identity configurations associated with this Big Data Service cluster.- Specified by:
- listIdentityConfigurationsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listNodeBackupConfigurationspublic ListNodeBackupConfigurationsResponse listNodeBackupConfigurations(ListNodeBackupConfigurationsRequest request) Description copied from interface:BdsReturns information about the NodeBackupConfigurations.- Specified by:
- listNodeBackupConfigurationsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listNodeBackupspublic ListNodeBackupsResponse listNodeBackups(ListNodeBackupsRequest request) Description copied from interface:BdsReturns information about the node Backups.- Specified by:
- listNodeBackupsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listNodeReplaceConfigurationspublic ListNodeReplaceConfigurationsResponse listNodeReplaceConfigurations(ListNodeReplaceConfigurationsRequest request) Description copied from interface:BdsReturns information about the NodeReplaceConfiguration.- Specified by:
- listNodeReplaceConfigurationsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listOsPatchespublic ListOsPatchesResponse listOsPatches(ListOsPatchesRequest request) Description copied from interface:BdsList all available os patches for a given cluster- Specified by:
- listOsPatchesin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listPatchHistoriespublic ListPatchHistoriesResponse listPatchHistories(ListPatchHistoriesRequest request) Description copied from interface:BdsList the patch history of this cluster.- Specified by:
- listPatchHistoriesin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listPatchespublic ListPatchesResponse listPatches(ListPatchesRequest request) Description copied from interface:BdsList all the available patches for this cluster.- Specified by:
- listPatchesin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listResourcePrincipalConfigurationspublic ListResourcePrincipalConfigurationsResponse listResourcePrincipalConfigurations(ListResourcePrincipalConfigurationsRequest request) Description copied from interface:BdsReturns information about the ResourcePrincipalConfiguration.- Specified by:
- listResourcePrincipalConfigurationsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listSoftwareUpdatespublic ListSoftwareUpdatesResponse listSoftwareUpdates(ListSoftwareUpdatesRequest request) Description copied from interface:BdsList all the available software updates for current cluster.- Specified by:
- listSoftwareUpdatesin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestErrorspublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request) Description copied from interface:BdsReturns a paginated list of errors for a work request identified by the given ID.- Specified by:
- listWorkRequestErrorsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestLogspublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request) Description copied from interface:BdsReturns a paginated list of logs for a given work request.- Specified by:
- listWorkRequestLogsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestspublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request) Description copied from interface:BdsLists the work requests in a compartment.- Specified by:
- listWorkRequestsin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
refreshConfidentialApplicationpublic RefreshConfidentialApplicationResponse refreshConfidentialApplication(RefreshConfidentialApplicationRequest request) Description copied from interface:BdsRefresh confidential application for the given identity configuration in case of any update to the confidential application (e.g.regenerated client secret) - Specified by:
- refreshConfidentialApplicationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
refreshUpstTokenExchangeKeytabpublic RefreshUpstTokenExchangeKeytabResponse refreshUpstTokenExchangeKeytab(RefreshUpstTokenExchangeKeytabRequest request) Description copied from interface:BdsRefresh token exchange kerberos principal keytab for the UPST enabled identity configuration- Specified by:
- refreshUpstTokenExchangeKeytabin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
removeAutoScalingConfigurationpublic RemoveAutoScalingConfigurationResponse removeAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest request) Description copied from interface:BdsDeletes an autoscale configuration.- Specified by:
- removeAutoScalingConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
removeCloudSqlpublic RemoveCloudSqlResponse removeCloudSql(RemoveCloudSqlRequest request) Description copied from interface:BdsRemoves Cloud SQL from the cluster.- Specified by:
- removeCloudSqlin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
removeKafkapublic RemoveKafkaResponse removeKafka(RemoveKafkaRequest request) Description copied from interface:BdsRemove Kafka from the cluster.- Specified by:
- removeKafkain interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
removeNodepublic RemoveNodeResponse removeNode(RemoveNodeRequest request) Description copied from interface:BdsRemove a single node of a Big Data Service cluster- Specified by:
- removeNodein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
removeNodeReplaceConfigurationpublic RemoveNodeReplaceConfigurationResponse removeNodeReplaceConfiguration(RemoveNodeReplaceConfigurationRequest request) Description copied from interface:BdsDeletes a nodeReplaceConfiguration- Specified by:
- removeNodeReplaceConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
removeResourcePrincipalConfigurationpublic RemoveResourcePrincipalConfigurationResponse removeResourcePrincipalConfiguration(RemoveResourcePrincipalConfigurationRequest request) Description copied from interface:BdsDelete the resource principal configuration for the cluster.- Specified by:
- removeResourcePrincipalConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
renewCertificatepublic RenewCertificateResponse renewCertificate(RenewCertificateRequest request) Description copied from interface:BdsRenewing TLS/SSL for various ODH services running on the BDS cluster.- Specified by:
- renewCertificatein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
replaceNodepublic ReplaceNodeResponse replaceNode(ReplaceNodeRequest request) Description copied from interface:BdsReplaces a node of a Big Data Service cluster from backup.- Specified by:
- replaceNodein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
restartNodepublic RestartNodeResponse restartNode(RestartNodeRequest request) Description copied from interface:BdsRestarts a single node of a Big Data Service cluster- Specified by:
- restartNodein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
startBdsInstancepublic StartBdsInstanceResponse startBdsInstance(StartBdsInstanceRequest request) Description copied from interface:BdsStarts the BDS cluster that was stopped earlier.- Specified by:
- startBdsInstancein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
stopBdsInstancepublic StopBdsInstanceResponse stopBdsInstance(StopBdsInstanceRequest request) Description copied from interface:BdsStops the BDS cluster that can be started at later point of time.- Specified by:
- stopBdsInstancein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
testBdsMetastoreConfigurationpublic TestBdsMetastoreConfigurationResponse testBdsMetastoreConfiguration(TestBdsMetastoreConfigurationRequest request) Description copied from interface:BdsTest specified metastore configuration.- Specified by:
- testBdsMetastoreConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
testBdsObjectStorageConnectionpublic TestBdsObjectStorageConnectionResponse testBdsObjectStorageConnection(TestBdsObjectStorageConnectionRequest request) Description copied from interface:BdsTest access to specified Object Storage bucket using the API key.- Specified by:
- testBdsObjectStorageConnectionin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateAutoScalingConfigurationpublic UpdateAutoScalingConfigurationResponse updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request) Description copied from interface:BdsUpdates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale configuration is enabled.- Specified by:
- updateAutoScalingConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateBdsInstancepublic UpdateBdsInstanceResponse updateBdsInstance(UpdateBdsInstanceRequest request) Description copied from interface:BdsUpdates the Big Data Service cluster identified by the given ID.- Specified by:
- updateBdsInstancein interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateBdsMetastoreConfigurationpublic UpdateBdsMetastoreConfigurationResponse updateBdsMetastoreConfiguration(UpdateBdsMetastoreConfigurationRequest request) Description copied from interface:BdsUpdate the BDS metastore configuration represented by the provided ID.- Specified by:
- updateBdsMetastoreConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateIdentityConfigurationpublic UpdateIdentityConfigurationResponse updateIdentityConfiguration(UpdateIdentityConfigurationRequest request) Description copied from interface:BdsUpdate the IAM user sync and UPST configuration for the specified identity configuration- Specified by:
- updateIdentityConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateNodeBackupConfigurationpublic UpdateNodeBackupConfigurationResponse updateNodeBackupConfiguration(UpdateNodeBackupConfigurationRequest request) Description copied from interface:BdsUpdates fields on NodeBackupConfiguration, including the name, the schedule.- Specified by:
- updateNodeBackupConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateNodeReplaceConfigurationpublic UpdateNodeReplaceConfigurationResponse updateNodeReplaceConfiguration(UpdateNodeReplaceConfigurationRequest request) Description copied from interface:BdsUpdates fields on nodeReplaceConfigurations, including the name, the schedule- Specified by:
- updateNodeReplaceConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateResourcePrincipalConfigurationpublic UpdateResourcePrincipalConfigurationResponse updateResourcePrincipalConfiguration(UpdateResourcePrincipalConfigurationRequest request) Description copied from interface:BdsUpdates fields on resourcePrincipalConfiguration, including the name, the lifeSpanInHours of the token.- Specified by:
- updateResourcePrincipalConfigurationin interface- Bds
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getWaiterspublic BdsWaiters getWaiters() Description copied from interface:BdsGets the pre-configured waiters available for resources for this service.- Specified by:
- getWaitersin interface- Bds
- Returns:
- The service waiters.
 
 - 
getPaginatorspublic BdsPaginators getPaginators() Description copied from interface:BdsGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
- getPaginatorsin interface- Bds
- Returns:
- The service paginators.
 
 - 
getDefaultConfiguratorprotected ClientConfigurator getDefaultConfigurator() 
 - 
useRealmSpecificEndpointTemplatepublic void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false - Parameters:
- useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
 
 - 
populateServiceParametersInEndpointpublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank. - Parameters:
- endpoint- The endpoint template in use
- requiredParametersMap- Map of parameter name as key and value set in request path or query parameter as value
 
 - 
updateBaseEndpointpublic final void updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters. - Parameters:
- endpoint- The updated endpoint to use
 
 - 
setEndpointpublic final void setEndpoint(String endpoint) 
 - 
getEndpointpublic final String getEndpoint() 
 - 
refreshClientpublic final void refreshClient() Rebuild the backingHttpClient.This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
 - 
closepublic final void close() - Specified by:
- closein interface- AutoCloseable
 
 - 
getClientCommonLibraryVersionpublic String getClientCommonLibraryVersion() 
 
- 
 
-