Class DescribeGeofenceCollectionResponse

    • Method Detail

      • collectionName

        public final String collectionName()

        The name of the geofence collection.

        Returns:
        The name of the geofence collection.
      • collectionArn

        public final String collectionArn()

        The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.

        • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

        Returns:
        The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.

        • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

      • description

        public final String description()

        The optional description for the geofence collection.

        Returns:
        The optional description for the geofence collection.
      • pricingPlan

        @Deprecated
        public final PricingPlan pricingPlan()
        Deprecated.
        Deprecated. Always returns RequestBasedUsage.

        No longer used. Always returns RequestBasedUsage.

        If the service returns an enum value that is not available in the current SDK version, pricingPlan will return PricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pricingPlanAsString().

        Returns:
        No longer used. Always returns RequestBasedUsage.
        See Also:
        PricingPlan
      • pricingPlanAsString

        @Deprecated
        public final String pricingPlanAsString()
        Deprecated.
        Deprecated. Always returns RequestBasedUsage.

        No longer used. Always returns RequestBasedUsage.

        If the service returns an enum value that is not available in the current SDK version, pricingPlan will return PricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pricingPlanAsString().

        Returns:
        No longer used. Always returns RequestBasedUsage.
        See Also:
        PricingPlan
      • pricingPlanDataSource

        @Deprecated
        public final String pricingPlanDataSource()
        Deprecated.
        Deprecated. Unused.

        No longer used. Always returns an empty string.

        Returns:
        No longer used. Always returns an empty string.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final Map<String,​String> tags()

        Displays the key, value pairs of tags associated with this resource.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        Displays the key, value pairs of tags associated with this resource.
      • createTime

        public final Instant createTime()

        The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

        Returns:
        The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
      • updateTime

        public final Instant updateTime()

        The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

        Returns:
        The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
      • geofenceCount

        public final Integer geofenceCount()

        The number of geofences in the geofence collection.

        Returns:
        The number of geofences in the geofence collection.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object