commonMain.aws.sdk.kotlin.services.route53domains.model.ExtraParam.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of route53domains-jvm Show documentation
Show all versions of route53domains-jvm Show documentation
The AWS SDK for Kotlin client for Route 53 Domains
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.route53domains.model
import aws.smithy.kotlin.runtime.SdkDsl
/**
* ExtraParam includes the following elements.
*/
public class ExtraParam private constructor(builder: Builder) {
/**
* 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`.
*/
public val name: aws.sdk.kotlin.services.route53domains.model.ExtraParamName = requireNotNull(builder.name) { "A non-null value must be provided for name" }
/**
* The value that corresponds with the name of an extra parameter.
*/
public val value: kotlin.String = requireNotNull(builder.value) { "A non-null value must be provided for value" }
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.route53domains.model.ExtraParam = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("ExtraParam(")
append("name=$name,")
append("value=*** Sensitive Data Redacted ***")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = name.hashCode()
result = 31 * result + (value.hashCode())
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as ExtraParam
if (name != other.name) return false
if (value != other.value) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.route53domains.model.ExtraParam = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* 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`.
*/
public var name: aws.sdk.kotlin.services.route53domains.model.ExtraParamName? = null
/**
* The value that corresponds with the name of an extra parameter.
*/
public var value: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.route53domains.model.ExtraParam) : this() {
this.name = x.name
this.value = x.value
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.route53domains.model.ExtraParam = ExtraParam(this)
internal fun correctErrors(): Builder {
if (name == null) name = ExtraParamName.SdkUnknown("no value provided")
if (value == null) value = ""
return this
}
}
}