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

Interface SearchRequest.Builder

    • Method Detail

      • 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:
        ResourceType, ResourceType

      • 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:
        ResourceType, ResourceType

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

      • 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:
        SearchSortOrder, SearchSortOrder

      • 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:
        SearchSortOrder, SearchSortOrder

      • 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, CrossAccountFilterOption

      • 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:
        CrossAccountFilterOption, CrossAccountFilterOption