Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.jobs/v3.Company
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a new company entity.
Create Company Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Company(name: string, args: CompanyArgs, opts?: CustomResourceOptions);@overload
def Company(resource_name: str,
            args: CompanyArgs,
            opts: Optional[ResourceOptions] = None)
@overload
def Company(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            display_name: Optional[str] = None,
            external_id: Optional[str] = None,
            career_site_uri: Optional[str] = None,
            eeo_text: Optional[str] = None,
            headquarters_address: Optional[str] = None,
            hiring_agency: Optional[bool] = None,
            image_uri: Optional[str] = None,
            keyword_searchable_job_custom_attributes: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            size: Optional[CompanySize] = None,
            website_uri: Optional[str] = None)func NewCompany(ctx *Context, name string, args CompanyArgs, opts ...ResourceOption) (*Company, error)public Company(string name, CompanyArgs args, CustomResourceOptions? opts = null)
public Company(String name, CompanyArgs args)
public Company(String name, CompanyArgs args, CustomResourceOptions options)
type: google-native:jobs/v3:Company
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CompanyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CompanyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CompanyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CompanyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CompanyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var companyResource = new GoogleNative.Jobs.V3.Company("companyResource", new()
{
    DisplayName = "string",
    ExternalId = "string",
    CareerSiteUri = "string",
    EeoText = "string",
    HeadquartersAddress = "string",
    HiringAgency = false,
    ImageUri = "string",
    Name = "string",
    Project = "string",
    Size = GoogleNative.Jobs.V3.CompanySize.CompanySizeUnspecified,
    WebsiteUri = "string",
});
example, err := jobs.NewCompany(ctx, "companyResource", &jobs.CompanyArgs{
	DisplayName:         pulumi.String("string"),
	ExternalId:          pulumi.String("string"),
	CareerSiteUri:       pulumi.String("string"),
	EeoText:             pulumi.String("string"),
	HeadquartersAddress: pulumi.String("string"),
	HiringAgency:        pulumi.Bool(false),
	ImageUri:            pulumi.String("string"),
	Name:                pulumi.String("string"),
	Project:             pulumi.String("string"),
	Size:                jobs.CompanySizeCompanySizeUnspecified,
	WebsiteUri:          pulumi.String("string"),
})
var companyResource = new Company("companyResource", CompanyArgs.builder()
    .displayName("string")
    .externalId("string")
    .careerSiteUri("string")
    .eeoText("string")
    .headquartersAddress("string")
    .hiringAgency(false)
    .imageUri("string")
    .name("string")
    .project("string")
    .size("COMPANY_SIZE_UNSPECIFIED")
    .websiteUri("string")
    .build());
company_resource = google_native.jobs.v3.Company("companyResource",
    display_name="string",
    external_id="string",
    career_site_uri="string",
    eeo_text="string",
    headquarters_address="string",
    hiring_agency=False,
    image_uri="string",
    name="string",
    project="string",
    size=google_native.jobs.v3.CompanySize.COMPANY_SIZE_UNSPECIFIED,
    website_uri="string")
const companyResource = new google_native.jobs.v3.Company("companyResource", {
    displayName: "string",
    externalId: "string",
    careerSiteUri: "string",
    eeoText: "string",
    headquartersAddress: "string",
    hiringAgency: false,
    imageUri: "string",
    name: "string",
    project: "string",
    size: google_native.jobs.v3.CompanySize.CompanySizeUnspecified,
    websiteUri: "string",
});
type: google-native:jobs/v3:Company
properties:
    careerSiteUri: string
    displayName: string
    eeoText: string
    externalId: string
    headquartersAddress: string
    hiringAgency: false
    imageUri: string
    name: string
    project: string
    size: COMPANY_SIZE_UNSPECIFIED
    websiteUri: string
