Package io.github.brenoepics.at4j.azure

Enum BaseURL

java.lang.Object

java.lang.Enum<BaseURL>

io.github.brenoepics.at4j.azure.BaseURL

All Implemented Interfaces:

Serializable, Comparable<BaseURL>

public enum BaseURL
extends Enum<BaseURL>

The base URL of the Azure Translator API. The list of available domains can be found here.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASIA_PACIFIC	The domain of the Azure Translator API for the Asia Pacific.
EUROPE	The domain of the Azure Translator API for the Europe.
GLOBAL	The default domain of the Azure Translator API.
UNITED_STATES	The domain of the Azure Translator API for the United States.

Method Summary

Modifier and Type	Method	Description
String	getUrl()	Gets the URL of the Azure Translator API.
static BaseURL	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BaseURL[]	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

GLOBAL

public static final BaseURL GLOBAL

The default domain of the Azure Translator API. Datacenters: Closest available datacenter.

ASIA_PACIFIC

public static final BaseURL ASIA_PACIFIC

The domain of the Azure Translator API for the Asia Pacific. Datacenters: Korea South, Japan East, Southeast Asia, and Australia East.

EUROPE

public static final BaseURL EUROPE

The domain of the Azure Translator API for the Europe. Datacenters: North Europe and West Europe.

UNITED_STATES

public static final BaseURL UNITED_STATES

The domain of the Azure Translator API for the United States. Datacenters: East US, South Central US, West Central US, and West US 2

Method Detail

values

public static BaseURL[] 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 (BaseURL c : BaseURL.values())
    System.out.println(c);

Returns:

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

valueOf

public static BaseURL 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

getUrl

public String getUrl()

Gets the URL of the Azure Translator API.

Returns:

The URL of the Azure Translator API.