Class: Aws::DataSync::Types::LocationFilter

Inherits:

Struct

• Object
• Struct
• Aws::DataSync::Types::LocationFilter

Defined in:

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

Overview

Note:

When making an API call, you may pass LocationFilter data as a hash:

{
  name: "LocationUri", # required, accepts LocationUri, LocationType, 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 ListLocations. For example, to retrieve all your Amazon S3 locations, you can use ListLocations with filter name LocationType S3 and Operator Equals.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #name ⇒ String

  The name of the filter being used.

• #operator ⇒ String

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

• #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, LocationType for ListLocations).

Returns:

• (String)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2145

class LocationFilter < 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 query-resources.

Returns:

• (String)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2145

class LocationFilter < 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 Amazon S3 locations.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2145

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