software.amazon.awssdk.services.neptunedata.model

Interface GetEngineStatusResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetEngineStatusResponse.Builder,GetEngineStatusResponse>, NeptunedataResponse.Builder, SdkBuilder<GetEngineStatusResponse.Builder,GetEngineStatusResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetEngineStatusResponse

public static interface GetEngineStatusResponse.Builder
extends NeptunedataResponse.Builder, SdkPojo, CopyableBuilder<GetEngineStatusResponse.Builder,GetEngineStatusResponse>

Method Summary

Modifier and Type	Method and Description
GetEngineStatusResponse.Builder	dbEngineVersion(String dbEngineVersion) Set to the Neptune engine version running on your DB cluster.
GetEngineStatusResponse.Builder	dfeQueryEngine(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.
GetEngineStatusResponse.Builder	features(Map<String,Document> features) Contains status information about the features enabled on your DB cluster.
default GetEngineStatusResponse.Builder	gremlin(Consumer<QueryLanguageVersion.Builder> gremlin) Contains information about the Gremlin query language available on your cluster.
GetEngineStatusResponse.Builder	gremlin(QueryLanguageVersion gremlin) Contains information about the Gremlin query language available on your cluster.
GetEngineStatusResponse.Builder	labMode(Map<String,String> labMode) Contains Lab Mode settings being used by the engine.
default GetEngineStatusResponse.Builder	opencypher(Consumer<QueryLanguageVersion.Builder> opencypher) Contains information about the openCypher query language available on your cluster.
GetEngineStatusResponse.Builder	opencypher(QueryLanguageVersion opencypher) Contains information about the openCypher query language available on your cluster.
GetEngineStatusResponse.Builder	role(String role) Set to reader if the instance is a read-replica, or to writer if the instance is the primary instance.
GetEngineStatusResponse.Builder	rollingBackTrxCount(Integer rollingBackTrxCount) If there are transactions being rolled back, this field is set to the number of such transactions.
GetEngineStatusResponse.Builder	rollingBackTrxEarliestStartTime(String rollingBackTrxEarliestStartTime) Set to the start time of the earliest transaction being rolled back.
GetEngineStatusResponse.Builder	settings(Map<String,String> settings) Contains information about the current settings on your DB cluster.
default GetEngineStatusResponse.Builder	sparql(Consumer<QueryLanguageVersion.Builder> sparql) Contains information about the SPARQL query language available on your cluster.
GetEngineStatusResponse.Builder	sparql(QueryLanguageVersion sparql) Contains information about the SPARQL query language available on your cluster.
GetEngineStatusResponse.Builder	startTime(String startTime) Set to the UTC time at which the current server process started.
GetEngineStatusResponse.Builder	status(String status) Set to healthy if the instance is not experiencing problems.

Methods inherited from interface software.amazon.awssdk.services.neptunedata.model.NeptunedataResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

status

GetEngineStatusResponse.Builder status(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

startTime

GetEngineStatusResponse.Builder startTime(String startTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dbEngineVersion

GetEngineStatusResponse.Builder dbEngineVersion(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-.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

role

GetEngineStatusResponse.Builder role(String role)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dfeQueryEngine

GetEngineStatusResponse.Builder dfeQueryEngine(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

gremlin

GetEngineStatusResponse.Builder gremlin(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

gremlin

default GetEngineStatusResponse.Builder gremlin(Consumer<QueryLanguageVersion.Builder> 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.

This is a convenience method that creates an instance of the QueryLanguageVersion.Builder avoiding the need to create one manually via QueryLanguageVersion.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to gremlin(QueryLanguageVersion).

Parameters:

gremlin - a consumer that will call methods on QueryLanguageVersion.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

gremlin(QueryLanguageVersion)

sparql

GetEngineStatusResponse.Builder sparql(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sparql

default GetEngineStatusResponse.Builder sparql(Consumer<QueryLanguageVersion.Builder> 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.

This is a convenience method that creates an instance of the QueryLanguageVersion.Builder avoiding the need to create one manually via QueryLanguageVersion.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sparql(QueryLanguageVersion).

Parameters:

sparql - a consumer that will call methods on QueryLanguageVersion.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sparql(QueryLanguageVersion)

opencypher

GetEngineStatusResponse.Builder opencypher(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

opencypher

default GetEngineStatusResponse.Builder opencypher(Consumer<QueryLanguageVersion.Builder> 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.

This is a convenience method that creates an instance of the QueryLanguageVersion.Builder avoiding the need to create one manually via QueryLanguageVersion.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to opencypher(QueryLanguageVersion).

Parameters:

opencypher - a consumer that will call methods on QueryLanguageVersion.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

opencypher(QueryLanguageVersion)

labMode

GetEngineStatusResponse.Builder labMode(Map<String,String> labMode)

Contains Lab Mode settings being used by the engine.

Parameters:

labMode - Contains Lab Mode settings being used by the engine.

Returns:

Returns a reference to this object so that method calls can be chained together.

rollingBackTrxCount

GetEngineStatusResponse.Builder rollingBackTrxCount(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

rollingBackTrxEarliestStartTime

GetEngineStatusResponse.Builder rollingBackTrxEarliestStartTime(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

features

GetEngineStatusResponse.Builder features(Map<String,Document> features)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

settings

GetEngineStatusResponse.Builder settings(Map<String,String> settings)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.