Apps Interface

  • Reference
Package:
com.microsoft.azure.cognitiveservices.language.luis.authoring

public interface Apps

An instance of this class provides access to all the operations defined in Apps.

Method Summary

Modifier and Type Method and Description
UUID add(ApplicationCreateObject applicationCreateObject)

Creates a new LUIS app.
Observable<UUID> addAsync(ApplicationCreateObject applicationCreateObject)

Creates a new LUIS app.
UUID addCustomPrebuiltDomain(PrebuiltDomainCreateObject prebuiltDomainCreateObject)

Adds a prebuilt domain along with its intent and entity models as a new application.
Observable<UUID> addCustomPrebuiltDomainAsync(PrebuiltDomainCreateObject prebuiltDomainCreateObject)

Adds a prebuilt domain along with its intent and entity models as a new application.
AppsDeleteDefinitionStages.WithAppId delete()

Deletes an application.
OperationStatus delete(UUID appId, DeleteAppsOptionalParameter deleteOptionalParameter)

Deletes an application.
Observable<OperationStatus> deleteAsync(UUID appId, DeleteAppsOptionalParameter deleteOptionalParameter)

Deletes an application.
InputStream downloadQueryLogs(UUID appId)

Gets the logs of the past month's endpoint queries for the application.
Observable<InputStream> downloadQueryLogsAsync(UUID appId)

Gets the logs of the past month's endpoint queries for the application.
ApplicationInfoResponse get(UUID appId)

Gets the application info.
Observable<ApplicationInfoResponse> getAsync(UUID appId)

Gets the application info.
PublishSettings getPublishSettings(UUID appId)

Get the application publish settings including 'UseAllTrainingData'.
Observable<PublishSettings> getPublishSettingsAsync(UUID appId)

Get the application publish settings including 'UseAllTrainingData'.
ApplicationSettings getSettings(UUID appId)

Get the application settings including 'UseAllTrainingData'.
Observable<ApplicationSettings> getSettingsAsync(UUID appId)

Get the application settings including 'UseAllTrainingData'.
AppsImportLuFormatDefinitionStages.WithLuisAppLu importLuFormat()

