Class StartSearchRequest

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

Input for the StartSearch operation.

  • Method Details

    • workspaceName

      public final String workspaceName()

      The name of the workspace whose data is searched.

      Returns:
      The name of the workspace whose data is searched.

    • queryStatement

      public final String queryStatement()

      The natural-language query describing the data to search for.

      Returns:
      The natural-language query describing the data to search for.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier you provide to ensure the request is idempotent. Repeating a StartSearch call with the same clientToken returns the original search rather than starting a new one. If omitted, the SDK autogenerates one.

      Returns:
      A unique, case-sensitive identifier you provide to ensure the request is idempotent. Repeating a StartSearch call with the same clientToken returns the original search rather than starting a new one. If omitted, the SDK autogenerates one.

    • searchType

      public final SearchType searchType()

      The search strategy to use. Defaults to QUICK when omitted.

      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 to use. Defaults to QUICK when omitted.
      See Also:

    • searchTypeAsString

      public final String searchTypeAsString()

      The search strategy to use. Defaults to QUICK when omitted.

      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 to use. Defaults to QUICK when omitted.
      See Also:

    • searchFilters

      public final SearchFilters searchFilters()

      Optional filters that restrict the search to a subset of the workspace's data.

      Returns:
      Optional filters that restrict the search to a subset of the workspace's data.

    • groupId

      public final String groupId()

      An optional caller-supplied identifier used to group related searches together.

      Returns:
      An optional caller-supplied identifier used to group related searches together.

    • toBuilder

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

    • builder

      public static StartSearchRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.