com.oracle.bmc.oda

Class ManagementClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.oda.ManagementClient

All Implemented Interfaces:

Management, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190506")
public class ManagementClient
extends BaseSyncClient
implements Management

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ManagementClient.Builder	builder() Create a builder for this client.
BulkCreateSkillEntitiesResponse	bulkCreateSkillEntities(BulkCreateSkillEntitiesRequest request) Bulk create composite and value list entities into a skill.
CascadingDeleteSkillCustomEntitiesResponse	cascadingDeleteSkillCustomEntities(CascadingDeleteSkillCustomEntitiesRequest request) Cascading delete of the custom entities in a skill.
ChangeOdaPrivateEndpointCompartmentResponse	changeOdaPrivateEndpointCompartment(ChangeOdaPrivateEndpointCompartmentRequest request) Starts an asynchronous job to move the specified ODA Private Endpoint into a different compartment.
void	close()
ConfigureDigitalAssistantParametersResponse	configureDigitalAssistantParameters(ConfigureDigitalAssistantParametersRequest request) This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.
CreateAuthenticationProviderResponse	createAuthenticationProvider(CreateAuthenticationProviderRequest request) Creates a new Authentication Provider
CreateChannelResponse	createChannel(CreateChannelRequest request) Creates a new Channel.
CreateDigitalAssistantResponse	createDigitalAssistant(CreateDigitalAssistantRequest request) Creates a new Digital Assistant.
CreateOdaPrivateEndpointResponse	createOdaPrivateEndpoint(CreateOdaPrivateEndpointRequest request) Starts an asynchronous job to create an ODA Private Endpoint.
CreateOdaPrivateEndpointAttachmentResponse	createOdaPrivateEndpointAttachment(CreateOdaPrivateEndpointAttachmentRequest request) Starts an asynchronous job to create an ODA Private Endpoint Attachment.
CreateOdaPrivateEndpointScanProxyResponse	createOdaPrivateEndpointScanProxy(CreateOdaPrivateEndpointScanProxyRequest request) Starts an asynchronous job to create an ODA Private Endpoint Scan Proxy.
CreateSkillResponse	createSkill(CreateSkillRequest request) Creates a new Skill from scratch.
CreateSkillParameterResponse	createSkillParameter(CreateSkillParameterRequest request) Creates a new Skill Parameter.
CreateTranslatorResponse	createTranslator(CreateTranslatorRequest request) Creates a new Translator
DeleteAuthenticationProviderResponse	deleteAuthenticationProvider(DeleteAuthenticationProviderRequest request) Delete the specified Authentication Provider.
DeleteChannelResponse	deleteChannel(DeleteChannelRequest request) Delete the specified Channel.
DeleteDigitalAssistantResponse	deleteDigitalAssistant(DeleteDigitalAssistantRequest request) Delete the specified Digital Assistant.
DeleteOdaPrivateEndpointResponse	deleteOdaPrivateEndpoint(DeleteOdaPrivateEndpointRequest request) Starts an asynchronous job to delete the specified ODA Private Endpoint.
DeleteOdaPrivateEndpointAttachmentResponse	deleteOdaPrivateEndpointAttachment(DeleteOdaPrivateEndpointAttachmentRequest request) Starts an asynchronous job to delete the specified ODA Private Endpoint Attachment.
DeleteOdaPrivateEndpointScanProxyResponse	deleteOdaPrivateEndpointScanProxy(DeleteOdaPrivateEndpointScanProxyRequest request) Starts an asynchronous job to delete the specified ODA Private Endpoint Scan Proxy.
DeleteSkillResponse	deleteSkill(DeleteSkillRequest request) Delete the specified Skill.
DeleteSkillParameterResponse	deleteSkillParameter(DeleteSkillParameterRequest request) Delete the specified Skill Parameter.
DeleteTranslatorResponse	deleteTranslator(DeleteTranslatorRequest request) Delete the specified Translator.
ExportDigitalAssistantResponse	exportDigitalAssistant(ExportDigitalAssistantRequest request) Exports the specified Digital Assistant as an archive to Object Storage.
ExportSkillResponse	exportSkill(ExportSkillRequest request) Exports the specified Skill as an archive to Object Storage.
GetAuthenticationProviderResponse	getAuthenticationProvider(GetAuthenticationProviderRequest request) Gets the specified Authentication Provider.
GetChannelResponse	getChannel(GetChannelRequest request) Gets the specified Channel.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
GetDigitalAssistantResponse	getDigitalAssistant(GetDigitalAssistantRequest request) Gets the specified Digital Assistant.
GetDigitalAssistantParameterResponse	getDigitalAssistantParameter(GetDigitalAssistantParameterRequest request) Gets the specified Digital Assistant Parameter.
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetOdaPrivateEndpointResponse	getOdaPrivateEndpoint(GetOdaPrivateEndpointRequest request) Gets the specified ODA Private Endpoint.
GetOdaPrivateEndpointAttachmentResponse	getOdaPrivateEndpointAttachment(GetOdaPrivateEndpointAttachmentRequest request) Gets the specified ODA Private Endpoint Attachment.
GetOdaPrivateEndpointScanProxyResponse	getOdaPrivateEndpointScanProxy(GetOdaPrivateEndpointScanProxyRequest request) Gets the specified ODA Private Endpoint Scan Proxy.
ManagementPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetSkillResponse	getSkill(GetSkillRequest request) Gets the specified Skill.
GetSkillParameterResponse	getSkillParameter(GetSkillParameterRequest request) Gets the specified Skill Parameter.
GetTranslatorResponse	getTranslator(GetTranslatorRequest request) Gets the specified Translator.
ManagementWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ImportBotResponse	importBot(ImportBotRequest request) Import a Bot archive from Object Storage.
ListAuthenticationProvidersResponse	listAuthenticationProviders(ListAuthenticationProvidersRequest request) Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.
ListChannelsResponse	listChannels(ListChannelsRequest request) Returns a page of Channels that belong to the specified Digital Assistant instance.
ListDigitalAssistantParametersResponse	listDigitalAssistantParameters(ListDigitalAssistantParametersRequest request) Returns a page of Parameters that belong to the specified Digital Assistant.
ListDigitalAssistantsResponse	listDigitalAssistants(ListDigitalAssistantsRequest request) Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.
ListOdaPrivateEndpointAttachmentsResponse	listOdaPrivateEndpointAttachments(ListOdaPrivateEndpointAttachmentsRequest request) Returns a page of ODA Instances attached to this ODA Private Endpoint.
ListOdaPrivateEndpointsResponse	listOdaPrivateEndpoints(ListOdaPrivateEndpointsRequest request) Returns a page of ODA Private Endpoints that belong to the specified compartment.
ListOdaPrivateEndpointScanProxiesResponse	listOdaPrivateEndpointScanProxies(ListOdaPrivateEndpointScanProxiesRequest request) Returns a page of ODA Private Endpoint Scan Proxies that belong to the specified ODA Private Endpoint.
ListSkillParametersResponse	listSkillParameters(ListSkillParametersRequest request) Returns a page of Skill Parameters that belong to the specified Skill.
ListSkillsResponse	listSkills(ListSkillsRequest request) Returns a page of Skills that belong to the specified Digital Assistant instance.
ListTranslatorsResponse	listTranslators(ListTranslatorsRequest request) Returns a page of Translators that belong to the specified Digital Assistant instance.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
PublishDigitalAssistantResponse	publishDigitalAssistant(PublishDigitalAssistantRequest request) Publish a draft Digital Assistant.
PublishSkillResponse	publishSkill(PublishSkillRequest request) Publish a draft Skill.
void	refreshClient() Rebuild the backing HttpClient.
RotateChannelKeysResponse	rotateChannelKeys(RotateChannelKeysRequest request) This will generate new keys for any generated keys in the Channel (eg.
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’).
StartChannelResponse	startChannel(StartChannelRequest request) Starts a Channel so that it will begin accepting messages.
StopChannelResponse	stopChannel(StopChannelRequest request) Stops a Channel so that it will no longer accept messages.
TrainSkillResponse	trainSkill(TrainSkillRequest request) Train a skill.
UpdateAuthenticationProviderResponse	updateAuthenticationProvider(UpdateAuthenticationProviderRequest request) Updates the specified Authentication Provider with the information in the request body.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateChannelResponse	updateChannel(UpdateChannelRequest request) Updates the specified Channel with the information in the request body.
UpdateDigitalAssistantResponse	updateDigitalAssistant(UpdateDigitalAssistantRequest request) Updates the specified Digital Assistant with the information in the request body.
UpdateDigitalAssistantParameterResponse	updateDigitalAssistantParameter(UpdateDigitalAssistantParameterRequest request) Updates the specified Digital Assistant Parameter with the information in the request body.
UpdateOdaPrivateEndpointResponse	updateOdaPrivateEndpoint(UpdateOdaPrivateEndpointRequest request) Starts an asynchronous job to update the specified ODA Private Endpoint with the information in the request body.
UpdateSkillResponse	updateSkill(UpdateSkillRequest request) Updates the specified Skill with the information in the request body.
UpdateSkillParameterResponse	updateSkillParameter(UpdateSkillParameterRequest request) Updates the specified Skill Parameter with the information in the request body.
UpdateTranslatorResponse	updateTranslator(UpdateTranslatorRequest request) Updates the specified Translator with the information in the request body.
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.oda.Management

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Management.

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

