Class: Google::Apis::JobsV4::CommuteFilter

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

Overview

Parameters needed for commute search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CommuteFilter

Returns a new instance of CommuteFilter.



358
359
360
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 358

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

Instance Attribute Details

#allow_imprecise_addresses ⇒ Boolean Also known as: allow_imprecise_addresses?

If true, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to false or isn't specified, only jobs that include street level addresses will be returned by commute search. Corresponds to the JSON property allowImpreciseAddresses

Returns:

  • (Boolean) 


324
325
326
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 324

def allow_imprecise_addresses
  @allow_imprecise_addresses
end

#commute_method ⇒ String

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

Returns:

  • (String) 


330
331
332
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 330

def commute_method
  @commute_method
end

#departure_time ⇒ Google::Apis::JobsV4::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:



337
338
339
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 337

def departure_time
  @departure_time
end

#road_traffic ⇒ String

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

Returns:

  • (String) 


342
343
344
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 342

def road_traffic
  @road_traffic
end

#start_coordinates ⇒ Google::Apis::JobsV4::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:



350
351
352
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 350

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) 


356
357
358
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 356

def travel_duration
  @travel_duration
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



363
364
365
366
367
368
369
370
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 363

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