View Source GoogleApi.ContentWarehouse.V1.Model.GeostoreExistenceProto (google_api_content_warehouse v0.3.0)

Attributes

  • closeReason (type: String.t, default: nil) - Structured reason for the permanent closure (if any).
  • closed (type: boolean(), default: nil) - Indicates whether the place is closed (permanently or temporarily), i.e., not operational in the present, but was at in the past and/or will be in the future. WARNING: New code should use Geo Schema's libraries instead, specifically the OpeningStatus APIs, available in: C++ (cs/f:google3/geostore/base/public/feature.h%20function:ExistenceState) Java (cs/f:google3/java/com/google/geostore/base/Existence.java%20function:OpeningStatus) * Python (cs/f:google3/geostore/base/public/python/feature.clif%20existence_state)
  • endAsOfDate (type: GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProto.t, default: nil) - The earliest known date of this feature's "end" (e.g. an establishment's permanent closure), if the actual date is unknown; i.e. the best known upper bound of the day end_date would represent. end_as_of_date must be in local (civil) time and of PRECISION_DAY. For example, given an establishment: Without any end_as_of_date, the permanent closure definitely isn't now and isn't known to start at any point in the future. With an end_as_of_date of 2023-04-05 but without any end_date, the permanent closure definitely starts at latest 2023-04-05 but may start before 2023-04-05. * With an end_as_of_date of 2023-04-05 and an end_date of 2023 (at just PRECISION_YEAR), the permanent closure definitely starts at earliest 2023-01-01 (i.e. the first day of 2023) and at latest 2023-04-05, but may start at any day between 2023-01-01 and 2023-04-05. IMPORTANT: Generally for Geo Schema-internal use only. If you believe you need to use this field directly, please go/contact-geo-schema.
  • endDate (type: GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProto.t, default: nil) -
  • featureBirthTimestampSeconds (type: String.t, default: nil) - DEPRECATED This field is now deprecated (see b/22878252). Please use the Geo Schema GetFeatureBirthTimestamp() API to extract the birth timestamp of a feature. The timestamp in seconds since the UNIX epoch (January 1, 1970) when this feature becomes live in the Geo repository. Different from start_date in that this is the birth date of Google's representation of the place whereas start_date is the birth date of the place in the physical world.
  • removed (type: boolean(), default: nil) - Indicates whether the feature is marked as removed in the Geo repository. Removed features are still present in the Geo repository but are considered to be in an inactive state (not valid for lint purposes, not retrievable except explicitly by feature ID, etc.). NOTE: If you have access to a complete FeatureProto, do NOT read this bit directly to find out whether a feature is removed. Instead, rely on the IsFeatureRemoved() API, available in C++ (geostore/base/public/feature.h) and Java (geostore/base/Feature.java).
  • removedReason (type: String.t, default: nil) - Structured reason why the feature is marked as removed. Relevant only when removed == true.
  • startDate (type: GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProto.t, default: nil) - (Initial) opening and (permanent) closing dates of the establishment, such that start_date is the first day open and end_date is the first day closed. The only allowed precisions are PRECISION_DAY, PRECISION_MONTH, PRECISION_YEAR. DateTimeProto.seconds should have the lowest legal value for the desired date/time and precision. E.g. for PRECISION_MONTH, 2019-02-15 21:10:30 is not valid, it should be 2019-02-01 00:00:00 instead. NOTE: The start_date and end_date are stored in UTC but should be interpreted as being in the local timezone. So clients should convert the DateTimeProto to local (civil) time using UTC+0, and then treat the result as local to the feature.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.GeostoreExistenceProto{
  closeReason: String.t() | nil,
  closed: boolean() | nil,
  endAsOfDate:
    GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProto.t() | nil,
  endDate: GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProto.t() | nil,
  featureBirthTimestampSeconds: String.t() | nil,
  removed: boolean() | nil,
  removedReason: String.t() | nil,
  startDate: GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProto.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.