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 Summary
Nested Classes Modifier and Type Class Description static classBdsClient.BuilderBuilder class for this client.
-
Field Summary
Fields 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 Summary
Constructors 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.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.bds.Bds
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
BdsClient
@Deprecated public BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBdsClient.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 (seeBdsClient.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 (seeBdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 (seeBdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 (seeBdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-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 (seeBdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 (seeBdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 (seeBdsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-BdsClient.Builder.executorService
-
-
Method Detail
-
builder
public static BdsClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public 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.
-
setRegion
public 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.
-
activateBdsMetastoreConfiguration
public ActivateBdsMetastoreConfigurationResponse activateBdsMetastoreConfiguration(ActivateBdsMetastoreConfigurationRequest request)
Description copied from interface:BdsActivate specified metastore configuration.- Specified by:
activateBdsMetastoreConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
activateIamUserSyncConfiguration
public ActivateIamUserSyncConfigurationResponse activateIamUserSyncConfiguration(ActivateIamUserSyncConfigurationRequest request)
Description copied from interface:BdsActivate IAM user sync configuration for the given identity configuration- Specified by:
activateIamUserSyncConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
activateUpstConfiguration
public ActivateUpstConfigurationResponse activateUpstConfiguration(ActivateUpstConfigurationRequest request)
Description copied from interface:BdsActivate UPST configuration for the given identity configuration- Specified by:
activateUpstConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addAutoScalingConfiguration
public AddAutoScalingConfigurationResponse addAutoScalingConfiguration(AddAutoScalingConfigurationRequest request)
Description copied from interface:BdsAdd an autoscale configuration to the cluster.- Specified by:
addAutoScalingConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addBlockStorage
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addCloudSql
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addKafka
public AddKafkaResponse addKafka(AddKafkaRequest request)
Description copied from interface:BdsAdds Kafka to a cluster.
-
addMasterNodes
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addUtilityNodes
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addWorkerNodes
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
backupNode
public BackupNodeResponse backupNode(BackupNodeRequest request)
Description copied from interface:BdsTakes a backup of of given nodes.- Specified by:
backupNodein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
certificateServiceInfo
public CertificateServiceInfoResponse certificateServiceInfo(CertificateServiceInfoRequest request)
Description copied from interface:BdsA list of services and their certificate details.- Specified by:
certificateServiceInfoin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeBdsInstanceCompartment
public ChangeBdsInstanceCompartmentResponse changeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest request)
Description copied from interface:BdsMoves a Big Data Service cluster into a different compartment.- Specified by:
changeBdsInstanceCompartmentin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeShape
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createBdsApiKey
public CreateBdsApiKeyResponse createBdsApiKey(CreateBdsApiKeyRequest request)
Description copied from interface:BdsCreate an API key on behalf of the specified user.- Specified by:
createBdsApiKeyin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createBdsCapacityReport
public CreateBdsCapacityReportResponse createBdsCapacityReport(CreateBdsCapacityReportRequest request)
Description copied from interface:BdsCreate a detailed capacity report for BDS service- Specified by:
createBdsCapacityReportin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createBdsInstance
public CreateBdsInstanceResponse createBdsInstance(CreateBdsInstanceRequest request)
Description copied from interface:BdsCreates a Big Data Service cluster.- Specified by:
createBdsInstancein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createBdsMetastoreConfiguration
public CreateBdsMetastoreConfigurationResponse createBdsMetastoreConfiguration(CreateBdsMetastoreConfigurationRequest request)
Description copied from interface:BdsCreate and activate external metastore configuration.- Specified by:
createBdsMetastoreConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createIdentityConfiguration
public CreateIdentityConfigurationResponse createIdentityConfiguration(CreateIdentityConfigurationRequest request)
Description copied from interface:BdsCreate an identity configuration for the cluster- Specified by:
createIdentityConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createNodeBackupConfiguration
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createNodeReplaceConfiguration
public CreateNodeReplaceConfigurationResponse createNodeReplaceConfiguration(CreateNodeReplaceConfigurationRequest request)
Description copied from interface:BdsAdd a nodeReplaceConfigurations to the cluster.- Specified by:
createNodeReplaceConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createResourcePrincipalConfiguration
public CreateResourcePrincipalConfigurationResponse createResourcePrincipalConfiguration(CreateResourcePrincipalConfigurationRequest request)
Description copied from interface:BdsCreate a resource principal session token configuration.- Specified by:
createResourcePrincipalConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deactivateIamUserSyncConfiguration
public DeactivateIamUserSyncConfigurationResponse deactivateIamUserSyncConfiguration(DeactivateIamUserSyncConfigurationRequest request)
Description copied from interface:BdsDeactivate the IAM user sync configuration.- Specified by:
deactivateIamUserSyncConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deactivateUpstConfiguration
public DeactivateUpstConfigurationResponse deactivateUpstConfiguration(DeactivateUpstConfigurationRequest request)
Description copied from interface:BdsDeactivate the UPST configuration represented by the provided ID.- Specified by:
deactivateUpstConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteBdsApiKey
public DeleteBdsApiKeyResponse deleteBdsApiKey(DeleteBdsApiKeyRequest request)
Description copied from interface:BdsDeletes the user’s API key represented by the provided ID.- Specified by:
deleteBdsApiKeyin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteBdsInstance
public DeleteBdsInstanceResponse deleteBdsInstance(DeleteBdsInstanceRequest request)
Description copied from interface:BdsDeletes the cluster identified by the given ID.- Specified by:
deleteBdsInstancein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteBdsMetastoreConfiguration
public DeleteBdsMetastoreConfigurationResponse deleteBdsMetastoreConfiguration(DeleteBdsMetastoreConfigurationRequest request)
Description copied from interface:BdsDelete the BDS metastore configuration represented by the provided ID.- Specified by:
deleteBdsMetastoreConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteIdentityConfiguration
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteNodeBackup
public DeleteNodeBackupResponse deleteNodeBackup(DeleteNodeBackupRequest request)
Description copied from interface:BdsDelete the NodeBackup represented by the provided ID.- Specified by:
deleteNodeBackupin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteNodeBackupConfiguration
public DeleteNodeBackupConfigurationResponse deleteNodeBackupConfiguration(DeleteNodeBackupConfigurationRequest request)
Description copied from interface:BdsDelete the NodeBackupConfiguration represented by the provided ID.- Specified by:
deleteNodeBackupConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
disableCertificate
public DisableCertificateResponse disableCertificate(DisableCertificateRequest request)
Description copied from interface:BdsDisabling TLS/SSL for various ODH services running on the BDS cluster.- Specified by:
disableCertificatein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
enableCertificate
public EnableCertificateResponse enableCertificate(EnableCertificateRequest request)
Description copied from interface:BdsConfiguring TLS/SSL for various ODH services running on the BDS cluster.- Specified by:
enableCertificatein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
executeBootstrapScript
public ExecuteBootstrapScriptResponse executeBootstrapScript(ExecuteBootstrapScriptRequest request)
Description copied from interface:BdsExecute bootstrap script.- Specified by:
executeBootstrapScriptin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
forceRefreshResourcePrincipal
public ForceRefreshResourcePrincipalResponse forceRefreshResourcePrincipal(ForceRefreshResourcePrincipalRequest request)
Description copied from interface:BdsForce Refresh Resource Principal for the cluster.- Specified by:
forceRefreshResourcePrincipalin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAutoScalingConfiguration
public GetAutoScalingConfigurationResponse getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request)
Description copied from interface:BdsReturns details of the autoscale configuration identified by the given ID.- Specified by:
getAutoScalingConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBdsApiKey
public GetBdsApiKeyResponse getBdsApiKey(GetBdsApiKeyRequest request)
Description copied from interface:BdsReturns the user’s API key information for the given ID.- Specified by:
getBdsApiKeyin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBdsInstance
public GetBdsInstanceResponse getBdsInstance(GetBdsInstanceRequest request)
Description copied from interface:BdsReturns information about the Big Data Service cluster identified by the given ID.- Specified by:
getBdsInstancein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBdsMetastoreConfiguration
public GetBdsMetastoreConfigurationResponse getBdsMetastoreConfiguration(GetBdsMetastoreConfigurationRequest request)
Description copied from interface:BdsReturns the BDS Metastore configuration information for the given ID.- Specified by:
getBdsMetastoreConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getIdentityConfiguration
public GetIdentityConfigurationResponse getIdentityConfiguration(GetIdentityConfigurationRequest request)
Description copied from interface:BdsGet details of one identity config on the cluster- Specified by:
getIdentityConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getNodeBackup
public GetNodeBackupResponse getNodeBackup(GetNodeBackupRequest request)
Description copied from interface:BdsReturns details of NodeBackup identified by the given ID.- Specified by:
getNodeBackupin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getNodeBackupConfiguration
public GetNodeBackupConfigurationResponse getNodeBackupConfiguration(GetNodeBackupConfigurationRequest request)
Description copied from interface:BdsReturns details of the NodeBackupConfiguration identified by the given ID.- Specified by:
getNodeBackupConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getNodeReplaceConfiguration
public GetNodeReplaceConfigurationResponse getNodeReplaceConfiguration(GetNodeReplaceConfigurationRequest request)
Description copied from interface:BdsReturns details of the nodeReplaceConfiguration identified by the given ID.- Specified by:
getNodeReplaceConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOsPatchDetails
public GetOsPatchDetailsResponse getOsPatchDetails(GetOsPatchDetailsRequest request)
Description copied from interface:BdsGet the details of an os patch- Specified by:
getOsPatchDetailsin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getResourcePrincipalConfiguration
public GetResourcePrincipalConfigurationResponse getResourcePrincipalConfiguration(GetResourcePrincipalConfigurationRequest request)
Description copied from interface:BdsReturns details of the resourcePrincipalConfiguration identified by the given ID.- Specified by:
getResourcePrincipalConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSoftwareUpdate
public GetSoftwareUpdateResponse getSoftwareUpdate(GetSoftwareUpdateRequest request)
Description copied from interface:BdsGet the details of the software update of the given SoftwareUpdateId- Specified by:
getSoftwareUpdatein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:BdsReturns the status of the work request identified by the given ID.- Specified by:
getWorkRequestin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
installOsPatch
public InstallOsPatchResponse installOsPatch(InstallOsPatchRequest request)
Description copied from interface:BdsInstall an os patch on a cluster- Specified by:
installOsPatchin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
installPatch
public InstallPatchResponse installPatch(InstallPatchRequest request)
Description copied from interface:BdsInstall the specified patch to this cluster.- Specified by:
installPatchin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
installSoftwareUpdates
public InstallSoftwareUpdatesResponse installSoftwareUpdates(InstallSoftwareUpdatesRequest request)
Description copied from interface:BdsInstall the specified software update to this cluster.- Specified by:
installSoftwareUpdatesin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAutoScalingConfigurations
public ListAutoScalingConfigurationsResponse listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)
Description copied from interface:BdsReturns information about the autoscaling configurations for a cluster.- Specified by:
listAutoScalingConfigurationsin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBdsApiKeys
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBdsClusterVersions
public ListBdsClusterVersionsResponse listBdsClusterVersions(ListBdsClusterVersionsRequest request)
Description copied from interface:BdsReturns a list of cluster versions with associated odh and bds versions.- Specified by:
listBdsClusterVersionsin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBdsInstances
public ListBdsInstancesResponse listBdsInstances(ListBdsInstancesRequest request)
Description copied from interface:BdsReturns a list of all Big Data Service clusters in a compartment.- Specified by:
listBdsInstancesin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBdsMetastoreConfigurations
public ListBdsMetastoreConfigurationsResponse listBdsMetastoreConfigurations(ListBdsMetastoreConfigurationsRequest request)
Description copied from interface:BdsReturns a list of metastore configurations ssociated with this Big Data Service cluster.- Specified by:
listBdsMetastoreConfigurationsin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listIdentityConfigurations
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listNodeBackupConfigurations
public ListNodeBackupConfigurationsResponse listNodeBackupConfigurations(ListNodeBackupConfigurationsRequest request)
Description copied from interface:BdsReturns information about the NodeBackupConfigurations.- Specified by:
listNodeBackupConfigurationsin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listNodeBackups
public ListNodeBackupsResponse listNodeBackups(ListNodeBackupsRequest request)
Description copied from interface:BdsReturns information about the node Backups.- Specified by:
listNodeBackupsin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listNodeReplaceConfigurations
public ListNodeReplaceConfigurationsResponse listNodeReplaceConfigurations(ListNodeReplaceConfigurationsRequest request)
Description copied from interface:BdsReturns information about the NodeReplaceConfiguration.- Specified by:
listNodeReplaceConfigurationsin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOsPatches
public ListOsPatchesResponse listOsPatches(ListOsPatchesRequest request)
Description copied from interface:BdsList all available os patches for a given cluster- Specified by:
listOsPatchesin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPatchHistories
public ListPatchHistoriesResponse listPatchHistories(ListPatchHistoriesRequest request)
Description copied from interface:BdsList the patch history of this cluster.- Specified by:
listPatchHistoriesin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPatches
public ListPatchesResponse listPatches(ListPatchesRequest request)
Description copied from interface:BdsList all the available patches for this cluster.- Specified by:
listPatchesin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResourcePrincipalConfigurations
public ListResourcePrincipalConfigurationsResponse listResourcePrincipalConfigurations(ListResourcePrincipalConfigurationsRequest request)
Description copied from interface:BdsReturns information about the ResourcePrincipalConfiguration.- Specified by:
listResourcePrincipalConfigurationsin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSoftwareUpdates
public ListSoftwareUpdatesResponse listSoftwareUpdates(ListSoftwareUpdatesRequest request)
Description copied from interface:BdsList all the available software updates for current cluster.- Specified by:
listSoftwareUpdatesin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:BdsReturns a paginated list of logs for a given work request.- Specified by:
listWorkRequestLogsin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:BdsLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshConfidentialApplication
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshUpstTokenExchangeKeytab
public RefreshUpstTokenExchangeKeytabResponse refreshUpstTokenExchangeKeytab(RefreshUpstTokenExchangeKeytabRequest request)
Description copied from interface:BdsRefresh token exchange kerberos principal keytab for the UPST enabled identity configuration- Specified by:
refreshUpstTokenExchangeKeytabin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeAutoScalingConfiguration
public RemoveAutoScalingConfigurationResponse removeAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest request)
Description copied from interface:BdsDeletes an autoscale configuration.- Specified by:
removeAutoScalingConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeCloudSql
public RemoveCloudSqlResponse removeCloudSql(RemoveCloudSqlRequest request)
Description copied from interface:BdsRemoves Cloud SQL from the cluster.- Specified by:
removeCloudSqlin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeKafka
public RemoveKafkaResponse removeKafka(RemoveKafkaRequest request)
Description copied from interface:BdsRemove Kafka from the cluster.- Specified by:
removeKafkain interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeNode
public RemoveNodeResponse removeNode(RemoveNodeRequest request)
Description copied from interface:BdsRemove a single node of a Big Data Service cluster- Specified by:
removeNodein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeNodeReplaceConfiguration
public RemoveNodeReplaceConfigurationResponse removeNodeReplaceConfiguration(RemoveNodeReplaceConfigurationRequest request)
Description copied from interface:BdsDeletes a nodeReplaceConfiguration- Specified by:
removeNodeReplaceConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeResourcePrincipalConfiguration
public RemoveResourcePrincipalConfigurationResponse removeResourcePrincipalConfiguration(RemoveResourcePrincipalConfigurationRequest request)
Description copied from interface:BdsDelete the resource principal configuration for the cluster.- Specified by:
removeResourcePrincipalConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
renewCertificate
public RenewCertificateResponse renewCertificate(RenewCertificateRequest request)
Description copied from interface:BdsRenewing TLS/SSL for various ODH services running on the BDS cluster.- Specified by:
renewCertificatein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
replaceNode
public ReplaceNodeResponse replaceNode(ReplaceNodeRequest request)
Description copied from interface:BdsReplaces a node of a Big Data Service cluster from backup.- Specified by:
replaceNodein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
restartNode
public RestartNodeResponse restartNode(RestartNodeRequest request)
Description copied from interface:BdsRestarts a single node of a Big Data Service cluster- Specified by:
restartNodein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startBdsInstance
public StartBdsInstanceResponse startBdsInstance(StartBdsInstanceRequest request)
Description copied from interface:BdsStarts the BDS cluster that was stopped earlier.- Specified by:
startBdsInstancein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
stopBdsInstance
public StopBdsInstanceResponse stopBdsInstance(StopBdsInstanceRequest request)
Description copied from interface:BdsStops the BDS cluster that can be started at later point of time.- Specified by:
stopBdsInstancein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
testBdsMetastoreConfiguration
public TestBdsMetastoreConfigurationResponse testBdsMetastoreConfiguration(TestBdsMetastoreConfigurationRequest request)
Description copied from interface:BdsTest specified metastore configuration.- Specified by:
testBdsMetastoreConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
testBdsObjectStorageConnection
public TestBdsObjectStorageConnectionResponse testBdsObjectStorageConnection(TestBdsObjectStorageConnectionRequest request)
Description copied from interface:BdsTest access to specified Object Storage bucket using the API key.- Specified by:
testBdsObjectStorageConnectionin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAutoScalingConfiguration
public 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 interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateBdsInstance
public UpdateBdsInstanceResponse updateBdsInstance(UpdateBdsInstanceRequest request)
Description copied from interface:BdsUpdates the Big Data Service cluster identified by the given ID.- Specified by:
updateBdsInstancein interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateBdsMetastoreConfiguration
public UpdateBdsMetastoreConfigurationResponse updateBdsMetastoreConfiguration(UpdateBdsMetastoreConfigurationRequest request)
Description copied from interface:BdsUpdate the BDS metastore configuration represented by the provided ID.- Specified by:
updateBdsMetastoreConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateIdentityConfiguration
public UpdateIdentityConfigurationResponse updateIdentityConfiguration(UpdateIdentityConfigurationRequest request)
Description copied from interface:BdsUpdate the IAM user sync and UPST configuration for the specified identity configuration- Specified by:
updateIdentityConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateNodeBackupConfiguration
public UpdateNodeBackupConfigurationResponse updateNodeBackupConfiguration(UpdateNodeBackupConfigurationRequest request)
Description copied from interface:BdsUpdates fields on NodeBackupConfiguration, including the name, the schedule.- Specified by:
updateNodeBackupConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateNodeReplaceConfiguration
public UpdateNodeReplaceConfigurationResponse updateNodeReplaceConfiguration(UpdateNodeReplaceConfigurationRequest request)
Description copied from interface:BdsUpdates fields on nodeReplaceConfigurations, including the name, the schedule- Specified by:
updateNodeReplaceConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateResourcePrincipalConfiguration
public UpdateResourcePrincipalConfigurationResponse updateResourcePrincipalConfiguration(UpdateResourcePrincipalConfigurationRequest request)
Description copied from interface:BdsUpdates fields on resourcePrincipalConfiguration, including the name, the lifeSpanInHours of the token.- Specified by:
updateResourcePrincipalConfigurationin interfaceBds- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public BdsWaiters getWaiters()
Description copied from interface:BdsGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceBds- Returns:
- The service waiters.
-
getPaginators
public 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 interfaceBds- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public 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
-
populateServiceParametersInEndpoint
public 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 userequiredParametersMap- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public 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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-