Package com.buildless.telemetry

Interface EventLocationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EventLocation, EventLocation.Builder
public interface EventLocationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCountry()
    The only required value for an event locality payload.
    com.google.protobuf.ByteString
    getCountryBytes()
    The only required value for an event locality payload.
    String
    getEdge()
    Detected edge region (state or province) for this event.
    com.google.protobuf.ByteString
    getEdgeBytes()
    Detected edge region (state or province) for this event.
    String
    getLocality()
    Detected locality (city name) for this event.
    com.google.protobuf.ByteString
    getLocalityBytes()
    Detected locality (city name) for this event.
    String
    getNielsen()
    Detected Nielsen metro (DMA) code for the provided location information on this event.
    com.google.protobuf.ByteString
    getNielsenBytes()
    Detected Nielsen metro (DMA) code for the provided location information on this event.
    GeoPoint
    getPoint()
    Specifies an explicit geo-point where this event originates from, or, the telemetry system's best-effort guess as to the originating location for this event.
    GeoPointOrBuilder
    getPointOrBuilder()
    Specifies an explicit geo-point where this event originates from, or, the telemetry system's best-effort guess as to the originating location for this event.
    String
    getRegion()
    Detected region (state or province) for this event.
    com.google.protobuf.ByteString
    getRegionBytes()
    Detected region (state or province) for this event.
    com.google.protobuf.ByteString
    getSourceIp()
    Specifies the salted and hashed bytes of the IP address which delivered this event.
    String
    getTag()
    Specifies the geo-hash tag value associated with this event location.
    com.google.protobuf.ByteString
    getTagBytes()
    Specifies the geo-hash tag value associated with this event location.
    String
    getTimezone()
    Specifies the timezone code for the originating location of this event.
    com.google.protobuf.ByteString
    getTimezoneBytes()
    Specifies the timezone code for the originating location of this event.
    boolean
    hasPoint()
    Specifies an explicit geo-point where this event originates from, or, the telemetry system's best-effort guess as to the originating location for this event.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getSourceIp

      com.google.protobuf.ByteString getSourceIp()
       Specifies the salted and hashed bytes of the IP address which delivered this event. This value is guaranteed to be
 stable for a given input IP address within the scope of a Buildless tenant or user account.
      bytes source_ip = 1 [json_name = "sourceIp", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The sourceIp.

    • getTimezone

      String getTimezone()
       Specifies the timezone code for the originating location of this event. This value is calculated by the telemetry
 system on a best-effort basis, or it can be declared and sent by the client.
      string timezone = 2 [json_name = "timezone", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The timezone.

    • getTimezoneBytes

      com.google.protobuf.ByteString getTimezoneBytes()
       Specifies the timezone code for the originating location of this event. This value is calculated by the telemetry
 system on a best-effort basis, or it can be declared and sent by the client.
      string timezone = 2 [json_name = "timezone", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for timezone.

    • hasPoint

      boolean hasPoint()
       Specifies an explicit geo-point where this event originates from, or, the telemetry system's best-effort guess as
 to the originating location for this event. This value is optional, and can be provided by the client.
      .buildless.telemetry.GeoPoint point = 3 [json_name = "point", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the point field is set.

    • getPoint

      GeoPoint getPoint()
       Specifies an explicit geo-point where this event originates from, or, the telemetry system's best-effort guess as
 to the originating location for this event. This value is optional, and can be provided by the client.
      .buildless.telemetry.GeoPoint point = 3 [json_name = "point", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The point.

    • getPointOrBuilder

      GeoPointOrBuilder getPointOrBuilder()
       Specifies an explicit geo-point where this event originates from, or, the telemetry system's best-effort guess as
 to the originating location for this event. This value is optional, and can be provided by the client.
      .buildless.telemetry.GeoPoint point = 3 [json_name = "point", (.google.api.field_behavior) = OPTIONAL];

    • getNielsen

      String getNielsen()
       Detected Nielsen metro (DMA) code for the provided location information on this event. This value is only available
 if the telemetry system is able to detect and resolve a Nielsen metro code for the provided location information.
      string nielsen = 4 [json_name = "nielsen", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The nielsen.

    • getNielsenBytes

      com.google.protobuf.ByteString getNielsenBytes()
       Detected Nielsen metro (DMA) code for the provided location information on this event. This value is only available
 if the telemetry system is able to detect and resolve a Nielsen metro code for the provided location information.
      string nielsen = 4 [json_name = "nielsen", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for nielsen.

    • getLocality

      String getLocality()
       Detected locality (city name) for this event. This value is a best-effort calculation, just like the `nielsen`
 code, unless location info is provided explicitly by the client.
      string locality = 5 [json_name = "locality", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The locality.

    • getLocalityBytes

      com.google.protobuf.ByteString getLocalityBytes()
       Detected locality (city name) for this event. This value is a best-effort calculation, just like the `nielsen`
 code, unless location info is provided explicitly by the client.
      string locality = 5 [json_name = "locality", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for locality.

    • getRegion

      String getRegion()
       Detected region (state or province) for this event. This value is a best-effort calculation, just like the other
 detected location values listed on this payload.
      string region = 6 [json_name = "region", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The region.

    • getRegionBytes

      com.google.protobuf.ByteString getRegionBytes()
       Detected region (state or province) for this event. This value is a best-effort calculation, just like the other
 detected location values listed on this payload.
      string region = 6 [json_name = "region", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for region.

    • getCountry

      String getCountry()
       The only required value for an event locality payload. If not provided by the client, this value will be reliably
 detected (on a best-effort basis) and filled in on behalf of the client by the telemetry system.
      string country = 7 [json_name = "country", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The country.

    • getCountryBytes

      com.google.protobuf.ByteString getCountryBytes()
       The only required value for an event locality payload. If not provided by the client, this value will be reliably
 detected (on a best-effort basis) and filled in on behalf of the client by the telemetry system.
      string country = 7 [json_name = "country", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for country.

    • getTag

      String getTag()
       Specifies the geo-hash tag value associated with this event location. This value is typically calculated by the
 service based on available geographic input material.
      string tag = 8 [json_name = "tag", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The tag.

    • getTagBytes

      com.google.protobuf.ByteString getTagBytes()
       Specifies the geo-hash tag value associated with this event location. This value is typically calculated by the
 service based on available geographic input material.
      string tag = 8 [json_name = "tag", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for tag.

    • getEdge

      String getEdge()
       Detected edge region (state or province) for this event. This value is indicated by the edge CDN service, and
 specifies the edge region where traffic first entered the network.
      string edge = 9 [json_name = "edge", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The edge.

    • getEdgeBytes

      com.google.protobuf.ByteString getEdgeBytes()
       Detected edge region (state or province) for this event. This value is indicated by the edge CDN service, and
 specifies the edge region where traffic first entered the network.
      string edge = 9 [json_name = "edge", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for edge.