com.oracle.bmc.bds

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 and Description
static class	BdsClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Bds.

Constructor Summary

Constructors

Constructor and Description
BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
BdsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
ActivateBdsMetastoreConfigurationResponse	activateBdsMetastoreConfiguration(ActivateBdsMetastoreConfigurationRequest request) Activate specified metastore configuration.
AddAutoScalingConfigurationResponse	addAutoScalingConfiguration(AddAutoScalingConfigurationRequest request) Add an autoscale configuration to the cluster.
AddBlockStorageResponse	addBlockStorage(AddBlockStorageRequest request) Adds block storage to existing worker/compute only worker nodes.
AddCloudSqlResponse	addCloudSql(AddCloudSqlRequest request) Adds Cloud SQL to your cluster.
AddKafkaResponse	addKafka(AddKafkaRequest request) Adds Kafka to a cluster.
AddMasterNodesResponse	addMasterNodes(AddMasterNodesRequest request) Increases the size (scales out) of a cluster by adding master nodes.
AddUtilityNodesResponse	addUtilityNodes(AddUtilityNodesRequest request) Increases the size (scales out) of a cluster by adding utility nodes.
AddWorkerNodesResponse	addWorkerNodes(AddWorkerNodesRequest request) Increases the size (scales out) a cluster by adding worker nodes(data/compute).
BackupNodeResponse	backupNode(BackupNodeRequest request) Takes a backup of of given nodes.
static BdsClient.Builder	builder() Create a builder for this client.
CertificateServiceInfoResponse	certificateServiceInfo(CertificateServiceInfoRequest request) A list of services and their certificate details.
ChangeBdsInstanceCompartmentResponse	changeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest request) Moves a Big Data Service cluster into a different compartment.
ChangeShapeResponse	changeShape(ChangeShapeRequest request) Changes the size of a cluster by scaling up or scaling down the nodes.
void	close()
CreateBdsApiKeyResponse	createBdsApiKey(CreateBdsApiKeyRequest request) Create an API key on behalf of the specified user.
CreateBdsInstanceResponse	createBdsInstance(CreateBdsInstanceRequest request) Creates a Big Data Service cluster.
CreateBdsMetastoreConfigurationResponse	createBdsMetastoreConfiguration(CreateBdsMetastoreConfigurationRequest request) Create and activate external metastore configuration.
CreateNodeBackupConfigurationResponse	createNodeBackupConfiguration(CreateNodeBackupConfigurationRequest request) Add a node volume backup configuration to the cluster for an indicated node type or node.
CreateNodeReplaceConfigurationResponse	createNodeReplaceConfiguration(CreateNodeReplaceConfigurationRequest request) Add a nodeReplaceConfigurations to the cluster.
CreateResourcePrincipalConfigurationResponse	createResourcePrincipalConfiguration(CreateResourcePrincipalConfigurationRequest request) Create a resource principal session token configuration.
DeleteBdsApiKeyResponse	deleteBdsApiKey(DeleteBdsApiKeyRequest request) Deletes the user’s API key represented by the provided ID.
DeleteBdsInstanceResponse	deleteBdsInstance(DeleteBdsInstanceRequest request) Deletes the cluster identified by the given ID.
DeleteBdsMetastoreConfigurationResponse	deleteBdsMetastoreConfiguration(DeleteBdsMetastoreConfigurationRequest request) Delete the BDS metastore configuration represented by the provided ID.
DeleteNodeBackupResponse	deleteNodeBackup(DeleteNodeBackupRequest request) Delete the NodeBackup represented by the provided ID.
DeleteNodeBackupConfigurationResponse	deleteNodeBackupConfiguration(DeleteNodeBackupConfigurationRequest request) Delete the NodeBackupConfiguration represented by the provided ID.
DisableCertificateResponse	disableCertificate(DisableCertificateRequest request) Disabling TLS/SSL for various ODH services running on the BDS cluster.
EnableCertificateResponse	enableCertificate(EnableCertificateRequest request) Configuring TLS/SSL for various ODH services running on the BDS cluster.
ExecuteBootstrapScriptResponse	executeBootstrapScript(ExecuteBootstrapScriptRequest request) Execute bootstrap script.
ForceRefreshResourcePrincipalResponse	forceRefreshResourcePrincipal(ForceRefreshResourcePrincipalRequest request) Force Refresh Resource Principal for the cluster.
GetAutoScalingConfigurationResponse	getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request) Returns details of the autoscale configuration identified by the given ID.
GetBdsApiKeyResponse	getBdsApiKey(GetBdsApiKeyRequest request) Returns the user’s API key information for the given ID.
GetBdsInstanceResponse	getBdsInstance(GetBdsInstanceRequest request) Returns information about the Big Data Service cluster identified by the given ID.
GetBdsMetastoreConfigurationResponse	getBdsMetastoreConfiguration(GetBdsMetastoreConfigurationRequest request) Returns the BDS Metastore configuration information for the given ID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetNodeBackupResponse	getNodeBackup(GetNodeBackupRequest request) Returns details of NodeBackup identified by the given ID.
GetNodeBackupConfigurationResponse	getNodeBackupConfiguration(GetNodeBackupConfigurationRequest request) Returns details of the NodeBackupConfiguration identified by the given ID.
GetNodeReplaceConfigurationResponse	getNodeReplaceConfiguration(GetNodeReplaceConfigurationRequest request) Returns details of the nodeReplaceConfiguration identified by the given ID.
GetOsPatchDetailsResponse	getOsPatchDetails(GetOsPatchDetailsRequest request) Get the details of an os patch
BdsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetResourcePrincipalConfigurationResponse	getResourcePrincipalConfiguration(GetResourcePrincipalConfigurationRequest request) Returns details of the resourcePrincipalConfiguration identified by the given ID.
BdsWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Returns the status of the work request identified by the given ID.
InstallOsPatchResponse	installOsPatch(InstallOsPatchRequest request) Install an os patch on a cluster
InstallPatchResponse	installPatch(InstallPatchRequest request) Install the specified patch to this cluster.
ListAutoScalingConfigurationsResponse	listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request) Returns information about the autoscaling configurations for a cluster.
ListBdsApiKeysResponse	listBdsApiKeys(ListBdsApiKeysRequest request) Returns a list of all API keys associated with this Big Data Service cluster.
ListBdsInstancesResponse	listBdsInstances(ListBdsInstancesRequest request) Returns a list of all Big Data Service clusters in a compartment.
ListBdsMetastoreConfigurationsResponse	listBdsMetastoreConfigurations(ListBdsMetastoreConfigurationsRequest request) Returns a list of metastore configurations ssociated with this Big Data Service cluster.
ListNodeBackupConfigurationsResponse	listNodeBackupConfigurations(ListNodeBackupConfigurationsRequest request) Returns information about the NodeBackupConfigurations.
ListNodeBackupsResponse	listNodeBackups(ListNodeBackupsRequest request) Returns information about the node Backups.
ListNodeReplaceConfigurationsResponse	listNodeReplaceConfigurations(ListNodeReplaceConfigurationsRequest request) Returns information about the NodeReplaceConfiguration.
ListOsPatchesResponse	listOsPatches(ListOsPatchesRequest request) List all available os patches for a given cluster
ListPatchesResponse	listPatches(ListPatchesRequest request) List all the available patches for this cluster.
ListPatchHistoriesResponse	listPatchHistories(ListPatchHistoriesRequest request) List the patch history of this cluster.
ListResourcePrincipalConfigurationsResponse	listResourcePrincipalConfigurations(ListResourcePrincipalConfigurationsRequest request) Returns information about the ResourcePrincipalConfiguration.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Returns a paginated list of errors for a work request identified by the given ID.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Returns a paginated list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
RemoveAutoScalingConfigurationResponse	removeAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest request) Deletes an autoscale configuration.
RemoveCloudSqlResponse	removeCloudSql(RemoveCloudSqlRequest request) Removes Cloud SQL from the cluster.
RemoveKafkaResponse	removeKafka(RemoveKafkaRequest request) Remove Kafka from the cluster.
RemoveNodeResponse	removeNode(RemoveNodeRequest request) Remove a single node of a Big Data Service cluster
RemoveNodeReplaceConfigurationResponse	removeNodeReplaceConfiguration(RemoveNodeReplaceConfigurationRequest request) Deletes a nodeReplaceConfiguration
RemoveResourcePrincipalConfigurationResponse	removeResourcePrincipalConfiguration(RemoveResourcePrincipalConfigurationRequest request) Delete the resource principal configuration for the cluster.
RenewCertificateResponse	renewCertificate(RenewCertificateRequest request) Renewing TLS/SSL for various ODH services running on the BDS cluster.
ReplaceNodeResponse	replaceNode(ReplaceNodeRequest request) Replaces a node of a Big Data Service cluster from backup.
RestartNodeResponse	restartNode(RestartNodeRequest request) Restarts a single node of a Big Data Service cluster
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
StartBdsInstanceResponse	startBdsInstance(StartBdsInstanceRequest request) Starts the BDS cluster that was stopped earlier.
StopBdsInstanceResponse	stopBdsInstance(StopBdsInstanceRequest request) Stops the BDS cluster that can be started at later point of time.
TestBdsMetastoreConfigurationResponse	testBdsMetastoreConfiguration(TestBdsMetastoreConfigurationRequest request) Test specified metastore configuration.
TestBdsObjectStorageConnectionResponse	testBdsObjectStorageConnection(TestBdsObjectStorageConnectionRequest request) Test access to specified Object Storage bucket using the API key.
UpdateAutoScalingConfigurationResponse	updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request) Updates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale configuration is enabled.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateBdsInstanceResponse	updateBdsInstance(UpdateBdsInstanceRequest request) Updates the Big Data Service cluster identified by the given ID.
UpdateBdsMetastoreConfigurationResponse	updateBdsMetastoreConfiguration(UpdateBdsMetastoreConfigurationRequest request) Update the BDS metastore configuration represented by the provided ID.
UpdateNodeBackupConfigurationResponse	updateNodeBackupConfiguration(UpdateNodeBackupConfigurationRequest request) Updates fields on NodeBackupConfiguration, including the name, the schedule.
UpdateNodeReplaceConfigurationResponse	updateNodeReplaceConfiguration(UpdateNodeReplaceConfigurationRequest request) Updates fields on nodeReplaceConfigurations, including the name, the schedule
UpdateResourcePrincipalConfigurationResponse	updateResourcePrincipalConfiguration(UpdateResourcePrincipalConfigurationRequest request) Updates fields on resourcePrincipalConfiguration, including the name, the lifeSpanInHours of the token.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

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 com.oracle.bmc.bds.Bds

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Bds.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

