com.oracle.bmc.datalabelingservice

Class DataLabelingManagementAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.datalabelingservice.DataLabelingManagementAsyncClient

All Implemented Interfaces:

DataLabelingManagementAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20211001")
public class DataLabelingManagementAsyncClient
extends BaseAsyncClient
implements DataLabelingManagementAsync

Async client implementation for DataLabelingManagement service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Future<AddDatasetLabelsResponse>	addDatasetLabels(AddDatasetLabelsRequest request, AsyncHandler<AddDatasetLabelsRequest,AddDatasetLabelsResponse> handler) Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.
static DataLabelingManagementAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeDatasetCompartmentResponse>	changeDatasetCompartment(ChangeDatasetCompartmentRequest request, AsyncHandler<ChangeDatasetCompartmentRequest,ChangeDatasetCompartmentResponse> handler) Moves a Dataset resource from one compartment identifier to another.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateDatasetResponse>	createDataset(CreateDatasetRequest request, AsyncHandler<CreateDatasetRequest,CreateDatasetResponse> handler) Creates a new Dataset.
Future<DeleteDatasetResponse>	deleteDataset(DeleteDatasetRequest request, AsyncHandler<DeleteDatasetRequest,DeleteDatasetResponse> handler) Deletes a Dataset resource by identifier
Future<GenerateDatasetRecordsResponse>	generateDatasetRecords(GenerateDatasetRecordsRequest request, AsyncHandler<GenerateDatasetRecordsRequest,GenerateDatasetRecordsResponse> handler) Generates Record resources from the Dataset’s data source
String	getClientCommonLibraryVersion()
Future<GetDatasetResponse>	getDataset(GetDatasetRequest request, AsyncHandler<GetDatasetRequest,GetDatasetResponse> handler) Gets a Dataset by identifier
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the work request with the given ID.
Future<ImportPreAnnotatedDataResponse>	importPreAnnotatedData(ImportPreAnnotatedDataRequest request, AsyncHandler<ImportPreAnnotatedDataRequest,ImportPreAnnotatedDataResponse> handler) Imports records and annotations from dataset files into existing Dataset.
Future<ListAnnotationFormatsResponse>	listAnnotationFormats(ListAnnotationFormatsRequest request, AsyncHandler<ListAnnotationFormatsRequest,ListAnnotationFormatsResponse> handler) These are a static list in a given region.
Future<ListDatasetsResponse>	listDatasets(ListDatasetsRequest request, AsyncHandler<ListDatasetsRequest,ListDatasetsResponse> handler) Returns a list of Datasets.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Return a (paginated) list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Return a (paginated) list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) 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.
Future<RemoveDatasetLabelsResponse>	removeDatasetLabels(RemoveDatasetLabelsRequest request, AsyncHandler<RemoveDatasetLabelsRequest,RemoveDatasetLabelsResponse> handler) Removes the labels from the Dataset Labelset.
Future<RenameDatasetLabelsResponse>	renameDatasetLabels(RenameDatasetLabelsRequest request, AsyncHandler<RenameDatasetLabelsRequest,RenameDatasetLabelsResponse> handler) Renames the labels from the Dataset Labelset.
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’).
Future<SnapshotDatasetResponse>	snapshotDataset(SnapshotDatasetRequest request, AsyncHandler<SnapshotDatasetRequest,SnapshotDatasetResponse> handler) Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateDatasetResponse>	updateDataset(UpdateDatasetRequest request, AsyncHandler<UpdateDatasetRequest,UpdateDatasetResponse> handler) Updates the Dataset
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

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.datalabelingservice.DataLabelingManagementAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DataLabelingManagement.

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

DataLabelingManagementAsyncClient

@Deprecated
public DataLabelingManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

DataLabelingManagementAsyncClient

@Deprecated
public DataLabelingManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                     ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DataLabelingManagementAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DataLabelingManagementAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DataLabelingManagementAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DataLabelingManagementAsyncClient

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

DataLabelingManagementAsyncClient

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

Method Detail

builder

public static DataLabelingManagementAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DataLabelingManagementAsync

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 DataLabelingManagementAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DataLabelingManagementAsync

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 DataLabelingManagementAsync

Parameters:

regionId - The public region ID.

addDatasetLabels

