Package com.microsoft.cognitiveservices.speech

Enum ServicePropertyChannel

java.lang.Object

java.lang.Enum<ServicePropertyChannel>

com.microsoft.cognitiveservices.speech.ServicePropertyChannel

All Implemented Interfaces:

Serializable, Comparable<ServicePropertyChannel>

public enum ServicePropertyChannel
extends Enum<ServicePropertyChannel>

Defines channels used to send service properties. Added in version 1.5.0.

Enum Constant Summary

Enum Constants

Enum Constant	Description
HttpHeader	Uses HttpHeader to set a key/value in a HTTP header.
UriQueryParameter	Uses URI query parameter to pass property settings to service.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the internal value
static ServicePropertyChannel	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ServicePropertyChannel[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UriQueryParameter

public static final ServicePropertyChannel UriQueryParameter

Uses URI query parameter to pass property settings to service.

HttpHeader

public static final ServicePropertyChannel HttpHeader

Uses HttpHeader to set a key/value in a HTTP header.

Method Detail

values

public static ServicePropertyChannel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ServicePropertyChannel c : ServicePropertyChannel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ServicePropertyChannel valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Returns the internal value

Returns:

the channel value