Class ExtraParam

java.lang.Object

software.amazon.awssdk.services.route53domains.model.ExtraParam

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExtraParam.Builder,ExtraParam>

@Generated("software.amazon.awssdk:codegen")
public final class ExtraParam
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExtraParam.Builder,ExtraParam>

ExtraParam includes the following elements.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExtraParam.Builder

Method Summary

Modifier and Type	Method	Description
static ExtraParam.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final ExtraParamName	name()	The name of an additional parameter that is required by a top-level domain.
final String	nameAsString()	The name of an additional parameter that is required by a top-level domain.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends ExtraParam.Builder>	serializableBuilderClass()
ExtraParam.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final String	value()	The value that corresponds with the name of an extra parameter.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

name

public final ExtraParamName name()

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:

.com.au and .net.au

• AU_ID_NUMBER

• AU_ID_TYPE

  Valid values include the following:

  • ABN (Australian business number)

  • ACN (Australian company number)

  • TM (Trademark number)

.ca

• BRAND_NUMBER

• CA_BUSINESS_ENTITY_TYPE

  Valid values include the following:

  • BANK (Bank)

  • COMMERCIAL_COMPANY (Commercial company)

  • COMPANY (Company)

  • COOPERATION (Cooperation)

  • COOPERATIVE (Cooperative)

  • COOPRIX (Cooprix)

  • CORP (Corporation)

  • CREDIT_UNION (Credit union)

  • FOMIA (Federation of mutual insurance associations)

  • INC (Incorporated)

  • LTD (Limited)

  • LTEE (Limitée)

  • LLC (Limited liability corporation)

  • LLP (Limited liability partnership)

  • LTE (Lte.)

  • MBA (Mutual benefit association)

  • MIC (Mutual insurance company)

  • NFP (Not-for-profit corporation)

  • SA (S.A.)

  • SAVINGS_COMPANY (Savings company)

  • SAVINGS_UNION (Savings union)

  • SARL (Société à responsabilité limitée)

  • TRUST (Trust)

  • ULC (Unlimited liability corporation)

• CA_LEGAL_TYPE

  When ContactType is PERSON, valid values include the following:

  • ABO (Aboriginal Peoples indigenous to Canada)

  • CCT (Canadian citizen)

  • LGR (Legal Representative of a Canadian Citizen or Permanent Resident)

  • RES (Permanent resident of Canada)

  When ContactType is a value other than PERSON, valid values include the following:

  • ASS (Canadian unincorporated association)

  • CCO (Canadian corporation)

  • EDU (Canadian educational institution)

  • GOV (Government or government entity in Canada)

  • HOP (Canadian Hospital)

  • INB (Indian Band recognized by the Indian Act of Canada)

  • LAM (Canadian Library, Archive, or Museum)

  • MAJ (Her/His Majesty the Queen/King)

  • OMK (Official mark registered in Canada)

  • PLT (Canadian Political Party)

  • PRT (Partnership Registered in Canada)

  • TDM (Trademark registered in Canada)

  • TRD (Canadian Trade Union)

  • TRS (Trust established in Canada)

.es

• ES_IDENTIFICATION

  The value of ES_IDENTIFICATION depends on the following values:

  • The value of ES_LEGAL_FORM

  • The value of ES_IDENTIFICATION_TYPE

  If ES_LEGAL_FORM is any value other than INDIVIDUAL:

  • Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])

  • Example: B12345678

  If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:

  • If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):

    • Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])

    • Example: 12345678M

  • If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):

    • Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])

    • Example: Y1234567X

  • If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):

    • Specify a passport number, drivers license number, or national identity card number

• ES_IDENTIFICATION_TYPE

  Valid values include the following:

  • DNI_AND_NIF (For Spanish contacts)

  • NIE (For foreigners with legal residence)

  • OTHER (For contacts outside of Spain)

• ES_LEGAL_FORM

  Valid values include the following:

  • ASSOCIATION

  • CENTRAL_GOVERNMENT_BODY

  • CIVIL_SOCIETY

  • COMMUNITY_OF_OWNERS

  • COMMUNITY_PROPERTY

  • CONSULATE

  • COOPERATIVE

  • DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL

  • ECONOMIC_INTEREST_GROUP

  • EMBASSY

  • ENTITY_MANAGING_NATURAL_AREAS

  • FARM_PARTNERSHIP

  • FOUNDATION

  • GENERAL_AND_LIMITED_PARTNERSHIP

  • GENERAL_PARTNERSHIP

  • INDIVIDUAL

  • LIMITED_COMPANY

  • LOCAL_AUTHORITY

  • LOCAL_PUBLIC_ENTITY

  • MUTUAL_INSURANCE_COMPANY

  • NATIONAL_PUBLIC_ENTITY

  • ORDER_OR_RELIGIOUS_INSTITUTION

  • OTHERS (Only for contacts outside of Spain)

  • POLITICAL_PARTY

  • PROFESSIONAL_ASSOCIATION

  • PUBLIC_LAW_ASSOCIATION

  • PUBLIC_LIMITED_COMPANY

  • REGIONAL_GOVERNMENT_BODY

  • REGIONAL_PUBLIC_ENTITY

  • SAVINGS_BANK

  • SPANISH_OFFICE

  • SPORTS_ASSOCIATION

  • SPORTS_FEDERATION

  • SPORTS_LIMITED_COMPANY

  • TEMPORARY_ALLIANCE_OF_ENTERPRISES

  • TRADE_UNION

  • WORKER_OWNED_COMPANY

  • WORKER_OWNED_LIMITED_COMPANY

.eu

• EU_COUNTRY_OF_CITIZENSHIP

.fi

• BIRTH_DATE_IN_YYYY_MM_DD

• FI_BUSINESS_NUMBER

• FI_ID_NUMBER

• FI_NATIONALITY

  Valid values include the following:

  • FINNISH

  • NOT_FINNISH

• FI_ORGANIZATION_TYPE

  Valid values include the following:

  • COMPANY

  • CORPORATION

  • GOVERNMENT

  • INSTITUTION

  • POLITICAL_PARTY

  • PUBLIC_COMMUNITY

  • TOWNSHIP

.it

• IT_NATIONALITY

• IT_PIN

• IT_REGISTRANT_ENTITY_TYPE

  Valid values include the following:

  • FOREIGNERS

  • FREELANCE_WORKERS (Freelance workers and professionals)

  • ITALIAN_COMPANIES (Italian companies and one-person companies)

  • NON_PROFIT_ORGANIZATIONS

  • OTHER_SUBJECTS

  • PUBLIC_ORGANIZATIONS

.ru

• BIRTH_DATE_IN_YYYY_MM_DD

• RU_PASSPORT_DATA

.se

• BIRTH_COUNTRY

• SE_ID_NUMBER

.sg

• SG_ID_NUMBER

.uk, .co.uk, .me.uk, and .org.uk

• UK_CONTACT_TYPE

  Valid values include the following:

  • CRC (UK Corporation by Royal Charter)

  • FCORP (Non-UK Corporation)

  • FIND (Non-UK Individual, representing self)

  • FOTHER (Non-UK Entity that does not fit into any other category)

  • GOV (UK Government Body)

  • IND (UK Individual (representing self))

  • IP (UK Industrial/Provident Registered Company)

  • LLP (UK Limited Liability Partnership)

  • LTD (UK Limited Company)

  • OTHER (UK Entity that does not fit into any other category)

  • PLC (UK Public Limited Company)

  • PTNR (UK Partnership)

  • RCHAR (UK Registered Charity)

  • SCH (UK School)

  • STAT (UK Statutory Body)

  • STRA (UK Sole Trader)

• UK_COMPANY_NUMBER

In addition, many TLDs require a VAT_NUMBER.

If the service returns an enum value that is not available in the current SDK version, name will return ExtraParamName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:

.com.au and .net.au

• AU_ID_NUMBER

• AU_ID_TYPE

  Valid values include the following:

  • ABN (Australian business number)

  • ACN (Australian company number)

  • TM (Trademark number)

.ca

• BRAND_NUMBER

• CA_BUSINESS_ENTITY_TYPE

  Valid values include the following:

  • BANK (Bank)

  • COMMERCIAL_COMPANY (Commercial company)

  • COMPANY (Company)

  • COOPERATION (Cooperation)

  • COOPERATIVE (Cooperative)

  • COOPRIX (Cooprix)

  • CORP (Corporation)

  • CREDIT_UNION (Credit union)

  • FOMIA (Federation of mutual insurance associations)

  • INC (Incorporated)

  • LTD (Limited)

  • LTEE (Limitée)

  • LLC (Limited liability corporation)

  • LLP (Limited liability partnership)

  • LTE (Lte.)

  • MBA (Mutual benefit association)

  • MIC (Mutual insurance company)

  • NFP (Not-for-profit corporation)

  • SA (S.A.)

  • SAVINGS_COMPANY (Savings company)

  • SAVINGS_UNION (Savings union)

  • SARL (Société à responsabilité limitée)

  • TRUST (Trust)

  • ULC (Unlimited liability corporation)

• CA_LEGAL_TYPE

  When ContactType is PERSON, valid values include the following:

  • ABO (Aboriginal Peoples indigenous to Canada)

  • CCT (Canadian citizen)

  • LGR (Legal Representative of a Canadian Citizen or Permanent Resident)

  • RES (Permanent resident of Canada)

  When ContactType is a value other than PERSON, valid values include the following:

  • ASS (Canadian unincorporated association)

  • CCO (Canadian corporation)

  • EDU (Canadian educational institution)

  • GOV (Government or government entity in Canada)

  • HOP (Canadian Hospital)

  • INB (Indian Band recognized by the Indian Act of Canada)

  • LAM (Canadian Library, Archive, or Museum)

  • MAJ (Her/His Majesty the Queen/King)

  • OMK (Official mark registered in Canada)

  • PLT (Canadian Political Party)

  • PRT (Partnership Registered in Canada)

  • TDM (Trademark registered in Canada)

  • TRD (Canadian Trade Union)

  • TRS (Trust established in Canada)

.es

• ES_IDENTIFICATION

  The value of ES_IDENTIFICATION depends on the following values:

  • The value of ES_LEGAL_FORM

  • The value of ES_IDENTIFICATION_TYPE

  If ES_LEGAL_FORM is any value other than INDIVIDUAL:

  • Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])

  • Example: B12345678

  If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:

  • If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):

    • Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])

    • Example: 12345678M

  • If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):

    • Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])

    • Example: Y1234567X

  • If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):

    • Specify a passport number, drivers license number, or national identity card number

• ES_IDENTIFICATION_TYPE

  Valid values include the following:

  • DNI_AND_NIF (For Spanish contacts)

  • NIE (For foreigners with legal residence)

  • OTHER (For contacts outside of Spain)

• ES_LEGAL_FORM

  Valid values include the following:

  • ASSOCIATION

  • CENTRAL_GOVERNMENT_BODY

  • CIVIL_SOCIETY

  • COMMUNITY_OF_OWNERS

  • COMMUNITY_PROPERTY

  • CONSULATE

  • COOPERATIVE

  • DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL

  • ECONOMIC_INTEREST_GROUP

  • EMBASSY

  • ENTITY_MANAGING_NATURAL_AREAS

  • FARM_PARTNERSHIP

  • FOUNDATION

  • GENERAL_AND_LIMITED_PARTNERSHIP

  • GENERAL_PARTNERSHIP

  • INDIVIDUAL

  • LIMITED_COMPANY

  • LOCAL_AUTHORITY

  • LOCAL_PUBLIC_ENTITY

  • MUTUAL_INSURANCE_COMPANY

  • NATIONAL_PUBLIC_ENTITY

  • ORDER_OR_RELIGIOUS_INSTITUTION

  • OTHERS (Only for contacts outside of Spain)

  • POLITICAL_PARTY

  • PROFESSIONAL_ASSOCIATION

  • PUBLIC_LAW_ASSOCIATION

  • PUBLIC_LIMITED_COMPANY

  • REGIONAL_GOVERNMENT_BODY

  • REGIONAL_PUBLIC_ENTITY

  • SAVINGS_BANK

  • SPANISH_OFFICE

  • SPORTS_ASSOCIATION

  • SPORTS_FEDERATION

  • SPORTS_LIMITED_COMPANY

  • TEMPORARY_ALLIANCE_OF_ENTERPRISES

  • TRADE_UNION

  • WORKER_OWNED_COMPANY

  • WORKER_OWNED_LIMITED_COMPANY

.eu

• EU_COUNTRY_OF_CITIZENSHIP

.fi

• BIRTH_DATE_IN_YYYY_MM_DD

• FI_BUSINESS_NUMBER

• FI_ID_NUMBER

• FI_NATIONALITY

  Valid values include the following:

  • FINNISH

  • NOT_FINNISH

• FI_ORGANIZATION_TYPE

  Valid values include the following:

  • COMPANY

  • CORPORATION

  • GOVERNMENT

  • INSTITUTION

  • POLITICAL_PARTY

  • PUBLIC_COMMUNITY

  • TOWNSHIP

.it

• IT_NATIONALITY

• IT_PIN

• IT_REGISTRANT_ENTITY_TYPE

  Valid values include the following:

  • FOREIGNERS

  • FREELANCE_WORKERS (Freelance workers and professionals)

  • ITALIAN_COMPANIES (Italian companies and one-person companies)

  • NON_PROFIT_ORGANIZATIONS

  • OTHER_SUBJECTS

  • PUBLIC_ORGANIZATIONS

.ru

• BIRTH_DATE_IN_YYYY_MM_DD

• RU_PASSPORT_DATA

.se

• BIRTH_COUNTRY

• SE_ID_NUMBER

.sg

• SG_ID_NUMBER

.uk, .co.uk, .me.uk, and .org.uk

• UK_CONTACT_TYPE

  Valid values include the following:

  • CRC (UK Corporation by Royal Charter)

  • FCORP (Non-UK Corporation)

  • FIND (Non-UK Individual, representing self)

  • FOTHER (Non-UK Entity that does not fit into any other category)

  • GOV (UK Government Body)

  • IND (UK Individual (representing self))

  • IP (UK Industrial/Provident Registered Company)

  • LLP (UK Limited Liability Partnership)

  • LTD (UK Limited Company)

  • OTHER (UK Entity that does not fit into any other category)

  • PLC (UK Public Limited Company)

  • PTNR (UK Partnership)

  • RCHAR (UK Registered Charity)

  • SCH (UK School)

  • STAT (UK Statutory Body)

  • STRA (UK Sole Trader)

• UK_COMPANY_NUMBER

In addition, many TLDs require a VAT_NUMBER.

See Also:

• ExtraParamName

nameAsString

public final String nameAsString()

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:

.com.au and .net.au

• AU_ID_NUMBER

• AU_ID_TYPE

  Valid values include the following:

  • ABN (Australian business number)

  • ACN (Australian company number)

  • TM (Trademark number)

.ca

• BRAND_NUMBER

• CA_BUSINESS_ENTITY_TYPE

  Valid values include the following:

  • BANK (Bank)

  • COMMERCIAL_COMPANY (Commercial company)

  • COMPANY (Company)

  • COOPERATION (Cooperation)

  • COOPERATIVE (Cooperative)

  • COOPRIX (Cooprix)

  • CORP (Corporation)

  • CREDIT_UNION (Credit union)

  • FOMIA (Federation of mutual insurance associations)

  • INC (Incorporated)

  • LTD (Limited)

  • LTEE (Limitée)

  • LLC (Limited liability corporation)

  • LLP (Limited liability partnership)

  • LTE (Lte.)

  • MBA (Mutual benefit association)

  • MIC (Mutual insurance company)

  • NFP (Not-for-profit corporation)

  • SA (S.A.)

  • SAVINGS_COMPANY (Savings company)

  • SAVINGS_UNION (Savings union)

  • SARL (Société à responsabilité limitée)

  • TRUST (Trust)

  • ULC (Unlimited liability corporation)

• CA_LEGAL_TYPE

  When ContactType is PERSON, valid values include the following:

  • ABO (Aboriginal Peoples indigenous to Canada)

  • CCT (Canadian citizen)

  • LGR (Legal Representative of a Canadian Citizen or Permanent Resident)

  • RES (Permanent resident of Canada)

  When ContactType is a value other than PERSON, valid values include the following:

  • ASS (Canadian unincorporated association)

  • CCO (Canadian corporation)

  • EDU (Canadian educational institution)

  • GOV (Government or government entity in Canada)

  • HOP (Canadian Hospital)

  • INB (Indian Band recognized by the Indian Act of Canada)

  • LAM (Canadian Library, Archive, or Museum)

  • MAJ (Her/His Majesty the Queen/King)

  • OMK (Official mark registered in Canada)

  • PLT (Canadian Political Party)

  • PRT (Partnership Registered in Canada)

  • TDM (Trademark registered in Canada)

  • TRD (Canadian Trade Union)

  • TRS (Trust established in Canada)

