Package com.oracle.bmc.opensearch

Class OpensearchClusterClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.opensearch.OpensearchClusterClient

All Implemented Interfaces:

OpensearchCluster, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180828")
public class OpensearchClusterClient
extends BaseSyncClient
implements OpensearchCluster

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpensearchClusterClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	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 OpensearchCluster.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BackupOpensearchClusterResponse	backupOpensearchCluster(BackupOpensearchClusterRequest request)	Backup the opensearch cluster details.
static OpensearchClusterClient.Builder	builder()	Create a builder for this client.
void	close()
ConfigureOutboundClusterResponse	configureOutboundCluster(ConfigureOutboundClusterRequest request)	Configure Outbound cluster for cross-cluster operations
CreateOpensearchClusterResponse	createOpensearchCluster(CreateOpensearchClusterRequest request)	Creates a new OpensearchCluster.
DeleteOpensearchClusterResponse	deleteOpensearchCluster(DeleteOpensearchClusterRequest request)	Deletes a OpensearchCluster resource by identifier
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetOpensearchClusterResponse	getOpensearchCluster(GetOpensearchClusterRequest request)	Gets a OpensearchCluster by identifier
OpensearchClusterPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
OpensearchClusterWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets the status of the work request with the given ID.
ListOpensearchClustersResponse	listOpensearchClusters(ListOpensearchClustersRequest request)	Returns a list of OpensearchClusters.
ListOpensearchClusterShapesResponse	listOpensearchClusterShapes(ListOpensearchClusterShapesRequest request)	Retrieves available OpenSearch Cluster node shapes.
ListOpensearchVersionsResponse	listOpensearchVersions(ListOpensearchVersionsRequest request)	Lists the supported Opensearch versions
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Return a (paginated) list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Return a (paginated) list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	Lists the work requests in a compartment.
OpensearchClusterRestoreResponse	opensearchClusterRestore(OpensearchClusterRestoreRequest request)	Restore the opensearch cluster details.
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.
ResizeOpensearchClusterHorizontalResponse	resizeOpensearchClusterHorizontal(ResizeOpensearchClusterHorizontalRequest request)	Resize the opensearch cluster horizontal details.
ResizeOpensearchClusterVerticalResponse	resizeOpensearchClusterVertical(ResizeOpensearchClusterVerticalRequest request)	Resize the opensearch cluster vertical details.
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateOpensearchClusterResponse	updateOpensearchCluster(UpdateOpensearchClusterRequest request)	Updates the OpensearchCluster
UpgradeOpenSearchClusterResponse	upgradeOpenSearchCluster(UpgradeOpenSearchClusterRequest request)	Upgrade or clone the opensearch cluster.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.opensearch.OpensearchCluster

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for OpensearchCluster.

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

OpensearchClusterClient

@Deprecated
public OpensearchClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

OpensearchClusterClient

@Deprecated
public OpensearchClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

OpensearchClusterClient

@Deprecated
public OpensearchClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

OpensearchClusterClient

@Deprecated
public OpensearchClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OpensearchClusterClient

