Class: Aws::Neptunedata::Types::GetEngineStatusOutput

Inherits:

Struct

• Object
• Struct
• Aws::Neptunedata::Types::GetEngineStatusOutput

Includes:

Structure

Defined in:

lib/aws-sdk-neptunedata/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_engine_version ⇒ String

  Set to the Neptune engine version running on your DB cluster.

• #dfe_query_engine ⇒ String

  Set to ‘enabled` if the DFE engine is fully enabled, or to `viaQueryHint` (the default) if the DFE engine is only used with queries that have the `useDFE` query hint set to `true`.

• #features ⇒ Hash<String,Hash,Array,String,Numeric,Boolean>

  Contains status information about the features enabled on your DB cluster.

• #gremlin ⇒ Types::QueryLanguageVersion

  Contains information about the Gremlin query language available on your cluster.

• #lab_mode ⇒ Hash<String,String>

  Contains Lab Mode settings being used by the engine.

• #opencypher ⇒ Types::QueryLanguageVersion

  Contains information about the openCypher query language available on your cluster.

• #role ⇒ String

  Set to ‘reader` if the instance is a read-replica, or to `writer` if the instance is the primary instance.

• #rolling_back_trx_count ⇒ Integer

  If there are transactions being rolled back, this field is set to the number of such transactions.

• #rolling_back_trx_earliest_start_time ⇒ String

  Set to the start time of the earliest transaction being rolled back.

• #settings ⇒ Hash<String,String>

  Contains information about the current settings on your DB cluster.

• #sparql ⇒ Types::QueryLanguageVersion

  Contains information about the SPARQL query language available on your cluster.

• #start_time ⇒ String

  Set to the UTC time at which the current server process started.

• #status ⇒ String

  Set to ‘healthy` if the instance is not experiencing problems.

Instance Attribute Details

#db_engine_version ⇒ String

Set to the Neptune engine version running on your DB cluster. If this engine version has been manually patched since it was released, the version number is prefixed by ‘Patch-`.

Returns:

• (String)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#dfe_query_engine ⇒ String

Set to ‘enabled` if the DFE engine is fully enabled, or to `viaQueryHint` (the default) if the DFE engine is only used with queries that have the `useDFE` query hint set to `true`.

Returns:

• (String)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#features ⇒ Hash<String,Hash,Array,String,Numeric,Boolean>

Contains status information about the features enabled on your DB cluster.

Returns:

• (Hash<String,Hash,Array,String,Numeric,Boolean>)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#gremlin ⇒ Types::QueryLanguageVersion

Contains information about the Gremlin query language available on your cluster. Specifically, it contains a version field that specifies the current TinkerPop version being used by the engine.

Returns:

• (Types::QueryLanguageVersion)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#lab_mode ⇒ Hash<String,String>

Contains Lab Mode settings being used by the engine.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#opencypher ⇒ Types::QueryLanguageVersion

Contains information about the openCypher query language available on your cluster. Specifically, it contains a version field that specifies the current operCypher version being used by the engine.

Returns:

• (Types::QueryLanguageVersion)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ String

Set to ‘reader` if the instance is a read-replica, or to `writer` if the instance is the primary instance.

Returns:

• (String)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#rolling_back_trx_count ⇒ Integer

If there are transactions being rolled back, this field is set to the number of such transactions. If there are none, the field doesn’t appear at all.

Returns:

• (Integer)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#rolling_back_trx_earliest_start_time ⇒ String

Set to the start time of the earliest transaction being rolled back. If no transactions are being rolled back, the field doesn’t appear at all.

Returns:

• (String)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Hash<String,String>

Contains information about the current settings on your DB cluster. For example, contains the current cluster query timeout setting (‘clusterQueryTimeoutInMs`).

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#sparql ⇒ Types::QueryLanguageVersion

Contains information about the SPARQL query language available on your cluster. Specifically, it contains a version field that specifies the current SPARQL version being used by the engine.

Returns:

• (Types::QueryLanguageVersion)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ String

Set to the UTC time at which the current server process started.

Returns:

• (String)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Set to ‘healthy` if the instance is not experiencing problems. If the instance is recovering from a crash or from being rebooted and there are active transactions running from the latest server shutdown, status is set to `recovery`.

Returns:

• (String)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end