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

Interface EndpointKeys

All Known Implementing Classes:

EndpointKeysImpl

public interface EndpointKeys

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

Method Summary

Modifier and Type	Method	Description
EndpointKeysDTO	getKeys()	Gets endpoint keys for an endpoint.
rx.Observable<EndpointKeysDTO>	getKeysAsync()	Gets endpoint keys for an endpoint.
EndpointKeysDTO	refreshKeys(String keyType)	Re-generates an endpoint key.
rx.Observable<EndpointKeysDTO>	refreshKeysAsync(String keyType)	Re-generates an endpoint key.

Method Detail

getKeys

EndpointKeysDTO getKeys()

Gets endpoint keys for an endpoint.

Returns:

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

getKeysAsync

rx.Observable<EndpointKeysDTO> getKeysAsync()

Gets endpoint keys for an endpoint.

Returns:

the observable to the EndpointKeysDTO object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

refreshKeys

EndpointKeysDTO refreshKeys(String keyType)

Re-generates an endpoint key.

Parameters:

keyType - Type of Key.

Returns:

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

refreshKeysAsync

rx.Observable<EndpointKeysDTO> refreshKeysAsync(String keyType)

Re-generates an endpoint key.

Parameters:

keyType - Type of Key.

Returns:

the observable to the EndpointKeysDTO object

Throws:

IllegalArgumentException - thrown if parameters fail the validation