ManagementClient

@Deprecated
public ManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ManagementClient

@Deprecated
public ManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ManagementClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ManagementClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ManagementClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ManagementClient

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

ManagementClient

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

ManagementClient

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

Method Detail

builder

public static ManagementClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Management

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 Management

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Management

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 Management

Parameters:

regionId - The public region ID.

bulkCreateSkillEntities

public BulkCreateSkillEntitiesResponse bulkCreateSkillEntities(BulkCreateSkillEntitiesRequest request)

Description copied from interface: Management

Bulk create composite and value list entities into a skill.

Specified by:

bulkCreateSkillEntities in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cascadingDeleteSkillCustomEntities

public CascadingDeleteSkillCustomEntitiesResponse cascadingDeleteSkillCustomEntities(CascadingDeleteSkillCustomEntitiesRequest request)

Description copied from interface: Management

Cascading delete of the custom entities in a skill.

Specified by:

cascadingDeleteSkillCustomEntities in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeOdaPrivateEndpointCompartment

public ChangeOdaPrivateEndpointCompartmentResponse changeOdaPrivateEndpointCompartment(ChangeOdaPrivateEndpointCompartmentRequest request)

Description copied from interface: Management

Starts an asynchronous job to move the specified ODA Private Endpoint into a different compartment.

To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeOdaPrivateEndpointCompartment in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

configureDigitalAssistantParameters

public ConfigureDigitalAssistantParametersResponse configureDigitalAssistantParameters(ConfigureDigitalAssistantParametersRequest request)

Description copied from interface: Management

This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.

Specified by:

configureDigitalAssistantParameters in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAuthenticationProvider

public CreateAuthenticationProviderResponse createAuthenticationProvider(CreateAuthenticationProviderRequest request)

Description copied from interface: Management

Creates a new Authentication Provider

Specified by:

createAuthenticationProvider in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createChannel

public CreateChannelResponse createChannel(CreateChannelRequest request)

Description copied from interface: Management

Creates a new Channel.

Specified by:

createChannel in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDigitalAssistant

public CreateDigitalAssistantResponse createDigitalAssistant(CreateDigitalAssistantRequest request)

Description copied from interface: Management

Creates a new Digital Assistant.

Specified by:

createDigitalAssistant in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOdaPrivateEndpoint

public CreateOdaPrivateEndpointResponse createOdaPrivateEndpoint(CreateOdaPrivateEndpointRequest request)

Description copied from interface: Management

Starts an asynchronous job to create an ODA Private Endpoint.

To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

Specified by:

createOdaPrivateEndpoint in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOdaPrivateEndpointAttachment

public CreateOdaPrivateEndpointAttachmentResponse createOdaPrivateEndpointAttachment(CreateOdaPrivateEndpointAttachmentRequest request)

Description copied from interface: Management

Starts an asynchronous job to create an ODA Private Endpoint Attachment.

To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

Specified by:

createOdaPrivateEndpointAttachment in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOdaPrivateEndpointScanProxy

public CreateOdaPrivateEndpointScanProxyResponse createOdaPrivateEndpointScanProxy(CreateOdaPrivateEndpointScanProxyRequest request)

