software.amazon.awssdk.services.neptunedata.model

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(value="software.amazon.awssdk:codegen")
public final class GetEngineStatusResponse
extends NeptunedataResponse
implements ToCopyableBuilder<GetEngineStatusResponse.Builder,GetEngineStatusResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetEngineStatusResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetEngineStatusResponse.Builder	builder()
String	dbEngineVersion() Set to the Neptune engine version running on your DB cluster.
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,Document>	features() Contains status information about the features enabled on your DB cluster.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
QueryLanguageVersion	gremlin() Contains information about the Gremlin query language available on your cluster.
boolean	hasFeatures() For responses, this returns true if the service returned a value for the Features property.
int	hashCode()
boolean	hasLabMode() For responses, this returns true if the service returned a value for the LabMode property.
boolean	hasSettings() For responses, this returns true if the service returned a value for the Settings property.
Map<String,String>	labMode() Contains Lab Mode settings being used by the engine.
QueryLanguageVersion	opencypher() Contains information about the openCypher query language available on your cluster.
String	role() Set to reader if the instance is a read-replica, or to writer if the instance is the primary instance.
Integer	rollingBackTrxCount() If there are transactions being rolled back, this field is set to the number of such transactions.
String	rollingBackTrxEarliestStartTime() Set to the start time of the earliest transaction being rolled back.
List<SdkField<?>>	sdkFields()
static Class<? extends GetEngineStatusResponse.Builder>	serializableBuilderClass()
Map<String,String>	settings() Contains information about the current settings on your DB cluster.
QueryLanguageVersion	sparql() Contains information about the SPARQL query language available on your cluster.
String	startTime() Set to the UTC time at which the current server process started.
String	status() Set to healthy if the instance is not experiencing problems.
GetEngineStatusResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.neptunedata.model.NeptunedataResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<GetEngineStatusResponse.Builder,GetEngineStatusResponse>

Overrides:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo