Class SearchRequest

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

  • Method Details

    • additionalAttributes

      public final List<SearchOutputAdditionalAttribute> additionalAttributes()

      Specifies additional attributes for the Search action.

      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 hasAdditionalAttributes() method.

      Returns:
      Specifies additional attributes for the Search action.

    • hasAdditionalAttributes

      public final boolean hasAdditionalAttributes()
      For responses, this returns true if the service returned a value for the AdditionalAttributes 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.

    • additionalAttributesAsStrings

      public final List<String> additionalAttributesAsStrings()

      Specifies additional attributes for the Search action.

      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 hasAdditionalAttributes() method.

      Returns:
      Specifies additional attributes for the Search action.

    • domainIdentifier

      public final String domainIdentifier()

      The identifier of the Amazon DataZone domain.

      Returns:
      The identifier of the Amazon DataZone domain.

    • filters

      public final FilterClause filters()

      Specifies the search filters.

      Returns:
      Specifies the search filters.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

      Returns:
      The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

    • nextToken

      public final String nextToken()

      When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

      Returns:
      When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

    • owningProjectIdentifier

      public final String owningProjectIdentifier()

      The identifier of the owning project specified for the search.

      Returns:
      The identifier of the owning project specified for the search.

    • hasSearchIn

      public final boolean hasSearchIn()
      For responses, this returns true if the service returned a value for the SearchIn 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.

    • searchIn

      public final List<SearchInItem> searchIn()

      The details of the search.

      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 hasSearchIn() method.

      Returns:
      The details of the search.

    • searchScope

      public final InventorySearchScope searchScope()

      The scope of the search.

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

      Returns:
      The scope of the search.
      See Also:

    • searchScopeAsString

      public final String searchScopeAsString()

      The scope of the search.

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

      Returns:
      The scope of the search.
      See Also:

    • searchText

      public final String searchText()

      Specifies the text for which to search.

      Returns:
      Specifies the text for which to search.

    • sort

      public final SearchSort sort()

      Specifies the way in which the search results are to be sorted.

      Returns:
      Specifies the way in which the search results are to be sorted.

    • toBuilder

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

    • builder

      public static SearchRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchRequest.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.