Description copied from interface: Management

Starts an asynchronous job to create an ODA Private Endpoint Scan Proxy.

To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

Specified by:

createOdaPrivateEndpointScanProxy in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createSkill

public CreateSkillResponse createSkill(CreateSkillRequest request)

Description copied from interface: Management

Creates a new Skill from scratch.

Specified by:

createSkill in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createSkillParameter

public CreateSkillParameterResponse createSkillParameter(CreateSkillParameterRequest request)

Description copied from interface: Management

Creates a new Skill Parameter.

Specified by:

createSkillParameter in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createTranslator

public CreateTranslatorResponse createTranslator(CreateTranslatorRequest request)

Description copied from interface: Management

Creates a new Translator

Specified by:

createTranslator in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAuthenticationProvider

public DeleteAuthenticationProviderResponse deleteAuthenticationProvider(DeleteAuthenticationProviderRequest request)

Description copied from interface: Management

Delete the specified Authentication Provider.

Specified by:

deleteAuthenticationProvider in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteChannel

public DeleteChannelResponse deleteChannel(DeleteChannelRequest request)

Description copied from interface: Management

Delete the specified Channel.

Specified by:

deleteChannel in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDigitalAssistant

public DeleteDigitalAssistantResponse deleteDigitalAssistant(DeleteDigitalAssistantRequest request)

Description copied from interface: Management

Delete the specified Digital Assistant.

Specified by:

deleteDigitalAssistant in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOdaPrivateEndpoint

public DeleteOdaPrivateEndpointResponse deleteOdaPrivateEndpoint(DeleteOdaPrivateEndpointRequest request)

Description copied from interface: Management

Starts an asynchronous job to delete the specified ODA Private Endpoint. To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.

Specified by:

deleteOdaPrivateEndpoint in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOdaPrivateEndpointAttachment

public DeleteOdaPrivateEndpointAttachmentResponse deleteOdaPrivateEndpointAttachment(DeleteOdaPrivateEndpointAttachmentRequest request)

Description copied from interface: Management

Starts an asynchronous job to delete the specified ODA Private Endpoint Attachment. To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.

Specified by:

deleteOdaPrivateEndpointAttachment in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOdaPrivateEndpointScanProxy

public DeleteOdaPrivateEndpointScanProxyResponse deleteOdaPrivateEndpointScanProxy(DeleteOdaPrivateEndpointScanProxyRequest request)

Description copied from interface: Management

Starts an asynchronous job to delete the specified ODA Private Endpoint Scan Proxy. To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.

Specified by:

deleteOdaPrivateEndpointScanProxy in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteSkill

public DeleteSkillResponse deleteSkill(DeleteSkillRequest request)

Description copied from interface: Management

Delete the specified Skill.

Specified by:

deleteSkill in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteSkillParameter

public DeleteSkillParameterResponse deleteSkillParameter(DeleteSkillParameterRequest request)

Description copied from interface: Management

Delete the specified Skill Parameter.

Specified by:

deleteSkillParameter in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteTranslator

public DeleteTranslatorResponse deleteTranslator(DeleteTranslatorRequest request)

Description copied from interface: Management

Delete the specified Translator.

Specified by:

deleteTranslator in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

exportDigitalAssistant

public ExportDigitalAssistantResponse exportDigitalAssistant(ExportDigitalAssistantRequest request)

Description copied from interface: Management

Exports the specified Digital Assistant as an archive to Object Storage.

Specified by:

exportDigitalAssistant in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

exportSkill

public ExportSkillResponse exportSkill(ExportSkillRequest request)

Description copied from interface: Management

Exports the specified Skill as an archive to Object Storage.

Specified by:

exportSkill in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAuthenticationProvider

public GetAuthenticationProviderResponse getAuthenticationProvider(GetAuthenticationProviderRequest request)

Description copied from interface: Management

Gets the specified Authentication Provider.

Specified by:

getAuthenticationProvider in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getChannel

public GetChannelResponse getChannel(GetChannelRequest request)

Description copied from interface: Management

Gets the specified Channel.

Specified by:

getChannel in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDigitalAssistant

public GetDigitalAssistantResponse getDigitalAssistant(GetDigitalAssistantRequest request)

