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

Inherits:
Object
  • Object
show all
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

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



201
202
203
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 201

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

Instance Attribute Details

#allow_imprecise_addresses ⇒ Boolean Also known as: allow_imprecise_addresses?

Optional. 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 is not specified, only jobs that include street level addresses will be returned by commute search. Corresponds to the JSON property allowImpreciseAddresses

Returns:

  • (Boolean) 


163
164
165
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 163

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) 


170
171
172
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 170

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:



177
178
179
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 177

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) 


183
184
185
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 183

def road_traffic
  @road_traffic
end

#start_coordinates ⇒ 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 startCoordinates

Returns:



192
193
194
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 192

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) 


199
200
201
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 199

def travel_duration
  @travel_duration
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



206
207
208
209
210
211
212
213
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 206

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