Class: Aws::WorkDocs::Types::Filters

Inherits:

Struct

• Object
• Struct
• Aws::WorkDocs::Types::Filters

Defined in:

gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Filters results based on entity metadata.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ancestor_ids ⇒ Array<String>

  Filter based on resource’s path.

• #content_categories ⇒ Array<String>

  Filters by content category.

• #created_range ⇒ Types::DateRangeType

  Filter based on resource’s creation timestamp.

• #labels ⇒ Array<String>

  Filter by labels using exact match.

• #modified_range ⇒ Types::DateRangeType

  Filter based on resource’s modified timestamp.

• #principals ⇒ Array<Types::SearchPrincipalType>

  Filter based on UserIds or GroupIds.

• #resource_types ⇒ Array<String>

  Filters based on entity type.

• #search_collection_types ⇒ Array<String>

  Filter based on file groupings.

• #size_range ⇒ Types::LongRangeType

  Filter based on size (in bytes).

• #text_locales ⇒ Array<String>

  Filters by the locale of the content or comment.

Instance Attribute Details

#ancestor_ids ⇒ Array<String>

Filter based on resource’s path.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1634

class Filters < Struct.new(
  :text_locales,
  :content_categories,
  :resource_types,
  :labels,
  :principals,
  :ancestor_ids,
  :search_collection_types,
  :size_range,
  :created_range,
  :modified_range)
  SENSITIVE = []
  include Aws::Structure
end

#content_categories ⇒ Array<String>

Filters by content category.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1634

class Filters < Struct.new(
  :text_locales,
  :content_categories,
  :resource_types,
  :labels,
  :principals,
  :ancestor_ids,
  :search_collection_types,
  :size_range,
  :created_range,
  :modified_range)
  SENSITIVE = []
  include Aws::Structure
end

#created_range ⇒ Types::DateRangeType

Filter based on resource’s creation timestamp.

Returns:

• (Types::DateRangeType)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1634

class Filters < Struct.new(
  :text_locales,
  :content_categories,
  :resource_types,
  :labels,
  :principals,
  :ancestor_ids,
  :search_collection_types,
  :size_range,
  :created_range,
  :modified_range)
  SENSITIVE = []
  include Aws::Structure
end

#labels ⇒ Array<String>

Filter by labels using exact match.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1634

class Filters < Struct.new(
  :text_locales,
  :content_categories,
  :resource_types,
  :labels,
  :principals,
  :ancestor_ids,
  :search_collection_types,
  :size_range,
  :created_range,
  :modified_range)
  SENSITIVE = []
  include Aws::Structure
end

#modified_range ⇒ Types::DateRangeType

Filter based on resource’s modified timestamp.

Returns:

• (Types::DateRangeType)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1634

class Filters < Struct.new(
  :text_locales,
  :content_categories,
  :resource_types,
  :labels,
  :principals,
  :ancestor_ids,
  :search_collection_types,
  :size_range,
  :created_range,
  :modified_range)
  SENSITIVE = []
  include Aws::Structure
end

#principals ⇒ Array<Types::SearchPrincipalType>

Filter based on UserIds or GroupIds.

Returns:

• (Array<Types::SearchPrincipalType>)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1634

class Filters < Struct.new(
  :text_locales,
  :content_categories,
  :resource_types,
  :labels,
  :principals,
  :ancestor_ids,
  :search_collection_types,
  :size_range,
  :created_range,
  :modified_range)
  SENSITIVE = []
  include Aws::Structure
end

#resource_types ⇒ Array<String>

Filters based on entity type.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1634

class Filters < Struct.new(
  :text_locales,
  :content_categories,
  :resource_types,
  :labels,
  :principals,
  :ancestor_ids,
  :search_collection_types,
  :size_range,
  :created_range,
  :modified_range)
  SENSITIVE = []
  include Aws::Structure
end

#search_collection_types ⇒ Array<String>

Filter based on file groupings.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1634

class Filters < Struct.new(
  :text_locales,
  :content_categories,
  :resource_types,
  :labels,
  :principals,
  :ancestor_ids,
  :search_collection_types,
  :size_range,
  :created_range,
  :modified_range)
  SENSITIVE = []
  include Aws::Structure
end

#size_range ⇒ Types::LongRangeType

Filter based on size (in bytes).

Returns:

• (Types::LongRangeType)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1634

class Filters < Struct.new(
  :text_locales,
  :content_categories,
  :resource_types,
  :labels,
  :principals,
  :ancestor_ids,
  :search_collection_types,
  :size_range,
  :created_range,
  :modified_range)
  SENSITIVE = []
  include Aws::Structure
end

#text_locales ⇒ Array<String>

Filters by the locale of the content or comment.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1634

class Filters < Struct.new(
  :text_locales,
  :content_categories,
  :resource_types,
  :labels,
  :principals,
  :ancestor_ids,
  :search_collection_types,
  :size_range,
  :created_range,
  :modified_range)
  SENSITIVE = []
  include Aws::Structure
end