Package com.microsoft.azure.cognitiveservices.knowledge.qnamaker

Interface EndpointSettings

All Known Implementing Classes:

EndpointSettingsImpl

public interface EndpointSettings

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EndpointSettings.EndpointSettingsUpdateSettingsDefinition	The entirety of updateSettings definition.
static interface	EndpointSettings.EndpointSettingsUpdateSettingsDefinitionStages	Grouping of updateSettings definition stages.

Method Summary

Modifier and Type	Method	Description
EndpointSettingsDTO	getSettings()	Gets endpoint settings for an endpoint.
rx.Observable<EndpointSettingsDTO>	getSettingsAsync()	Gets endpoint settings for an endpoint.
EndpointSettings.EndpointSettingsUpdateSettingsDefinitionStages.WithExecute	updateSettings()	Updates endpoint settings for an endpoint.
void	updateSettings(UpdateSettingsOptionalParameter updateSettingsOptionalParameter)	Updates endpoint settings for an endpoint.
rx.Observable<Void>	updateSettingsAsync(UpdateSettingsOptionalParameter updateSettingsOptionalParameter)	Updates endpoint settings for an endpoint.

Method Detail

getSettings

EndpointSettingsDTO getSettings()

Gets endpoint settings for an endpoint.

Returns:

the EndpointSettingsDTO 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

rx.Observable<EndpointSettingsDTO> getSettingsAsync()

Gets endpoint settings for an endpoint.

Returns:

the observable to the EndpointSettingsDTO object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateSettings

void updateSettings(UpdateSettingsOptionalParameter updateSettingsOptionalParameter)

Updates endpoint settings for an endpoint.

Parameters:

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

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

rx.Observable<Void> updateSettingsAsync(UpdateSettingsOptionalParameter updateSettingsOptionalParameter)

Updates endpoint settings for an endpoint.

Parameters:

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

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateSettings

EndpointSettings.EndpointSettingsUpdateSettingsDefinitionStages.WithExecute updateSettings()

Updates endpoint settings for an endpoint.

Returns:

the first stage of the updateSettings call