Package com.oracle.bmc.aidataplatform

Class AiDataPlatformClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.aidataplatform.AiDataPlatformClient

All Implemented Interfaces:

AiDataPlatform, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240831")
public class AiDataPlatformClient
extends BaseSyncClient
implements AiDataPlatform

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AiDataPlatformClient.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 AiDataPlatform.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static AiDataPlatformClient.Builder	builder()	Create a builder for this client.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request)	Cancels a work request.
ChangeAiDataPlatformCompartmentResponse	changeAiDataPlatformCompartment(ChangeAiDataPlatformCompartmentRequest request)	Moves a AiDataPlatform into a different compartment within the same tenancy.
void	close()
CreateAiDataPlatformResponse	createAiDataPlatform(CreateAiDataPlatformRequest request)	Creates a AiDataPlatform.
DeleteAiDataPlatformResponse	deleteAiDataPlatform(DeleteAiDataPlatformRequest request)	Deletes a AiDataPlatform.
GetAiDataPlatformResponse	getAiDataPlatform(GetAiDataPlatformRequest request)	Gets information about a AiDataPlatform.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
AiDataPlatformPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
AiDataPlatformWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets the details of a work request.
ListAiDataPlatformsResponse	listAiDataPlatforms(ListAiDataPlatformsRequest request)	Gets a list of AiDataPlatforms.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Lists the errors for a work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Lists the logs for a 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.
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’).
UpdateAiDataPlatformResponse	updateAiDataPlatform(UpdateAiDataPlatformRequest request)	Updates a AiDataPlatform.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
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.aidataplatform.AiDataPlatform

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for AiDataPlatform.

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

AiDataPlatformClient

@Deprecated
public AiDataPlatformClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

AiDataPlatformClient

@Deprecated
public AiDataPlatformClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

AiDataPlatformClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

AiDataPlatformClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

AiDataPlatformClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

AiDataPlatformClient

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

AiDataPlatformClient

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

AiDataPlatformClient

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

Method Detail

builder

public static AiDataPlatformClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: AiDataPlatform

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 AiDataPlatform

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: AiDataPlatform

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 AiDataPlatform

Parameters:

regionId - The public region ID.

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: AiDataPlatform

Cancels a work request.

Specified by:

cancelWorkRequest in interface AiDataPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeAiDataPlatformCompartment

public ChangeAiDataPlatformCompartmentResponse changeAiDataPlatformCompartment(ChangeAiDataPlatformCompartmentRequest request)

Description copied from interface: AiDataPlatform

Moves a AiDataPlatform into a different compartment within the same tenancy.

For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeAiDataPlatformCompartment in interface AiDataPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAiDataPlatform

public CreateAiDataPlatformResponse createAiDataPlatform(CreateAiDataPlatformRequest request)

Description copied from interface: AiDataPlatform

Creates a AiDataPlatform.

Specified by:

createAiDataPlatform in interface AiDataPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAiDataPlatform

public DeleteAiDataPlatformResponse deleteAiDataPlatform(DeleteAiDataPlatformRequest request)

Description copied from interface: AiDataPlatform

Deletes a AiDataPlatform.

Specified by:

deleteAiDataPlatform in interface AiDataPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAiDataPlatform

public GetAiDataPlatformResponse getAiDataPlatform(GetAiDataPlatformRequest request)

Description copied from interface: AiDataPlatform

Gets information about a AiDataPlatform.

Specified by:

getAiDataPlatform in interface AiDataPlatform

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

Gets the details of a work request.

Specified by:

getWorkRequest in interface AiDataPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAiDataPlatforms

public ListAiDataPlatformsResponse listAiDataPlatforms(ListAiDataPlatformsRequest request)

Description copied from interface: AiDataPlatform

Gets a list of AiDataPlatforms.

Specified by:

listAiDataPlatforms in interface AiDataPlatform

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

Lists the errors for a work request.

Specified by:

listWorkRequestErrors in interface AiDataPlatform

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

Lists the logs for a work request.

Specified by:

listWorkRequestLogs in interface AiDataPlatform

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

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface AiDataPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAiDataPlatform

public UpdateAiDataPlatformResponse updateAiDataPlatform(UpdateAiDataPlatformRequest request)

Description copied from interface: AiDataPlatform

Updates a AiDataPlatform.

Specified by:

updateAiDataPlatform in interface AiDataPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public AiDataPlatformWaiters getWaiters()

Description copied from interface: AiDataPlatform

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

Specified by:

getWaiters in interface AiDataPlatform

Returns:

The service waiters.

getPaginators

public AiDataPlatformPaginators getPaginators()

Description copied from interface: AiDataPlatform

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 AiDataPlatform

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