BdsClient

@Deprecated
public BdsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

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 the builder instead.

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 the builder instead.

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 the builder instead.

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 the builder instead.

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 the builder instead.

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 the builder instead.

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 the builder instead.

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

builder

public static BdsClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Bds

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface Bds

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Bds

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface Bds

Parameters:

regionId - The public region ID.

activateBdsMetastoreConfiguration

public ActivateBdsMetastoreConfigurationResponse activateBdsMetastoreConfiguration(ActivateBdsMetastoreConfigurationRequest request)

Description copied from interface: Bds

Activate specified metastore configuration.

Specified by:

activateBdsMetastoreConfiguration in interface Bds

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: Bds

Add an autoscale configuration to the cluster.

Specified by:

addAutoScalingConfiguration in interface Bds

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: Bds

Adds block storage to existing worker/compute only worker nodes. The same amount of storage will be added to all worker/compute only worker nodes. No change will be made to storage that is already attached. Block storage cannot be removed.

Specified by:

addBlockStorage in interface Bds

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: Bds

Adds Cloud SQL to your cluster. You can use Cloud SQL to query against non-relational data stored in multiple big data sources, including Apache Hive, HDFS, Oracle NoSQL Database, and Apache HBase. Adding Cloud SQL adds a query server node to the cluster and creates cell servers on all the worker nodes in the cluster.

