com.oracle.bmc.datalabelingservicedataplane

Class DataLabelingAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.datalabelingservicedataplane.DataLabelingAsyncClient

All Implemented Interfaces:

DataLabelingAsync, AutoCloseable

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

Async client implementation for DataLabeling 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	DataLabelingAsyncClient.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 DataLabeling.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DataLabelingAsyncClient.Builder	builder() Create a builder for this client.
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<CreateAnnotationResponse>	createAnnotation(CreateAnnotationRequest request, AsyncHandler<CreateAnnotationRequest,CreateAnnotationResponse> handler) Creates an annotation.
Future<CreateRecordResponse>	createRecord(CreateRecordRequest request, AsyncHandler<CreateRecordRequest,CreateRecordResponse> handler) Creates a record.
Future<DeleteAnnotationResponse>	deleteAnnotation(DeleteAnnotationRequest request, AsyncHandler<DeleteAnnotationRequest,DeleteAnnotationResponse> handler) It deletes an annotation resource by identifier.
Future<DeleteRecordResponse>	deleteRecord(DeleteRecordRequest request, AsyncHandler<DeleteRecordRequest,DeleteRecordResponse> handler) Deletes a record resource by identifier.
Future<GetAnnotationResponse>	getAnnotation(GetAnnotationRequest request, AsyncHandler<GetAnnotationRequest,GetAnnotationResponse> handler) Gets an annotation.
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<GetRecordResponse>	getRecord(GetRecordRequest request, AsyncHandler<GetRecordRequest,GetRecordResponse> handler) Gets a record.
Future<GetRecordContentResponse>	getRecordContent(GetRecordContentRequest request, AsyncHandler<GetRecordContentRequest,GetRecordContentResponse> handler) Retrieves the content of the record from the dataset source.
Future<GetRecordPreviewContentResponse>	getRecordPreviewContent(GetRecordPreviewContentRequest request, AsyncHandler<GetRecordPreviewContentRequest,GetRecordPreviewContentResponse> handler) Retrieves the preview of the record content from the dataset source.
Future<ListAnnotationsResponse>	listAnnotations(ListAnnotationsRequest request, AsyncHandler<ListAnnotationsRequest,ListAnnotationsResponse> handler) Returns a list of annotations.
Future<ListRecordsResponse>	listRecords(ListRecordsRequest request, AsyncHandler<ListRecordsRequest,ListRecordsResponse> handler) The list of records in the specified 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’).
Future<SummarizeAnnotationAnalyticsResponse>	summarizeAnnotationAnalytics(SummarizeAnnotationAnalyticsRequest request, AsyncHandler<SummarizeAnnotationAnalyticsRequest,SummarizeAnnotationAnalyticsResponse> handler) Summarize the annotations created for a given dataset.
Future<SummarizeRecordAnalyticsResponse>	summarizeRecordAnalytics(SummarizeRecordAnalyticsRequest request, AsyncHandler<SummarizeRecordAnalyticsRequest,SummarizeRecordAnalyticsResponse> handler) Summarize the records created for a given dataset.
Future<UpdateAnnotationResponse>	updateAnnotation(UpdateAnnotationRequest request, AsyncHandler<UpdateAnnotationRequest,UpdateAnnotationResponse> handler) Updates an annotation.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateRecordResponse>	updateRecord(UpdateRecordRequest request, AsyncHandler<UpdateRecordRequest,UpdateRecordResponse> handler) Updates a record.
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.datalabelingservicedataplane.DataLabelingAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DataLabeling.

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

DataLabelingAsyncClient

@Deprecated
public DataLabelingAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

DataLabelingAsyncClient

@Deprecated
public DataLabelingAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DataLabelingAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DataLabelingAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DataLabelingAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DataLabelingAsyncClient

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

DataLabelingAsyncClient