Description copied from interface: Management

Gets the specified Digital Assistant.

Specified by:

getDigitalAssistant in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDigitalAssistantParameter

public GetDigitalAssistantParameterResponse getDigitalAssistantParameter(GetDigitalAssistantParameterRequest request)

Description copied from interface: Management

Gets the specified Digital Assistant Parameter.

Specified by:

getDigitalAssistantParameter in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOdaPrivateEndpoint

public GetOdaPrivateEndpointResponse getOdaPrivateEndpoint(GetOdaPrivateEndpointRequest request)

Description copied from interface: Management

Gets the specified ODA Private Endpoint.

Specified by:

getOdaPrivateEndpoint in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOdaPrivateEndpointAttachment

public GetOdaPrivateEndpointAttachmentResponse getOdaPrivateEndpointAttachment(GetOdaPrivateEndpointAttachmentRequest request)

Description copied from interface: Management

Gets the specified ODA Private Endpoint Attachment.

Specified by:

getOdaPrivateEndpointAttachment in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOdaPrivateEndpointScanProxy

public GetOdaPrivateEndpointScanProxyResponse getOdaPrivateEndpointScanProxy(GetOdaPrivateEndpointScanProxyRequest request)

Description copied from interface: Management

Gets the specified ODA Private Endpoint Scan Proxy.

Specified by:

getOdaPrivateEndpointScanProxy in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSkill

public GetSkillResponse getSkill(GetSkillRequest request)

Description copied from interface: Management

Gets the specified Skill.

Specified by:

getSkill in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSkillParameter

public GetSkillParameterResponse getSkillParameter(GetSkillParameterRequest request)

Description copied from interface: Management

Gets the specified Skill Parameter.

Specified by:

getSkillParameter in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getTranslator

public GetTranslatorResponse getTranslator(GetTranslatorRequest request)

Description copied from interface: Management

Gets the specified Translator.

Specified by:

getTranslator in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

importBot

public ImportBotResponse importBot(ImportBotRequest request)

Description copied from interface: Management

Import a Bot archive from Object Storage.

Specified by:

importBot in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAuthenticationProviders

public ListAuthenticationProvidersResponse listAuthenticationProviders(ListAuthenticationProvidersRequest request)

Description copied from interface: Management

Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Specified by:

listAuthenticationProviders in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listChannels

public ListChannelsResponse listChannels(ListChannelsRequest request)

Description copied from interface: Management

Returns a page of Channels that belong to the specified Digital Assistant instance.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Specified by:

listChannels in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDigitalAssistantParameters

public ListDigitalAssistantParametersResponse listDigitalAssistantParameters(ListDigitalAssistantParametersRequest request)

Description copied from interface: Management

Returns a page of Parameters that belong to the specified Digital Assistant.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Specified by:

listDigitalAssistantParameters in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDigitalAssistants

public ListDigitalAssistantsResponse listDigitalAssistants(ListDigitalAssistantsRequest request)

Description copied from interface: Management

Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Specified by:

listDigitalAssistants in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOdaPrivateEndpointAttachments

public ListOdaPrivateEndpointAttachmentsResponse listOdaPrivateEndpointAttachments(ListOdaPrivateEndpointAttachmentsRequest request)

Description copied from interface: Management

Returns a page of ODA Instances attached to this ODA Private Endpoint.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Specified by:

listOdaPrivateEndpointAttachments in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOdaPrivateEndpointScanProxies

public ListOdaPrivateEndpointScanProxiesResponse listOdaPrivateEndpointScanProxies(ListOdaPrivateEndpointScanProxiesRequest request)

Description copied from interface: Management

Returns a page of ODA Private Endpoint Scan Proxies that belong to the specified ODA Private Endpoint.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Specified by:

listOdaPrivateEndpointScanProxies in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOdaPrivateEndpoints

public ListOdaPrivateEndpointsResponse listOdaPrivateEndpoints(ListOdaPrivateEndpointsRequest request)

Description copied from interface: Management

Returns a page of ODA Private Endpoints that belong to the specified compartment.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Specified by:

listOdaPrivateEndpoints in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSkillParameters

public ListSkillParametersResponse listSkillParameters(ListSkillParametersRequest request)

