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

Inherits:

Struct

• Object
• Struct
• Aws::CloudSearch::Types::OptionStatus

Includes:

Structure

Defined in:

lib/aws-sdk-cloudsearch/types.rb

Overview

The status of domain configuration option.

Instance Attribute Summary

• #creation_date ⇒ Time

  A timestamp for when this option was created.

• #pending_deletion ⇒ Boolean

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

• #state ⇒ String

  The state of processing a change to an option.

• #update_date ⇒ Time

  A timestamp for when this option was last updated.

• #update_version ⇒ Integer

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

Instance Attribute Details

#creation_date ⇒ Time

A timestamp for when this option was created.

Returns:

• (Time)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 2070

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

#pending_deletion ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 2070

class OptionStatus < Struct.new(
  :creation_date,
  :update_date,
  :update_version,
  :state,
  :pending_deletion)
  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)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 2070

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

#update_date ⇒ Time

A timestamp for when this option was last updated.

Returns:

• (Time)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 2070

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

#update_version ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 2070

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