Class: Google::Apis::JobsV3p1beta1::CommuteFilter

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

Overview

Input only. Parameters needed for commute search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CommuteFilter

Returns a new instance of CommuteFilter.



272
273
274
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 272

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) 


236
237
238
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 236

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) 


242
243
244
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 242

def commute_method
  @commute_method
end

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



249
250
251
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 249

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) 


254
255
256
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 254

def road_traffic
  @road_traffic
end

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

Returns:



263
264
265
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 263

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) 


270
271
272
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 270

def travel_duration
  @travel_duration
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



277
278
279
280
281
282
283
284
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 277

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