.es

• ES_IDENTIFICATION

  The value of ES_IDENTIFICATION depends on the following values:

  • The value of ES_LEGAL_FORM

  • The value of ES_IDENTIFICATION_TYPE

  If ES_LEGAL_FORM is any value other than INDIVIDUAL:

  • Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])

  • Example: B12345678

  If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:

  • If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):

    • Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])

    • Example: 12345678M

  • If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):

    • Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])

    • Example: Y1234567X

  • If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):

    • Specify a passport number, drivers license number, or national identity card number

• ES_IDENTIFICATION_TYPE

  Valid values include the following:

  • DNI_AND_NIF (For Spanish contacts)

  • NIE (For foreigners with legal residence)

  • OTHER (For contacts outside of Spain)

• ES_LEGAL_FORM

  Valid values include the following:

  • ASSOCIATION

  • CENTRAL_GOVERNMENT_BODY

  • CIVIL_SOCIETY

  • COMMUNITY_OF_OWNERS

  • COMMUNITY_PROPERTY

  • CONSULATE

  • COOPERATIVE

  • DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL

  • ECONOMIC_INTEREST_GROUP

  • EMBASSY

  • ENTITY_MANAGING_NATURAL_AREAS

  • FARM_PARTNERSHIP

  • FOUNDATION

  • GENERAL_AND_LIMITED_PARTNERSHIP

  • GENERAL_PARTNERSHIP

  • INDIVIDUAL

  • LIMITED_COMPANY

  • LOCAL_AUTHORITY

  • LOCAL_PUBLIC_ENTITY

  • MUTUAL_INSURANCE_COMPANY

  • NATIONAL_PUBLIC_ENTITY

  • ORDER_OR_RELIGIOUS_INSTITUTION

  • OTHERS (Only for contacts outside of Spain)

  • POLITICAL_PARTY

  • PROFESSIONAL_ASSOCIATION

  • PUBLIC_LAW_ASSOCIATION

  • PUBLIC_LIMITED_COMPANY

  • REGIONAL_GOVERNMENT_BODY

  • REGIONAL_PUBLIC_ENTITY

  • SAVINGS_BANK

  • SPANISH_OFFICE

  • SPORTS_ASSOCIATION

  • SPORTS_FEDERATION

  • SPORTS_LIMITED_COMPANY

  • TEMPORARY_ALLIANCE_OF_ENTERPRISES

  • TRADE_UNION

  • WORKER_OWNED_COMPANY

  • WORKER_OWNED_LIMITED_COMPANY

.eu

• EU_COUNTRY_OF_CITIZENSHIP

.fi

• BIRTH_DATE_IN_YYYY_MM_DD

• FI_BUSINESS_NUMBER

• FI_ID_NUMBER

• FI_NATIONALITY

  Valid values include the following:

  • FINNISH

  • NOT_FINNISH

• FI_ORGANIZATION_TYPE

  Valid values include the following:

  • COMPANY

  • CORPORATION

  • GOVERNMENT

  • INSTITUTION

  • POLITICAL_PARTY

  • PUBLIC_COMMUNITY

  • TOWNSHIP

.it

• IT_NATIONALITY

• IT_PIN

• IT_REGISTRANT_ENTITY_TYPE

  Valid values include the following:

  • FOREIGNERS

  • FREELANCE_WORKERS (Freelance workers and professionals)

  • ITALIAN_COMPANIES (Italian companies and one-person companies)

  • NON_PROFIT_ORGANIZATIONS

  • OTHER_SUBJECTS

  • PUBLIC_ORGANIZATIONS

.ru

• BIRTH_DATE_IN_YYYY_MM_DD

• RU_PASSPORT_DATA

.se

• BIRTH_COUNTRY

• SE_ID_NUMBER

.sg

• SG_ID_NUMBER

