Class ManagementClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.oda.ManagementClient
-
- All Implemented Interfaces:
Management,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20190506") public class ManagementClient extends BaseSyncClient implements Management
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classManagementClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Management.
-
Constructor Summary
Constructors Constructor Description ManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.ManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.ManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.ManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.ManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.ManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ManagementClient.Builderbuilder()Create a builder for this client.BulkCreateSkillEntitiesResponsebulkCreateSkillEntities(BulkCreateSkillEntitiesRequest request)Bulk create composite and value list entities into a skill.CascadingDeleteSkillCustomEntitiesResponsecascadingDeleteSkillCustomEntities(CascadingDeleteSkillCustomEntitiesRequest request)Cascading delete of the custom entities in a skill.ChangeOdaPrivateEndpointCompartmentResponsechangeOdaPrivateEndpointCompartment(ChangeOdaPrivateEndpointCompartmentRequest request)Starts an asynchronous job to move the specified ODA Private Endpoint into a different compartment.voidclose()ConfigureDigitalAssistantParametersResponseconfigureDigitalAssistantParameters(ConfigureDigitalAssistantParametersRequest request)This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.CreateAuthenticationProviderResponsecreateAuthenticationProvider(CreateAuthenticationProviderRequest request)Creates a new Authentication ProviderCreateChannelResponsecreateChannel(CreateChannelRequest request)Creates a new Channel.CreateDigitalAssistantResponsecreateDigitalAssistant(CreateDigitalAssistantRequest request)Creates a new Digital Assistant.CreateOdaPrivateEndpointResponsecreateOdaPrivateEndpoint(CreateOdaPrivateEndpointRequest request)Starts an asynchronous job to create an ODA Private Endpoint.CreateOdaPrivateEndpointAttachmentResponsecreateOdaPrivateEndpointAttachment(CreateOdaPrivateEndpointAttachmentRequest request)Starts an asynchronous job to create an ODA Private Endpoint Attachment.CreateOdaPrivateEndpointScanProxyResponsecreateOdaPrivateEndpointScanProxy(CreateOdaPrivateEndpointScanProxyRequest request)Starts an asynchronous job to create an ODA Private Endpoint Scan Proxy.CreateSkillResponsecreateSkill(CreateSkillRequest request)Creates a new Skill from scratch.CreateSkillParameterResponsecreateSkillParameter(CreateSkillParameterRequest request)Creates a new Skill Parameter.CreateTranslatorResponsecreateTranslator(CreateTranslatorRequest request)Creates a new TranslatorDeleteAuthenticationProviderResponsedeleteAuthenticationProvider(DeleteAuthenticationProviderRequest request)Delete the specified Authentication Provider.DeleteChannelResponsedeleteChannel(DeleteChannelRequest request)Delete the specified Channel.DeleteDigitalAssistantResponsedeleteDigitalAssistant(DeleteDigitalAssistantRequest request)Delete the specified Digital Assistant.DeleteOdaPrivateEndpointResponsedeleteOdaPrivateEndpoint(DeleteOdaPrivateEndpointRequest request)Starts an asynchronous job to delete the specified ODA Private Endpoint.DeleteOdaPrivateEndpointAttachmentResponsedeleteOdaPrivateEndpointAttachment(DeleteOdaPrivateEndpointAttachmentRequest request)Starts an asynchronous job to delete the specified ODA Private Endpoint Attachment.DeleteOdaPrivateEndpointScanProxyResponsedeleteOdaPrivateEndpointScanProxy(DeleteOdaPrivateEndpointScanProxyRequest request)Starts an asynchronous job to delete the specified ODA Private Endpoint Scan Proxy.DeleteSkillResponsedeleteSkill(DeleteSkillRequest request)Delete the specified Skill.DeleteSkillParameterResponsedeleteSkillParameter(DeleteSkillParameterRequest request)Delete the specified Skill Parameter.DeleteTranslatorResponsedeleteTranslator(DeleteTranslatorRequest request)Delete the specified Translator.ExportDigitalAssistantResponseexportDigitalAssistant(ExportDigitalAssistantRequest request)Exports the specified Digital Assistant as an archive to Object Storage.ExportSkillResponseexportSkill(ExportSkillRequest request)Exports the specified Skill as an archive to Object Storage.GetAuthenticationProviderResponsegetAuthenticationProvider(GetAuthenticationProviderRequest request)Gets the specified Authentication Provider.GetChannelResponsegetChannel(GetChannelRequest request)Gets the specified Channel.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()GetDigitalAssistantResponsegetDigitalAssistant(GetDigitalAssistantRequest request)Gets the specified Digital Assistant.GetDigitalAssistantParameterResponsegetDigitalAssistantParameter(GetDigitalAssistantParameterRequest request)Gets the specified Digital Assistant Parameter.StringgetEndpoint()Optional<String>getMinimumClientCommonLibraryVersionFromClient()GetOdaPrivateEndpointResponsegetOdaPrivateEndpoint(GetOdaPrivateEndpointRequest request)Gets the specified ODA Private Endpoint.GetOdaPrivateEndpointAttachmentResponsegetOdaPrivateEndpointAttachment(GetOdaPrivateEndpointAttachmentRequest request)Gets the specified ODA Private Endpoint Attachment.GetOdaPrivateEndpointScanProxyResponsegetOdaPrivateEndpointScanProxy(GetOdaPrivateEndpointScanProxyRequest request)Gets the specified ODA Private Endpoint Scan Proxy.ManagementPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetSkillResponsegetSkill(GetSkillRequest request)Gets the specified Skill.GetSkillParameterResponsegetSkillParameter(GetSkillParameterRequest request)Gets the specified Skill Parameter.GetTranslatorResponsegetTranslator(GetTranslatorRequest request)Gets the specified Translator.ManagementWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ImportBotResponseimportBot(ImportBotRequest request)Import a Bot archive from Object Storage.ListAuthenticationProvidersResponselistAuthenticationProviders(ListAuthenticationProvidersRequest request)Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.ListChannelsResponselistChannels(ListChannelsRequest request)Returns a page of Channels that belong to the specified Digital Assistant instance.ListDigitalAssistantParametersResponselistDigitalAssistantParameters(ListDigitalAssistantParametersRequest request)Returns a page of Parameters that belong to the specified Digital Assistant.ListDigitalAssistantsResponselistDigitalAssistants(ListDigitalAssistantsRequest request)Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.ListOdaPrivateEndpointAttachmentsResponselistOdaPrivateEndpointAttachments(ListOdaPrivateEndpointAttachmentsRequest request)Returns a page of ODA Instances attached to this ODA Private Endpoint.ListOdaPrivateEndpointsResponselistOdaPrivateEndpoints(ListOdaPrivateEndpointsRequest request)Returns a page of ODA Private Endpoints that belong to the specified compartment.ListOdaPrivateEndpointScanProxiesResponselistOdaPrivateEndpointScanProxies(ListOdaPrivateEndpointScanProxiesRequest request)Returns a page of ODA Private Endpoint Scan Proxies that belong to the specified ODA Private Endpoint.ListSkillParametersResponselistSkillParameters(ListSkillParametersRequest request)Returns a page of Skill Parameters that belong to the specified Skill.ListSkillsResponselistSkills(ListSkillsRequest request)Returns a page of Skills that belong to the specified Digital Assistant instance.ListTranslatorsResponselistTranslators(ListTranslatorsRequest request)Returns a page of Translators that belong to the specified Digital Assistant instance.voidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.PublishDigitalAssistantResponsepublishDigitalAssistant(PublishDigitalAssistantRequest request)Publish a draft Digital Assistant.PublishSkillResponsepublishSkill(PublishSkillRequest request)Publish a draft Skill.voidrefreshClient()Rebuild the backingHttpClient.RotateChannelKeysResponserotateChannelKeys(RotateChannelKeysRequest request)This will generate new keys for any generated keys in the Channel (eg.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).StartChannelResponsestartChannel(StartChannelRequest request)Starts a Channel so that it will begin accepting messages.StopChannelResponsestopChannel(StopChannelRequest request)Stops a Channel so that it will no longer accept messages.TrainSkillResponsetrainSkill(TrainSkillRequest request)Train a skill.UpdateAuthenticationProviderResponseupdateAuthenticationProvider(UpdateAuthenticationProviderRequest request)Updates the specified Authentication Provider with the information in the request body.voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateChannelResponseupdateChannel(UpdateChannelRequest request)Updates the specified Channel with the information in the request body.UpdateDigitalAssistantResponseupdateDigitalAssistant(UpdateDigitalAssistantRequest request)Updates the specified Digital Assistant with the information in the request body.UpdateDigitalAssistantParameterResponseupdateDigitalAssistantParameter(UpdateDigitalAssistantParameterRequest request)Updates the specified Digital Assistant Parameter with the information in the request body.UpdateOdaPrivateEndpointResponseupdateOdaPrivateEndpoint(UpdateOdaPrivateEndpointRequest request)Starts an asynchronous job to update the specified ODA Private Endpoint with the information in the request body.UpdateSkillResponseupdateSkill(UpdateSkillRequest request)Updates the specified Skill with the information in the request body.UpdateSkillParameterResponseupdateSkillParameter(UpdateSkillParameterRequest request)Updates the specified Skill Parameter with the information in the request body.UpdateTranslatorResponseupdateTranslator(UpdateTranslatorRequest request)Updates the specified Translator with the information in the request body.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.oda.Management
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
ManagementClient
@Deprecated public ManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
ManagementClient
@Deprecated public ManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
ManagementClient
@Deprecated public ManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ManagementClient
@Deprecated public ManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
ManagementClient
@Deprecated public ManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
ManagementClient
@Deprecated public ManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
ManagementClient
@Deprecated public ManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
ManagementClient
@Deprecated public ManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-ManagementClient.Builder.executorService
-
-
Method Detail
-
builder
public static ManagementClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ManagementSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceManagement- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ManagementSets 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.- Specified by:
setRegionin interfaceManagement- Parameters:
regionId- The public region ID.
-
bulkCreateSkillEntities
public BulkCreateSkillEntitiesResponse bulkCreateSkillEntities(BulkCreateSkillEntitiesRequest request)
Description copied from interface:ManagementBulk create composite and value list entities into a skill.- Specified by:
bulkCreateSkillEntitiesin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cascadingDeleteSkillCustomEntities
public CascadingDeleteSkillCustomEntitiesResponse cascadingDeleteSkillCustomEntities(CascadingDeleteSkillCustomEntitiesRequest request)
Description copied from interface:ManagementCascading delete of the custom entities in a skill.- Specified by:
cascadingDeleteSkillCustomEntitiesin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeOdaPrivateEndpointCompartment
public ChangeOdaPrivateEndpointCompartmentResponse changeOdaPrivateEndpointCompartment(ChangeOdaPrivateEndpointCompartmentRequest request)
Description copied from interface:ManagementStarts an asynchronous job to move the specified ODA Private Endpoint into a different compartment.To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`. When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeOdaPrivateEndpointCompartmentin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
configureDigitalAssistantParameters
public ConfigureDigitalAssistantParametersResponse configureDigitalAssistantParameters(ConfigureDigitalAssistantParametersRequest request)
Description copied from interface:ManagementThis will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.- Specified by:
configureDigitalAssistantParametersin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAuthenticationProvider
public CreateAuthenticationProviderResponse createAuthenticationProvider(CreateAuthenticationProviderRequest request)
Description copied from interface:ManagementCreates a new Authentication Provider- Specified by:
createAuthenticationProviderin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createChannel
public CreateChannelResponse createChannel(CreateChannelRequest request)
Description copied from interface:ManagementCreates a new Channel.- Specified by:
createChannelin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDigitalAssistant
public CreateDigitalAssistantResponse createDigitalAssistant(CreateDigitalAssistantRequest request)
Description copied from interface:ManagementCreates a new Digital Assistant.- Specified by:
createDigitalAssistantin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOdaPrivateEndpoint
public CreateOdaPrivateEndpointResponse createOdaPrivateEndpoint(CreateOdaPrivateEndpointRequest request)
Description copied from interface:ManagementStarts an asynchronous job to create an ODA Private Endpoint.To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
- Specified by:
createOdaPrivateEndpointin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOdaPrivateEndpointAttachment
public CreateOdaPrivateEndpointAttachmentResponse createOdaPrivateEndpointAttachment(CreateOdaPrivateEndpointAttachmentRequest request)
Description copied from interface:ManagementStarts an asynchronous job to create an ODA Private Endpoint Attachment.To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
- Specified by:
createOdaPrivateEndpointAttachmentin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOdaPrivateEndpointScanProxy
public CreateOdaPrivateEndpointScanProxyResponse createOdaPrivateEndpointScanProxy(CreateOdaPrivateEndpointScanProxyRequest request)
Description copied from interface:ManagementStarts an asynchronous job to create an ODA Private Endpoint Scan Proxy.To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
- Specified by:
createOdaPrivateEndpointScanProxyin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSkill
public CreateSkillResponse createSkill(CreateSkillRequest request)
Description copied from interface:ManagementCreates a new Skill from scratch.- Specified by:
createSkillin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSkillParameter
public CreateSkillParameterResponse createSkillParameter(CreateSkillParameterRequest request)
Description copied from interface:ManagementCreates a new Skill Parameter.- Specified by:
createSkillParameterin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTranslator
public CreateTranslatorResponse createTranslator(CreateTranslatorRequest request)
Description copied from interface:ManagementCreates a new Translator- Specified by:
createTranslatorin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAuthenticationProvider
public DeleteAuthenticationProviderResponse deleteAuthenticationProvider(DeleteAuthenticationProviderRequest request)
Description copied from interface:ManagementDelete the specified Authentication Provider.- Specified by:
deleteAuthenticationProviderin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteChannel
public DeleteChannelResponse deleteChannel(DeleteChannelRequest request)
Description copied from interface:ManagementDelete the specified Channel.- Specified by:
deleteChannelin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDigitalAssistant
public DeleteDigitalAssistantResponse deleteDigitalAssistant(DeleteDigitalAssistantRequest request)
Description copied from interface:ManagementDelete the specified Digital Assistant.- Specified by:
deleteDigitalAssistantin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOdaPrivateEndpoint
public DeleteOdaPrivateEndpointResponse deleteOdaPrivateEndpoint(DeleteOdaPrivateEndpointRequest request)
Description copied from interface:ManagementStarts an asynchronous job to delete the specified ODA Private Endpoint.To monitor the status of the job, take the
opc-work-request-idresponse header value and use it to callGET /workRequests/{workRequestID}.- Specified by:
deleteOdaPrivateEndpointin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOdaPrivateEndpointAttachment
public DeleteOdaPrivateEndpointAttachmentResponse deleteOdaPrivateEndpointAttachment(DeleteOdaPrivateEndpointAttachmentRequest request)
Description copied from interface:ManagementStarts an asynchronous job to delete the specified ODA Private Endpoint Attachment.To monitor the status of the job, take the
opc-work-request-idresponse header value and use it to callGET /workRequests/{workRequestID}.- Specified by:
deleteOdaPrivateEndpointAttachmentin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOdaPrivateEndpointScanProxy
public DeleteOdaPrivateEndpointScanProxyResponse deleteOdaPrivateEndpointScanProxy(DeleteOdaPrivateEndpointScanProxyRequest request)
Description copied from interface:ManagementStarts an asynchronous job to delete the specified ODA Private Endpoint Scan Proxy.To monitor the status of the job, take the
opc-work-request-idresponse header value and use it to callGET /workRequests/{workRequestID}.- Specified by:
deleteOdaPrivateEndpointScanProxyin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSkill
public DeleteSkillResponse deleteSkill(DeleteSkillRequest request)
Description copied from interface:ManagementDelete the specified Skill.- Specified by:
deleteSkillin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSkillParameter
public DeleteSkillParameterResponse deleteSkillParameter(DeleteSkillParameterRequest request)
Description copied from interface:ManagementDelete the specified Skill Parameter.- Specified by:
deleteSkillParameterin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTranslator
public DeleteTranslatorResponse deleteTranslator(DeleteTranslatorRequest request)
Description copied from interface:ManagementDelete the specified Translator.- Specified by:
deleteTranslatorin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
exportDigitalAssistant
public ExportDigitalAssistantResponse exportDigitalAssistant(ExportDigitalAssistantRequest request)
Description copied from interface:ManagementExports the specified Digital Assistant as an archive to Object Storage.- Specified by:
exportDigitalAssistantin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
exportSkill
public ExportSkillResponse exportSkill(ExportSkillRequest request)
Description copied from interface:ManagementExports the specified Skill as an archive to Object Storage.- Specified by:
exportSkillin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAuthenticationProvider
public GetAuthenticationProviderResponse getAuthenticationProvider(GetAuthenticationProviderRequest request)
Description copied from interface:ManagementGets the specified Authentication Provider.- Specified by:
getAuthenticationProviderin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getChannel
public GetChannelResponse getChannel(GetChannelRequest request)
Description copied from interface:ManagementGets the specified Channel.- Specified by:
getChannelin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDigitalAssistant
public GetDigitalAssistantResponse getDigitalAssistant(GetDigitalAssistantRequest request)
Description copied from interface:ManagementGets the specified Digital Assistant.- Specified by:
getDigitalAssistantin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDigitalAssistantParameter
public GetDigitalAssistantParameterResponse getDigitalAssistantParameter(GetDigitalAssistantParameterRequest request)
Description copied from interface:ManagementGets the specified Digital Assistant Parameter.- Specified by:
getDigitalAssistantParameterin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOdaPrivateEndpoint
public GetOdaPrivateEndpointResponse getOdaPrivateEndpoint(GetOdaPrivateEndpointRequest request)
Description copied from interface:ManagementGets the specified ODA Private Endpoint.- Specified by:
getOdaPrivateEndpointin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOdaPrivateEndpointAttachment
public GetOdaPrivateEndpointAttachmentResponse getOdaPrivateEndpointAttachment(GetOdaPrivateEndpointAttachmentRequest request)
Description copied from interface:ManagementGets the specified ODA Private Endpoint Attachment.- Specified by:
getOdaPrivateEndpointAttachmentin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOdaPrivateEndpointScanProxy
public GetOdaPrivateEndpointScanProxyResponse getOdaPrivateEndpointScanProxy(GetOdaPrivateEndpointScanProxyRequest request)
Description copied from interface:ManagementGets the specified ODA Private Endpoint Scan Proxy.- Specified by:
getOdaPrivateEndpointScanProxyin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSkill
public GetSkillResponse getSkill(GetSkillRequest request)
Description copied from interface:ManagementGets the specified Skill.- Specified by:
getSkillin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSkillParameter
public GetSkillParameterResponse getSkillParameter(GetSkillParameterRequest request)
Description copied from interface:ManagementGets the specified Skill Parameter.- Specified by:
getSkillParameterin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTranslator
public GetTranslatorResponse getTranslator(GetTranslatorRequest request)
Description copied from interface:ManagementGets the specified Translator.- Specified by:
getTranslatorin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
importBot
public ImportBotResponse importBot(ImportBotRequest request)
Description copied from interface:ManagementImport a Bot archive from Object Storage.- Specified by:
importBotin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuthenticationProviders
public ListAuthenticationProvidersResponse listAuthenticationProviders(ListAuthenticationProvidersRequest request)
Description copied from interface:ManagementReturns a page of Authentication Providers that belong to the specified Digital Assistant instance.If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
- Specified by:
listAuthenticationProvidersin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listChannels
public ListChannelsResponse listChannels(ListChannelsRequest request)
Description copied from interface:ManagementReturns a page of Channels that belong to the specified Digital Assistant instance.If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
- Specified by:
listChannelsin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDigitalAssistantParameters
public ListDigitalAssistantParametersResponse listDigitalAssistantParameters(ListDigitalAssistantParametersRequest request)
Description copied from interface:ManagementReturns a page of Parameters that belong to the specified Digital Assistant.If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
- Specified by:
listDigitalAssistantParametersin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDigitalAssistants
public ListDigitalAssistantsResponse listDigitalAssistants(ListDigitalAssistantsRequest request)
Description copied from interface:ManagementReturns a page of Digital Assistants that belong to the specified Digital Assistant instance.If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
- Specified by:
listDigitalAssistantsin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOdaPrivateEndpointAttachments
public ListOdaPrivateEndpointAttachmentsResponse listOdaPrivateEndpointAttachments(ListOdaPrivateEndpointAttachmentsRequest request)
Description copied from interface:ManagementReturns a page of ODA Instances attached to this ODA Private Endpoint.If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
- Specified by:
listOdaPrivateEndpointAttachmentsin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOdaPrivateEndpointScanProxies
public ListOdaPrivateEndpointScanProxiesResponse listOdaPrivateEndpointScanProxies(ListOdaPrivateEndpointScanProxiesRequest request)
Description copied from interface:ManagementReturns a page of ODA Private Endpoint Scan Proxies that belong to the specified ODA Private Endpoint.If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
- Specified by:
listOdaPrivateEndpointScanProxiesin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOdaPrivateEndpoints
public ListOdaPrivateEndpointsResponse listOdaPrivateEndpoints(ListOdaPrivateEndpointsRequest request)
Description copied from interface:ManagementReturns a page of ODA Private Endpoints that belong to the specified compartment.If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
- Specified by:
listOdaPrivateEndpointsin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSkillParameters
public ListSkillParametersResponse listSkillParameters(ListSkillParametersRequest request)
Description copied from interface:ManagementReturns a page of Skill Parameters that belong to the specified Skill.If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
- Specified by:
listSkillParametersin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSkills
public ListSkillsResponse listSkills(ListSkillsRequest request)
Description copied from interface:ManagementReturns a page of Skills that belong to the specified Digital Assistant instance.If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
- Specified by:
listSkillsin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTranslators
public ListTranslatorsResponse listTranslators(ListTranslatorsRequest request)
Description copied from interface:ManagementReturns a page of Translators that belong to the specified Digital Assistant instance.If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
- Specified by:
listTranslatorsin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
publishDigitalAssistant
public PublishDigitalAssistantResponse publishDigitalAssistant(PublishDigitalAssistantRequest request)
Description copied from interface:ManagementPublish a draft Digital Assistant.Once published the Digital Assistant cannot be modified.
- Specified by:
publishDigitalAssistantin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
publishSkill
public PublishSkillResponse publishSkill(PublishSkillRequest request)
Description copied from interface:ManagementPublish a draft Skill.Once published it cannot be modified.
- Specified by:
publishSkillin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
rotateChannelKeys
public RotateChannelKeysResponse rotateChannelKeys(RotateChannelKeysRequest request)
Description copied from interface:ManagementThis will generate new keys for any generated keys in the Channel (eg.secretKey, verifyToken). If a Channel has no generated keys then no changes will be made. Ensure that you take note of the newly generated keys in the response as they will not be returned again.
- Specified by:
rotateChannelKeysin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startChannel
public StartChannelResponse startChannel(StartChannelRequest request)
Description copied from interface:ManagementStarts a Channel so that it will begin accepting messages.- Specified by:
startChannelin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
stopChannel
public StopChannelResponse stopChannel(StopChannelRequest request)
Description copied from interface:ManagementStops a Channel so that it will no longer accept messages.- Specified by:
stopChannelin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
trainSkill
public TrainSkillResponse trainSkill(TrainSkillRequest request)
Description copied from interface:ManagementTrain a skill.- Specified by:
trainSkillin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAuthenticationProvider
public UpdateAuthenticationProviderResponse updateAuthenticationProvider(UpdateAuthenticationProviderRequest request)
Description copied from interface:ManagementUpdates the specified Authentication Provider with the information in the request body.- Specified by:
updateAuthenticationProviderin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateChannel
public UpdateChannelResponse updateChannel(UpdateChannelRequest request)
Description copied from interface:ManagementUpdates the specified Channel with the information in the request body.- Specified by:
updateChannelin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDigitalAssistant
public UpdateDigitalAssistantResponse updateDigitalAssistant(UpdateDigitalAssistantRequest request)
Description copied from interface:ManagementUpdates the specified Digital Assistant with the information in the request body.- Specified by:
updateDigitalAssistantin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDigitalAssistantParameter
public UpdateDigitalAssistantParameterResponse updateDigitalAssistantParameter(UpdateDigitalAssistantParameterRequest request)
Description copied from interface:ManagementUpdates the specified Digital Assistant Parameter with the information in the request body.- Specified by:
updateDigitalAssistantParameterin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOdaPrivateEndpoint
public UpdateOdaPrivateEndpointResponse updateOdaPrivateEndpoint(UpdateOdaPrivateEndpointRequest request)
Description copied from interface:ManagementStarts an asynchronous job to update the specified ODA Private Endpoint with the information in the request body.- Specified by:
updateOdaPrivateEndpointin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSkill
public UpdateSkillResponse updateSkill(UpdateSkillRequest request)
Description copied from interface:ManagementUpdates the specified Skill with the information in the request body.- Specified by:
updateSkillin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSkillParameter
public UpdateSkillParameterResponse updateSkillParameter(UpdateSkillParameterRequest request)
Description copied from interface:ManagementUpdates the specified Skill Parameter with the information in the request body.- Specified by:
updateSkillParameterin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTranslator
public UpdateTranslatorResponse updateTranslator(UpdateTranslatorRequest request)
Description copied from interface:ManagementUpdates the specified Translator with the information in the request body.- Specified by:
updateTranslatorin interfaceManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public ManagementWaiters getWaiters()
Description copied from interface:ManagementGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceManagement- Returns:
- The service waiters.
-
getPaginators
public ManagementPaginators getPaginators()
Description copied from interface:ManagementGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceManagement- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint- The endpoint template in userequiredParametersMap- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-