Company Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Company resource accepts the following input properties:
- DisplayName string
- The display name of the company, for example, "Google LLC".
- ExternalId string
- Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
- CareerSite stringUri 
- Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
- EeoText string
- Optional. 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.
- HeadquartersAddress string
- Optional. 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
- Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
- ImageUri string
- Optional. A URI that hosts the employer's company logo.
- KeywordSearchable List<string>Job Custom Attributes 
- Optional. This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding string_valuesare used in keyword search. Jobs withstring_valuesunder these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
- Project string
- Size
Pulumi.Google Native. Jobs. V3. Company Size 
- Optional. The employer's company size.
- WebsiteUri string
- Optional. 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.
- DisplayName string
- The display name of the company, for example, "Google LLC".
- ExternalId string
- Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
- CareerSite stringUri 
- Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
- EeoText string
- Optional. 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.
- HeadquartersAddress string
- Optional. 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
- Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
- ImageUri string
- Optional. A URI that hosts the employer's company logo.
- KeywordSearchable []stringJob Custom Attributes 
- Optional. This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding string_valuesare used in keyword search. Jobs withstring_valuesunder these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
- Project string
- Size
CompanySize 
- Optional. The employer's company size.
- WebsiteUri string
- Optional. 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.
- displayName String
- The display name of the company, for example, "Google LLC".
- externalId String
- Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
- careerSite StringUri 
- Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
- eeoText String
- Optional. 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.
- headquartersAddress String
- Optional. 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
- Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
- imageUri String
- Optional. A URI that hosts the employer's company logo.
- keywordSearchable List<String>Job Custom Attributes 
- Optional. This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding string_valuesare used in keyword search. Jobs withstring_valuesunder these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
- project String
- size
CompanySize 
- Optional. The employer's company size.
- websiteUri String
- Optional. 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.
- displayName string
- The display name of the company, for example, "Google LLC".
- externalId string
- Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
- careerSite stringUri 
- Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
- eeoText string
- Optional. 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.
- headquartersAddress string
- Optional. 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
- Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
- imageUri string
- Optional. A URI that hosts the employer's company logo.
- keywordSearchable string[]Job Custom Attributes 
- Optional. This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding string_valuesare used in keyword search. Jobs withstring_valuesunder these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
- project string
- size
CompanySize 
- Optional. The employer's company size.
- websiteUri string
- Optional. 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.
- display_name str
- The display name of the company, for example, "Google LLC".
- external_id str
- Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
- career_site_ struri 
- Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
- eeo_text str
- Optional. 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.
- headquarters_address str
- Optional. 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
- Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
- image_uri str
- Optional. A URI that hosts the employer's company logo.
- keyword_searchable_ Sequence[str]job_ custom_ attributes 
- Optional. This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding string_valuesare used in keyword search. Jobs withstring_valuesunder these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
- project str
- size
CompanySize 
- Optional. The employer's company size.
- website_uri str
- Optional. 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.
- displayName String
- The display name of the company, for example, "Google LLC".
- externalId String
- Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
- careerSite StringUri 
- Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
- eeoText String
- Optional. 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.
- headquartersAddress String
- Optional. 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
- Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
- imageUri String
- Optional. A URI that hosts the employer's company logo.
- keywordSearchable List<String>Job Custom Attributes 
- Optional. This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding string_valuesare used in keyword search. Jobs withstring_valuesunder these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".
- project String
- size "COMPANY_SIZE_UNSPECIFIED" | "MINI" | "SMALL" | "SMEDIUM" | "MEDIUM" | "BIG" | "BIGGER" | "GIANT"
- Optional. The employer's company size.
- websiteUri String
- Optional. 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Company resource produces the following output properties:
- DerivedInfo Pulumi.Google Native. Jobs. V3. Outputs. Company Derived Info Response 
- Derived details about the company.
- Id string
- The provider-assigned unique ID for this managed resource.
- 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.
- DerivedInfo CompanyDerived Info Response 
- Derived details about the company.
- Id string
- The provider-assigned unique ID for this managed resource.
- 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.
- derivedInfo CompanyDerived Info Response 
- Derived details about the company.
- id String
- The provider-assigned unique ID for this managed resource.
- 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.
- derivedInfo CompanyDerived Info Response 
- Derived details about the company.
- id string
- The provider-assigned unique ID for this managed resource.
- 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.
- derived_info CompanyDerived Info Response 
- Derived details about the company.
- id str
- The provider-assigned unique ID for this managed resource.
- 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.
- derivedInfo Property Map
- Derived details about the company.
- id String
- The provider-assigned unique ID for this managed resource.
- 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.
Supporting Types
CompanyDerivedInfoResponse, CompanyDerivedInfoResponseArgs        
- HeadquartersLocation Pulumi.Google Native. Jobs. V3. Inputs. Location Response 
- A structured headquarters location of the company, resolved from Company.hq_location if provided.
- HeadquartersLocation LocationResponse 
- A structured headquarters location of the company, resolved from Company.hq_location if provided.
- headquartersLocation LocationResponse 
- A structured headquarters location of the company, resolved from Company.hq_location if provided.
- headquartersLocation LocationResponse 
- A structured headquarters location of the company, resolved from Company.hq_location if provided.
- headquarters_location LocationResponse 
- A structured headquarters location of the company, resolved from Company.hq_location if provided.
- headquartersLocation Property Map
- A structured headquarters location of the company, resolved from Company.hq_location if provided.
CompanySize, CompanySizeArgs    
- CompanySize Unspecified 
- COMPANY_SIZE_UNSPECIFIEDDefault value if the size is not specified.
- Mini
- MINIThe company has less than 50 employees.
- Small
- SMALLThe company has between 50 and 99 employees.
- Smedium
- SMEDIUMThe company has between 100 and 499 employees.
- Medium
- MEDIUMThe company has between 500 and 999 employees.
- Big
- BIGThe company has between 1,000 and 4,999 employees.
- Bigger
- BIGGERThe company has between 5,000 and 9,999 employees.
- Giant
- GIANTThe company has 10,000 or more employees.
- CompanySize Company Size Unspecified 
- COMPANY_SIZE_UNSPECIFIEDDefault value if the size is not specified.
- CompanySize Mini 
- MINIThe company has less than 50 employees.
- CompanySize Small 
- SMALLThe company has between 50 and 99 employees.
- CompanySize Smedium 
- SMEDIUMThe company has between 100 and 499 employees.
- CompanySize Medium 
- MEDIUMThe company has between 500 and 999 employees.
- CompanySize Big 
- BIGThe company has between 1,000 and 4,999 employees.
- CompanySize Bigger 
- BIGGERThe company has between 5,000 and 9,999 employees.
- CompanySize Giant 
- GIANTThe company has 10,000 or more employees.
- CompanySize Unspecified 
- COMPANY_SIZE_UNSPECIFIEDDefault value if the size is not specified.
- Mini
- MINIThe company has less than 50 employees.
- Small
- SMALLThe company has between 50 and 99 employees.
- Smedium
- SMEDIUMThe company has between 100 and 499 employees.
- Medium
- MEDIUMThe company has between 500 and 999 employees.
- Big
- BIGThe company has between 1,000 and 4,999 employees.
- Bigger
- BIGGERThe company has between 5,000 and 9,999 employees.
- Giant
- GIANTThe company has 10,000 or more employees.
- CompanySize Unspecified 
- COMPANY_SIZE_UNSPECIFIEDDefault value if the size is not specified.
- Mini
- MINIThe company has less than 50 employees.
- Small
- SMALLThe company has between 50 and 99 employees.
- Smedium
- SMEDIUMThe company has between 100 and 499 employees.
- Medium
- MEDIUMThe company has between 500 and 999 employees.
- Big
- BIGThe company has between 1,000 and 4,999 employees.
- Bigger
- BIGGERThe company has between 5,000 and 9,999 employees.
- Giant
- GIANTThe company has 10,000 or more employees.
- COMPANY_SIZE_UNSPECIFIED
- COMPANY_SIZE_UNSPECIFIEDDefault value if the size is not specified.
- MINI
- MINIThe company has less than 50 employees.
- SMALL
- SMALLThe company has between 50 and 99 employees.
- SMEDIUM
- SMEDIUMThe company has between 100 and 499 employees.
- MEDIUM
- MEDIUMThe company has between 500 and 999 employees.
- BIG
- BIGThe company has between 1,000 and 4,999 employees.
- BIGGER
- BIGGERThe company has between 5,000 and 9,999 employees.
- GIANT
- GIANTThe company has 10,000 or more employees.
- "COMPANY_SIZE_UNSPECIFIED"
- COMPANY_SIZE_UNSPECIFIEDDefault value if the size is not specified.
- "MINI"
- MINIThe company has less than 50 employees.
- "SMALL"
- SMALLThe company has between 50 and 99 employees.
- "SMEDIUM"
- SMEDIUMThe company has between 100 and 499 employees.
- "MEDIUM"
- MEDIUMThe company has between 500 and 999 employees.
- "BIG"
- BIGThe company has between 1,000 and 4,999 employees.
- "BIGGER"
- BIGGERThe company has between 5,000 and 9,999 employees.
- "GIANT"
- GIANTThe company has 10,000 or more employees.
LatLngResponse, LatLngResponseArgs      
LocationResponse, LocationResponseArgs    
- LatLng Pulumi.Google Native. Jobs. V3. Inputs. Lat Lng Response 
- An object representing a latitude/longitude pair.
- LocationType string
- The type of a location, which corresponds to the address lines field of 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.Google Native. Jobs. V3. Inputs. Postal Address Response 
- 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.
- RadiusIn doubleMiles 
- 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 LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.
- LatLng LatLng Response 
- An object representing a latitude/longitude pair.
- LocationType string
- The type of a location, which corresponds to the address lines field of 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 PostalAddress Response 
- 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.
- RadiusIn float64Miles 
- 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 LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.
- latLng LatLng Response 
- An object representing a latitude/longitude pair.
- locationType String
- The type of a location, which corresponds to the address lines field of 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 PostalAddress Response 
- 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.
- radiusIn DoubleMiles 
- 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 LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.
- latLng LatLng Response 
- An object representing a latitude/longitude pair.
- locationType string
- The type of a location, which corresponds to the address lines field of 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 PostalAddress Response 
- 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.
- radiusIn numberMiles 
- 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 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 LatLng Response 
- An object representing a latitude/longitude pair.
- location_type str
- The type of a location, which corresponds to the address lines field of 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 PostalAddress Response 
- 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_in_ floatmiles 
- 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 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 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.
- radiusIn NumberMiles 
- 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 LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles.
PostalAddressResponse, PostalAddressResponseArgs      
- 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
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.