@Generated(value="OracleSDKGenerator", comments="API Version: 20190506") public interface Management extends AutoCloseable
API to create and maintain Oracle Digital Assistant service instances. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
GetDigitalAssistantResponse |
getDigitalAssistant(GetDigitalAssistantRequest request)
Gets the specified Digital Assistant.
|
GetDigitalAssistantParameterResponse |
getDigitalAssistantParameter(GetDigitalAssistantParameterRequest request)
Gets the specified Digital Assistant Parameter.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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.
|
PublishDigitalAssistantResponse |
publishDigitalAssistant(PublishDigitalAssistantRequest request)
Publish a draft Digital Assistant.
|
PublishSkillResponse |
publishSkill(PublishSkillRequest request)
Publish a draft Skill.
|
void |
refreshClient()
Rebuilds the client from scratch.
|
RotateChannelKeysResponse |
rotateChannelKeys(RotateChannelKeysRequest request)
This will generate new keys for any generated keys in the Channel (eg.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
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.
|
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 realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
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.
region
- The region of the service.void setRegion(String regionId)
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
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateBulkCreateSkillEntitiesResponse bulkCreateSkillEntities(BulkCreateSkillEntitiesRequest request)
Bulk create composite and value list entities into a skill.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use BulkCreateSkillEntities API.
CascadingDeleteSkillCustomEntitiesResponse cascadingDeleteSkillCustomEntities(CascadingDeleteSkillCustomEntitiesRequest request)
Cascading delete of the custom entities in a skill.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CascadingDeleteSkillCustomEntities API.
ChangeOdaPrivateEndpointCompartmentResponse changeOdaPrivateEndpointCompartment(ChangeOdaPrivateEndpointCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeOdaPrivateEndpointCompartment API.
ConfigureDigitalAssistantParametersResponse configureDigitalAssistantParameters(ConfigureDigitalAssistantParametersRequest request)
This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ConfigureDigitalAssistantParameters API.
CreateAuthenticationProviderResponse createAuthenticationProvider(CreateAuthenticationProviderRequest request)
Creates a new Authentication Provider
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateAuthenticationProvider API.
CreateChannelResponse createChannel(CreateChannelRequest request)
Creates a new Channel.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateChannel API.
CreateDigitalAssistantResponse createDigitalAssistant(CreateDigitalAssistantRequest request)
Creates a new Digital Assistant.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDigitalAssistant API.
CreateOdaPrivateEndpointResponse createOdaPrivateEndpoint(CreateOdaPrivateEndpointRequest request)
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}`.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateOdaPrivateEndpoint API.
CreateOdaPrivateEndpointAttachmentResponse createOdaPrivateEndpointAttachment(CreateOdaPrivateEndpointAttachmentRequest request)
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}`.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateOdaPrivateEndpointAttachment API.
CreateOdaPrivateEndpointScanProxyResponse createOdaPrivateEndpointScanProxy(CreateOdaPrivateEndpointScanProxyRequest request)
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}`.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateOdaPrivateEndpointScanProxy API.
CreateSkillResponse createSkill(CreateSkillRequest request)
Creates a new Skill from scratch.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSkill API.
CreateSkillParameterResponse createSkillParameter(CreateSkillParameterRequest request)
Creates a new Skill Parameter.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSkillParameter API.
CreateTranslatorResponse createTranslator(CreateTranslatorRequest request)
Creates a new Translator
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateTranslator API.
DeleteAuthenticationProviderResponse deleteAuthenticationProvider(DeleteAuthenticationProviderRequest request)
Delete the specified Authentication Provider.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteAuthenticationProvider API.
DeleteChannelResponse deleteChannel(DeleteChannelRequest request)
Delete the specified Channel.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteChannel API.
DeleteDigitalAssistantResponse deleteDigitalAssistant(DeleteDigitalAssistantRequest request)
Delete the specified Digital Assistant.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDigitalAssistant API.
DeleteOdaPrivateEndpointResponse deleteOdaPrivateEndpoint(DeleteOdaPrivateEndpointRequest request)
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}
.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteOdaPrivateEndpoint API.
DeleteOdaPrivateEndpointAttachmentResponse deleteOdaPrivateEndpointAttachment(DeleteOdaPrivateEndpointAttachmentRequest request)
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}
.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteOdaPrivateEndpointAttachment API.
DeleteOdaPrivateEndpointScanProxyResponse deleteOdaPrivateEndpointScanProxy(DeleteOdaPrivateEndpointScanProxyRequest request)
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}
.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteOdaPrivateEndpointScanProxy API.
DeleteSkillResponse deleteSkill(DeleteSkillRequest request)
Delete the specified Skill.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteSkill API.
DeleteSkillParameterResponse deleteSkillParameter(DeleteSkillParameterRequest request)
Delete the specified Skill Parameter.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteSkillParameter API.
DeleteTranslatorResponse deleteTranslator(DeleteTranslatorRequest request)
Delete the specified Translator.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteTranslator API.
ExportDigitalAssistantResponse exportDigitalAssistant(ExportDigitalAssistantRequest request)
Exports the specified Digital Assistant as an archive to Object Storage.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ExportDigitalAssistant API.
ExportSkillResponse exportSkill(ExportSkillRequest request)
Exports the specified Skill as an archive to Object Storage.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ExportSkill API.
GetAuthenticationProviderResponse getAuthenticationProvider(GetAuthenticationProviderRequest request)
Gets the specified Authentication Provider.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAuthenticationProvider API.
GetChannelResponse getChannel(GetChannelRequest request)
Gets the specified Channel.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetChannel API.
GetDigitalAssistantResponse getDigitalAssistant(GetDigitalAssistantRequest request)
Gets the specified Digital Assistant.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDigitalAssistant API.
GetDigitalAssistantParameterResponse getDigitalAssistantParameter(GetDigitalAssistantParameterRequest request)
Gets the specified Digital Assistant Parameter.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDigitalAssistantParameter API.
GetOdaPrivateEndpointResponse getOdaPrivateEndpoint(GetOdaPrivateEndpointRequest request)
Gets the specified ODA Private Endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetOdaPrivateEndpoint API.
GetOdaPrivateEndpointAttachmentResponse getOdaPrivateEndpointAttachment(GetOdaPrivateEndpointAttachmentRequest request)
Gets the specified ODA Private Endpoint Attachment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetOdaPrivateEndpointAttachment API.
GetOdaPrivateEndpointScanProxyResponse getOdaPrivateEndpointScanProxy(GetOdaPrivateEndpointScanProxyRequest request)
Gets the specified ODA Private Endpoint Scan Proxy.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetOdaPrivateEndpointScanProxy API.
GetSkillResponse getSkill(GetSkillRequest request)
Gets the specified Skill.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSkill API.
GetSkillParameterResponse getSkillParameter(GetSkillParameterRequest request)
Gets the specified Skill Parameter.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSkillParameter API.
GetTranslatorResponse getTranslator(GetTranslatorRequest request)
Gets the specified Translator.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTranslator API.
ImportBotResponse importBot(ImportBotRequest request)
Import a Bot archive from Object Storage.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ImportBot API.
ListAuthenticationProvidersResponse listAuthenticationProviders(ListAuthenticationProvidersRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAuthenticationProviders API.
ListChannelsResponse listChannels(ListChannelsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListChannels API.
ListDigitalAssistantParametersResponse listDigitalAssistantParameters(ListDigitalAssistantParametersRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDigitalAssistantParameters API.
ListDigitalAssistantsResponse listDigitalAssistants(ListDigitalAssistantsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDigitalAssistants API.
ListOdaPrivateEndpointAttachmentsResponse listOdaPrivateEndpointAttachments(ListOdaPrivateEndpointAttachmentsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListOdaPrivateEndpointAttachments API.
ListOdaPrivateEndpointScanProxiesResponse listOdaPrivateEndpointScanProxies(ListOdaPrivateEndpointScanProxiesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListOdaPrivateEndpointScanProxies API.
ListOdaPrivateEndpointsResponse listOdaPrivateEndpoints(ListOdaPrivateEndpointsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListOdaPrivateEndpoints API.
ListSkillParametersResponse listSkillParameters(ListSkillParametersRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSkillParameters API.
ListSkillsResponse listSkills(ListSkillsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSkills API.
ListTranslatorsResponse listTranslators(ListTranslatorsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTranslators API.
PublishDigitalAssistantResponse publishDigitalAssistant(PublishDigitalAssistantRequest request)
Publish a draft Digital Assistant. Once published the Digital Assistant cannot be modified.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use PublishDigitalAssistant API.
PublishSkillResponse publishSkill(PublishSkillRequest request)
Publish a draft Skill. Once published it cannot be modified.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use PublishSkill API.
RotateChannelKeysResponse rotateChannelKeys(RotateChannelKeysRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RotateChannelKeys API.
StartChannelResponse startChannel(StartChannelRequest request)
Starts a Channel so that it will begin accepting messages.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use StartChannel API.
StopChannelResponse stopChannel(StopChannelRequest request)
Stops a Channel so that it will no longer accept messages.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use StopChannel API.
TrainSkillResponse trainSkill(TrainSkillRequest request)
Train a skill.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use TrainSkill API.
UpdateAuthenticationProviderResponse updateAuthenticationProvider(UpdateAuthenticationProviderRequest request)
Updates the specified Authentication Provider with the information in the request body.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateAuthenticationProvider API.
UpdateChannelResponse updateChannel(UpdateChannelRequest request)
Updates the specified Channel with the information in the request body.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateChannel API.
UpdateDigitalAssistantResponse updateDigitalAssistant(UpdateDigitalAssistantRequest request)
Updates the specified Digital Assistant with the information in the request body.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDigitalAssistant API.
UpdateDigitalAssistantParameterResponse updateDigitalAssistantParameter(UpdateDigitalAssistantParameterRequest request)
Updates the specified Digital Assistant Parameter with the information in the request body.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDigitalAssistantParameter API.
UpdateOdaPrivateEndpointResponse updateOdaPrivateEndpoint(UpdateOdaPrivateEndpointRequest request)
Starts an asynchronous job to update the specified ODA Private Endpoint with the information in the request body.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateOdaPrivateEndpoint API.
UpdateSkillResponse updateSkill(UpdateSkillRequest request)
Updates the specified Skill with the information in the request body.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSkill API.
UpdateSkillParameterResponse updateSkillParameter(UpdateSkillParameterRequest request)
Updates the specified Skill Parameter with the information in the request body.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSkillParameter API.
UpdateTranslatorResponse updateTranslator(UpdateTranslatorRequest request)
Updates the specified Translator with the information in the request body.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateTranslator API.
ManagementWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
ManagementPaginators getPaginators()
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.
Copyright © 2016–2024. All rights reserved.