Package software.amazon.awssdk.services.sagemaker.model

Interface SearchRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchRequest.Builder,SearchRequest>, SageMakerRequest.Builder, SdkBuilder<SearchRequest.Builder,SearchRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchRequest
public static interface SearchRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<SearchRequest.Builder,SearchRequest>

  • Method Details

    • resource

      SearchRequest.Builder resource(String resource)

      The name of the SageMaker resource to search for.

      Parameters:
      resource - The name of the SageMaker resource to search for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resource

      SearchRequest.Builder resource(ResourceType resource)

      The name of the SageMaker resource to search for.

      Parameters:
      resource - The name of the SageMaker resource to search for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • searchExpression

      SearchRequest.Builder searchExpression(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • searchExpression

      default SearchRequest.Builder searchExpression(Consumer<SearchExpression.Builder> 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.

      This is a convenience method that creates an instance of the SearchExpression.Builder avoiding the need to create one manually via SearchExpression.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchExpression(SearchExpression).

      Parameters:
      searchExpression - a consumer that will call methods on SearchExpression.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      SearchRequest.Builder sortBy(String sortBy)

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

      Parameters:
      sortBy - The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortOrder

      SearchRequest.Builder sortOrder(String sortOrder)

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

      Parameters:
      sortOrder - How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      SearchRequest.Builder sortOrder(SearchSortOrder sortOrder)

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

      Parameters:
      sortOrder - How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      SearchRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      SearchRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return.

      Parameters:
      maxResults - The maximum number of results to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • crossAccountFilterOption

      SearchRequest.Builder crossAccountFilterOption(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • crossAccountFilterOption

      SearchRequest.Builder crossAccountFilterOption(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • visibilityConditions

      SearchRequest.Builder visibilityConditions(Collection<VisibilityConditions> visibilityConditions)

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

      Parameters:
      visibilityConditions - Limits the results of your search request to the resources that you can access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • visibilityConditions

      SearchRequest.Builder visibilityConditions(VisibilityConditions... visibilityConditions)

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

      Parameters:
      visibilityConditions - Limits the results of your search request to the resources that you can access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • visibilityConditions

      SearchRequest.Builder visibilityConditions(Consumer<VisibilityConditions.Builder>... visibilityConditions)

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

      This is a convenience method that creates an instance of the VisibilityConditions.Builder avoiding the need to create one manually via VisibilityConditions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to visibilityConditions(List<VisibilityConditions>).

      Parameters:
      visibilityConditions - a consumer that will call methods on VisibilityConditions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      SearchRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SearchRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.