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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SearchRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SearchRequest.Builder`	`builder()`
`CrossAccountFilterOption`	`crossAccountFilterOption()`	A cross account filter option.
`String`	`crossAccountFilterOptionAsString()`	A cross account filter option.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`maxResults()`	The maximum number of results to return.
`String`	`nextToken()`	If more than `MaxResults` resources match the specified `SearchExpression`, the response includes a `NextToken`.
`ResourceType`	`resource()`	The name of the SageMaker resource to search for.
`String`	`resourceAsString()`	The name of the SageMaker resource to search for.
`List<SdkField<?>>`	`sdkFields()`
`SearchExpression`	`searchExpression()`	A Boolean conditional statement.
`static Class<? extends SearchRequest.Builder>`	`serializableBuilderClass()`
`String`	`sortBy()`	The name of the resource property used to sort the `SearchResults`.
`SearchSortOrder`	`sortOrder()`	How `SearchResults` are ordered.
`String`	`sortOrderAsString()`	How `SearchResults` are ordered.
`SearchRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    ResourceType
  - 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:
    
    ResourceType
  - 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:
    
    SearchSortOrder
  - 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:
    
    SearchSortOrder
  - 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:
    
    CrossAccountFilterOption
  - 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:
    
    CrossAccountFilterOption
  - toBuilder
```
public SearchRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SearchRequest.Builder,SearchRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SearchRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

resource

resourceAsString

searchExpression

sortBy

sortOrder

sortOrderAsString

nextToken

maxResults

crossAccountFilterOption

crossAccountFilterOptionAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields