Class SearchRequest

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

  • Method Details

    • resource

      public final ResourceType resource()

      The name of the SageMaker resource to search for.

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

      Returns:
      The name of the SageMaker resource to search for.
      See Also:

    • resourceAsString

      public final String resourceAsString()

      The name of the SageMaker resource to search for.

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

      Returns:
      The name of the SageMaker resource to search for.
      See Also:

    • searchExpression

      public final SearchExpression searchExpression()

      A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

      Returns:
      A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

    • sortBy

      public final String sortBy()

      The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

      Returns:
      The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

    • sortOrder

      public final SearchSortOrder sortOrder()

      How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

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

      Returns:
      How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

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

      Returns:
      How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
      See Also:

    • nextToken

      public final String nextToken()

      If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

      Returns:
      If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return.

      Returns:
      The maximum number of results to return.

    • crossAccountFilterOption

      public final CrossAccountFilterOption crossAccountFilterOption()

      A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

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

      Returns:
      A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.
      See Also:

    • crossAccountFilterOptionAsString

      public final String crossAccountFilterOptionAsString()

      A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

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

      Returns:
      A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.
      See Also:

    • hasVisibilityConditions

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

    • visibilityConditions

      public final List<VisibilityConditions> visibilityConditions()

      Limits the results of your search request to the resources that you can access.

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

      Returns:
      Limits the results of your search request to the resources that you can access.

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

    • sdkFieldNameToField

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