.uk, .co.uk, .me.uk, and .org.uk

• UK_CONTACT_TYPE

  Valid values include the following:

  • CRC (UK Corporation by Royal Charter)

  • FCORP (Non-UK Corporation)

  • FIND (Non-UK Individual, representing self)

  • FOTHER (Non-UK Entity that does not fit into any other category)

  • GOV (UK Government Body)

  • IND (UK Individual (representing self))

  • IP (UK Industrial/Provident Registered Company)

  • LLP (UK Limited Liability Partnership)

  • LTD (UK Limited Company)

  • OTHER (UK Entity that does not fit into any other category)

  • PLC (UK Public Limited Company)

  • PTNR (UK Partnership)

  • RCHAR (UK Registered Charity)

  • SCH (UK School)

  • STAT (UK Statutory Body)

  • STRA (UK Sole Trader)

• UK_COMPANY_NUMBER

In addition, many TLDs require a VAT_NUMBER.

If the service returns an enum value that is not available in the current SDK version, name will return ExtraParamName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:

.com.au and .net.au

• AU_ID_NUMBER

• AU_ID_TYPE

  Valid values include the following:

  • ABN (Australian business number)

  • ACN (Australian company number)

  • TM (Trademark number)

.ca

• BRAND_NUMBER

• CA_BUSINESS_ENTITY_TYPE

  Valid values include the following:

  • BANK (Bank)

  • COMMERCIAL_COMPANY (Commercial company)

  • COMPANY (Company)

  • COOPERATION (Cooperation)

  • COOPERATIVE (Cooperative)

  • COOPRIX (Cooprix)

  • CORP (Corporation)

  • CREDIT_UNION (Credit union)

  • FOMIA (Federation of mutual insurance associations)

  • INC (Incorporated)

  • LTD (Limited)

  • LTEE (Limitée)

  • LLC (Limited liability corporation)

  • LLP (Limited liability partnership)

  • LTE (Lte.)

  • MBA (Mutual benefit association)

  • MIC (Mutual insurance company)

  • NFP (Not-for-profit corporation)

  • SA (S.A.)

  • SAVINGS_COMPANY (Savings company)

  • SAVINGS_UNION (Savings union)

  • SARL (Société à responsabilité limitée)

  • TRUST (Trust)

  • ULC (Unlimited liability corporation)

• CA_LEGAL_TYPE

  When ContactType is PERSON, valid values include the following:

  • ABO (Aboriginal Peoples indigenous to Canada)

  • CCT (Canadian citizen)

  • LGR (Legal Representative of a Canadian Citizen or Permanent Resident)

  • RES (Permanent resident of Canada)

  When ContactType is a value other than PERSON, valid values include the following:

  • ASS (Canadian unincorporated association)

  • CCO (Canadian corporation)

  • EDU (Canadian educational institution)

  • GOV (Government or government entity in Canada)

  • HOP (Canadian Hospital)

  • INB (Indian Band recognized by the Indian Act of Canada)

  • LAM (Canadian Library, Archive, or Museum)

  • MAJ (Her/His Majesty the Queen/King)

  • OMK (Official mark registered in Canada)

  • PLT (Canadian Political Party)

  • PRT (Partnership Registered in Canada)

  • TDM (Trademark registered in Canada)

  • TRD (Canadian Trade Union)

  • TRS (Trust established in Canada)

.es

• ES_IDENTIFICATION

  The value of ES_IDENTIFICATION depends on the following values:

  • The value of ES_LEGAL_FORM

  • The value of ES_IDENTIFICATION_TYPE

  If ES_LEGAL_FORM is any value other than INDIVIDUAL:

  • Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])

  • Example: B12345678

  If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:

  • If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):

    • Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])

    • Example: 12345678M

  • If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):

    • Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])

    • Example: Y1234567X

  • If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):

    • Specify a passport number, drivers license number, or national identity card number

• ES_IDENTIFICATION_TYPE

  Valid values include the following:

  • DNI_AND_NIF (For Spanish contacts)

  • NIE (For foreigners with legal residence)

  • OTHER (For contacts outside of Spain)