Description copied from interface: Management

Returns a page of Skill Parameters that belong to the specified Skill.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Specified by:

listSkillParameters in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSkills

public ListSkillsResponse listSkills(ListSkillsRequest request)

Description copied from interface: Management

Returns a page of Skills that belong to the specified Digital Assistant instance.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Specified by:

listSkills in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTranslators

public ListTranslatorsResponse listTranslators(ListTranslatorsRequest request)

Description copied from interface: Management

Returns a page of Translators that belong to the specified Digital Assistant instance.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Specified by:

listTranslators in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

publishDigitalAssistant

public PublishDigitalAssistantResponse publishDigitalAssistant(PublishDigitalAssistantRequest request)

Description copied from interface: Management

Publish a draft Digital Assistant. Once published the Digital Assistant cannot be modified.

Specified by:

publishDigitalAssistant in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

publishSkill

public PublishSkillResponse publishSkill(PublishSkillRequest request)

Description copied from interface: Management

Publish a draft Skill. Once published it cannot be modified.

Specified by:

publishSkill in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rotateChannelKeys

public RotateChannelKeysResponse rotateChannelKeys(RotateChannelKeysRequest request)

Description copied from interface: Management

This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken). If a Channel has no generated keys then no changes will be made. Ensure that you take note of the newly generated keys in the response as they will not be returned again.

Specified by:

rotateChannelKeys in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startChannel

public StartChannelResponse startChannel(StartChannelRequest request)

Description copied from interface: Management

Starts a Channel so that it will begin accepting messages.

Specified by:

startChannel in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopChannel

public StopChannelResponse stopChannel(StopChannelRequest request)

Description copied from interface: Management

Stops a Channel so that it will no longer accept messages.

Specified by:

stopChannel in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

trainSkill

public TrainSkillResponse trainSkill(TrainSkillRequest request)

Description copied from interface: Management

Train a skill.

Specified by:

trainSkill in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAuthenticationProvider

public UpdateAuthenticationProviderResponse updateAuthenticationProvider(UpdateAuthenticationProviderRequest request)

Description copied from interface: Management

Updates the specified Authentication Provider with the information in the request body.

Specified by:

updateAuthenticationProvider in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateChannel

public UpdateChannelResponse updateChannel(UpdateChannelRequest request)

Description copied from interface: Management

Updates the specified Channel with the information in the request body.

Specified by:

updateChannel in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDigitalAssistant

public UpdateDigitalAssistantResponse updateDigitalAssistant(UpdateDigitalAssistantRequest request)

Description copied from interface: Management

Updates the specified Digital Assistant with the information in the request body.

Specified by:

updateDigitalAssistant in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDigitalAssistantParameter

public UpdateDigitalAssistantParameterResponse updateDigitalAssistantParameter(UpdateDigitalAssistantParameterRequest request)

Description copied from interface: Management

Updates the specified Digital Assistant Parameter with the information in the request body.

Specified by:

updateDigitalAssistantParameter in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOdaPrivateEndpoint

public UpdateOdaPrivateEndpointResponse updateOdaPrivateEndpoint(UpdateOdaPrivateEndpointRequest request)

Description copied from interface: Management

Starts an asynchronous job to update the specified ODA Private Endpoint with the information in the request body.

Specified by:

updateOdaPrivateEndpoint in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateSkill

public UpdateSkillResponse updateSkill(UpdateSkillRequest request)

Description copied from interface: Management

Updates the specified Skill with the information in the request body.

Specified by:

updateSkill in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateSkillParameter

public UpdateSkillParameterResponse updateSkillParameter(UpdateSkillParameterRequest request)

Description copied from interface: Management

Updates the specified Skill Parameter with the information in the request body.

Specified by:

updateSkillParameter in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateTranslator

public UpdateTranslatorResponse updateTranslator(UpdateTranslatorRequest request)

Description copied from interface: Management

Updates the specified Translator with the information in the request body.

Specified by:

updateTranslator in interface Management

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ManagementWaiters getWaiters()

Description copied from interface: Management

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

Specified by:

getWaiters in interface Management

Returns:

The service waiters.

getPaginators

public ManagementPaginators getPaginators()

Description copied from interface: Management

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 Management

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