Class: Google::Apis::JobsV3::Location

Inherits:

Object

• Object
• Google::Apis::JobsV3::Location

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/jobs_v3/classes.rb,
generated/google/apis/jobs_v3/representations.rb,
generated/google/apis/jobs_v3/representations.rb

Overview

Output only. A resource that represents a location with full geographic information.

Instance Attribute Summary

• #lat_lng ⇒ Google::Apis::JobsV3::LatLng

  An object representing a latitude/longitude pair.

• #location_type ⇒ String

  The type of a location, which corresponds to the address lines field of PostalAddress.

• #postal_address ⇒ Google::Apis::JobsV3::PostalAddress

  Represents a postal address, e.g.

• #radius_in_miles ⇒ Float

  Radius in miles of the job location.

Instance Method Summary

• #initialize(**args) ⇒ Location constructor

  A new instance of Location.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Location

Returns a new instance of Location.

# File 'generated/google/apis/jobs_v3/classes.rb', line 1755

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#lat_lng ⇒ Google::Apis::JobsV3::LatLng

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Corresponds to the JSON property latLng

Returns:

• (Google::Apis::JobsV3::LatLng)

# File 'generated/google/apis/jobs_v3/classes.rb', line 1718

def lat_lng
  @lat_lng
end

#location_type ⇒ 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. Corresponds to the JSON property locationType

Returns:

• (String)

# File 'generated/google/apis/jobs_v3/classes.rb', line 1726

def location_type
  @location_type
end

#postal_address ⇒ Google::Apis::JobsV3::PostalAddress

Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing:

• Use an i18n-ready address widget such as https://github.com/google/libaddressinput)
• Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 Corresponds to the JSON property postalAddress

Returns:

• (Google::Apis::JobsV3::PostalAddress)

# File 'generated/google/apis/jobs_v3/classes.rb', line 1744

def postal_address
  @postal_address
end

#radius_in_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 LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles. Corresponds to the JSON property radiusInMiles

Returns:

• (Float)

# File 'generated/google/apis/jobs_v3/classes.rb', line 1753

def radius_in_miles
  @radius_in_miles
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/jobs_v3/classes.rb', line 1760

def update!(**args)
  @lat_lng = args[:lat_lng] if args.key?(:lat_lng)
  @location_type = args[:location_type] if args.key?(:location_type)
  @postal_address = args[:postal_address] if args.key?(:postal_address)
  @radius_in_miles = args[:radius_in_miles] if args.key?(:radius_in_miles)
end