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

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

Overview

The status of domain configuration option.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date ⇒ Time

A timestamp for when this option was created.

Returns:

  • (Time) 


1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1743

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

#pending_deletion ⇒ Boolean

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

Returns:

  • (Boolean) 


1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1743

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

#state ⇒ String

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) 


1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1743

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

#update_date ⇒ Time

A timestamp for when this option was last updated.

Returns:

  • (Time) 


1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1743

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

#update_version ⇒ Integer

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

Returns:

  • (Integer) 


1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1743

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