Imports an application to LUIS, the application's structure is included in the request body.
UUID importLuFormat(String luisAppLu, ImportLuFormatAppsOptionalParameter importLuFormatOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.
Observable<UUID> importLuFormatAsync(String luisAppLu, ImportLuFormatAppsOptionalParameter importLuFormatOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.
AppsImportMethodDefinitionStages.WithLuisApp importMethod()

Imports an application to LUIS, the application's structure is included in the request body.
UUID importMethod(LuisApp luisApp, ImportMethodAppsOptionalParameter importMethodOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.
Observable<UUID> importMethodAsync(LuisApp luisApp, ImportMethodAppsOptionalParameter importMethodOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.
AppsImportV2AppDefinitionStages.WithLuisAppV2 importV2App()

Imports an application to LUIS, the application's structure is included in the request body.
UUID importV2App(LuisAppV2 luisAppV2, ImportV2AppAppsOptionalParameter importV2AppOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.
Observable<UUID> importV2AppAsync(LuisAppV2 luisAppV2, ImportV2AppAppsOptionalParameter importV2AppOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.
AppsListDefinitionStages.WithExecute list()

Lists all of the user's applications.
List<ApplicationInfoResponse> list(ListAppsOptionalParameter listOptionalParameter)

Lists all of the user's applications.
Observable<List<ApplicationInfoResponse>> listAsync(ListAppsOptionalParameter listOptionalParameter)

Lists all of the user's applications.
List<PrebuiltDomain> listAvailableCustomPrebuiltDomains()

Gets all the available custom prebuilt domains for all cultures.
Observable<List<PrebuiltDomain>> listAvailableCustomPrebuiltDomainsAsync()

Gets all the available custom prebuilt domains for all cultures.
List<PrebuiltDomain> listAvailableCustomPrebuiltDomainsForCulture(String culture)

Gets all the available prebuilt domains for a specific culture.
Observable<List<PrebuiltDomain>> listAvailableCustomPrebuiltDomainsForCultureAsync(String culture)

Gets all the available prebuilt domains for a specific culture.
PersonalAssistantsResponse listCortanaEndpoints()

Gets the endpoint URLs for the prebuilt Cortana applications.
Observable<PersonalAssistantsResponse> listCortanaEndpointsAsync()

Gets the endpoint URLs for the prebuilt Cortana applications.
List<String> listDomains()

Gets the available application domains.
Observable<List<String>> listDomainsAsync()

Gets the available application domains.
Map<String, String> listEndpoints(UUID appId)

Returns the available endpoint deployment regions and URLs.
Observable<Map<String, String>> listEndpointsAsync(UUID appId)

Returns the available endpoint deployment regions and URLs.
List<AvailableCulture> listSupportedCultures()

Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,"en-us" represents the U.S. variation of English.
Observable<List<AvailableCulture>> listSupportedCulturesAsync()

Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,"en-us" represents the U.S. variation of English.
List<String> listUsageScenarios()

Gets the application available usage scenarios.
Observable<List<String>> listUsageScenariosAsync()

Gets the application available usage scenarios.
InputStream packagePublishedApplicationAsGzip(UUID appId, String slotName)

package - Gets published LUIS application package in binary stream GZip format. Packages a published LUIS application as a GZip file to be used in the LUIS container.
Observable<InputStream> packagePublishedApplicationAsGzipAsync(UUID appId, String slotName)

package - Gets published LUIS application package in binary stream GZip format. Packages a published LUIS application as a GZip file to be used in the LUIS container.
InputStream packageTrainedApplicationAsGzip(UUID appId, String versionId)

package - Gets trained LUIS application package in binary stream GZip format. Packages trained LUIS application as GZip file to be used in the LUIS container.
Observable<InputStream> packageTrainedApplicationAsGzipAsync(UUID appId, String versionId)

package - Gets trained LUIS application package in binary stream GZip format. Packages trained LUIS application as GZip file to be used in the LUIS container.
ProductionOrStagingEndpointInfo publish(UUID appId, ApplicationPublishObject applicationPublishObject)

Publishes a specific version of the application.
Observable<ProductionOrStagingEndpointInfo> publishAsync(UUID appId, ApplicationPublishObject applicationPublishObject)

Publishes a specific version of the application.
OperationStatus update(UUID appId, ApplicationUpdateObject applicationUpdateObject)

Updates the name or description of the application.
Observable<OperationStatus> updateAsync(UUID appId, ApplicationUpdateObject applicationUpdateObject)

Updates the name or description of the application.
OperationStatus updatePublishSettings(UUID appId, PublishSettingUpdateObject publishSettingUpdateObject)

Updates the application publish settings including 'UseAllTrainingData'.
Observable<OperationStatus> updatePublishSettingsAsync(UUID appId, PublishSettingUpdateObject publishSettingUpdateObject)

Updates the application publish settings including 'UseAllTrainingData'.
AppsUpdateSettingsDefinitionStages.WithAppId updateSettings()

Updates the application settings including 'UseAllTrainingData'.
OperationStatus updateSettings(UUID appId, UpdateSettingsOptionalParameter updateSettingsOptionalParameter)

Updates the application settings including 'UseAllTrainingData'.
Observable<OperationStatus> updateSettingsAsync(UUID appId, UpdateSettingsOptionalParameter updateSettingsOptionalParameter)

Updates the application settings including 'UseAllTrainingData'.

Method Details

add

public UUID add(ApplicationCreateObject applicationCreateObject)

Creates a new LUIS app.

Parameters:

applicationCreateObject - An application containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is "0.1". Note: the culture cannot be changed after the app is created.

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addAsync

public Observable addAsync(ApplicationCreateObject applicationCreateObject)

Creates a new LUIS app.

Parameters:

applicationCreateObject - An application containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is "0.1". Note: the culture cannot be changed after the app is created.

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addCustomPrebuiltDomain

public UUID addCustomPrebuiltDomain(PrebuiltDomainCreateObject prebuiltDomainCreateObject)

Adds a prebuilt domain along with its intent and entity models as a new application.

Parameters:

prebuiltDomainCreateObject - A prebuilt domain create object containing the name and culture of the domain.

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addCustomPrebuiltDomainAsync

public Observable addCustomPrebuiltDomainAsync(PrebuiltDomainCreateObject prebuiltDomainCreateObject)

Adds a prebuilt domain along with its intent and entity models as a new application.

Parameters:

prebuiltDomainCreateObject - A prebuilt domain create object containing the name and culture of the domain.

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

delete

public AppsDeleteDefinitionStages.WithAppId delete()

Deletes an application.

Returns:

the first stage of the delete call

delete

public OperationStatus delete(UUID appId, DeleteAppsOptionalParameter deleteOptionalParameter)

Deletes an application.

Parameters:

appId - The application ID.
deleteOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteAsync

public Observable deleteAsync(UUID appId, DeleteAppsOptionalParameter deleteOptionalParameter)

Deletes an application.

Parameters:

appId - The application ID.
deleteOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

downloadQueryLogs

public InputStream downloadQueryLogs(UUID appId)

Gets the logs of the past month's endpoint queries for the application.

Parameters:

appId - The application ID.

Returns:

the InputStream object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

downloadQueryLogsAsync

public Observable downloadQueryLogsAsync(UUID appId)

Gets the logs of the past month's endpoint queries for the application.

Parameters:

appId - The application ID.

Returns:

the observable to the InputStream object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

get

public ApplicationInfoResponse get(UUID appId)

Gets the application info.

Parameters:

appId - The application ID.

Returns:

the ApplicationInfoResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAsync

public Observable getAsync(UUID appId)

Gets the application info.

Parameters:

appId - The application ID.

Returns:

the observable to the ApplicationInfoResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getPublishSettings

public PublishSettings getPublishSettings(UUID appId)

Get the application publish settings including 'UseAllTrainingData'.

Parameters:

appId - The application ID.

Returns:

the PublishSettings object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getPublishSettingsAsync

public Observable getPublishSettingsAsync(UUID appId)

Get the application publish settings including 'UseAllTrainingData'.

Parameters:

appId - The application ID.

Returns:

the observable to the PublishSettings object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getSettings

public ApplicationSettings getSettings(UUID appId)

Get the application settings including 'UseAllTrainingData'.

Parameters:

appId - The application ID.

Returns:

the ApplicationSettings object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getSettingsAsync

public Observable getSettingsAsync(UUID appId)

Get the application settings including 'UseAllTrainingData'.

Parameters:

appId - The application ID.

Returns:

the observable to the ApplicationSettings object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

importLuFormat

public AppsImportLuFormatDefinitionStages.WithLuisAppLu importLuFormat()

Imports an application to LUIS, the application's structure is included in the request body.

Returns:

the first stage of the importLuFormat call

importLuFormat

public UUID importLuFormat(String luisAppLu, ImportLuFormatAppsOptionalParameter importLuFormatOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.

Parameters:

luisAppLu - A LUIS application structure.
importLuFormatOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

importLuFormatAsync

public Observable importLuFormatAsync(String luisAppLu, ImportLuFormatAppsOptionalParameter importLuFormatOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.

Parameters:

luisAppLu - A LUIS application structure.
importLuFormatOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

importMethod

public AppsImportMethodDefinitionStages.WithLuisApp importMethod()

Imports an application to LUIS, the application's structure is included in the request body.

Returns:

the first stage of the importMethod call

importMethod

public UUID importMethod(LuisApp luisApp, ImportMethodAppsOptionalParameter importMethodOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.

Parameters:

luisApp - A LUIS application structure.
importMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

importMethodAsync

public Observable importMethodAsync(LuisApp luisApp, ImportMethodAppsOptionalParameter importMethodOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.

Parameters:

luisApp - A LUIS application structure.
importMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

importV2App

public AppsImportV2AppDefinitionStages.WithLuisAppV2 importV2App()

Imports an application to LUIS, the application's structure is included in the request body.

Returns:

the first stage of the importV2App call

importV2App

public UUID importV2App(LuisAppV2 luisAppV2, ImportV2AppAppsOptionalParameter importV2AppOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.

Parameters:

luisAppV2 - A LUIS application structure.
importV2AppOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

importV2AppAsync

public Observable importV2AppAsync(LuisAppV2 luisAppV2, ImportV2AppAppsOptionalParameter importV2AppOptionalParameter)

Imports an application to LUIS, the application's structure is included in the request body.

Parameters:

luisAppV2 - A LUIS application structure.
importV2AppOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

public AppsListDefinitionStages.WithExecute list()

Lists all of the user's applications.

Returns:

the first stage of the list call

list

public List list(ListAppsOptionalParameter listOptionalParameter)

Lists all of the user's applications.

Parameters:

listOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<ApplicationInfoResponse> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listAsync

public Observable> listAsync(ListAppsOptionalParameter listOptionalParameter)

Lists all of the user's applications.

Parameters:

listOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<ApplicationInfoResponse> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAvailableCustomPrebuiltDomains

public List listAvailableCustomPrebuiltDomains()

Gets all the available custom prebuilt domains for all cultures.

Returns:

the List<PrebuiltDomain> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listAvailableCustomPrebuiltDomainsAsync

public Observable> listAvailableCustomPrebuiltDomainsAsync()

Gets all the available custom prebuilt domains for all cultures.

Returns:

the observable to the List<PrebuiltDomain> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAvailableCustomPrebuiltDomainsForCulture

public List listAvailableCustomPrebuiltDomainsForCulture(String culture)

Gets all the available prebuilt domains for a specific culture.

Parameters:

culture - Culture.

Returns:

the List<PrebuiltDomain> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listAvailableCustomPrebuiltDomainsForCultureAsync

public Observable> listAvailableCustomPrebuiltDomainsForCultureAsync(String culture)

Gets all the available prebuilt domains for a specific culture.

Parameters:

culture - Culture.

Returns:

the observable to the List<PrebuiltDomain> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listCortanaEndpoints

public PersonalAssistantsResponse listCortanaEndpoints()

Gets the endpoint URLs for the prebuilt Cortana applications.

Returns:

the PersonalAssistantsResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listCortanaEndpointsAsync

public Observable listCortanaEndpointsAsync()

Gets the endpoint URLs for the prebuilt Cortana applications.

Returns:

the observable to the PersonalAssistantsResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listDomains

public List listDomains()

Gets the available application domains.

Returns:

the List<String> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listDomainsAsync

public Observable> listDomainsAsync()

Gets the available application domains.

Returns:

the observable to the List<String> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listEndpoints

public Map listEndpoints(UUID appId)

Returns the available endpoint deployment regions and URLs.

Parameters:

appId - The application ID.

Returns:

the Map<String, String> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listEndpointsAsync

public Observable> listEndpointsAsync(UUID appId)

Returns the available endpoint deployment regions and URLs.

Parameters:

appId - The application ID.

Returns:

the observable to the Map<String, String> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listSupportedCultures

public List listSupportedCultures()

Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,"en-us" represents the U.S. variation of English.

Returns:

the List<AvailableCulture> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listSupportedCulturesAsync

public Observable> listSupportedCulturesAsync()

Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,"en-us" represents the U.S. variation of English.

Returns:

the observable to the List<AvailableCulture> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageScenarios

public List listUsageScenarios()

Gets the application available usage scenarios.

Returns:

the List<String> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listUsageScenariosAsync

public Observable> listUsageScenariosAsync()

Gets the application available usage scenarios.

Returns:

the observable to the List<String> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

packagePublishedApplicationAsGzip

public InputStream packagePublishedApplicationAsGzip(UUID appId, String slotName)

package - Gets published LUIS application package in binary stream GZip format. Packages a published LUIS application as a GZip file to be used in the LUIS container.

Parameters:

appId - The application ID.
slotName - The publishing slot name.

Returns:

the InputStream object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

packagePublishedApplicationAsGzipAsync

public Observable packagePublishedApplicationAsGzipAsync(UUID appId, String slotName)

package - Gets published LUIS application package in binary stream GZip format. Packages a published LUIS application as a GZip file to be used in the LUIS container.

Parameters:

appId - The application ID.
slotName - The publishing slot name.

Returns:

the observable to the InputStream object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

packageTrainedApplicationAsGzip

public InputStream packageTrainedApplicationAsGzip(UUID appId, String versionId)

package - Gets trained LUIS application package in binary stream GZip format. Packages trained LUIS application as GZip file to be used in the LUIS container.

Parameters:

appId - The application ID.
versionId - The version ID.

Returns:

the InputStream object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

packageTrainedApplicationAsGzipAsync

public Observable packageTrainedApplicationAsGzipAsync(UUID appId, String versionId)

package - Gets trained LUIS application package in binary stream GZip format. Packages trained LUIS application as GZip file to be used in the LUIS container.

Parameters:

appId - The application ID.
versionId - The version ID.

Returns:

the observable to the InputStream object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

publish

public ProductionOrStagingEndpointInfo publish(UUID appId, ApplicationPublishObject applicationPublishObject)

Publishes a specific version of the application.

Parameters:

appId - The application ID.
applicationPublishObject - The application publish object. The region is the target region that the application is published to.

Returns:

the ProductionOrStagingEndpointInfo object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

publishAsync

public Observable publishAsync(UUID appId, ApplicationPublishObject applicationPublishObject)

Publishes a specific version of the application.

Parameters:

appId - The application ID.
applicationPublishObject - The application publish object. The region is the target region that the application is published to.

Returns:

the observable to the ProductionOrStagingEndpointInfo object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

update

public OperationStatus update(UUID appId, ApplicationUpdateObject applicationUpdateObject)

Updates the name or description of the application.

Parameters:

appId - The application ID.
applicationUpdateObject - A model containing Name and Description of the application.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateAsync

public Observable updateAsync(UUID appId, ApplicationUpdateObject applicationUpdateObject)

Updates the name or description of the application.

Parameters:

appId - The application ID.
applicationUpdateObject - A model containing Name and Description of the application.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePublishSettings

public OperationStatus updatePublishSettings(UUID appId, PublishSettingUpdateObject publishSettingUpdateObject)

Updates the application publish settings including 'UseAllTrainingData'.

Parameters:

appId - The application ID.
publishSettingUpdateObject - An object containing the new publish application settings.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updatePublishSettingsAsync

public Observable updatePublishSettingsAsync(UUID appId, PublishSettingUpdateObject publishSettingUpdateObject)

Updates the application publish settings including 'UseAllTrainingData'.

Parameters:

appId - The application ID.
publishSettingUpdateObject - An object containing the new publish application settings.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateSettings

public AppsUpdateSettingsDefinitionStages.WithAppId updateSettings()

Updates the application settings including 'UseAllTrainingData'.

Returns:

the first stage of the updateSettings call

updateSettings

public OperationStatus updateSettings(UUID appId, UpdateSettingsOptionalParameter updateSettingsOptionalParameter)

Updates the application settings including 'UseAllTrainingData'.

Parameters:

appId - The application ID.
updateSettingsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ErrorResponseException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateSettingsAsync

public Observable updateSettingsAsync(UUID appId, UpdateSettingsOptionalParameter updateSettingsOptionalParameter)

Updates the application settings including 'UseAllTrainingData'.

Parameters:

appId - The application ID.
updateSettingsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

Applies to