Class: Aws::DataZone::Types::SearchInput

Inherits:

Struct

• Object
• Struct
• Aws::DataZone::Types::SearchInput

Includes:

Structure

Defined in:

lib/aws-sdk-datazone/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_attributes ⇒ Array<String>

  Specifies additional attributes for the ‘Search` action.

• #domain_identifier ⇒ String

  The identifier of the Amazon DataZone domain.

• #filters ⇒ Types::FilterClause

  Specifies the search filters.

• #max_results ⇒ Integer

  The maximum number of results to return in a single call to ‘Search`.

• #next_token ⇒ String

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

• #owning_project_identifier ⇒ String

  The identifier of the owning project specified for the search.

• #search_in ⇒ Array<Types::SearchInItem>

  The details of the search.

• #search_scope ⇒ String

  The scope of the search.

• #search_text ⇒ String

  Specifies the text for which to search.

• #sort ⇒ Types::SearchSort

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

Instance Attribute Details

#additional_attributes ⇒ Array<String>

Specifies additional attributes for the ‘Search` action.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-datazone/types.rb', line 18900

class SearchInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :max_results,
  :next_token,
  :search_scope,
  :search_text,
  :search_in,
  :filters,
  :sort,
  :additional_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#domain_identifier ⇒ String

The identifier of the Amazon DataZone domain.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 18900

class SearchInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :max_results,
  :next_token,
  :search_scope,
  :search_text,
  :search_in,
  :filters,
  :sort,
  :additional_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Types::FilterClause

Specifies the search filters.

Returns:

• (Types::FilterClause)

# File 'lib/aws-sdk-datazone/types.rb', line 18900

class SearchInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :max_results,
  :next_token,
  :search_scope,
  :search_text,
  :search_in,
  :filters,
  :sort,
  :additional_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-datazone/types.rb', line 18900

class SearchInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :max_results,
  :next_token,
  :search_scope,
  :search_text,
  :search_in,
  :filters,
  :sort,
  :additional_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 18900

class SearchInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :max_results,
  :next_token,
  :search_scope,
  :search_text,
  :search_in,
  :filters,
  :sort,
  :additional_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#owning_project_identifier ⇒ String

The identifier of the owning project specified for the search.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 18900

class SearchInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :max_results,
  :next_token,
  :search_scope,
  :search_text,
  :search_in,
  :filters,
  :sort,
  :additional_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#search_in ⇒ Array<Types::SearchInItem>

The details of the search.

Returns:

• (Array<Types::SearchInItem>)

# File 'lib/aws-sdk-datazone/types.rb', line 18900

class SearchInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :max_results,
  :next_token,
  :search_scope,
  :search_text,
  :search_in,
  :filters,
  :sort,
  :additional_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#search_scope ⇒ String

The scope of the search.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 18900

class SearchInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :max_results,
  :next_token,
  :search_scope,
  :search_text,
  :search_in,
  :filters,
  :sort,
  :additional_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#search_text ⇒ String

Specifies the text for which to search.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 18900

class SearchInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :max_results,
  :next_token,
  :search_scope,
  :search_text,
  :search_in,
  :filters,
  :sort,
  :additional_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#sort ⇒ Types::SearchSort

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

Returns:

• (Types::SearchSort)

# File 'lib/aws-sdk-datazone/types.rb', line 18900

class SearchInput < Struct.new(
  :domain_identifier,
  :owning_project_identifier,
  :max_results,
  :next_token,
  :search_scope,
  :search_text,
  :search_in,
  :filters,
  :sort,
  :additional_attributes)
  SENSITIVE = []
  include Aws::Structure
end