software.amazon.awssdk.services.route53domains.model.ExtraParam Maven / Gradle / Ivy
Show all versions of route53domains Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.route53domains.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* ExtraParam includes the following elements.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ExtraParam implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(ExtraParam::nameAsString)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Value")
.getter(getter(ExtraParam::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Value").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, VALUE_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String value;
private ExtraParam(BuilderImpl builder) {
this.name = builder.name;
this.value = builder.value;
}
/**
*
* 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, {@link #name} will return
* {@link ExtraParamName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return 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 ExtraParamName
*/
public final ExtraParamName name() {
return ExtraParamName.fromValue(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, {@link #name} will return
* {@link ExtraParamName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return 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 ExtraParamName
*/
public final String nameAsString() {
return name;
}
/**
*
* The value that corresponds with the name of an extra parameter.
*
*
* @return The value that corresponds with the name of an extra parameter.
*/
public final String value() {
return value;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(nameAsString());
hashCode = 31 * hashCode + Objects.hashCode(value());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ExtraParam)) {
return false;
}
ExtraParam other = (ExtraParam) obj;
return Objects.equals(nameAsString(), other.nameAsString()) && Objects.equals(value(), other.value());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ExtraParam").add("Name", nameAsString())
.add("Value", value() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(nameAsString()));
case "Value":
return Optional.ofNullable(clazz.cast(value()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ExtraParam) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @see ExtraParamName
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExtraParamName
*/
Builder name(String 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.
*
*
* @param 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.
* @see ExtraParamName
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExtraParamName
*/
Builder name(ExtraParamName name);
/**
*
* The value that corresponds with the name of an extra parameter.
*
*
* @param value
* The value that corresponds with the name of an extra parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(String value);
}
static final class BuilderImpl implements Builder {
private String name;
private String value;
private BuilderImpl() {
}
private BuilderImpl(ExtraParam model) {
name(model.name);
value(model.value);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
@Override
public final Builder name(ExtraParamName name) {
this.name(name == null ? null : name.toString());
return this;
}
public final String getValue() {
return value;
}
public final void setValue(String value) {
this.value = value;
}
@Override
public final Builder value(String value) {
this.value = value;
return this;
}
@Override
public ExtraParam build() {
return new ExtraParam(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}