Class: Google::Cloud::Talent::V4::CommuteFilter

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/talent/v4/filters.rb

Overview

Parameters needed for commute search.

Defined Under Namespace

Modules: RoadTraffic

Instance Attribute Summary collapse

Instance Attribute Details

#allow_imprecise_addresses ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 373

class CommuteFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The traffic density to use when calculating commute time.
  module RoadTraffic
    # Road traffic situation isn't specified.
    ROAD_TRAFFIC_UNSPECIFIED = 0

    # Optimal commute time without considering any traffic impact.
    TRAFFIC_FREE = 1

    # Commute time calculation takes in account the peak traffic impact.
    BUSY_HOUR = 2
  end
end

#commute_method ⇒ ::Google::Cloud::Talent::V4::CommuteMethod

Returns Required. The method of transportation to calculate the commute time for.

Returns:



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 373

class CommuteFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The traffic density to use when calculating commute time.
  module RoadTraffic
    # Road traffic situation isn't specified.
    ROAD_TRAFFIC_UNSPECIFIED = 0

    # Optimal commute time without considering any traffic impact.
    TRAFFIC_FREE = 1

    # Commute time calculation takes in account the peak traffic impact.
    BUSY_HOUR = 2
  end
end

#departure_time ⇒ ::Google::Type::TimeOfDay

Returns The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone.

Currently traffic model is restricted to hour level resolution.

Note: The following fields are mutually exclusive: departure_time, road_traffic. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Type::TimeOfDay) —

    The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone.

    Currently traffic model is restricted to hour level resolution.

    Note: The following fields are mutually exclusive: departure_time, road_traffic. If a field in that set is populated, all other fields in the set will automatically be cleared.



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 373

class CommuteFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The traffic density to use when calculating commute time.
  module RoadTraffic
    # Road traffic situation isn't specified.
    ROAD_TRAFFIC_UNSPECIFIED = 0

    # Optimal commute time without considering any traffic impact.
    TRAFFIC_FREE = 1

    # Commute time calculation takes in account the peak traffic impact.
    BUSY_HOUR = 2
  end
end

#road_traffic ⇒ ::Google::Cloud::Talent::V4::CommuteFilter::RoadTraffic

Returns Specifies the traffic density to use when calculating commute time.

Note: The following fields are mutually exclusive: road_traffic, departure_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Talent::V4::CommuteFilter::RoadTraffic) —

    Specifies the traffic density to use when calculating commute time.

    Note: The following fields are mutually exclusive: road_traffic, departure_time. If a field in that set is populated, all other fields in the set will automatically be cleared.



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 373

class CommuteFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The traffic density to use when calculating commute time.
  module RoadTraffic
    # Road traffic situation isn't specified.
    ROAD_TRAFFIC_UNSPECIFIED = 0

    # Optimal commute time without considering any traffic impact.
    TRAFFIC_FREE = 1

    # Commute time calculation takes in account the peak traffic impact.
    BUSY_HOUR = 2
  end
end

#start_coordinates ⇒ ::Google::Type::LatLng

Returns Required. The latitude and longitude of the location to calculate the commute time from.

Returns:

  • (::Google::Type::LatLng) —

    Required. The latitude and longitude of the location to calculate the commute time from.



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 373

class CommuteFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The traffic density to use when calculating commute time.
  module RoadTraffic
    # Road traffic situation isn't specified.
    ROAD_TRAFFIC_UNSPECIFIED = 0

    # Optimal commute time without considering any traffic impact.
    TRAFFIC_FREE = 1

    # Commute time calculation takes in account the peak traffic impact.
    BUSY_HOUR = 2
  end
end

#travel_duration ⇒ ::Google::Protobuf::Duration

Returns Required. The maximum travel time in seconds. The maximum allowed value is 3600s (one hour). Format is 123s.

Returns:

  • (::Google::Protobuf::Duration) —

    Required. The maximum travel time in seconds. The maximum allowed value is 3600s (one hour). Format is 123s.



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 373

class CommuteFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The traffic density to use when calculating commute time.
  module RoadTraffic
    # Road traffic situation isn't specified.
    ROAD_TRAFFIC_UNSPECIFIED = 0

    # Optimal commute time without considering any traffic impact.
    TRAFFIC_FREE = 1

    # Commute time calculation takes in account the peak traffic impact.
    BUSY_HOUR = 2
  end
end