Interface NeptuneGraphClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 TypeMethodDescriptionstatic NeptuneGraphClientBuilder
builder()
Create a builder that can be used to configure and create aNeptuneGraphClient
.default CancelImportTaskResponse
cancelImportTask
(Consumer<CancelImportTaskRequest.Builder> cancelImportTaskRequest) Deletes the specified import task.default CancelImportTaskResponse
cancelImportTask
(CancelImportTaskRequest cancelImportTaskRequest) Deletes the specified import task.default CancelQueryResponse
cancelQuery
(Consumer<CancelQueryRequest.Builder> cancelQueryRequest) Cancels a specified query.default CancelQueryResponse
cancelQuery
(CancelQueryRequest cancelQueryRequest) Cancels a specified query.static NeptuneGraphClient
create()
Create aNeptuneGraphClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateGraphResponse
createGraph
(Consumer<CreateGraphRequest.Builder> createGraphRequest) Creates a new Neptune Analytics graph.default CreateGraphResponse
createGraph
(CreateGraphRequest createGraphRequest) Creates a new Neptune Analytics graph.default CreateGraphSnapshotResponse
createGraphSnapshot
(Consumer<CreateGraphSnapshotRequest.Builder> createGraphSnapshotRequest) Creates a snapshot of the specific graph.default CreateGraphSnapshotResponse
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 DeleteGraphResponse
deleteGraph
(Consumer<DeleteGraphRequest.Builder> deleteGraphRequest) Deletes the specified graph.default DeleteGraphResponse
deleteGraph
(DeleteGraphRequest deleteGraphRequest) Deletes the specified graph.default DeleteGraphSnapshotResponse
deleteGraphSnapshot
(Consumer<DeleteGraphSnapshotRequest.Builder> deleteGraphSnapshotRequest) Deletes the specifed graph snapshot.default DeleteGraphSnapshotResponse
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 ResponseInputStream
<ExecuteQueryResponse> executeQuery
(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest) Execute an openCypher query.default ExecuteQueryResponse
executeQuery
(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest, Path destinationPath) Execute an openCypher query.default <ReturnT> ReturnT
executeQuery
(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest, ResponseTransformer<ExecuteQueryResponse, ReturnT> responseTransformer) Execute an openCypher query.default ResponseInputStream
<ExecuteQueryResponse> executeQuery
(ExecuteQueryRequest executeQueryRequest) Execute an openCypher query.default ExecuteQueryResponse
executeQuery
(ExecuteQueryRequest executeQueryRequest, Path destinationPath) Execute an openCypher query.default <ReturnT> ReturnT
executeQuery
(ExecuteQueryRequest executeQueryRequest, ResponseTransformer<ExecuteQueryResponse, ReturnT> responseTransformer) Execute an openCypher query.default ResponseBytes
<ExecuteQueryResponse> executeQueryAsBytes
(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest) Execute an openCypher query.default ResponseBytes
<ExecuteQueryResponse> executeQueryAsBytes
(ExecuteQueryRequest executeQueryRequest) Execute an openCypher query.default GetGraphResponse
getGraph
(Consumer<GetGraphRequest.Builder> getGraphRequest) Gets information about a specified graph.default GetGraphResponse
getGraph
(GetGraphRequest getGraphRequest) Gets information about a specified graph.default GetGraphSnapshotResponse
getGraphSnapshot
(Consumer<GetGraphSnapshotRequest.Builder> getGraphSnapshotRequest) Retrieves a specified graph snapshot.default GetGraphSnapshotResponse
getGraphSnapshot
(GetGraphSnapshotRequest getGraphSnapshotRequest) Retrieves a specified graph snapshot.default GetGraphSummaryResponse
getGraphSummary
(Consumer<GetGraphSummaryRequest.Builder> getGraphSummaryRequest) Gets a graph summary for a property graph.default GetGraphSummaryResponse
getGraphSummary
(GetGraphSummaryRequest getGraphSummaryRequest) Gets a graph summary for a property graph.default GetImportTaskResponse
getImportTask
(Consumer<GetImportTaskRequest.Builder> getImportTaskRequest) Retrieves a specified import task.default GetImportTaskResponse
getImportTask
(GetImportTaskRequest getImportTaskRequest) Retrieves a specified import task.default GetPrivateGraphEndpointResponse
getPrivateGraphEndpoint
(Consumer<GetPrivateGraphEndpointRequest.Builder> getPrivateGraphEndpointRequest) Retrieves information about a specified private endpoint.default GetPrivateGraphEndpointResponse
getPrivateGraphEndpoint
(GetPrivateGraphEndpointRequest getPrivateGraphEndpointRequest) Retrieves information about a specified private endpoint.default GetQueryResponse
getQuery
(Consumer<GetQueryRequest.Builder> getQueryRequest) Retrieves the status of a specified query.default GetQueryResponse
getQuery
(GetQueryRequest getQueryRequest) Retrieves the status of a specified query.default ListGraphsResponse
listGraphs
(Consumer<ListGraphsRequest.Builder> listGraphsRequest) Lists available Neptune Analytics graphs.default ListGraphsResponse
listGraphs
(ListGraphsRequest listGraphsRequest) Lists available Neptune Analytics graphs.default ListGraphSnapshotsResponse
listGraphSnapshots
(Consumer<ListGraphSnapshotsRequest.Builder> listGraphSnapshotsRequest) Lists available snapshots of a specified Neptune Analytics graph.default ListGraphSnapshotsResponse
listGraphSnapshots
(ListGraphSnapshotsRequest listGraphSnapshotsRequest) Lists available snapshots of a specified Neptune Analytics graph.default ListGraphSnapshotsIterable
listGraphSnapshotsPaginator
(Consumer<ListGraphSnapshotsRequest.Builder> listGraphSnapshotsRequest) This is a variant oflistGraphSnapshots(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsRequest)
operation.default ListGraphSnapshotsIterable
listGraphSnapshotsPaginator
(ListGraphSnapshotsRequest listGraphSnapshotsRequest) This is a variant oflistGraphSnapshots(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsRequest)
operation.default ListGraphsIterable
listGraphsPaginator
(Consumer<ListGraphsRequest.Builder> listGraphsRequest) This is a variant oflistGraphs(software.amazon.awssdk.services.neptunegraph.model.ListGraphsRequest)
operation.default ListGraphsIterable
listGraphsPaginator
(ListGraphsRequest listGraphsRequest) This is a variant oflistGraphs(software.amazon.awssdk.services.neptunegraph.model.ListGraphsRequest)
operation.default ListImportTasksResponse
listImportTasks
(Consumer<ListImportTasksRequest.Builder> listImportTasksRequest) Lists import tasks.default ListImportTasksResponse
listImportTasks
(ListImportTasksRequest listImportTasksRequest) Lists import tasks.default ListImportTasksIterable
listImportTasksPaginator
(Consumer<ListImportTasksRequest.Builder> listImportTasksRequest) This is a variant oflistImportTasks(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksRequest)
operation.default ListImportTasksIterable
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 ListQueriesResponse
listQueries
(Consumer<ListQueriesRequest.Builder> listQueriesRequest) Lists active openCypher queries.default ListQueriesResponse
listQueries
(ListQueriesRequest listQueriesRequest) Lists active openCypher queries.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists tags associated with a specified resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags associated with a specified resource.default ResetGraphResponse
resetGraph
(Consumer<ResetGraphRequest.Builder> resetGraphRequest) Empties the data from a specified Neptune Analytics graph.default ResetGraphResponse
resetGraph
(ResetGraphRequest resetGraphRequest) Empties the data from a specified Neptune Analytics graph.default RestoreGraphFromSnapshotResponse
restoreGraphFromSnapshot
(Consumer<RestoreGraphFromSnapshotRequest.Builder> restoreGraphFromSnapshotRequest) Restores a graph from a snapshot.default RestoreGraphFromSnapshotResponse
restoreGraphFromSnapshot
(RestoreGraphFromSnapshotRequest restoreGraphFromSnapshotRequest) Restores a graph from a snapshot.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartImportTaskResponse
startImportTask
(Consumer<StartImportTaskRequest.Builder> startImportTaskRequest) Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3).default StartImportTaskResponse
startImportTask
(StartImportTaskRequest startImportTaskRequest) Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3).default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds tags to the specified resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds tags to the specified resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.default UpdateGraphResponse
updateGraph
(Consumer<UpdateGraphRequest.Builder> updateGraphRequest) Updates the configuration of a specified Neptune Analytics graphdefault UpdateGraphResponse
updateGraph
(UpdateGraphRequest updateGraphRequest) Updates the configuration of a specified Neptune Analytics graphdefault NeptuneGraphWaiter
waiter()
Create an instance ofNeptuneGraphWaiter
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 CancelImportTaskResponse cancelImportTask(CancelImportTaskRequest cancelImportTaskRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Deletes the specified import task.
- Parameters:
cancelImportTaskRequest
-- Returns:
- Result of the CancelImportTask operation returned by the service.
- See Also:
-
cancelImportTask
default CancelImportTaskResponse cancelImportTask(Consumer<CancelImportTaskRequest.Builder> cancelImportTaskRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the CancelImportTask operation returned by the service.
- See Also:
-
cancelQuery
default CancelQueryResponse cancelQuery(CancelQueryRequest cancelQueryRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Cancels a specified query.
- Parameters:
cancelQueryRequest
-- Returns:
- Result of the CancelQuery operation returned by the service.
- See Also:
-
cancelQuery
default CancelQueryResponse cancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the CancelQuery operation returned by the service.
- See Also:
-
createGraph
default CreateGraphResponse createGraph(CreateGraphRequest createGraphRequest) throws ServiceQuotaExceededException, ThrottlingException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException Creates a new Neptune Analytics graph.
- Parameters:
createGraphRequest
-- Returns:
- Result of the CreateGraph operation returned by the service.
- See Also:
-
createGraph
default CreateGraphResponse createGraph(Consumer<CreateGraphRequest.Builder> createGraphRequest) throws ServiceQuotaExceededException, ThrottlingException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the CreateGraph operation returned by the service.
- See Also:
-
createGraphSnapshot
default CreateGraphSnapshotResponse createGraphSnapshot(CreateGraphSnapshotRequest createGraphSnapshotRequest) throws ServiceQuotaExceededException, ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Creates a snapshot of the specific graph.
- Parameters:
createGraphSnapshotRequest
-- Returns:
- Result of the CreateGraphSnapshot operation returned by the service.
- See Also:
-
createGraphSnapshot
default CreateGraphSnapshotResponse createGraphSnapshot(Consumer<CreateGraphSnapshotRequest.Builder> createGraphSnapshotRequest) throws ServiceQuotaExceededException, ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the CreateGraphSnapshot operation returned by the service.
- See Also:
-
createGraphUsingImportTask
default CreateGraphUsingImportTaskResponse createGraphUsingImportTask(CreateGraphUsingImportTaskRequest createGraphUsingImportTaskRequest) throws ServiceQuotaExceededException, ThrottlingException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the CreateGraphUsingImportTask operation returned by the service.
- See Also:
-
createGraphUsingImportTask
default CreateGraphUsingImportTaskResponse createGraphUsingImportTask(Consumer<CreateGraphUsingImportTaskRequest.Builder> createGraphUsingImportTaskRequest) throws ServiceQuotaExceededException, ThrottlingException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the CreateGraphUsingImportTask operation returned by the service.
- See Also:
-
createPrivateGraphEndpoint
default CreatePrivateGraphEndpointResponse createPrivateGraphEndpoint(CreatePrivateGraphEndpointRequest createPrivateGraphEndpointRequest) throws ServiceQuotaExceededException, ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the CreatePrivateGraphEndpoint operation returned by the service.
- See Also:
-
createPrivateGraphEndpoint
default CreatePrivateGraphEndpointResponse createPrivateGraphEndpoint(Consumer<CreatePrivateGraphEndpointRequest.Builder> createPrivateGraphEndpointRequest) throws ServiceQuotaExceededException, ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the CreatePrivateGraphEndpoint operation returned by the service.
- See Also:
-
deleteGraph
default DeleteGraphResponse deleteGraph(DeleteGraphRequest deleteGraphRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.
- Parameters:
deleteGraphRequest
-- Returns:
- Result of the DeleteGraph operation returned by the service.
- See Also:
-
deleteGraph
default DeleteGraphResponse deleteGraph(Consumer<DeleteGraphRequest.Builder> deleteGraphRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the DeleteGraph operation returned by the service.
- See Also:
-
deleteGraphSnapshot
default DeleteGraphSnapshotResponse deleteGraphSnapshot(DeleteGraphSnapshotRequest deleteGraphSnapshotRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Deletes the specifed graph snapshot.
- Parameters:
deleteGraphSnapshotRequest
-- Returns:
- Result of the DeleteGraphSnapshot operation returned by the service.
- See Also:
-
deleteGraphSnapshot
default DeleteGraphSnapshotResponse deleteGraphSnapshot(Consumer<DeleteGraphSnapshotRequest.Builder> deleteGraphSnapshotRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the DeleteGraphSnapshot operation returned by the service.
- See Also:
-
deletePrivateGraphEndpoint
default DeletePrivateGraphEndpointResponse deletePrivateGraphEndpoint(DeletePrivateGraphEndpointRequest deletePrivateGraphEndpointRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Deletes a private graph endpoint.
- Parameters:
deletePrivateGraphEndpointRequest
-- Returns:
- Result of the DeletePrivateGraphEndpoint operation returned by the service.
- See Also:
-
deletePrivateGraphEndpoint
default DeletePrivateGraphEndpointResponse deletePrivateGraphEndpoint(Consumer<DeletePrivateGraphEndpointRequest.Builder> deletePrivateGraphEndpointRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the DeletePrivateGraphEndpoint operation returned by the service.
- See Also:
-
executeQuery
default <ReturnT> ReturnT executeQuery(ExecuteQueryRequest executeQueryRequest, ResponseTransformer<ExecuteQueryResponse, ReturnT> responseTransformer) throws UnprocessableException, ThrottlingException, ValidationException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphExceptionExecute 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
-responseTransformer
- Functional interface for processing the streamed response content. The unmarshalled ExecuteQueryResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. SeeResponseTransformer
for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The query results.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
-
executeQuery
default <ReturnT> ReturnT executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest, ResponseTransformer<ExecuteQueryResponse, ReturnT> responseTransformer) throws UnprocessableException, ThrottlingException, ValidationException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphExceptionExecute 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.responseTransformer
- Functional interface for processing the streamed response content. The unmarshalled ExecuteQueryResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. SeeResponseTransformer
for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The query results.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
-
executeQuery
default ExecuteQueryResponse executeQuery(ExecuteQueryRequest executeQueryRequest, Path destinationPath) throws UnprocessableException, ThrottlingException, ValidationException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- The transformed result of the ResponseTransformer.
- See Also:
-
-
executeQuery
default ExecuteQueryResponse executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest, Path destinationPath) throws UnprocessableException, ThrottlingException, ValidationException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- The transformed result of the ResponseTransformer.
- See Also:
-
-
executeQuery
default ResponseInputStream<ExecuteQueryResponse> executeQuery(ExecuteQueryRequest executeQueryRequest) throws UnprocessableException, ThrottlingException, ValidationException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException 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
-- Returns:
- A
ResponseInputStream
containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained viaResponseInputStream.response()
. The service documentation for the response content is as follows 'The query results.
'. - See Also:
-
-
executeQuery
default ResponseInputStream<ExecuteQueryResponse> executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest) throws UnprocessableException, ThrottlingException, ValidationException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException 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.- Returns:
- A
ResponseInputStream
containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained viaResponseInputStream.response()
. The service documentation for the response content is as follows 'The query results.
'. - See Also:
-
-
executeQueryAsBytes
default ResponseBytes<ExecuteQueryResponse> executeQueryAsBytes(ExecuteQueryRequest executeQueryRequest) throws UnprocessableException, ThrottlingException, ValidationException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException 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
-- Returns:
- A
ResponseBytes
that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained viaResponseBytes.response()
. The service documentation for the response content is as follows 'The query results.
'. - See Also:
-
-
executeQueryAsBytes
default ResponseBytes<ExecuteQueryResponse> executeQueryAsBytes(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest) throws UnprocessableException, ThrottlingException, ValidationException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException 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.- Returns:
- A
ResponseBytes
that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained viaResponseBytes.response()
. The service documentation for the response content is as follows 'The query results.
'. - See Also:
-
-
getGraph
default GetGraphResponse getGraph(GetGraphRequest getGraphRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Gets information about a specified graph.
- Parameters:
getGraphRequest
-- Returns:
- Result of the GetGraph operation returned by the service.
- See Also:
-
getGraph
default GetGraphResponse getGraph(Consumer<GetGraphRequest.Builder> getGraphRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the GetGraph operation returned by the service.
- See Also:
-
getGraphSnapshot
default GetGraphSnapshotResponse getGraphSnapshot(GetGraphSnapshotRequest getGraphSnapshotRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Retrieves a specified graph snapshot.
- Parameters:
getGraphSnapshotRequest
-- Returns:
- Result of the GetGraphSnapshot operation returned by the service.
- See Also:
-
getGraphSnapshot
default GetGraphSnapshotResponse getGraphSnapshot(Consumer<GetGraphSnapshotRequest.Builder> getGraphSnapshotRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the GetGraphSnapshot operation returned by the service.
- See Also:
-
getGraphSummary
default GetGraphSummaryResponse getGraphSummary(GetGraphSummaryRequest getGraphSummaryRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Gets a graph summary for a property graph.
- Parameters:
getGraphSummaryRequest
-- Returns:
- Result of the GetGraphSummary operation returned by the service.
- See Also:
-
getGraphSummary
default GetGraphSummaryResponse getGraphSummary(Consumer<GetGraphSummaryRequest.Builder> getGraphSummaryRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the GetGraphSummary operation returned by the service.
- See Also:
-
getImportTask
default GetImportTaskResponse getImportTask(GetImportTaskRequest getImportTaskRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Retrieves a specified import task.
- Parameters:
getImportTaskRequest
-- Returns:
- Result of the GetImportTask operation returned by the service.
- See Also:
-
getImportTask
default GetImportTaskResponse getImportTask(Consumer<GetImportTaskRequest.Builder> getImportTaskRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the GetImportTask operation returned by the service.
- See Also:
-
getPrivateGraphEndpoint
default GetPrivateGraphEndpointResponse getPrivateGraphEndpoint(GetPrivateGraphEndpointRequest getPrivateGraphEndpointRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Retrieves information about a specified private endpoint.
- Parameters:
getPrivateGraphEndpointRequest
-- Returns:
- Result of the GetPrivateGraphEndpoint operation returned by the service.
- See Also:
-
getPrivateGraphEndpoint
default GetPrivateGraphEndpointResponse getPrivateGraphEndpoint(Consumer<GetPrivateGraphEndpointRequest.Builder> getPrivateGraphEndpointRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the GetPrivateGraphEndpoint operation returned by the service.
- See Also:
-
getQuery
default GetQueryResponse getQuery(GetQueryRequest getQueryRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the GetQuery operation returned by the service.
- See Also:
-
getQuery
default GetQueryResponse getQuery(Consumer<GetQueryRequest.Builder> getQueryRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the GetQuery operation returned by the service.
- See Also:
-
listGraphSnapshots
default ListGraphSnapshotsResponse listGraphSnapshots(ListGraphSnapshotsRequest listGraphSnapshotsRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Lists available snapshots of a specified Neptune Analytics graph.
- Parameters:
listGraphSnapshotsRequest
-- Returns:
- Result of the ListGraphSnapshots operation returned by the service.
- See Also:
-
listGraphSnapshots
default ListGraphSnapshotsResponse listGraphSnapshots(Consumer<ListGraphSnapshotsRequest.Builder> listGraphSnapshotsRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the ListGraphSnapshots operation returned by the service.
- See Also:
-
listGraphSnapshotsPaginator
default ListGraphSnapshotsIterable listGraphSnapshotsPaginator(ListGraphSnapshotsRequest listGraphSnapshotsRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException This is a variant of
listGraphSnapshots(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphSnapshotsIterable responses = client.listGraphSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptunegraph.paginators.ListGraphSnapshotsIterable responses = client .listGraphSnapshotsPaginator(request); for (software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphSnapshotsIterable responses = client.listGraphSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listGraphSnapshotsPaginator
default ListGraphSnapshotsIterable listGraphSnapshotsPaginator(Consumer<ListGraphSnapshotsRequest.Builder> listGraphSnapshotsRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException This is a variant of
listGraphSnapshots(software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphSnapshotsIterable responses = client.listGraphSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptunegraph.paginators.ListGraphSnapshotsIterable responses = client .listGraphSnapshotsPaginator(request); for (software.amazon.awssdk.services.neptunegraph.model.ListGraphSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphSnapshotsIterable responses = client.listGraphSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listGraphs
default ListGraphsResponse listGraphs(ListGraphsRequest listGraphsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Lists available Neptune Analytics graphs.
- Parameters:
listGraphsRequest
-- Returns:
- Result of the ListGraphs operation returned by the service.
- See Also:
-
listGraphs
default ListGraphsResponse listGraphs(Consumer<ListGraphsRequest.Builder> listGraphsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the ListGraphs operation returned by the service.
- See Also:
-
listGraphsPaginator
default ListGraphsIterable listGraphsPaginator(ListGraphsRequest listGraphsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException This is a variant of
listGraphs(software.amazon.awssdk.services.neptunegraph.model.ListGraphsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptunegraph.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request); for (software.amazon.awssdk.services.neptunegraph.model.ListGraphsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listGraphsPaginator
default ListGraphsIterable listGraphsPaginator(Consumer<ListGraphsRequest.Builder> listGraphsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException This is a variant of
listGraphs(software.amazon.awssdk.services.neptunegraph.model.ListGraphsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptunegraph.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request); for (software.amazon.awssdk.services.neptunegraph.model.ListGraphsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptunegraph.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listImportTasks
default ListImportTasksResponse listImportTasks(ListImportTasksRequest listImportTasksRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Lists import tasks.
- Parameters:
listImportTasksRequest
-- Returns:
- Result of the ListImportTasks operation returned by the service.
- See Also:
-
listImportTasks
default ListImportTasksResponse listImportTasks(Consumer<ListImportTasksRequest.Builder> listImportTasksRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the ListImportTasks operation returned by the service.
- See Also:
-
listImportTasksPaginator
default ListImportTasksIterable listImportTasksPaginator(ListImportTasksRequest listImportTasksRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException This is a variant of
listImportTasks(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptunegraph.paginators.ListImportTasksIterable responses = client.listImportTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptunegraph.paginators.ListImportTasksIterable responses = client .listImportTasksPaginator(request); for (software.amazon.awssdk.services.neptunegraph.model.ListImportTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptunegraph.paginators.ListImportTasksIterable responses = client.listImportTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listImportTasksPaginator
default ListImportTasksIterable listImportTasksPaginator(Consumer<ListImportTasksRequest.Builder> listImportTasksRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException This is a variant of
listImportTasks(software.amazon.awssdk.services.neptunegraph.model.ListImportTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptunegraph.paginators.ListImportTasksIterable responses = client.listImportTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptunegraph.paginators.ListImportTasksIterable responses = client .listImportTasksPaginator(request); for (software.amazon.awssdk.services.neptunegraph.model.ListImportTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptunegraph.paginators.ListImportTasksIterable responses = client.listImportTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listPrivateGraphEndpoints
default ListPrivateGraphEndpointsResponse listPrivateGraphEndpoints(ListPrivateGraphEndpointsRequest listPrivateGraphEndpointsRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Lists private endpoints for a specified Neptune Analytics graph.
- Parameters:
listPrivateGraphEndpointsRequest
-- Returns:
- Result of the ListPrivateGraphEndpoints operation returned by the service.
- See Also:
-
listPrivateGraphEndpoints
default ListPrivateGraphEndpointsResponse listPrivateGraphEndpoints(Consumer<ListPrivateGraphEndpointsRequest.Builder> listPrivateGraphEndpointsRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the ListPrivateGraphEndpoints operation returned by the service.
- See Also:
-
listPrivateGraphEndpointsPaginator
default ListPrivateGraphEndpointsIterable listPrivateGraphEndpointsPaginator(ListPrivateGraphEndpointsRequest listPrivateGraphEndpointsRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException This is a variant of
listPrivateGraphEndpoints(software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptunegraph.paginators.ListPrivateGraphEndpointsIterable responses = client.listPrivateGraphEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptunegraph.paginators.ListPrivateGraphEndpointsIterable responses = client .listPrivateGraphEndpointsPaginator(request); for (software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptunegraph.paginators.ListPrivateGraphEndpointsIterable responses = client.listPrivateGraphEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listPrivateGraphEndpointsPaginator
default ListPrivateGraphEndpointsIterable listPrivateGraphEndpointsPaginator(Consumer<ListPrivateGraphEndpointsRequest.Builder> listPrivateGraphEndpointsRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException This is a variant of
listPrivateGraphEndpoints(software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptunegraph.paginators.ListPrivateGraphEndpointsIterable responses = client.listPrivateGraphEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptunegraph.paginators.ListPrivateGraphEndpointsIterable responses = client .listPrivateGraphEndpointsPaginator(request); for (software.amazon.awssdk.services.neptunegraph.model.ListPrivateGraphEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptunegraph.paginators.ListPrivateGraphEndpointsIterable responses = client.listPrivateGraphEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listQueries
default ListQueriesResponse listQueries(ListQueriesRequest listQueriesRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException Lists active openCypher queries.
- Parameters:
listQueriesRequest
-- Returns:
- Result of the ListQueries operation returned by the service.
- See Also:
-
listQueries
default ListQueriesResponse listQueries(Consumer<ListQueriesRequest.Builder> listQueriesRequest) throws ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the ListQueries operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Lists tags associated with a specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
resetGraph
default ResetGraphResponse resetGraph(ResetGraphRequest resetGraphRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Empties the data from a specified Neptune Analytics graph.
- Parameters:
resetGraphRequest
-- Returns:
- Result of the ResetGraph operation returned by the service.
- See Also:
-
resetGraph
default ResetGraphResponse resetGraph(Consumer<ResetGraphRequest.Builder> resetGraphRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the ResetGraph operation returned by the service.
- See Also:
-
restoreGraphFromSnapshot
default RestoreGraphFromSnapshotResponse restoreGraphFromSnapshot(RestoreGraphFromSnapshotRequest restoreGraphFromSnapshotRequest) throws ServiceQuotaExceededException, ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Restores a graph from a snapshot.
- Parameters:
restoreGraphFromSnapshotRequest
-- Returns:
- Result of the RestoreGraphFromSnapshot operation returned by the service.
- See Also:
-
restoreGraphFromSnapshot
default RestoreGraphFromSnapshotResponse restoreGraphFromSnapshot(Consumer<RestoreGraphFromSnapshotRequest.Builder> restoreGraphFromSnapshotRequest) throws ServiceQuotaExceededException, ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the RestoreGraphFromSnapshot operation returned by the service.
- See Also:
-
startImportTask
default StartImportTaskResponse startImportTask(StartImportTaskRequest startImportTaskRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the StartImportTask operation returned by the service.
- See Also:
-
startImportTask
default StartImportTaskResponse startImportTask(Consumer<StartImportTaskRequest.Builder> startImportTaskRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the StartImportTask operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Adds tags to the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Removes the specified tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateGraph
default UpdateGraphResponse updateGraph(UpdateGraphRequest updateGraphRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException Updates the configuration of a specified Neptune Analytics graph
- Parameters:
updateGraphRequest
-- Returns:
- Result of the UpdateGraph operation returned by the service.
- See Also:
-
updateGraph
default UpdateGraphResponse updateGraph(Consumer<UpdateGraphRequest.Builder> updateGraphRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneGraphException 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:
- Result of the UpdateGraph operation returned by the service.
- See Also:
-
waiter
Create an instance ofNeptuneGraphWaiter
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
NeptuneGraphWaiter
-
create
Create aNeptuneGraphClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aNeptuneGraphClient
. -
serviceMetadata
-
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
-