Class GetEngineStatusResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.neptunedata.model.NeptunedataResponse
software.amazon.awssdk.services.neptunedata.model.GetEngineStatusResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetEngineStatusResponse.Builder,GetEngineStatusResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetEngineStatusResponse extends NeptunedataResponse implements ToCopyableBuilder<GetEngineStatusResponse.Builder,GetEngineStatusResponse>

  • Method Details

    • status

      public final String status()

      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:
      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.

    • startTime

      public final String startTime()

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

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

    • dbEngineVersion

      public final String dbEngineVersion()

      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:
      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-.

    • role

      public final String role()

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

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

    • dfeQueryEngine

      public final String dfeQueryEngine()

      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:
      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.

    • gremlin

      public final QueryLanguageVersion gremlin()

      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:
      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.

    • sparql

      public final QueryLanguageVersion sparql()

      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:
      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.

    • opencypher

      public final QueryLanguageVersion opencypher()

      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:
      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.

    • hasLabMode

      public final boolean hasLabMode()
      For responses, this returns true if the service returned a value for the LabMode property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • labMode

      public final Map<String,String> labMode()

      Contains Lab Mode settings being used by the engine.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLabMode() method.

      Returns:
      Contains Lab Mode settings being used by the engine.

    • rollingBackTrxCount

      public final Integer rollingBackTrxCount()

      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:
      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.

    • rollingBackTrxEarliestStartTime

      public final String rollingBackTrxEarliestStartTime()

      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:
      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.

    • hasFeatures

      public final boolean hasFeatures()
      For responses, this returns true if the service returned a value for the Features property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • features

      public final Map<String,Document> features()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFeatures() method.

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

    • hasSettings

      public final boolean hasSettings()
      For responses, this returns true if the service returned a value for the Settings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • settings

      public final Map<String,String> settings()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSettings() method.

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

    • toBuilder

      public GetEngineStatusResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetEngineStatusResponse.Builder,GetEngineStatusResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetEngineStatusResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetEngineStatusResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.