@Deprecated
public OpensearchClusterClient(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 OpensearchClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OpensearchClusterClient

@Deprecated
public OpensearchClusterClient(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 OpensearchClusterClient.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)

OpensearchClusterClient

@Deprecated
public OpensearchClusterClient(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 OpensearchClusterClient.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

OpensearchClusterClient

@Deprecated
public OpensearchClusterClient(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 OpensearchClusterClient.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 - OpensearchClusterClient.Builder.executorService

Method Detail

builder

public static OpensearchClusterClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OpensearchCluster

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 OpensearchCluster

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OpensearchCluster

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 OpensearchCluster

Parameters:

regionId - The public region ID.

backupOpensearchCluster

public BackupOpensearchClusterResponse backupOpensearchCluster(BackupOpensearchClusterRequest request)

Description copied from interface: OpensearchCluster

Backup the opensearch cluster details.

Specified by:

backupOpensearchCluster in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

configureOutboundCluster

public ConfigureOutboundClusterResponse configureOutboundCluster(ConfigureOutboundClusterRequest request)

Description copied from interface: OpensearchCluster

Configure Outbound cluster for cross-cluster operations

Specified by:

configureOutboundCluster in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOpensearchCluster

public CreateOpensearchClusterResponse createOpensearchCluster(CreateOpensearchClusterRequest request)

Description copied from interface: OpensearchCluster

Creates a new OpensearchCluster.

Specified by:

createOpensearchCluster in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOpensearchCluster

public DeleteOpensearchClusterResponse deleteOpensearchCluster(DeleteOpensearchClusterRequest request)

Description copied from interface: OpensearchCluster

Deletes a OpensearchCluster resource by identifier

Specified by:

deleteOpensearchCluster in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOpensearchCluster

public GetOpensearchClusterResponse getOpensearchCluster(GetOpensearchClusterRequest request)

Description copied from interface: OpensearchCluster

Gets a OpensearchCluster by identifier

Specified by:

getOpensearchCluster in interface OpensearchCluster

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

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

Specified by:

getWorkRequest in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOpensearchClusterShapes

public ListOpensearchClusterShapesResponse listOpensearchClusterShapes(ListOpensearchClusterShapesRequest request)

Description copied from interface: OpensearchCluster

Retrieves available OpenSearch Cluster node shapes.

Specified by:

listOpensearchClusterShapes in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOpensearchClusters

public ListOpensearchClustersResponse listOpensearchClusters(ListOpensearchClustersRequest request)

Description copied from interface: OpensearchCluster

Returns a list of OpensearchClusters.

Specified by:

listOpensearchClusters in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOpensearchVersions

public ListOpensearchVersionsResponse listOpensearchVersions(ListOpensearchVersionsRequest request)

Description copied from interface: OpensearchCluster

Lists the supported Opensearch versions

Specified by:

listOpensearchVersions in interface OpensearchCluster

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

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

Specified by:

listWorkRequestErrors in interface OpensearchCluster

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

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

Specified by:

listWorkRequestLogs in interface OpensearchCluster

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

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

opensearchClusterRestore

public OpensearchClusterRestoreResponse opensearchClusterRestore(OpensearchClusterRestoreRequest request)

Description copied from interface: OpensearchCluster

Restore the opensearch cluster details.

Specified by:

opensearchClusterRestore in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

resizeOpensearchClusterHorizontal

public ResizeOpensearchClusterHorizontalResponse resizeOpensearchClusterHorizontal(ResizeOpensearchClusterHorizontalRequest request)

Description copied from interface: OpensearchCluster

Resize the opensearch cluster horizontal details.

Specified by:

resizeOpensearchClusterHorizontal in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

resizeOpensearchClusterVertical

public ResizeOpensearchClusterVerticalResponse resizeOpensearchClusterVertical(ResizeOpensearchClusterVerticalRequest request)

Description copied from interface: OpensearchCluster

Resize the opensearch cluster vertical details.

Specified by:

resizeOpensearchClusterVertical in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOpensearchCluster

public UpdateOpensearchClusterResponse updateOpensearchCluster(UpdateOpensearchClusterRequest request)

Description copied from interface: OpensearchCluster

Updates the OpensearchCluster

Specified by:

updateOpensearchCluster in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

upgradeOpenSearchCluster

public UpgradeOpenSearchClusterResponse upgradeOpenSearchCluster(UpgradeOpenSearchClusterRequest request)

Description copied from interface: OpensearchCluster

Upgrade or clone the opensearch cluster.

Specified by:

upgradeOpenSearchCluster in interface OpensearchCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public OpensearchClusterWaiters getWaiters()

Description copied from interface: OpensearchCluster

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

Specified by:

getWaiters in interface OpensearchCluster

Returns:

The service waiters.

getPaginators

public OpensearchClusterPaginators getPaginators()

Description copied from interface: OpensearchCluster

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 OpensearchCluster

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()