Class: Aws::DataZone::Types::SearchTypesInput

Inherits:

Struct

• Object
• Struct
• Aws::DataZone::Types::SearchTypesInput

Includes:

Structure

Defined in:

lib/aws-sdk-datazone/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #domain_identifier ⇒ String

  The identifier of the Amazon DataZone domain in which to invoke the ‘SearchTypes` action.

• #filters ⇒ Types::FilterClause

  The filters for the ‘SearchTypes` action.

• #managed ⇒ Boolean

  Specifies whether the search is managed.

• #max_results ⇒ Integer

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

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

• #search_in ⇒ Array<Types::SearchInItem>

  The details of the search.

• #search_scope ⇒ String

  Specifies the scope of the search for types.

• #search_text ⇒ String

  Specifies the text for which to search.

• #sort ⇒ Types::SearchSort

  The specifies the way to sort the ‘SearchTypes` results.

Instance Attribute Details

#domain_identifier ⇒ String

The identifier of the Amazon DataZone domain in which to invoke the ‘SearchTypes` action.

Returns:

• (String)

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

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

#filters ⇒ Types::FilterClause

The filters for the ‘SearchTypes` action.

Returns:

• (Types::FilterClause)

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

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

#managed ⇒ Boolean

Specifies whether the search is managed.

Returns:

• (Boolean)

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

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

#max_results ⇒ Integer

The maximum number of results to return in a single call to ‘SearchTypes`. 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 `SearchTypes` to list the next set of results.

Returns:

• (Integer)

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

class SearchTypesInput < Struct.new(
  :domain_identifier,
  :filters,
  :managed,
  :max_results,
  :next_token,
  :search_in,
  :search_scope,
  :search_text,
  :sort)
  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 `SearchTypes` to list the next set of results.

Returns:

• (String)

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

class SearchTypesInput < Struct.new(
  :domain_identifier,
  :filters,
  :managed,
  :max_results,
  :next_token,
  :search_in,
  :search_scope,
  :search_text,
  :sort)
  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 13858

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

#search_scope ⇒ String

Specifies the scope of the search for types.

Returns:

• (String)

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

class SearchTypesInput < Struct.new(
  :domain_identifier,
  :filters,
  :managed,
  :max_results,
  :next_token,
  :search_in,
  :search_scope,
  :search_text,
  :sort)
  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 13858

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

#sort ⇒ Types::SearchSort

The specifies the way to sort the ‘SearchTypes` results.

Returns:

• (Types::SearchSort)

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

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