• ES_LEGAL_FORM

  Valid values include the following:

  • ASSOCIATION

  • CENTRAL_GOVERNMENT_BODY

  • CIVIL_SOCIETY

  • COMMUNITY_OF_OWNERS

  • COMMUNITY_PROPERTY

  • CONSULATE

  • COOPERATIVE

  • DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL

  • ECONOMIC_INTEREST_GROUP

  • EMBASSY

  • ENTITY_MANAGING_NATURAL_AREAS

  • FARM_PARTNERSHIP

  • FOUNDATION

  • GENERAL_AND_LIMITED_PARTNERSHIP

  • GENERAL_PARTNERSHIP

  • INDIVIDUAL

  • LIMITED_COMPANY

  • LOCAL_AUTHORITY

  • LOCAL_PUBLIC_ENTITY

  • MUTUAL_INSURANCE_COMPANY

  • NATIONAL_PUBLIC_ENTITY

  • ORDER_OR_RELIGIOUS_INSTITUTION

  • OTHERS (Only for contacts outside of Spain)

  • POLITICAL_PARTY

  • PROFESSIONAL_ASSOCIATION

  • PUBLIC_LAW_ASSOCIATION

  • PUBLIC_LIMITED_COMPANY

  • REGIONAL_GOVERNMENT_BODY

  • REGIONAL_PUBLIC_ENTITY

  • SAVINGS_BANK

  • SPANISH_OFFICE

  • SPORTS_ASSOCIATION

  • SPORTS_FEDERATION

  • SPORTS_LIMITED_COMPANY

  • TEMPORARY_ALLIANCE_OF_ENTERPRISES

  • TRADE_UNION

  • WORKER_OWNED_COMPANY

  • WORKER_OWNED_LIMITED_COMPANY

.eu

• EU_COUNTRY_OF_CITIZENSHIP

.fi

• BIRTH_DATE_IN_YYYY_MM_DD

• FI_BUSINESS_NUMBER

• FI_ID_NUMBER

• FI_NATIONALITY

  Valid values include the following:

  • FINNISH

  • NOT_FINNISH

• FI_ORGANIZATION_TYPE

  Valid values include the following:

  • COMPANY

  • CORPORATION

  • GOVERNMENT

  • INSTITUTION

  • POLITICAL_PARTY

  • PUBLIC_COMMUNITY

  • TOWNSHIP

.it

• IT_NATIONALITY

• IT_PIN

• IT_REGISTRANT_ENTITY_TYPE

  Valid values include the following:

  • FOREIGNERS

  • FREELANCE_WORKERS (Freelance workers and professionals)

  • ITALIAN_COMPANIES (Italian companies and one-person companies)

  • NON_PROFIT_ORGANIZATIONS

  • OTHER_SUBJECTS

  • PUBLIC_ORGANIZATIONS

.ru

• BIRTH_DATE_IN_YYYY_MM_DD

• RU_PASSPORT_DATA

.se

• BIRTH_COUNTRY

• SE_ID_NUMBER

.sg

• SG_ID_NUMBER

.uk, .co.uk, .me.uk, and .org.uk

• UK_CONTACT_TYPE

  Valid values include the following:

  • CRC (UK Corporation by Royal Charter)

  • FCORP (Non-UK Corporation)

  • FIND (Non-UK Individual, representing self)

  • FOTHER (Non-UK Entity that does not fit into any other category)

  • GOV (UK Government Body)

  • IND (UK Individual (representing self))

  • IP (UK Industrial/Provident Registered Company)

  • LLP (UK Limited Liability Partnership)

  • LTD (UK Limited Company)

  • OTHER (UK Entity that does not fit into any other category)

  • PLC (UK Public Limited Company)

  • PTNR (UK Partnership)

  • RCHAR (UK Registered Charity)

  • SCH (UK School)

  • STAT (UK Statutory Body)

  • STRA (UK Sole Trader)

• UK_COMPANY_NUMBER

In addition, many TLDs require a VAT_NUMBER.

See Also:

• ExtraParamName

value

public final String value()

The value that corresponds with the name of an extra parameter.

Returns:

The value that corresponds with the name of an extra parameter.

toBuilder

public ExtraParam.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ExtraParam.Builder,ExtraParam>

Returns:

a builder for type T

builder

public static ExtraParam.Builder builder()

serializableBuilderClass

public static Class<? extends ExtraParam.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.