Interface NeptuneGraphAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of graph data, invoking popular graph analytic algorithms in low-latency queries, and getting analytics results in seconds.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aNeptuneGraphAsyncClient
.cancelImportTask
(Consumer<CancelImportTaskRequest.Builder> cancelImportTaskRequest) Deletes the specified import task.cancelImportTask
(CancelImportTaskRequest cancelImportTaskRequest) Deletes the specified import task.default CompletableFuture
<CancelQueryResponse> cancelQuery
(Consumer<CancelQueryRequest.Builder> cancelQueryRequest) Cancels a specified query.default CompletableFuture
<CancelQueryResponse> cancelQuery
(CancelQueryRequest cancelQueryRequest) Cancels a specified query.static NeptuneGraphAsyncClient
create()
Create aNeptuneGraphAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateGraphResponse> createGraph
(Consumer<CreateGraphRequest.Builder> createGraphRequest) Creates a new Neptune Analytics graph.default CompletableFuture
<CreateGraphResponse> createGraph
(CreateGraphRequest createGraphRequest) Creates a new Neptune Analytics graph.createGraphSnapshot
(Consumer<CreateGraphSnapshotRequest.Builder> createGraphSnapshotRequest) Creates a snapshot of the specific graph.createGraphSnapshot
(CreateGraphSnapshotRequest createGraphSnapshotRequest) Creates a snapshot of the specific graph.createGraphUsingImportTask
(Consumer<CreateGraphUsingImportTaskRequest.Builder> createGraphUsingImportTaskRequest) Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot.createGraphUsingImportTask
(CreateGraphUsingImportTaskRequest createGraphUsingImportTaskRequest) Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot.createPrivateGraphEndpoint
(Consumer<CreatePrivateGraphEndpointRequest.Builder> createPrivateGraphEndpointRequest) Create a private graph endpoint to allow private access from to the graph from within a VPC.createPrivateGraphEndpoint
(CreatePrivateGraphEndpointRequest createPrivateGraphEndpointRequest) Create a private graph endpoint to allow private access from to the graph from within a VPC.default CompletableFuture
<DeleteGraphResponse> deleteGraph
(Consumer<DeleteGraphRequest.Builder> deleteGraphRequest) Deletes the specified graph.default CompletableFuture
<DeleteGraphResponse> deleteGraph
(DeleteGraphRequest deleteGraphRequest) Deletes the specified graph.deleteGraphSnapshot
(Consumer<DeleteGraphSnapshotRequest.Builder> deleteGraphSnapshotRequest) Deletes the specifed graph snapshot.deleteGraphSnapshot
(DeleteGraphSnapshotRequest deleteGraphSnapshotRequest) Deletes the specifed graph snapshot.deletePrivateGraphEndpoint
(Consumer<DeletePrivateGraphEndpointRequest.Builder> deletePrivateGraphEndpointRequest) Deletes a private graph endpoint.deletePrivateGraphEndpoint
(DeletePrivateGraphEndpointRequest deletePrivateGraphEndpointRequest) Deletes a private graph endpoint.default CompletableFuture
<ExecuteQueryResponse> executeQuery
(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest, Path destinationPath) Execute an openCypher query.default <ReturnT> CompletableFuture
<ReturnT> executeQuery
(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest, AsyncResponseTransformer<ExecuteQueryResponse, ReturnT> asyncResponseTransformer) Execute an openCypher query.default CompletableFuture
<ExecuteQueryResponse> executeQuery
(ExecuteQueryRequest executeQueryRequest, Path destinationPath) Execute an openCypher query.default <ReturnT> CompletableFuture
<ReturnT> executeQuery
(ExecuteQueryRequest executeQueryRequest, AsyncResponseTransformer<ExecuteQueryResponse, ReturnT> asyncResponseTransformer) Execute an openCypher query.default CompletableFuture
<GetGraphResponse> getGraph
(Consumer<GetGraphRequest.Builder> getGraphRequest) Gets information about a specified graph.default CompletableFuture
<GetGraphResponse> getGraph
(GetGraphRequest getGraphRequest) Gets information about a specified graph.getGraphSnapshot
(Consumer<GetGraphSnapshotRequest.Builder> getGraphSnapshotRequest) Retrieves a specified graph snapshot.getGraphSnapshot
(GetGraphSnapshotRequest getGraphSnapshotRequest) Retrieves a specified graph snapshot.default CompletableFuture
<GetGraphSummaryResponse> getGraphSummary
(Consumer<GetGraphSummaryRequest.Builder> getGraphSummaryRequest) Gets a graph summary for a property graph.default CompletableFuture
<GetGraphSummaryResponse> getGraphSummary
(GetGraphSummaryRequest getGraphSummaryRequest) Gets a graph summary for a property graph.default CompletableFuture
<GetImportTaskResponse> getImportTask
(Consumer<GetImportTaskRequest.Builder> getImportTaskRequest) Retrieves a specified import task.default CompletableFuture
<GetImportTaskResponse> getImportTask
(GetImportTaskRequest getImportTaskRequest) Retrieves a specified import task.getPrivateGraphEndpoint
(Consumer<GetPrivateGraphEndpointRequest.Builder> getPrivateGraphEndpointRequest) Retrieves information about a specified private endpoint.getPrivateGraphEndpoint
(GetPrivateGraphEndpointRequest getPrivateGraphEndpointRequest) Retrieves information about a specified private endpoint.default CompletableFuture
<GetQueryResponse> getQuery
(Consumer<GetQueryRequest.Builder> getQueryRequest) Retrieves the status of a specified query.default CompletableFuture
<GetQueryResponse> getQuery
(GetQueryRequest getQueryRequest) Retrieves the status of a specified query.default CompletableFuture
<ListGraphsResponse> listGraphs
(Consumer<ListGraphsRequest.Builder> listGraphsRequest) Lists available Neptune Analytics graphs.default CompletableFuture
<ListGraphsResponse> listGraphs
(ListGraphsRequest listGraphsRequest) Lists available Neptune Analytics graphs.listGraphSnapshots
(Consumer<ListGraphSnapshotsRequest.Builder> listGraphSnapshotsRequest) Lists available snapshots of a specified Neptune Analytics graph.listGraphSnapshots
(ListGraphSnapshotsRequest listGraphSnapshotsRequest) Lists available snapshots of a specified Neptune Analytics graph.default ListGraphSnapshotsPublisher
listGraphSnapshotsPaginator
(Consumer<ListGraphSnapshotsRequest.Builder> listGraphSnapshotsRequest) This is a variant oflistGraphSnapshots(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsRequest)
operation.default ListGraphSnapshotsPublisher
listGraphSnapshotsPaginator
(ListGraphSnapshotsRequest listGraphSnapshotsRequest) This is a variant oflistGraphSnapshots(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsRequest)
operation.default ListGraphsPublisher
listGraphsPaginator
(Consumer<ListGraphsRequest.Builder> listGraphsRequest) This is a variant oflistGraphs(software.amazon.awssdk.services.neptunegraph.model.ListGraphsRequest)
operation.default ListGraphsPublisher
listGraphsPaginator
(ListGraphsRequest listGraphsRequest) This is a variant oflistGraphs(software.amazon.awssdk.services.neptunegraph.model.ListGraphsRequest)
operation.default CompletableFuture
<ListImportTasksResponse> listImportTasks
(Consumer<ListImportTasksRequest.Builder> listImportTasksRequest) Lists import tasks.default CompletableFuture
<ListImportTasksResponse> listImportTasks
(ListImportTasksRequest listImportTasksRequest) Lists import tasks.default ListImportTasksPublisher
listImportTasksPaginator
(Consumer<ListImportTasksRequest.Builder> listImportTasksRequest) This is a variant oflistImportTasks(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksRequest)
operation.default ListImportTasksPublisher
listImportTasksPaginator
(ListImportTasksRequest listImportTasksRequest) This is a variant oflistImportTasks(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksRequest)
operation.listPrivateGraphEndpoints
(Consumer<ListPrivateGraphEndpointsRequest.Builder> listPrivateGraphEndpointsRequest) Lists private endpoints for a specified Neptune Analytics graph.listPrivateGraphEndpoints
(ListPrivateGraphEndpointsRequest listPrivateGraphEndpointsRequest) Lists private endpoints for a specified Neptune Analytics graph.listPrivateGraphEndpointsPaginator
(Consumer<ListPrivateGraphEndpointsRequest.Builder> listPrivateGraphEndpointsRequest) This is a variant oflistPrivateGraphEndpoints(software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsRequest)
operation.listPrivateGraphEndpointsPaginator
(ListPrivateGraphEndpointsRequest listPrivateGraphEndpointsRequest) This is a variant oflistPrivateGraphEndpoints(software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsRequest)
operation.default CompletableFuture
<ListQueriesResponse> listQueries
(Consumer<ListQueriesRequest.Builder> listQueriesRequest) Lists active openCypher queries.default CompletableFuture
<ListQueriesResponse> listQueries
(ListQueriesRequest listQueriesRequest) Lists active openCypher queries.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists tags associated with a specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags associated with a specified resource.default CompletableFuture
<ResetGraphResponse> resetGraph
(Consumer<ResetGraphRequest.Builder> resetGraphRequest) Empties the data from a specified Neptune Analytics graph.default CompletableFuture
<ResetGraphResponse> resetGraph
(ResetGraphRequest resetGraphRequest) Empties the data from a specified Neptune Analytics graph.restoreGraphFromSnapshot
(Consumer<RestoreGraphFromSnapshotRequest.Builder> restoreGraphFromSnapshotRequest) Restores a graph from a snapshot.restoreGraphFromSnapshot
(RestoreGraphFromSnapshotRequest restoreGraphFromSnapshotRequest) Restores a graph from a snapshot.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartImportTaskResponse> startImportTask
(Consumer<StartImportTaskRequest.Builder> startImportTaskRequest) Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3).default CompletableFuture
<StartImportTaskResponse> startImportTask
(StartImportTaskRequest startImportTaskRequest) Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3).default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds tags to the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds tags to the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.default CompletableFuture
<UpdateGraphResponse> updateGraph
(Consumer<UpdateGraphRequest.Builder> updateGraphRequest) Updates the configuration of a specified Neptune Analytics graphdefault CompletableFuture
<UpdateGraphResponse> updateGraph
(UpdateGraphRequest updateGraphRequest) Updates the configuration of a specified Neptune Analytics graphdefault NeptuneGraphAsyncWaiter
waiter()
Create an instance ofNeptuneGraphAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelImportTask
default CompletableFuture<CancelImportTaskResponse> cancelImportTask(CancelImportTaskRequest cancelImportTaskRequest) Deletes the specified import task.
- Parameters:
cancelImportTaskRequest
-- Returns:
- A Java Future containing the result of the CancelImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelImportTask
default CompletableFuture<CancelImportTaskResponse> cancelImportTask(Consumer<CancelImportTaskRequest.Builder> cancelImportTaskRequest) Deletes the specified import task.
This is a convenience which creates an instance of the
CancelImportTaskRequest.Builder
avoiding the need to create one manually viaCancelImportTaskRequest.builder()
- Parameters:
cancelImportTaskRequest
- AConsumer
that will call methods onCancelImportTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelQuery
Cancels a specified query.
- Parameters:
cancelQueryRequest
-- Returns:
- A Java Future containing the result of the CancelQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelQuery
default CompletableFuture<CancelQueryResponse> cancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest) Cancels a specified query.
This is a convenience which creates an instance of the
CancelQueryRequest.Builder
avoiding the need to create one manually viaCancelQueryRequest.builder()
- Parameters:
cancelQueryRequest
- AConsumer
that will call methods onCancelQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGraph
Creates a new Neptune Analytics graph.
- Parameters:
createGraphRequest
-- Returns:
- A Java Future containing the result of the CreateGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException A service quota was exceeded.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGraph
default CompletableFuture<CreateGraphResponse> createGraph(Consumer<CreateGraphRequest.Builder> createGraphRequest) Creates a new Neptune Analytics graph.
This is a convenience which creates an instance of the
CreateGraphRequest.Builder
avoiding the need to create one manually viaCreateGraphRequest.builder()
- Parameters:
createGraphRequest
- AConsumer
that will call methods onCreateGraphRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException A service quota was exceeded.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGraphSnapshot
default CompletableFuture<CreateGraphSnapshotResponse> createGraphSnapshot(CreateGraphSnapshotRequest createGraphSnapshotRequest) Creates a snapshot of the specific graph.
- Parameters:
createGraphSnapshotRequest
-- Returns:
- A Java Future containing the result of the CreateGraphSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException A service quota was exceeded.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGraphSnapshot
default CompletableFuture<CreateGraphSnapshotResponse> createGraphSnapshot(Consumer<CreateGraphSnapshotRequest.Builder> createGraphSnapshotRequest) Creates a snapshot of the specific graph.
This is a convenience which creates an instance of the
CreateGraphSnapshotRequest.Builder
avoiding the need to create one manually viaCreateGraphSnapshotRequest.builder()
- Parameters:
createGraphSnapshotRequest
- AConsumer
that will call methods onCreateGraphSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGraphSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException A service quota was exceeded.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGraphUsingImportTask
default CompletableFuture<CreateGraphUsingImportTaskResponse> createGraphUsingImportTask(CreateGraphUsingImportTaskRequest createGraphUsingImportTaskRequest) Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot.
The data can be loaded from files in S3 that in either the Gremlin CSV format or the openCypher load format.
- Parameters:
createGraphUsingImportTaskRequest
-- Returns:
- A Java Future containing the result of the CreateGraphUsingImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException A service quota was exceeded.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGraphUsingImportTask
default CompletableFuture<CreateGraphUsingImportTaskResponse> createGraphUsingImportTask(Consumer<CreateGraphUsingImportTaskRequest.Builder> createGraphUsingImportTaskRequest) Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot.
The data can be loaded from files in S3 that in either the Gremlin CSV format or the openCypher load format.
This is a convenience which creates an instance of the
CreateGraphUsingImportTaskRequest.Builder
avoiding the need to create one manually viaCreateGraphUsingImportTaskRequest.builder()
- Parameters:
createGraphUsingImportTaskRequest
- AConsumer
that will call methods onCreateGraphUsingImportTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGraphUsingImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException A service quota was exceeded.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPrivateGraphEndpoint
default CompletableFuture<CreatePrivateGraphEndpointResponse> createPrivateGraphEndpoint(CreatePrivateGraphEndpointRequest createPrivateGraphEndpointRequest) Create a private graph endpoint to allow private access from to the graph from within a VPC. You can attach security groups to the private graph endpoint.
VPC endpoint charges apply.
- Parameters:
createPrivateGraphEndpointRequest
-- Returns:
- A Java Future containing the result of the CreatePrivateGraphEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException A service quota was exceeded.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPrivateGraphEndpoint
default CompletableFuture<CreatePrivateGraphEndpointResponse> createPrivateGraphEndpoint(Consumer<CreatePrivateGraphEndpointRequest.Builder> createPrivateGraphEndpointRequest) Create a private graph endpoint to allow private access from to the graph from within a VPC. You can attach security groups to the private graph endpoint.
VPC endpoint charges apply.
This is a convenience which creates an instance of the
CreatePrivateGraphEndpointRequest.Builder
avoiding the need to create one manually viaCreatePrivateGraphEndpointRequest.builder()
- Parameters:
createPrivateGraphEndpointRequest
- AConsumer
that will call methods onCreatePrivateGraphEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePrivateGraphEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException A service quota was exceeded.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGraph
Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.
- Parameters:
deleteGraphRequest
-- Returns:
- A Java Future containing the result of the DeleteGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGraph
default CompletableFuture<DeleteGraphResponse> deleteGraph(Consumer<DeleteGraphRequest.Builder> deleteGraphRequest) Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.
This is a convenience which creates an instance of the
DeleteGraphRequest.Builder
avoiding the need to create one manually viaDeleteGraphRequest.builder()
- Parameters:
deleteGraphRequest
- AConsumer
that will call methods onDeleteGraphRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGraphSnapshot
default CompletableFuture<DeleteGraphSnapshotResponse> deleteGraphSnapshot(DeleteGraphSnapshotRequest deleteGraphSnapshotRequest) Deletes the specifed graph snapshot.
- Parameters:
deleteGraphSnapshotRequest
-- Returns:
- A Java Future containing the result of the DeleteGraphSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGraphSnapshot
default CompletableFuture<DeleteGraphSnapshotResponse> deleteGraphSnapshot(Consumer<DeleteGraphSnapshotRequest.Builder> deleteGraphSnapshotRequest) Deletes the specifed graph snapshot.
This is a convenience which creates an instance of the
DeleteGraphSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteGraphSnapshotRequest.builder()
- Parameters:
deleteGraphSnapshotRequest
- AConsumer
that will call methods onDeleteGraphSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGraphSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePrivateGraphEndpoint
default CompletableFuture<DeletePrivateGraphEndpointResponse> deletePrivateGraphEndpoint(DeletePrivateGraphEndpointRequest deletePrivateGraphEndpointRequest) Deletes a private graph endpoint.
- Parameters:
deletePrivateGraphEndpointRequest
-- Returns:
- A Java Future containing the result of the DeletePrivateGraphEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePrivateGraphEndpoint
default CompletableFuture<DeletePrivateGraphEndpointResponse> deletePrivateGraphEndpoint(Consumer<DeletePrivateGraphEndpointRequest.Builder> deletePrivateGraphEndpointRequest) Deletes a private graph endpoint.
This is a convenience which creates an instance of the
DeletePrivateGraphEndpointRequest.Builder
avoiding the need to create one manually viaDeletePrivateGraphEndpointRequest.builder()
- Parameters:
deletePrivateGraphEndpointRequest
- AConsumer
that will call methods onDeletePrivateGraphEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePrivateGraphEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
executeQuery
default <ReturnT> CompletableFuture<ReturnT> executeQuery(ExecuteQueryRequest executeQueryRequest, AsyncResponseTransformer<ExecuteQueryResponse, ReturnT> asyncResponseTransformer) Execute an openCypher query.
When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:
-
neptune-graph:ReadDataViaQuery
-
neptune-graph:WriteDataViaQuery
-
neptune-graph:DeleteDataViaQuery
- Parameters:
executeQueryRequest
-asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformer
for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The query results.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnprocessableException Request cannot be processed due to known reasons. Eg. partition full.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
executeQuery
default <ReturnT> CompletableFuture<ReturnT> executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest, AsyncResponseTransformer<ExecuteQueryResponse, ReturnT> asyncResponseTransformer) Execute an openCypher query.
When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:
-
neptune-graph:ReadDataViaQuery
-
neptune-graph:WriteDataViaQuery
-
neptune-graph:DeleteDataViaQuery
This is a convenience which creates an instance of the
ExecuteQueryRequest.Builder
avoiding the need to create one manually viaExecuteQueryRequest.builder()
- Parameters:
executeQueryRequest
- AConsumer
that will call methods onExecuteQueryRequest.Builder
to create a request.asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformer
for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The query results.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnprocessableException Request cannot be processed due to known reasons. Eg. partition full.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
executeQuery
default CompletableFuture<ExecuteQueryResponse> executeQuery(ExecuteQueryRequest executeQueryRequest, Path destinationPath) Execute an openCypher query.
When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:
-
neptune-graph:ReadDataViaQuery
-
neptune-graph:WriteDataViaQuery
-
neptune-graph:DeleteDataViaQuery
- Parameters:
executeQueryRequest
-destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The query results.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnprocessableException Request cannot be processed due to known reasons. Eg. partition full.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
executeQuery
default CompletableFuture<ExecuteQueryResponse> executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest, Path destinationPath) Execute an openCypher query.
When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:
-
neptune-graph:ReadDataViaQuery
-
neptune-graph:WriteDataViaQuery
-
neptune-graph:DeleteDataViaQuery
This is a convenience which creates an instance of the
ExecuteQueryRequest.Builder
avoiding the need to create one manually viaExecuteQueryRequest.builder()
- Parameters:
executeQueryRequest
- AConsumer
that will call methods onExecuteQueryRequest.Builder
to create a request.destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The query results.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnprocessableException Request cannot be processed due to known reasons. Eg. partition full.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getGraph
Gets information about a specified graph.
- Parameters:
getGraphRequest
-- Returns:
- A Java Future containing the result of the GetGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGraph
default CompletableFuture<GetGraphResponse> getGraph(Consumer<GetGraphRequest.Builder> getGraphRequest) Gets information about a specified graph.
This is a convenience which creates an instance of the
GetGraphRequest.Builder
avoiding the need to create one manually viaGetGraphRequest.builder()
- Parameters:
getGraphRequest
- AConsumer
that will call methods onGetGraphRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGraphSnapshot
default CompletableFuture<GetGraphSnapshotResponse> getGraphSnapshot(GetGraphSnapshotRequest getGraphSnapshotRequest) Retrieves a specified graph snapshot.
- Parameters:
getGraphSnapshotRequest
-- Returns:
- A Java Future containing the result of the GetGraphSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGraphSnapshot
default CompletableFuture<GetGraphSnapshotResponse> getGraphSnapshot(Consumer<GetGraphSnapshotRequest.Builder> getGraphSnapshotRequest) Retrieves a specified graph snapshot.
This is a convenience which creates an instance of the
GetGraphSnapshotRequest.Builder
avoiding the need to create one manually viaGetGraphSnapshotRequest.builder()
- Parameters:
getGraphSnapshotRequest
- AConsumer
that will call methods onGetGraphSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGraphSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGraphSummary
default CompletableFuture<GetGraphSummaryResponse> getGraphSummary(GetGraphSummaryRequest getGraphSummaryRequest) Gets a graph summary for a property graph.
- Parameters:
getGraphSummaryRequest
-- Returns:
- A Java Future containing the result of the GetGraphSummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGraphSummary
default CompletableFuture<GetGraphSummaryResponse> getGraphSummary(Consumer<GetGraphSummaryRequest.Builder> getGraphSummaryRequest) Gets a graph summary for a property graph.
This is a convenience which creates an instance of the
GetGraphSummaryRequest.Builder
avoiding the need to create one manually viaGetGraphSummaryRequest.builder()
- Parameters:
getGraphSummaryRequest
- AConsumer
that will call methods onGetGraphSummaryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGraphSummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImportTask
default CompletableFuture<GetImportTaskResponse> getImportTask(GetImportTaskRequest getImportTaskRequest) Retrieves a specified import task.
- Parameters:
getImportTaskRequest
-- Returns:
- A Java Future containing the result of the GetImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImportTask
default CompletableFuture<GetImportTaskResponse> getImportTask(Consumer<GetImportTaskRequest.Builder> getImportTaskRequest) Retrieves a specified import task.
This is a convenience which creates an instance of the
GetImportTaskRequest.Builder
avoiding the need to create one manually viaGetImportTaskRequest.builder()
- Parameters:
getImportTaskRequest
- AConsumer
that will call methods onGetImportTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPrivateGraphEndpoint
default CompletableFuture<GetPrivateGraphEndpointResponse> getPrivateGraphEndpoint(GetPrivateGraphEndpointRequest getPrivateGraphEndpointRequest) Retrieves information about a specified private endpoint.
- Parameters:
getPrivateGraphEndpointRequest
-- Returns:
- A Java Future containing the result of the GetPrivateGraphEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPrivateGraphEndpoint
default CompletableFuture<GetPrivateGraphEndpointResponse> getPrivateGraphEndpoint(Consumer<GetPrivateGraphEndpointRequest.Builder> getPrivateGraphEndpointRequest) Retrieves information about a specified private endpoint.
This is a convenience which creates an instance of the
GetPrivateGraphEndpointRequest.Builder
avoiding the need to create one manually viaGetPrivateGraphEndpointRequest.builder()
- Parameters:
getPrivateGraphEndpointRequest
- AConsumer
that will call methods onGetPrivateGraphEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPrivateGraphEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQuery
Retrieves the status of a specified query.
When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the
neptune-graph:GetQueryStatus
IAM action attached.- Parameters:
getQueryRequest
-- Returns:
- A Java Future containing the result of the GetQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQuery
default CompletableFuture<GetQueryResponse> getQuery(Consumer<GetQueryRequest.Builder> getQueryRequest) Retrieves the status of a specified query.
When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the
neptune-graph:GetQueryStatus
IAM action attached.
This is a convenience which creates an instance of the
GetQueryRequest.Builder
avoiding the need to create one manually viaGetQueryRequest.builder()
- Parameters:
getQueryRequest
- AConsumer
that will call methods onGetQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGraphSnapshots
default CompletableFuture<ListGraphSnapshotsResponse> listGraphSnapshots(ListGraphSnapshotsRequest listGraphSnapshotsRequest) Lists available snapshots of a specified Neptune Analytics graph.
- Parameters:
listGraphSnapshotsRequest
-- Returns:
- A Java Future containing the result of the ListGraphSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGraphSnapshots
default CompletableFuture<ListGraphSnapshotsResponse> listGraphSnapshots(Consumer<ListGraphSnapshotsRequest.Builder> listGraphSnapshotsRequest) Lists available snapshots of a specified Neptune Analytics graph.
This is a convenience which creates an instance of the
ListGraphSnapshotsRequest.Builder
avoiding the need to create one manually viaListGraphSnapshotsRequest.builder()
- Parameters:
listGraphSnapshotsRequest
- AConsumer
that will call methods onListGraphSnapshotsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGraphSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGraphSnapshotsPaginator
default ListGraphSnapshotsPublisher listGraphSnapshotsPaginator(ListGraphSnapshotsRequest listGraphSnapshotsRequest) This is a variant of
listGraphSnapshots(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphSnapshotsPublisher publisher = client.listGraphSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptunegraph.paginators.ListGraphSnapshotsPublisher publisher = client.listGraphSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGraphSnapshots(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsRequest)
operation.- Parameters:
listGraphSnapshotsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGraphSnapshotsPaginator
default ListGraphSnapshotsPublisher listGraphSnapshotsPaginator(Consumer<ListGraphSnapshotsRequest.Builder> listGraphSnapshotsRequest) This is a variant of
listGraphSnapshots(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphSnapshotsPublisher publisher = client.listGraphSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptunegraph.paginators.ListGraphSnapshotsPublisher publisher = client.listGraphSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGraphSnapshots(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsRequest)
operation.
This is a convenience which creates an instance of the
ListGraphSnapshotsRequest.Builder
avoiding the need to create one manually viaListGraphSnapshotsRequest.builder()
- Parameters:
listGraphSnapshotsRequest
- AConsumer
that will call methods onListGraphSnapshotsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGraphs
Lists available Neptune Analytics graphs.
- Parameters:
listGraphsRequest
-- Returns:
- A Java Future containing the result of the ListGraphs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGraphs
default CompletableFuture<ListGraphsResponse> listGraphs(Consumer<ListGraphsRequest.Builder> listGraphsRequest) Lists available Neptune Analytics graphs.
This is a convenience which creates an instance of the
ListGraphsRequest.Builder
avoiding the need to create one manually viaListGraphsRequest.builder()
- Parameters:
listGraphsRequest
- AConsumer
that will call methods onListGraphsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGraphs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGraphsPaginator
This is a variant of
listGraphs(software.amazon.awssdk.services.neptunegraph.model.ListGraphsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphsPublisher publisher = client.listGraphsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptunegraph.paginators.ListGraphsPublisher publisher = client.listGraphsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptunegraph.model.ListGraphsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptunegraph.model.ListGraphsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGraphs(software.amazon.awssdk.services.neptunegraph.model.ListGraphsRequest)
operation.- Parameters:
listGraphsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGraphsPaginator
default ListGraphsPublisher listGraphsPaginator(Consumer<ListGraphsRequest.Builder> listGraphsRequest) This is a variant of
listGraphs(software.amazon.awssdk.services.neptunegraph.model.ListGraphsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphsPublisher publisher = client.listGraphsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptunegraph.paginators.ListGraphsPublisher publisher = client.listGraphsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptunegraph.model.ListGraphsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptunegraph.model.ListGraphsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGraphs(software.amazon.awssdk.services.neptunegraph.model.ListGraphsRequest)
operation.
This is a convenience which creates an instance of the
ListGraphsRequest.Builder
avoiding the need to create one manually viaListGraphsRequest.builder()
- Parameters:
listGraphsRequest
- AConsumer
that will call methods onListGraphsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportTasks
default CompletableFuture<ListImportTasksResponse> listImportTasks(ListImportTasksRequest listImportTasksRequest) Lists import tasks.
- Parameters:
listImportTasksRequest
-- Returns:
- A Java Future containing the result of the ListImportTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportTasks
default CompletableFuture<ListImportTasksResponse> listImportTasks(Consumer<ListImportTasksRequest.Builder> listImportTasksRequest) Lists import tasks.
This is a convenience which creates an instance of the
ListImportTasksRequest.Builder
avoiding the need to create one manually viaListImportTasksRequest.builder()
- Parameters:
listImportTasksRequest
- AConsumer
that will call methods onListImportTasksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListImportTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportTasksPaginator
default ListImportTasksPublisher listImportTasksPaginator(ListImportTasksRequest listImportTasksRequest) This is a variant of
listImportTasks(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptunegraph.paginators.ListImportTasksPublisher publisher = client.listImportTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptunegraph.paginators.ListImportTasksPublisher publisher = client.listImportTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptunegraph.model.ListImportTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportTasks(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksRequest)
operation.- Parameters:
listImportTasksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportTasksPaginator
default ListImportTasksPublisher listImportTasksPaginator(Consumer<ListImportTasksRequest.Builder> listImportTasksRequest) This is a variant of
listImportTasks(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptunegraph.paginators.ListImportTasksPublisher publisher = client.listImportTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptunegraph.paginators.ListImportTasksPublisher publisher = client.listImportTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptunegraph.model.ListImportTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportTasks(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksRequest)
operation.
This is a convenience which creates an instance of the
ListImportTasksRequest.Builder
avoiding the need to create one manually viaListImportTasksRequest.builder()
- Parameters:
listImportTasksRequest
- AConsumer
that will call methods onListImportTasksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPrivateGraphEndpoints
default CompletableFuture<ListPrivateGraphEndpointsResponse> listPrivateGraphEndpoints(ListPrivateGraphEndpointsRequest listPrivateGraphEndpointsRequest) Lists private endpoints for a specified Neptune Analytics graph.
- Parameters:
listPrivateGraphEndpointsRequest
-- Returns:
- A Java Future containing the result of the ListPrivateGraphEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPrivateGraphEndpoints
default CompletableFuture<ListPrivateGraphEndpointsResponse> listPrivateGraphEndpoints(Consumer<ListPrivateGraphEndpointsRequest.Builder> listPrivateGraphEndpointsRequest) Lists private endpoints for a specified Neptune Analytics graph.
This is a convenience which creates an instance of the
ListPrivateGraphEndpointsRequest.Builder
avoiding the need to create one manually viaListPrivateGraphEndpointsRequest.builder()
- Parameters:
listPrivateGraphEndpointsRequest
- AConsumer
that will call methods onListPrivateGraphEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPrivateGraphEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPrivateGraphEndpointsPaginator
default ListPrivateGraphEndpointsPublisher listPrivateGraphEndpointsPaginator(ListPrivateGraphEndpointsRequest listPrivateGraphEndpointsRequest) This is a variant of
listPrivateGraphEndpoints(software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptunegraph.paginators.ListPrivateGraphEndpointsPublisher publisher = client.listPrivateGraphEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptunegraph.paginators.ListPrivateGraphEndpointsPublisher publisher = client.listPrivateGraphEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrivateGraphEndpoints(software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsRequest)
operation.- Parameters:
listPrivateGraphEndpointsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPrivateGraphEndpointsPaginator
default ListPrivateGraphEndpointsPublisher listPrivateGraphEndpointsPaginator(Consumer<ListPrivateGraphEndpointsRequest.Builder> listPrivateGraphEndpointsRequest) This is a variant of
listPrivateGraphEndpoints(software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.neptunegraph.paginators.ListPrivateGraphEndpointsPublisher publisher = client.listPrivateGraphEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.neptunegraph.paginators.ListPrivateGraphEndpointsPublisher publisher = client.listPrivateGraphEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrivateGraphEndpoints(software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsRequest)
operation.
This is a convenience which creates an instance of the
ListPrivateGraphEndpointsRequest.Builder
avoiding the need to create one manually viaListPrivateGraphEndpointsRequest.builder()
- Parameters:
listPrivateGraphEndpointsRequest
- AConsumer
that will call methods onListPrivateGraphEndpointsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueries
Lists active openCypher queries.
- Parameters:
listQueriesRequest
-- Returns:
- A Java Future containing the result of the ListQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueries
default CompletableFuture<ListQueriesResponse> listQueries(Consumer<ListQueriesRequest.Builder> listQueriesRequest) Lists active openCypher queries.
This is a convenience which creates an instance of the
ListQueriesRequest.Builder
avoiding the need to create one manually viaListQueriesRequest.builder()
- Parameters:
listQueriesRequest
- AConsumer
that will call methods onListQueriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- AccessDeniedException Raised in case of an authentication or authorization failure.
- InternalServerException A failure occurred on the server.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags associated with a specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists tags associated with a specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetGraph
Empties the data from a specified Neptune Analytics graph.
- Parameters:
resetGraphRequest
-- Returns:
- A Java Future containing the result of the ResetGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetGraph
default CompletableFuture<ResetGraphResponse> resetGraph(Consumer<ResetGraphRequest.Builder> resetGraphRequest) Empties the data from a specified Neptune Analytics graph.
This is a convenience which creates an instance of the
ResetGraphRequest.Builder
avoiding the need to create one manually viaResetGraphRequest.builder()
- Parameters:
resetGraphRequest
- AConsumer
that will call methods onResetGraphRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreGraphFromSnapshot
default CompletableFuture<RestoreGraphFromSnapshotResponse> restoreGraphFromSnapshot(RestoreGraphFromSnapshotRequest restoreGraphFromSnapshotRequest) Restores a graph from a snapshot.
- Parameters:
restoreGraphFromSnapshotRequest
-- Returns:
- A Java Future containing the result of the RestoreGraphFromSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException A service quota was exceeded.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreGraphFromSnapshot
default CompletableFuture<RestoreGraphFromSnapshotResponse> restoreGraphFromSnapshot(Consumer<RestoreGraphFromSnapshotRequest.Builder> restoreGraphFromSnapshotRequest) Restores a graph from a snapshot.
This is a convenience which creates an instance of the
RestoreGraphFromSnapshotRequest.Builder
avoiding the need to create one manually viaRestoreGraphFromSnapshotRequest.builder()
- Parameters:
restoreGraphFromSnapshotRequest
- AConsumer
that will call methods onRestoreGraphFromSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreGraphFromSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException A service quota was exceeded.
- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startImportTask
default CompletableFuture<StartImportTaskResponse> startImportTask(StartImportTaskRequest startImportTaskRequest) Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3). The graph needs to be empty and in the AVAILABLE state.
- Parameters:
startImportTaskRequest
-- Returns:
- A Java Future containing the result of the StartImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startImportTask
default CompletableFuture<StartImportTaskResponse> startImportTask(Consumer<StartImportTaskRequest.Builder> startImportTaskRequest) Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3). The graph needs to be empty and in the AVAILABLE state.
This is a convenience which creates an instance of the
StartImportTaskRequest.Builder
avoiding the need to create one manually viaStartImportTaskRequest.builder()
- Parameters:
startImportTaskRequest
- AConsumer
that will call methods onStartImportTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds tags to the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds tags to the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGraph
Updates the configuration of a specified Neptune Analytics graph
- Parameters:
updateGraphRequest
-- Returns:
- A Java Future containing the result of the UpdateGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGraph
default CompletableFuture<UpdateGraphResponse> updateGraph(Consumer<UpdateGraphRequest.Builder> updateGraphRequest) Updates the configuration of a specified Neptune Analytics graph
This is a convenience which creates an instance of the
UpdateGraphRequest.Builder
avoiding the need to create one manually viaUpdateGraphRequest.builder()
- Parameters:
updateGraphRequest
- AConsumer
that will call methods onUpdateGraphRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The exception was interrupted by throttling.
- ValidationException A resource could not be validated.
- ConflictException Raised when a conflict is encountered.
- InternalServerException A failure occurred on the server.
- ResourceNotFoundException A specified resource could not be located.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- NeptuneGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofNeptuneGraphAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
NeptuneGraphAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aNeptuneGraphAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aNeptuneGraphAsyncClient
.
-