Class SearchResult

java.lang.Object
software.amazon.awssdk.services.iotsitewise.model.SearchResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SearchResult.Builder,SearchResult>
@Generated("software.amazon.awssdk:codegen") public final class SearchResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SearchResult.Builder,SearchResult>

A single matching segment of time-series data returned by a search.

See Also:

  • Method Details

    • searchId

      public final String searchId()

      The identifier of the search that produced this result.

      Returns:
      The identifier of the search that produced this result.

    • workspaceName

      public final String workspaceName()

      The name of the workspace the search ran against.

      Returns:
      The name of the workspace the search ran against.

    • datasetId

      public final String datasetId()

      The identifier of the dataset that contains the matching data.

      Returns:
      The identifier of the dataset that contains the matching data.

    • timeSeriesId

      public final String timeSeriesId()

      The identifier of the time series that contains the matching data.

      Returns:
      The identifier of the time series that contains the matching data.

    • startTimestamp

      public final TimeInNanos startTimestamp()

      The start of the matching time-series segment, in nanoseconds since the Unix epoch.

      Returns:
      The start of the matching time-series segment, in nanoseconds since the Unix epoch.

    • endTimestamp

      public final TimeInNanos endTimestamp()

      The end of the matching time-series segment, in nanoseconds since the Unix epoch.

      Returns:
      The end of the matching time-series segment, in nanoseconds since the Unix epoch.

    • topTimestamp

      public final TimeInNanos topTimestamp()

      The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.

      Returns:
      The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.

    • score

      public final Float score()

      The relevance score of this result. Higher scores indicate a stronger match.

      Returns:
      The relevance score of this result. Higher scores indicate a stronger match.

    • toBuilder

      public SearchResult.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchResult.Builder,SearchResult>
      Returns:
      a builder for type T

    • builder

      public static SearchResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchResult.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.