Specified by:

addCloudSql in interface Bds

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: Bds

Adds Kafka to a cluster.

Specified by:

addKafka in interface Bds

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

addMasterNodes

public AddMasterNodesResponse addMasterNodes(AddMasterNodesRequest request)

Description copied from interface: Bds

Increases 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:

addMasterNodes in interface Bds

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: Bds

Increases 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:

addUtilityNodes in interface Bds

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: Bds

Increases the size (scales out) a cluster by adding worker nodes(data/compute). The added worker nodes will have the same shape and will have the same amount of attached block storage as other worker nodes in the cluster.

Specified by:

addWorkerNodes in interface Bds

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: Bds

Takes a backup of of given nodes.

Specified by:

backupNode in interface Bds

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: Bds

A list of services and their certificate details.

Specified by:

certificateServiceInfo in interface Bds

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: Bds

Moves a Big Data Service cluster into a different compartment.

Specified by:

changeBdsInstanceCompartment in interface Bds

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: Bds

Changes the size of a cluster by scaling up or scaling down the nodes. Nodes are scaled up or down by changing the shapes of all the nodes of the same type to the next larger or smaller shape. The node types are master, utility, worker, and Cloud SQL. Only nodes with VM-STANDARD shapes can be scaled.

Specified by:

changeShape in interface Bds

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: Bds