public Future<AddDatasetLabelsResponse> addDatasetLabels(AddDatasetLabelsRequest request,
                                                         AsyncHandler<AddDatasetLabelsRequest,AddDatasetLabelsResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.

Specified by:

addDatasetLabels in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeDatasetCompartment

public Future<ChangeDatasetCompartmentResponse> changeDatasetCompartment(ChangeDatasetCompartmentRequest request,
                                                                         AsyncHandler<ChangeDatasetCompartmentRequest,ChangeDatasetCompartmentResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Moves a Dataset resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeDatasetCompartment in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createDataset

public Future<CreateDatasetResponse> createDataset(CreateDatasetRequest request,
                                                   AsyncHandler<CreateDatasetRequest,CreateDatasetResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Creates a new Dataset.

Specified by:

createDataset in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteDataset

public Future<DeleteDatasetResponse> deleteDataset(DeleteDatasetRequest request,
                                                   AsyncHandler<DeleteDatasetRequest,DeleteDatasetResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Deletes a Dataset resource by identifier

Specified by:

deleteDataset in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

generateDatasetRecords

public Future<GenerateDatasetRecordsResponse> generateDatasetRecords(GenerateDatasetRecordsRequest request,
                                                                     AsyncHandler<GenerateDatasetRecordsRequest,GenerateDatasetRecordsResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Generates Record resources from the Dataset’s data source

Specified by:

generateDatasetRecords in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDataset

public Future<GetDatasetResponse> getDataset(GetDatasetRequest request,
                                             AsyncHandler<GetDatasetRequest,GetDatasetResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Gets a Dataset by identifier

Specified by:

getDataset in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: DataLabelingManagementAsync

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

Specified by:

getWorkRequest in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

importPreAnnotatedData

public Future<ImportPreAnnotatedDataResponse> importPreAnnotatedData(ImportPreAnnotatedDataRequest request,
                                                                     AsyncHandler<ImportPreAnnotatedDataRequest,ImportPreAnnotatedDataResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Imports records and annotations from dataset files into existing Dataset.

Specified by:

importPreAnnotatedData in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAnnotationFormats

public Future<ListAnnotationFormatsResponse> listAnnotationFormats(ListAnnotationFormatsRequest request,
                                                                   AsyncHandler<ListAnnotationFormatsRequest,ListAnnotationFormatsResponse> handler)

Description copied from interface: DataLabelingManagementAsync

These are a static list in a given region.

Specified by:

listAnnotationFormats in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listDatasets

public Future<ListDatasetsResponse> listDatasets(ListDatasetsRequest request,
                                                 AsyncHandler<ListDatasetsRequest,ListDatasetsResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Returns a list of Datasets.

Specified by:

listDatasets in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: DataLabelingManagementAsync

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

Specified by:

listWorkRequestErrors in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: DataLabelingManagementAsync

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

Specified by:

listWorkRequestLogs in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

removeDatasetLabels

public Future<RemoveDatasetLabelsResponse> removeDatasetLabels(RemoveDatasetLabelsRequest request,
                                                               AsyncHandler<RemoveDatasetLabelsRequest,RemoveDatasetLabelsResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Removes the labels from the Dataset Labelset. Labels can only be removed if there are no Annotations associated with the Dataset that reference the Label names.

Specified by:

removeDatasetLabels in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

renameDatasetLabels

public Future<RenameDatasetLabelsResponse> renameDatasetLabels(RenameDatasetLabelsRequest request,
                                                               AsyncHandler<RenameDatasetLabelsRequest,RenameDatasetLabelsResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Renames the labels from the Dataset Labelset. Labels that are renamed will be reflected in Annotations associated with the Dataset that reference the Label names.

Specified by:

renameDatasetLabels in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

snapshotDataset

public Future<SnapshotDatasetResponse> snapshotDataset(SnapshotDatasetRequest request,
                                                       AsyncHandler<SnapshotDatasetRequest,SnapshotDatasetResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption. While the snapshot takes place, there may be a time while records and annotations cannot be created to ensure the snapshot is a point in time.

Specified by:

snapshotDataset in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateDataset

public Future<UpdateDatasetResponse> updateDataset(UpdateDatasetRequest request,
                                                   AsyncHandler<UpdateDatasetRequest,UpdateDatasetResponse> handler)

Description copied from interface: DataLabelingManagementAsync

Updates the Dataset

Specified by:

updateDataset in interface DataLabelingManagementAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

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

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)