Class DescribeSearchResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse
software.amazon.awssdk.services.iotsitewise.model.DescribeSearchResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeSearchResponse.Builder,DescribeSearchResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeSearchResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribeSearchResponse.Builder,DescribeSearchResponse>

Output of the DescribeSearch operation.

  • Method Details

    • searchId

      public final String searchId()

      The unique identifier of the search.

      Returns:
      The unique identifier of the search.

    • workspaceName

      public final String workspaceName()

      The name of the workspace the search runs against.

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

    • status

      public final SearchStatus status()

      The current status of the search.

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

      Returns:
      The current status of the search.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the search.

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

      Returns:
      The current status of the search.
      See Also:

    • queryStatement

      public final String queryStatement()

      The natural-language query that was submitted for the search.

      Returns:
      The natural-language query that was submitted for the search.

    • searchType

      public final SearchType searchType()

      The search strategy used for the search.

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

      Returns:
      The search strategy used for the search.
      See Also:

    • searchTypeAsString

      public final String searchTypeAsString()

      The search strategy used for the search.

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

      Returns:
      The search strategy used for the search.
      See Also:

    • statusReason

      public final String statusReason()

      A human-readable explanation of the current status. Populated when the search has FAILED.

      Returns:
      A human-readable explanation of the current status. Populated when the search has FAILED.

    • startedAt

      public final Instant startedAt()

      The time at which the search was started.

      Returns:
      The time at which the search was started.

    • groupId

      public final String groupId()

      The group identifier associated with the search, if one was supplied on the request.

      Returns:
      The group identifier associated with the search, if one was supplied on the request.

    • toBuilder

      public DescribeSearchResponse.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<DescribeSearchResponse.Builder,DescribeSearchResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeSearchResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.