Create an API key on behalf of the specified user.

Specified by:

createBdsApiKey in interface Bds

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: Bds

Creates a Big Data Service cluster.

Specified by:

createBdsInstance in interface Bds

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: Bds

Create and activate external metastore configuration.

Specified by:

createBdsMetastoreConfiguration in interface Bds

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: Bds

Add a node volume backup configuration to the cluster for an indicated node type or node.

Specified by:

createNodeBackupConfiguration in interface Bds

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: Bds

Add a nodeReplaceConfigurations to the cluster.

Specified by:

createNodeReplaceConfiguration in interface Bds

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: Bds

Create a resource principal session token configuration.

Specified by:

createResourcePrincipalConfiguration in interface Bds

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: Bds

Deletes the user’s API key represented by the provided ID.

Specified by:

deleteBdsApiKey in interface Bds

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: Bds

Deletes the cluster identified by the given ID.

Specified by:

deleteBdsInstance in interface Bds

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: Bds

Delete the BDS metastore configuration represented by the provided ID.

Specified by:

deleteBdsMetastoreConfiguration in interface Bds

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: Bds

Delete the NodeBackup represented by the provided ID.

Specified by:

deleteNodeBackup in interface Bds

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: Bds

Delete the NodeBackupConfiguration represented by the provided ID.

Specified by:

deleteNodeBackupConfiguration in interface Bds

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: Bds

Disabling TLS/SSL for various ODH services running on the BDS cluster.

Specified by:

disableCertificate in interface Bds

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: Bds

Configuring TLS/SSL for various ODH services running on the BDS cluster.

Specified by:

enableCertificate in interface Bds

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: Bds

Execute bootstrap script.

Specified by:

executeBootstrapScript in interface Bds

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: Bds

Force Refresh Resource Principal for the cluster.

Specified by:

forceRefreshResourcePrincipal in interface Bds

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: Bds

Returns details of the autoscale configuration identified by the given ID.

Specified by:

getAutoScalingConfiguration in interface Bds

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: Bds

Returns the user’s API key information for the given ID.

Specified by:

getBdsApiKey in interface Bds

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: Bds

Returns information about the Big Data Service cluster identified by the given ID.

Specified by:

getBdsInstance in interface Bds

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: Bds

Returns the BDS Metastore configuration information for the given ID.

Specified by:

getBdsMetastoreConfiguration in interface Bds

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: Bds

Returns details of NodeBackup identified by the given ID.

Specified by:

getNodeBackup in interface Bds

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: Bds

Returns details of the NodeBackupConfiguration identified by the given ID.

Specified by:

getNodeBackupConfiguration in interface Bds

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: Bds

Returns details of the nodeReplaceConfiguration identified by the given ID.

Specified by:

getNodeReplaceConfiguration in interface Bds

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: Bds

Get the details of an os patch

Specified by:

getOsPatchDetails in interface Bds

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: Bds

Returns details of the resourcePrincipalConfiguration identified by the given ID.

Specified by:

getResourcePrincipalConfiguration in interface Bds

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: Bds

Returns the status of the work request identified by the given ID.

Specified by:

getWorkRequest in interface Bds

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: Bds

Install an os patch on a cluster

Specified by:

installOsPatch in interface Bds

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: Bds

Install the specified patch to this cluster.

Specified by:

installPatch in interface Bds

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: Bds

Returns information about the autoscaling configurations for a cluster.

Specified by:

listAutoScalingConfigurations in interface Bds

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: Bds

Returns a list of all API keys associated with this Big Data Service cluster.

Specified by:

listBdsApiKeys in interface Bds

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: Bds

Returns a list of all Big Data Service clusters in a compartment.

Specified by:

listBdsInstances in interface Bds

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: Bds

Returns a list of metastore configurations ssociated with this Big Data Service cluster.

Specified by:

listBdsMetastoreConfigurations in interface Bds

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: Bds

Returns information about the NodeBackupConfigurations.

Specified by:

listNodeBackupConfigurations in interface Bds

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: Bds

Returns information about the node Backups.

Specified by:

listNodeBackups in interface Bds

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: Bds

Returns information about the NodeReplaceConfiguration.

Specified by:

listNodeReplaceConfigurations in interface Bds

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: Bds

List all available os patches for a given cluster

Specified by:

listOsPatches in interface Bds

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: Bds

List the patch history of this cluster.

Specified by:

listPatchHistories in interface Bds

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: Bds

List all the available patches for this cluster.

Specified by:

listPatches in interface Bds

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: Bds

Returns information about the ResourcePrincipalConfiguration.

Specified by:

listResourcePrincipalConfigurations in interface Bds

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: Bds

Returns a paginated list of errors for a work request identified by the given ID.

Specified by:

listWorkRequestErrors in interface Bds

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: Bds

Returns a paginated list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface Bds

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: Bds

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface Bds

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: Bds

Deletes an autoscale configuration.

Specified by:

removeAutoScalingConfiguration in interface Bds

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: Bds

Removes Cloud SQL from the cluster.

Specified by:

removeCloudSql in interface Bds

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: Bds

Remove Kafka from the cluster.

Specified by:

removeKafka in interface Bds

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: Bds

Remove a single node of a Big Data Service cluster

Specified by:

removeNode in interface Bds

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: Bds

Deletes a nodeReplaceConfiguration

Specified by:

removeNodeReplaceConfiguration in interface Bds

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: Bds

Delete the resource principal configuration for the cluster.

Specified by:

removeResourcePrincipalConfiguration in interface Bds

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: Bds

Renewing TLS/SSL for various ODH services running on the BDS cluster.

Specified by:

renewCertificate in interface Bds

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: Bds

Replaces a node of a Big Data Service cluster from backup.

Specified by:

replaceNode in interface Bds

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: Bds

Restarts a single node of a Big Data Service cluster

Specified by:

restartNode in interface Bds

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: Bds

Starts the BDS cluster that was stopped earlier.

Specified by:

startBdsInstance in interface Bds

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: Bds

Stops the BDS cluster that can be started at later point of time.

Specified by:

stopBdsInstance in interface Bds

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: Bds

Test specified metastore configuration.

Specified by:

testBdsMetastoreConfiguration in interface Bds

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: Bds

Test access to specified Object Storage bucket using the API key.

Specified by:

testBdsObjectStorageConnection in interface Bds

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: Bds

Updates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale configuration is enabled.

Specified by:

updateAutoScalingConfiguration in interface Bds

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: Bds

Updates the Big Data Service cluster identified by the given ID.

Specified by:

updateBdsInstance in interface Bds

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: Bds

Update the BDS metastore configuration represented by the provided ID.

Specified by:

updateBdsMetastoreConfiguration in interface Bds

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: Bds

Updates fields on NodeBackupConfiguration, including the name, the schedule.

Specified by:

updateNodeBackupConfiguration in interface Bds

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: Bds

Updates fields on nodeReplaceConfigurations, including the name, the schedule

Specified by:

updateNodeReplaceConfiguration in interface Bds

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: Bds

Updates fields on resourcePrincipalConfiguration, including the name, the lifeSpanInHours of the token.

Specified by:

updateResourcePrincipalConfiguration in interface Bds

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: Bds

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

Specified by:

getWaiters in interface Bds

Returns:

The service waiters.

getPaginators

public BdsPaginators getPaginators()

Description copied from interface: Bds

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

Specified by:

getPaginators in interface Bds

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 use

requiredParametersMap - 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 backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()