Google Native

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

getCompany

Retrieves specified company.

Using getCompany

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 getCompany(args: GetCompanyArgs, opts?: InvokeOptions): Promise<GetCompanyResult>
function getCompanyOutput(args: GetCompanyOutputArgs, opts?: InvokeOptions): Output<GetCompanyResult>
def get_company(company_id: Optional[str] = None,
                project: Optional[str] = None,
                tenant_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetCompanyResult
def get_company_output(company_id: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                tenant_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetCompanyResult]
func LookupCompany(ctx *Context, args *LookupCompanyArgs, opts ...InvokeOption) (*LookupCompanyResult, error)
func LookupCompanyOutput(ctx *Context, args *LookupCompanyOutputArgs, opts ...InvokeOption) LookupCompanyResultOutput

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

public static class GetCompany 
{
    public static Task<GetCompanyResult> InvokeAsync(GetCompanyArgs args, InvokeOptions? opts = null)
    public static Output<GetCompanyResult> Invoke(GetCompanyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCompanyResult> getCompany(GetCompanyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:jobs/v4:getCompany
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompanyId string
TenantId string
Project string
CompanyId string
TenantId string
Project string
companyId String
tenantId String
project String
companyId string
tenantId string
project string
companyId String
tenantId String
project String

getCompany Result

The following output properties are available:

CareerSiteUri string

The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

DerivedInfo Pulumi.GoogleNative.Jobs.V4.Outputs.CompanyDerivedInfoResponse

Derived details about the company.

DisplayName string

The display name of the company, for example, "Google LLC".

EeoText string

Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

ExternalId string

Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

HeadquartersAddress string

The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

HiringAgency bool

Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.

ImageUri string

A URI that hosts the employer's company logo.

KeywordSearchableJobCustomAttributes List<string>

A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.

Name string

Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

Size string

The employer's company size.

Suspended bool

Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

WebsiteUri string

The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

CareerSiteUri string

The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

DerivedInfo CompanyDerivedInfoResponse

Derived details about the company.

DisplayName string

The display name of the company, for example, "Google LLC".

EeoText string

Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

ExternalId string

Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

HeadquartersAddress string

The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

HiringAgency bool

Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.

ImageUri string

A URI that hosts the employer's company logo.

KeywordSearchableJobCustomAttributes []string

A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.

Name string

Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

Size string

The employer's company size.

Suspended bool

Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

WebsiteUri string

The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

careerSiteUri String

The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

derivedInfo CompanyDerivedInfoResponse

Derived details about the company.

displayName String

The display name of the company, for example, "Google LLC".

eeoText String

Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

externalId String

Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

headquartersAddress String

The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

hiringAgency Boolean

Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.

imageUri String

A URI that hosts the employer's company logo.

keywordSearchableJobCustomAttributes List<String>

A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.

name String

Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

size String

The employer's company size.

suspended Boolean

Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

websiteUri String

The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

careerSiteUri string

The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

derivedInfo CompanyDerivedInfoResponse

Derived details about the company.

displayName string

The display name of the company, for example, "Google LLC".

eeoText string

Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

externalId string

Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

headquartersAddress string

The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

hiringAgency boolean

Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.

imageUri string

A URI that hosts the employer's company logo.

keywordSearchableJobCustomAttributes string[]

A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.

name string

Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

size string

The employer's company size.

suspended boolean

Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

websiteUri string

The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

career_site_uri str

The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

derived_info CompanyDerivedInfoResponse

Derived details about the company.

display_name str

The display name of the company, for example, "Google LLC".

eeo_text str

Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

external_id str

Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

headquarters_address str

The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

hiring_agency bool

Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.

image_uri str

A URI that hosts the employer's company logo.

keyword_searchable_job_custom_attributes Sequence[str]

A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.

name str

Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

size str

The employer's company size.

suspended bool

Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

website_uri str

The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

careerSiteUri String

The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

derivedInfo Property Map

Derived details about the company.

displayName String

The display name of the company, for example, "Google LLC".

eeoText String

Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.

externalId String

Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

headquartersAddress String

The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

hiringAgency Boolean

Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.

imageUri String

A URI that hosts the employer's company logo.

keywordSearchableJobCustomAttributes List<String>

A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.

name String

Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

size String

The employer's company size.

suspended Boolean

Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

websiteUri String

The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.

Supporting Types

CompanyDerivedInfoResponse

HeadquartersLocation Pulumi.GoogleNative.Jobs.V4.Inputs.LocationResponse

A structured headquarters location of the company, resolved from Company.headquarters_address if provided.

HeadquartersLocation LocationResponse

A structured headquarters location of the company, resolved from Company.headquarters_address if provided.

headquartersLocation LocationResponse

A structured headquarters location of the company, resolved from Company.headquarters_address if provided.

headquartersLocation LocationResponse

A structured headquarters location of the company, resolved from Company.headquarters_address if provided.

headquarters_location LocationResponse

A structured headquarters location of the company, resolved from Company.headquarters_address if provided.

headquartersLocation Property Map

A structured headquarters location of the company, resolved from Company.headquarters_address if provided.

LatLngResponse

Latitude double

The latitude in degrees. It must be in the range [-90.0, +90.0].

Longitude double

The longitude in degrees. It must be in the range [-180.0, +180.0].

Latitude float64

The latitude in degrees. It must be in the range [-90.0, +90.0].

Longitude float64

The longitude in degrees. It must be in the range [-180.0, +180.0].

latitude Double

The latitude in degrees. It must be in the range [-90.0, +90.0].

longitude Double

The longitude in degrees. It must be in the range [-180.0, +180.0].

latitude number

The latitude in degrees. It must be in the range [-90.0, +90.0].

longitude number

The longitude in degrees. It must be in the range [-180.0, +180.0].

latitude float

The latitude in degrees. It must be in the range [-90.0, +90.0].

longitude float

The longitude in degrees. It must be in the range [-180.0, +180.0].

latitude Number

The latitude in degrees. It must be in the range [-90.0, +90.0].

longitude Number

The longitude in degrees. It must be in the range [-180.0, +180.0].

LocationResponse

LatLng Pulumi.GoogleNative.Jobs.V4.Inputs.LatLngResponse

An object representing a latitude/longitude pair.

LocationType string

The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY.

PostalAddress Pulumi.GoogleNative.Jobs.V4.Inputs.PostalAddressResponse

Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

RadiusMiles double

Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from google.type.LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

LatLng LatLngResponse

An object representing a latitude/longitude pair.

LocationType string

The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY.

PostalAddress PostalAddressResponse

Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

RadiusMiles float64

Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from google.type.LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

latLng LatLngResponse

An object representing a latitude/longitude pair.

locationType String

The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY.

postalAddress PostalAddressResponse

Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

radiusMiles Double

Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from google.type.LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

latLng LatLngResponse

An object representing a latitude/longitude pair.

locationType string

The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY.

postalAddress PostalAddressResponse

Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

radiusMiles number

Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from google.type.LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

lat_lng LatLngResponse

An object representing a latitude/longitude pair.

location_type str

The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY.

postal_address PostalAddressResponse

Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

radius_miles float

Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from google.type.LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

latLng Property Map

An object representing a latitude/longitude pair.

locationType String

The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY.

postalAddress Property Map

Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.

radiusMiles Number

Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from google.type.LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.

PostalAddressResponse

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