Interface Management
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
ManagementClient
@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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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 ProviderCreateChannelResponse
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 TranslatorDeleteAuthenticationProviderResponse
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.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the service.
-
getEndpoint
String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
-
setRegion
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.- Parameters:
region
- The region of the service.
-
setRegion
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 callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
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”
- Parameters:
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint template
-
bulkCreateSkillEntities
BulkCreateSkillEntitiesResponse bulkCreateSkillEntities(BulkCreateSkillEntitiesRequest request)
Bulk create composite and value list entities into a skill.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/BulkCreateSkillEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkCreateSkillEntities API.
-
cascadingDeleteSkillCustomEntities
CascadingDeleteSkillCustomEntitiesResponse cascadingDeleteSkillCustomEntities(CascadingDeleteSkillCustomEntitiesRequest request)
Cascading delete of the custom entities in a skill.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/CascadingDeleteSkillCustomEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CascadingDeleteSkillCustomEntities API.
-
changeOdaPrivateEndpointCompartment
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ChangeOdaPrivateEndpointCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeOdaPrivateEndpointCompartment API.
-
configureDigitalAssistantParameters
ConfigureDigitalAssistantParametersResponse configureDigitalAssistantParameters(ConfigureDigitalAssistantParametersRequest request)
This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ConfigureDigitalAssistantParametersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ConfigureDigitalAssistantParameters API.
-
createAuthenticationProvider
CreateAuthenticationProviderResponse createAuthenticationProvider(CreateAuthenticationProviderRequest request)
Creates a new Authentication Provider- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/CreateAuthenticationProviderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateAuthenticationProvider API.
-
createChannel
CreateChannelResponse createChannel(CreateChannelRequest request)
Creates a new Channel.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/CreateChannelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateChannel API.
-
createDigitalAssistant
CreateDigitalAssistantResponse createDigitalAssistant(CreateDigitalAssistantRequest request)
Creates a new Digital Assistant.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/CreateDigitalAssistantExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDigitalAssistant API.
-
createOdaPrivateEndpoint
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}`.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/CreateOdaPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOdaPrivateEndpoint API.
-
createOdaPrivateEndpointAttachment
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}`.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/CreateOdaPrivateEndpointAttachmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOdaPrivateEndpointAttachment API.
-
createOdaPrivateEndpointScanProxy
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}`.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/CreateOdaPrivateEndpointScanProxyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOdaPrivateEndpointScanProxy API.
-
createSkill
CreateSkillResponse createSkill(CreateSkillRequest request)
Creates a new Skill from scratch.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/CreateSkillExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSkill API.
-
createSkillParameter
CreateSkillParameterResponse createSkillParameter(CreateSkillParameterRequest request)
Creates a new Skill Parameter.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/CreateSkillParameterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSkillParameter API.
-
createTranslator
CreateTranslatorResponse createTranslator(CreateTranslatorRequest request)
Creates a new Translator- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/CreateTranslatorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateTranslator API.
-
deleteAuthenticationProvider
DeleteAuthenticationProviderResponse deleteAuthenticationProvider(DeleteAuthenticationProviderRequest request)
Delete the specified Authentication Provider.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/DeleteAuthenticationProviderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteAuthenticationProvider API.
-
deleteChannel
DeleteChannelResponse deleteChannel(DeleteChannelRequest request)
Delete the specified Channel.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/DeleteChannelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteChannel API.
-
deleteDigitalAssistant
DeleteDigitalAssistantResponse deleteDigitalAssistant(DeleteDigitalAssistantRequest request)
Delete the specified Digital Assistant.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/DeleteDigitalAssistantExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDigitalAssistant API.
-
deleteOdaPrivateEndpoint
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 callGET /workRequests/{workRequestID}
.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/DeleteOdaPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOdaPrivateEndpoint API.
-
deleteOdaPrivateEndpointAttachment
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 callGET /workRequests/{workRequestID}
.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/DeleteOdaPrivateEndpointAttachmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOdaPrivateEndpointAttachment API.
-
deleteOdaPrivateEndpointScanProxy
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 callGET /workRequests/{workRequestID}
.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/DeleteOdaPrivateEndpointScanProxyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOdaPrivateEndpointScanProxy API.
-
deleteSkill
DeleteSkillResponse deleteSkill(DeleteSkillRequest request)
Delete the specified Skill.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/DeleteSkillExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSkill API.
-
deleteSkillParameter
DeleteSkillParameterResponse deleteSkillParameter(DeleteSkillParameterRequest request)
Delete the specified Skill Parameter.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/DeleteSkillParameterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSkillParameter API.
-
deleteTranslator
DeleteTranslatorResponse deleteTranslator(DeleteTranslatorRequest request)
Delete the specified Translator.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/DeleteTranslatorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteTranslator API.
-
exportDigitalAssistant
ExportDigitalAssistantResponse exportDigitalAssistant(ExportDigitalAssistantRequest request)
Exports the specified Digital Assistant as an archive to Object Storage.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ExportDigitalAssistantExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExportDigitalAssistant API.
-
exportSkill
ExportSkillResponse exportSkill(ExportSkillRequest request)
Exports the specified Skill as an archive to Object Storage.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ExportSkillExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExportSkill API.
-
getAuthenticationProvider
GetAuthenticationProviderResponse getAuthenticationProvider(GetAuthenticationProviderRequest request)
Gets the specified Authentication Provider.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/GetAuthenticationProviderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAuthenticationProvider API.
-
getChannel
GetChannelResponse getChannel(GetChannelRequest request)
Gets the specified Channel.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/GetChannelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetChannel API.
-
getDigitalAssistant
GetDigitalAssistantResponse getDigitalAssistant(GetDigitalAssistantRequest request)
Gets the specified Digital Assistant.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/GetDigitalAssistantExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDigitalAssistant API.
-
getDigitalAssistantParameter
GetDigitalAssistantParameterResponse getDigitalAssistantParameter(GetDigitalAssistantParameterRequest request)
Gets the specified Digital Assistant Parameter.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/GetDigitalAssistantParameterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDigitalAssistantParameter API.
-
getOdaPrivateEndpoint
GetOdaPrivateEndpointResponse getOdaPrivateEndpoint(GetOdaPrivateEndpointRequest request)
Gets the specified ODA Private Endpoint.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/GetOdaPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOdaPrivateEndpoint API.
-
getOdaPrivateEndpointAttachment
GetOdaPrivateEndpointAttachmentResponse getOdaPrivateEndpointAttachment(GetOdaPrivateEndpointAttachmentRequest request)
Gets the specified ODA Private Endpoint Attachment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/GetOdaPrivateEndpointAttachmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOdaPrivateEndpointAttachment API.
-
getOdaPrivateEndpointScanProxy
GetOdaPrivateEndpointScanProxyResponse getOdaPrivateEndpointScanProxy(GetOdaPrivateEndpointScanProxyRequest request)
Gets the specified ODA Private Endpoint Scan Proxy.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/GetOdaPrivateEndpointScanProxyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOdaPrivateEndpointScanProxy API.
-
getSkill
GetSkillResponse getSkill(GetSkillRequest request)
Gets the specified Skill.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/GetSkillExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSkill API.
-
getSkillParameter
GetSkillParameterResponse getSkillParameter(GetSkillParameterRequest request)
Gets the specified Skill Parameter.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/GetSkillParameterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSkillParameter API.
-
getTranslator
GetTranslatorResponse getTranslator(GetTranslatorRequest request)
Gets the specified Translator.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/GetTranslatorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTranslator API.
-
importBot
ImportBotResponse importBot(ImportBotRequest request)
Import a Bot archive from Object Storage.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ImportBotExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ImportBot API.
-
listAuthenticationProviders
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ListAuthenticationProvidersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAuthenticationProviders API.
-
listChannels
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ListChannelsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListChannels API.
-
listDigitalAssistantParameters
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ListDigitalAssistantParametersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDigitalAssistantParameters API.
-
listDigitalAssistants
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ListDigitalAssistantsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDigitalAssistants API.
-
listOdaPrivateEndpointAttachments
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ListOdaPrivateEndpointAttachmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOdaPrivateEndpointAttachments API.
-
listOdaPrivateEndpointScanProxies
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ListOdaPrivateEndpointScanProxiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOdaPrivateEndpointScanProxies API.
-
listOdaPrivateEndpoints
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ListOdaPrivateEndpointsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOdaPrivateEndpoints API.
-
listSkillParameters
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ListSkillParametersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSkillParameters API.
-
listSkills
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ListSkillsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSkills API.
-
listTranslators
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/ListTranslatorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTranslators API.
-
publishDigitalAssistant
PublishDigitalAssistantResponse publishDigitalAssistant(PublishDigitalAssistantRequest request)
Publish a draft Digital Assistant.Once published the Digital Assistant cannot be modified.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/PublishDigitalAssistantExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PublishDigitalAssistant API.
-
publishSkill
PublishSkillResponse publishSkill(PublishSkillRequest request)
Publish a draft Skill.Once published it cannot be modified.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/PublishSkillExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PublishSkill API.
-
rotateChannelKeys
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/RotateChannelKeysExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RotateChannelKeys API.
-
startChannel
StartChannelResponse startChannel(StartChannelRequest request)
Starts a Channel so that it will begin accepting messages.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/StartChannelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartChannel API.
-
stopChannel
StopChannelResponse stopChannel(StopChannelRequest request)
Stops a Channel so that it will no longer accept messages.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/StopChannelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopChannel API.
-
trainSkill
TrainSkillResponse trainSkill(TrainSkillRequest request)
Train a skill.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/TrainSkillExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use TrainSkill API.
-
updateAuthenticationProvider
UpdateAuthenticationProviderResponse updateAuthenticationProvider(UpdateAuthenticationProviderRequest request)
Updates the specified Authentication Provider with the information in the request body.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/UpdateAuthenticationProviderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAuthenticationProvider API.
-
updateChannel
UpdateChannelResponse updateChannel(UpdateChannelRequest request)
Updates the specified Channel with the information in the request body.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/UpdateChannelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateChannel API.
-
updateDigitalAssistant
UpdateDigitalAssistantResponse updateDigitalAssistant(UpdateDigitalAssistantRequest request)
Updates the specified Digital Assistant with the information in the request body.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/UpdateDigitalAssistantExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDigitalAssistant API.
-
updateDigitalAssistantParameter
UpdateDigitalAssistantParameterResponse updateDigitalAssistantParameter(UpdateDigitalAssistantParameterRequest request)
Updates the specified Digital Assistant Parameter with the information in the request body.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/UpdateDigitalAssistantParameterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDigitalAssistantParameter API.
-
updateOdaPrivateEndpoint
UpdateOdaPrivateEndpointResponse updateOdaPrivateEndpoint(UpdateOdaPrivateEndpointRequest request)
Starts an asynchronous job to update the specified ODA Private Endpoint with the information in the request body.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/UpdateOdaPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOdaPrivateEndpoint API.
-
updateSkill
UpdateSkillResponse updateSkill(UpdateSkillRequest request)
Updates the specified Skill with the information in the request body.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/UpdateSkillExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSkill API.
-
updateSkillParameter
UpdateSkillParameterResponse updateSkillParameter(UpdateSkillParameterRequest request)
Updates the specified Skill Parameter with the information in the request body.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/UpdateSkillParameterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSkillParameter API.
-
updateTranslator
UpdateTranslatorResponse updateTranslator(UpdateTranslatorRequest request)
Updates the specified Translator with the information in the request body.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/oda/UpdateTranslatorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateTranslator API.
-
getWaiters
ManagementWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
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.- Returns:
- The service paginators.
-
-