Interface GetEngineStatusResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetEngineStatusResponse.Builder,
,GetEngineStatusResponse> NeptunedataResponse.Builder
,SdkBuilder<GetEngineStatusResponse.Builder,
,GetEngineStatusResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetEngineStatusResponse
-
Method Summary
Modifier and TypeMethodDescriptiondbEngineVersion
(String dbEngineVersion) Set to the Neptune engine version running on your DB cluster.dfeQueryEngine
(String dfeQueryEngine) Set toenabled
if the DFE engine is fully enabled, or toviaQueryHint
(the default) if the DFE engine is only used with queries that have theuseDFE
query hint set totrue
.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.gremlin
(QueryLanguageVersion gremlin) Contains information about the Gremlin query language available on your cluster.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.opencypher
(QueryLanguageVersion opencypher) Contains information about the openCypher query language available on your cluster.Set toreader
if the instance is a read-replica, or towriter
if the instance is the primary instance.rollingBackTrxCount
(Integer rollingBackTrxCount) If there are transactions being rolled back, this field is set to the number of such transactions.rollingBackTrxEarliestStartTime
(String rollingBackTrxEarliestStartTime) Set to the start time of the earliest transaction being rolled back.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.sparql
(QueryLanguageVersion sparql) Contains information about the SPARQL query language available on your cluster.Set to the UTC time at which the current server process started.Set tohealthy
if the instance is not experiencing problems.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.neptunedata.model.NeptunedataResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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 torecovery
.- Parameters:
status
- Set tohealthy
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 torecovery
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 byPatch-
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
role
Set to
reader
if the instance is a read-replica, or towriter
if the instance is the primary instance.- Parameters:
role
- Set toreader
if the instance is a read-replica, or towriter
if the instance is the primary instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dfeQueryEngine
Set to
enabled
if the DFE engine is fully enabled, or toviaQueryHint
(the default) if the DFE engine is only used with queries that have theuseDFE
query hint set totrue
.- Parameters:
dfeQueryEngine
- Set toenabled
if the DFE engine is fully enabled, or toviaQueryHint
(the default) if the DFE engine is only used with queries that have theuseDFE
query hint set totrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 theQueryLanguageVersion.Builder
avoiding the need to create one manually viaQueryLanguageVersion.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togremlin(QueryLanguageVersion)
.- Parameters:
gremlin
- a consumer that will call methods onQueryLanguageVersion.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theQueryLanguageVersion.Builder
avoiding the need to create one manually viaQueryLanguageVersion.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosparql(QueryLanguageVersion)
.- Parameters:
sparql
- a consumer that will call methods onQueryLanguageVersion.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theQueryLanguageVersion.Builder
avoiding the need to create one manually viaQueryLanguageVersion.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toopencypher(QueryLanguageVersion)
.- Parameters:
opencypher
- a consumer that will call methods onQueryLanguageVersion.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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.
-