Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

getCustomer

Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn’t exist. Usually the result of an invalid name parameter. Return value: The Customer resource.

Using getCustomer

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCustomer(args: GetCustomerArgs, opts?: InvokeOptions): Promise<GetCustomerResult>
function getCustomerOutput(args: GetCustomerOutputArgs, opts?: InvokeOptions): Output<GetCustomerResult>
def get_customer(account_id: Optional[str] = None,
                 channel_partner_link_id: Optional[str] = None,
                 customer_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetCustomerResult
def get_customer_output(account_id: Optional[pulumi.Input[str]] = None,
                 channel_partner_link_id: Optional[pulumi.Input[str]] = None,
                 customer_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetCustomerResult]
func LookupCustomer(ctx *Context, args *LookupCustomerArgs, opts ...InvokeOption) (*LookupCustomerResult, error)
func LookupCustomerOutput(ctx *Context, args *LookupCustomerOutputArgs, opts ...InvokeOption) LookupCustomerResultOutput

> Note: This function is named LookupCustomer in the Go SDK.

public static class GetCustomer 
{
    public static Task<GetCustomerResult> InvokeAsync(GetCustomerArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomerResult> Invoke(GetCustomerInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCustomerResult> getCustomer(GetCustomerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:cloudchannel/v1:getCustomer
  Arguments:
    # Arguments dictionary

The following arguments are supported:

getCustomer Result

The following output properties are available:

AlternateEmail string

Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.

ChannelPartnerId string

Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.

CloudIdentityId string

The customer's Cloud Identity ID if the customer has a Cloud Identity resource.

CloudIdentityInfo Pulumi.GoogleNative.CloudChannel.V1.Outputs.GoogleCloudChannelV1CloudIdentityInfoResponse

Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.

CreateTime string

Time when the customer was created.

Domain string

The customer's primary domain. Must match the primary contact email's domain.

LanguageCode string

Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

Name string

Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

OrgDisplayName string

Name of the organization that the customer entity represents.

OrgPostalAddress Pulumi.GoogleNative.CloudChannel.V1.Outputs.GoogleTypePostalAddressResponse

The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.

PrimaryContactInfo Pulumi.GoogleNative.CloudChannel.V1.Outputs.GoogleCloudChannelV1ContactInfoResponse

Primary contact info.

UpdateTime string

Time when the customer was updated.

AlternateEmail string

Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.

ChannelPartnerId string

Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.

CloudIdentityId string

The customer's Cloud Identity ID if the customer has a Cloud Identity resource.

CloudIdentityInfo GoogleCloudChannelV1CloudIdentityInfoResponse

Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.

CreateTime string

Time when the customer was created.

Domain string

The customer's primary domain. Must match the primary contact email's domain.

LanguageCode string

Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

Name string

Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

OrgDisplayName string

Name of the organization that the customer entity represents.

OrgPostalAddress GoogleTypePostalAddressResponse

The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.

PrimaryContactInfo GoogleCloudChannelV1ContactInfoResponse

Primary contact info.

UpdateTime string

Time when the customer was updated.

alternateEmail String

Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.

channelPartnerId String

Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.

cloudIdentityId String

The customer's Cloud Identity ID if the customer has a Cloud Identity resource.

cloudIdentityInfo GoogleCloudChannelV1CloudIdentityInfoResponse

Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.

createTime String

Time when the customer was created.

domain String

The customer's primary domain. Must match the primary contact email's domain.

languageCode String

Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

name String

Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

orgDisplayName String

Name of the organization that the customer entity represents.

orgPostalAddress GoogleTypePostalAddressResponse

The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.

primaryContactInfo GoogleCloudChannelV1ContactInfoResponse

Primary contact info.

updateTime String

Time when the customer was updated.

alternateEmail string

Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.

channelPartnerId string

Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.

cloudIdentityId string

The customer's Cloud Identity ID if the customer has a Cloud Identity resource.

cloudIdentityInfo GoogleCloudChannelV1CloudIdentityInfoResponse

Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.

createTime string

Time when the customer was created.

domain string

The customer's primary domain. Must match the primary contact email's domain.

languageCode string

Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

name string

Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

orgDisplayName string

Name of the organization that the customer entity represents.

orgPostalAddress GoogleTypePostalAddressResponse

The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.

primaryContactInfo GoogleCloudChannelV1ContactInfoResponse

Primary contact info.

updateTime string

Time when the customer was updated.

alternate_email str

Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.

channel_partner_id str

Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.

cloud_identity_id str

The customer's Cloud Identity ID if the customer has a Cloud Identity resource.

cloud_identity_info GoogleCloudChannelV1CloudIdentityInfoResponse

Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.

create_time str

Time when the customer was created.

domain str

The customer's primary domain. Must match the primary contact email's domain.

language_code str

Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

name str

Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

org_display_name str

Name of the organization that the customer entity represents.

org_postal_address GoogleTypePostalAddressResponse

The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.

primary_contact_info GoogleCloudChannelV1ContactInfoResponse

Primary contact info.

update_time str

Time when the customer was updated.

alternateEmail String

Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.

channelPartnerId String

Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.

cloudIdentityId String

The customer's Cloud Identity ID if the customer has a Cloud Identity resource.

cloudIdentityInfo Property Map

Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.

createTime String

Time when the customer was created.

domain String

The customer's primary domain. Must match the primary contact email's domain.

languageCode String

Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

name String

Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

orgDisplayName String

Name of the organization that the customer entity represents.

orgPostalAddress Property Map

The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.

primaryContactInfo Property Map

Primary contact info.

updateTime String

Time when the customer was updated.

Supporting Types

GoogleCloudChannelV1CloudIdentityInfoResponse

AdminConsoleUri string

URI of Customer's Admin console dashboard.

AlternateEmail string

The alternate email.

CustomerType string

CustomerType indicates verification type needed for using services.

EduData Pulumi.GoogleNative.CloudChannel.V1.Inputs.GoogleCloudChannelV1EduDataResponse

Edu information about the customer.

IsDomainVerified bool

Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

LanguageCode string

Language code.

PhoneNumber string

Phone number associated with the Cloud Identity.

PrimaryDomain string

The primary domain name.

AdminConsoleUri string

URI of Customer's Admin console dashboard.

AlternateEmail string

The alternate email.

CustomerType string

CustomerType indicates verification type needed for using services.

EduData GoogleCloudChannelV1EduDataResponse

Edu information about the customer.

IsDomainVerified bool

Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

LanguageCode string

Language code.

PhoneNumber string

Phone number associated with the Cloud Identity.

PrimaryDomain string

The primary domain name.

adminConsoleUri String

URI of Customer's Admin console dashboard.

alternateEmail String

The alternate email.

customerType String

CustomerType indicates verification type needed for using services.

eduData GoogleCloudChannelV1EduDataResponse

Edu information about the customer.

isDomainVerified Boolean

Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

languageCode String

Language code.

phoneNumber String

Phone number associated with the Cloud Identity.

primaryDomain String

The primary domain name.

adminConsoleUri string

URI of Customer's Admin console dashboard.

alternateEmail string

The alternate email.

customerType string

CustomerType indicates verification type needed for using services.

eduData GoogleCloudChannelV1EduDataResponse

Edu information about the customer.

isDomainVerified boolean

Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

languageCode string

Language code.

phoneNumber string

Phone number associated with the Cloud Identity.

primaryDomain string

The primary domain name.

admin_console_uri str

URI of Customer's Admin console dashboard.

alternate_email str

The alternate email.

customer_type str

CustomerType indicates verification type needed for using services.

edu_data GoogleCloudChannelV1EduDataResponse

Edu information about the customer.

is_domain_verified bool

Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

language_code str

Language code.

phone_number str

Phone number associated with the Cloud Identity.

primary_domain str

The primary domain name.

adminConsoleUri String

URI of Customer's Admin console dashboard.

alternateEmail String

The alternate email.

customerType String

CustomerType indicates verification type needed for using services.

eduData Property Map

Edu information about the customer.

isDomainVerified Boolean

Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

languageCode String

Language code.

phoneNumber String

Phone number associated with the Cloud Identity.

primaryDomain String

The primary domain name.

GoogleCloudChannelV1ContactInfoResponse

DisplayName string

The customer account contact's display name, formatted as a combination of the customer's first and last name.

Email string

The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.

FirstName string

The customer account contact's first name. Optional for Team customers.

LastName string

The customer account contact's last name. Optional for Team customers.

Phone string

The customer account's contact phone number.

Title string

Optional. The customer account contact's job title.

DisplayName string

The customer account contact's display name, formatted as a combination of the customer's first and last name.

Email string

The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.

FirstName string

The customer account contact's first name. Optional for Team customers.

LastName string

The customer account contact's last name. Optional for Team customers.

Phone string

The customer account's contact phone number.

Title string

Optional. The customer account contact's job title.

displayName String

The customer account contact's display name, formatted as a combination of the customer's first and last name.

email String

The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.

firstName String

The customer account contact's first name. Optional for Team customers.

lastName String

The customer account contact's last name. Optional for Team customers.

phone String

The customer account's contact phone number.

title String

Optional. The customer account contact's job title.

displayName string

The customer account contact's display name, formatted as a combination of the customer's first and last name.

email string

The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.

firstName string

The customer account contact's first name. Optional for Team customers.

lastName string

The customer account contact's last name. Optional for Team customers.

phone string

The customer account's contact phone number.

title string

Optional. The customer account contact's job title.

display_name str

The customer account contact's display name, formatted as a combination of the customer's first and last name.

email str

The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.

first_name str

The customer account contact's first name. Optional for Team customers.

last_name str

The customer account contact's last name. Optional for Team customers.

phone str

The customer account's contact phone number.

title str

Optional. The customer account contact's job title.

displayName String

The customer account contact's display name, formatted as a combination of the customer's first and last name.

email String

The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.

firstName String

The customer account contact's first name. Optional for Team customers.

lastName String

The customer account contact's last name. Optional for Team customers.

phone String

The customer account's contact phone number.

title String

Optional. The customer account contact's job title.

GoogleCloudChannelV1EduDataResponse

InstituteSize string

Size of the institute.

InstituteType string

Designated institute type of customer.

Website string

Web address for the edu customer's institution.

InstituteSize string

Size of the institute.

InstituteType string

Designated institute type of customer.

Website string

Web address for the edu customer's institution.

instituteSize String

Size of the institute.

instituteType String

Designated institute type of customer.

website String

Web address for the edu customer's institution.

instituteSize string

Size of the institute.

instituteType string

Designated institute type of customer.

website string

Web address for the edu customer's institution.

institute_size str

Size of the institute.

institute_type str

Designated institute type of customer.

website str

Web address for the edu customer's institution.

instituteSize String

Size of the institute.

instituteType String

Designated institute type of customer.

website String

Web address for the edu customer's institution.

GoogleTypePostalAddressResponse

AddressLines List<string>

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

AdministrativeArea string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

LanguageCode string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

Locality string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

Organization string

Optional. The name of the organization at the address.

PostalCode string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

Recipients List<string>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

RegionCode string

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

Revision int

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

SortingCode string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

Sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

AddressLines []string

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

AdministrativeArea string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

LanguageCode string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

Locality string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

Organization string

Optional. The name of the organization at the address.

PostalCode string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

Recipients []string

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

RegionCode string

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

Revision int

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

SortingCode string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

Sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

addressLines List<String>

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrativeArea String

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

languageCode String

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality String

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization String

Optional. The name of the organization at the address.

postalCode String

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients List<String>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

regionCode String

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

revision Integer

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sortingCode String

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality String

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

addressLines string[]

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrativeArea string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

languageCode string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization string

Optional. The name of the organization at the address.

postalCode string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients string[]

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

regionCode string

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

revision number

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sortingCode string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

address_lines Sequence[str]

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrative_area str

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

language_code str

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality str

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization str

Optional. The name of the organization at the address.

postal_code str

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients Sequence[str]

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

region_code str

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

revision int

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sorting_code str

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality str

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

addressLines List<String>

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrativeArea String

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

languageCode String

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality String

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization String

Optional. The name of the organization at the address.

postalCode String

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients List<String>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

regionCode String

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

revision Number

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sortingCode String

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality String

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0