Class: Aws::DataSync::Types::TaskFilter
- Inherits:
-
Struct
- Object
- Struct
- Aws::DataSync::Types::TaskFilter
- Defined in:
- gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb
Overview
When making an API call, you may pass TaskFilter data as a hash:
{
name: "LocationId", # required, accepts LocationId, CreationTime
values: ["FilterAttributeValue"], # required
operator: "Equals", # required, accepts Equals, NotEquals, In, LessThanOrEqual, LessThan, GreaterThanOrEqual, GreaterThan, Contains, NotContains, BeginsWith
}
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#name ⇒ String
The name of the filter being used.
-
#operator ⇒ String
The operator that is used to compare filter values (for example,
Equals
orContains
). -
#values ⇒ Array<String>
The values that you want to filter for.
Instance Attribute Details
#name ⇒ String
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
.
3964 3965 3966 3967 3968 3969 3970 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3964 class TaskFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end |
#operator ⇒ String
The operator that is used to compare filter values (for example,
Equals
or Contains
). For more about API filtering operators, see
API filters for ListTasks and ListLocations.
3964 3965 3966 3967 3968 3969 3970 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3964 class TaskFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end |
#values ⇒ Array<String>
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.
3964 3965 3966 3967 3968 3969 3970 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3964 class TaskFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end |