Class: Google::Apis::JobsV3::CommuteFilter

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/jobs_v3/classes.rb,
lib/google/apis/jobs_v3/representations.rb,
lib/google/apis/jobs_v3/representations.rb

Overview

Input only. Parameters needed for commute search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CommuteFilter

Returns a new instance of CommuteFilter.



249
250
251
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 249

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

Instance Attribute Details

#allow_imprecise_addresses ⇒ Boolean Also known as: allow_imprecise_addresses?

Optional. If true, jobs without “precise” addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If ` allow_imprecise_addresses is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a travel_duration time of 0 regardless of distance from the job seeker. Corresponds to the JSON property allowImpreciseAddresses`

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 215

def allow_imprecise_addresses
  @allow_imprecise_addresses
end

#commute_method ⇒ String

Required. The method of transportation for which to calculate the commute time. Corresponds to the JSON property commuteMethod

Returns:

  • (String) 


221
222
223
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 221

def commute_method
  @commute_method
end

#departure_time ⇒ Google::Apis::JobsV3::TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp. Corresponds to the JSON property departureTime

Returns:



228
229
230
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 228

def departure_time
  @departure_time
end

#road_traffic ⇒ String

Optional. Specifies the traffic density to use when calculating commute time. Corresponds to the JSON property roadTraffic

Returns:

  • (String) 


233
234
235
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 233

def road_traffic
  @road_traffic
end

#start_coordinates ⇒ Google::Apis::JobsV3::LatLng

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

Returns:



241
242
243
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 241

def start_coordinates
  @start_coordinates
end

#travel_duration ⇒ String

Required. The maximum travel time in seconds. The maximum allowed value is ` 3600s (one hour). Format is 123s. Corresponds to the JSON property travelDuration`

Returns:

  • (String) 


247
248
249
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 247

def travel_duration
  @travel_duration
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



254
255
256
257
258
259
260
261
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 254

def update!(**args)
  @allow_imprecise_addresses = args[:allow_imprecise_addresses] if args.key?(:allow_imprecise_addresses)
  @commute_method = args[:commute_method] if args.key?(:commute_method)
  @departure_time = args[:departure_time] if args.key?(:departure_time)
  @road_traffic = args[:road_traffic] if args.key?(:road_traffic)
  @start_coordinates = args[:start_coordinates] if args.key?(:start_coordinates)
  @travel_duration = args[:travel_duration] if args.key?(:travel_duration)
end