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

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

Overview

Note:

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


3040
3041
3042
3043
3044
3045
3046
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3040

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.

Returns:

  • (String) 


3040
3041
3042
3043
3044
3045
3046
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3040

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.

Returns:

  • (Array<String>) 


3040
3041
3042
3043
3044
3045
3046
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3040

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