Class: Google::Apis::CivicinfoV2::GeocodingSummary

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

Overview

Detailed summary of the result from geocoding an address

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GeocodingSummary

Returns a new instance of GeocodingSummary.



771
772
773
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 771

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

Instance Attribute Details

#address_understood ⇒ Boolean Also known as: address_understood?

Represents the best estimate of whether or not the input address was fully understood and the address is correctly componentized. Mirrors the same-name field in geostore.staging.AddressLinkupScoringProto. Corresponds to the JSON property addressUnderstood

Returns:

  • (Boolean) 


732
733
734
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 732

def address_understood
  @address_understood
end

#feature_id ⇒ Google::Apis::CivicinfoV2::FeatureIdProto

A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit "cell id" that ** sometimes** corresponds to the approximate centroid of the feature, plus a 64- bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don't need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos. Corresponds to the JSON property featureId

Returns:



754
755
756
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 754

def feature_id
  @feature_id
end

#feature_type ⇒ String

The feature type for the FeatureProto returned by the geocoder Corresponds to the JSON property featureType

Returns:

  • (String) 


759
760
761
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 759

def feature_type
  @feature_type
end

#position_precision_meters ⇒ Float

Precision of the center point (lat/long) of the geocoded FeatureProto Corresponds to the JSON property positionPrecisionMeters

Returns:

  • (Float) 


764
765
766
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 764

def position_precision_meters
  @position_precision_meters
end

#query_string ⇒ String

The query sent to the geocoder Corresponds to the JSON property queryString

Returns:

  • (String) 


769
770
771
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 769

def query_string
  @query_string
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



776
777
778
779
780
781
782
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 776

def update!(**args)
  @address_understood = args[:address_understood] if args.key?(:address_understood)
  @feature_id = args[:feature_id] if args.key?(:feature_id)
  @feature_type = args[:feature_type] if args.key?(:feature_type)
  @position_precision_meters = args[:position_precision_meters] if args.key?(:position_precision_meters)
  @query_string = args[:query_string] if args.key?(:query_string)
end