Class: Aws::DataSync::Types::TaskFilter

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-datasync/types.rb

Overview

You can use API filters to narrow down the list of resources returned by ‘ListTasks`. For example, to retrieve all tasks on a source location, you can use `ListTasks` with filter name `LocationId` and `Operator Equals` with the ARN for the location.

For more information, see [filtering DataSync resources].

[1]: docs.aws.amazon.com/datasync/latest/userguide/query-resources.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name of the filter being used. Each API call supports a list of filters that are available for it. For example, ‘LocationId` for `ListTasks`.

Returns:

  • (String)


5361
5362
5363
5364
5365
5366
5367
# File 'lib/aws-sdk-datasync/types.rb', line 5361

class TaskFilter < Struct.new(
  :name,
  :values,
  :operator)
  SENSITIVE = []
  include Aws::Structure
end

#operatorString

The operator that is used to compare filter values (for example, ‘Equals` or `Contains`).

Returns:

  • (String)


5361
5362
5363
5364
5365
5366
5367
# File 'lib/aws-sdk-datasync/types.rb', line 5361

class TaskFilter < Struct.new(
  :name,
  :values,
  :operator)
  SENSITIVE = []
  include Aws::Structure
end

#valuesArray<String>

The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.

Returns:

  • (Array<String>)


5361
5362
5363
5364
5365
5366
5367
# File 'lib/aws-sdk-datasync/types.rb', line 5361

class TaskFilter < Struct.new(
  :name,
  :values,
  :operator)
  SENSITIVE = []
  include Aws::Structure
end