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

Class: Aws::CloudSearch::Types::OptionStatus

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

Overview

The status of domain configuration option.

Instance Attribute Summary collapse

Instance Attribute Details

#creation_dateTime

A timestamp for when this option was created.

Returns:

  • (Time)


2086
2087
2088
2089
2090
2091
2092
2093
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2086

class OptionStatus < Struct.new(
  :creation_date,
  :update_date,
  :update_version,
  :state,
  :pending_deletion)
  include Aws::Structure
end

#pending_deletionBoolean

Indicates that the option will be deleted once processing is complete.

Returns:

  • (Boolean)


2086
2087
2088
2089
2090
2091
2092
2093
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2086

class OptionStatus < Struct.new(
  :creation_date,
  :update_date,
  :update_version,
  :state,
  :pending_deletion)
  include Aws::Structure
end

#stateString

The state of processing a change to an option. Possible values:

  • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
  • Processing: the option's latest value is in the process of being activated.
  • Active: the option's latest value is completely deployed.
  • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
2093
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2086

class OptionStatus < Struct.new(
  :creation_date,
  :update_date,
  :update_version,
  :state,
  :pending_deletion)
  include Aws::Structure
end

#update_dateTime

A timestamp for when this option was last updated.

Returns:

  • (Time)


2086
2087
2088
2089
2090
2091
2092
2093
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2086

class OptionStatus < Struct.new(
  :creation_date,
  :update_date,
  :update_version,
  :state,
  :pending_deletion)
  include Aws::Structure
end

#update_versionInteger

A unique integer that indicates when this option was last updated.

Returns:

  • (Integer)


2086
2087
2088
2089
2090
2091
2092
2093
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2086

class OptionStatus < Struct.new(
  :creation_date,
  :update_date,
  :update_version,
  :state,
  :pending_deletion)
  include Aws::Structure
end