@Deprecated
public DataLabelingAsyncClient(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 DataLabelingAsyncClient.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 DataLabelingAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DataLabelingAsync

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 DataLabelingAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DataLabelingAsync

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 DataLabelingAsync

Parameters:

regionId - The public region ID.

createAnnotation

public Future<CreateAnnotationResponse> createAnnotation(CreateAnnotationRequest request,
                                                         AsyncHandler<CreateAnnotationRequest,CreateAnnotationResponse> handler)

Description copied from interface: DataLabelingAsync

Creates an annotation.

Specified by:

createAnnotation in interface DataLabelingAsync

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.

createRecord

public Future<CreateRecordResponse> createRecord(CreateRecordRequest request,
                                                 AsyncHandler<CreateRecordRequest,CreateRecordResponse> handler)

Description copied from interface: DataLabelingAsync

Creates a record.

Specified by:

createRecord in interface DataLabelingAsync

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.

deleteAnnotation

public Future<DeleteAnnotationResponse> deleteAnnotation(DeleteAnnotationRequest request,
                                                         AsyncHandler<DeleteAnnotationRequest,DeleteAnnotationResponse> handler)

Description copied from interface: DataLabelingAsync

It deletes an annotation resource by identifier.

Specified by:

deleteAnnotation in interface DataLabelingAsync

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.

deleteRecord

public Future<DeleteRecordResponse> deleteRecord(DeleteRecordRequest request,
                                                 AsyncHandler<DeleteRecordRequest,DeleteRecordResponse> handler)

Description copied from interface: DataLabelingAsync

Deletes a record resource by identifier.

Specified by:

deleteRecord in interface DataLabelingAsync

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.

getAnnotation

public Future<GetAnnotationResponse> getAnnotation(GetAnnotationRequest request,
                                                   AsyncHandler<GetAnnotationRequest,GetAnnotationResponse> handler)

Description copied from interface: DataLabelingAsync

Gets an annotation.

Specified by:

getAnnotation in interface DataLabelingAsync

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

Gets a dataset by identifier.

Specified by:

getDataset in interface DataLabelingAsync

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.

getRecord

public Future<GetRecordResponse> getRecord(GetRecordRequest request,
                                           AsyncHandler<GetRecordRequest,GetRecordResponse> handler)

Description copied from interface: DataLabelingAsync

Gets a record.

Specified by:

getRecord in interface DataLabelingAsync

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.

getRecordContent

public Future<GetRecordContentResponse> getRecordContent(GetRecordContentRequest request,
                                                         AsyncHandler<GetRecordContentRequest,GetRecordContentResponse> handler)

Description copied from interface: DataLabelingAsync

Retrieves the content of the record from the dataset source.

Specified by:

getRecordContent in interface DataLabelingAsync

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.

getRecordPreviewContent

public Future<GetRecordPreviewContentResponse> getRecordPreviewContent(GetRecordPreviewContentRequest request,
                                                                       AsyncHandler<GetRecordPreviewContentRequest,GetRecordPreviewContentResponse> handler)

Description copied from interface: DataLabelingAsync

Retrieves the preview of the record content from the dataset source.

Specified by:

getRecordPreviewContent in interface DataLabelingAsync

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.

listAnnotations

public Future<ListAnnotationsResponse> listAnnotations(ListAnnotationsRequest request,
                                                       AsyncHandler<ListAnnotationsRequest,ListAnnotationsResponse> handler)

Description copied from interface: DataLabelingAsync

Returns a list of annotations.

Specified by:

listAnnotations in interface DataLabelingAsync

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.

listRecords

public Future<ListRecordsResponse> listRecords(ListRecordsRequest request,
                                               AsyncHandler<ListRecordsRequest,ListRecordsResponse> handler)

Description copied from interface: DataLabelingAsync

The list of records in the specified compartment.

Specified by:

listRecords in interface DataLabelingAsync

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.

summarizeAnnotationAnalytics

public Future<SummarizeAnnotationAnalyticsResponse> summarizeAnnotationAnalytics(SummarizeAnnotationAnalyticsRequest request,
                                                                                 AsyncHandler<SummarizeAnnotationAnalyticsRequest,SummarizeAnnotationAnalyticsResponse> handler)

Description copied from interface: DataLabelingAsync

Summarize the annotations created for a given dataset.

Specified by:

summarizeAnnotationAnalytics in interface DataLabelingAsync

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.

summarizeRecordAnalytics

public Future<SummarizeRecordAnalyticsResponse> summarizeRecordAnalytics(SummarizeRecordAnalyticsRequest request,
                                                                         AsyncHandler<SummarizeRecordAnalyticsRequest,SummarizeRecordAnalyticsResponse> handler)

Description copied from interface: DataLabelingAsync

Summarize the records created for a given dataset.

Specified by:

summarizeRecordAnalytics in interface DataLabelingAsync

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.

updateAnnotation

public Future<UpdateAnnotationResponse> updateAnnotation(UpdateAnnotationRequest request,
                                                         AsyncHandler<UpdateAnnotationRequest,UpdateAnnotationResponse> handler)

Description copied from interface: DataLabelingAsync

Updates an annotation.

Specified by:

updateAnnotation in interface DataLabelingAsync

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.

updateRecord

public Future<UpdateRecordResponse> updateRecord(UpdateRecordRequest request,
                                                 AsyncHandler<UpdateRecordRequest,UpdateRecordResponse> handler)

Description copied from interface: DataLabelingAsync

Updates a record.

Specified by:

updateRecord in interface DataLabelingAsync

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)