You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ServiceDiscovery::Types::OperationFilter

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

Overview

Note:

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

{
  name: "NAMESPACE_ID", # required, accepts NAMESPACE_ID, SERVICE_ID, STATUS, TYPE, UPDATE_DATE
  values: ["FilterValue"], # required
  condition: "EQ", # accepts EQ, IN, BETWEEN
}

A complex type that lets you select the operations that you want to list.

Instance Attribute Summary collapse

Instance Attribute Details

#conditionString

The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:

  • EQ: When you specify EQ for the condition, you can specify only one value. EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can be omitted.

  • IN: When you specify IN for the condition, you can specify a list of one or more values. IN is supported for STATUS and TYPE. An operation must match one of the specified values to be returned in the response.

  • BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN is supported for UPDATE_DATE.

Returns:

  • (String)


1699
1700
1701
1702
1703
1704
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 1699

class OperationFilter < Struct.new(
  :name,
  :values,
  :condition)
  include Aws::Structure
end

#nameString

Specify the operations that you want to get:

  • NAMESPACE_ID: Gets operations related to specified namespaces.

  • SERVICE_ID: Gets operations related to specified services.

  • STATUS: Gets operations based on the status of the operations: SUBMITTED, PENDING, SUCCEED, or FAIL.

  • TYPE: Gets specified types of operation.

  • UPDATE_DATE: Gets operations that changed status during a specified date/time range.

Returns:

  • (String)


1699
1700
1701
1702
1703
1704
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 1699

class OperationFilter < Struct.new(
  :name,
  :values,
  :condition)
  include Aws::Structure
end

#valuesArray<String>

Specify values that are applicable to the value that you specify for Name:

  • NAMESPACE_ID: Specify one namespace ID.

  • SERVICE_ID: Specify one service ID.

  • STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or FAIL.

  • TYPE: Specify one or more of the following types: CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE.

  • UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.

Returns:

  • (Array<String>)


1699
1700
1701
1702
1703
1704
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 1699

class OperationFilter < Struct.new(
  :name,
  :values,
  :condition)
  include Aws::Structure
end