Interface NeptuneGraphClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface NeptuneGraphClient extends AwsClient
Service client for accessing Neptune Graph. This can be created using the staticbuilder()method.Neptune Analytics is a serverless in-memory graph database service for analytics that delivers high-performance analytics and real-time queries for any graph type. It complements the Amazon Neptune Database, an industry-leading managed graph database.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCancelImportTaskRequest.builder()- Parameters:
cancelImportTaskRequest- AConsumerthat will call methods onCancelImportTaskRequest.Builderto create a request.- Returns:
- Result of the CancelImportTask operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ServiceQuotaExceededException- A service quota was exceeded.ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateGraphRequest.builder()- Parameters:
createGraphRequest- AConsumerthat will call methods onCreateGraphRequest.Builderto create a request.- Returns:
- Result of the CreateGraph operation returned by the service.
- Throws:
ServiceQuotaExceededException- A service quota was exceeded.ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ServiceQuotaExceededException- A service quota was exceeded.ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateGraphSnapshotRequest.builder()- Parameters:
createGraphSnapshotRequest- AConsumerthat will call methods onCreateGraphSnapshotRequest.Builderto create a request.- Returns:
- Result of the CreateGraphSnapshot operation returned by the service.
- Throws:
ServiceQuotaExceededException- A service quota was exceeded.ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ServiceQuotaExceededException- A service quota was exceeded.ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateGraphUsingImportTaskRequest.builder()- Parameters:
createGraphUsingImportTaskRequest- AConsumerthat will call methods onCreateGraphUsingImportTaskRequest.Builderto create a request.- Returns:
- Result of the CreateGraphUsingImportTask operation returned by the service.
- Throws:
ServiceQuotaExceededException- A service quota was exceeded.ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ServiceQuotaExceededException- A service quota was exceeded.ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreatePrivateGraphEndpointRequest.builder()- Parameters:
createPrivateGraphEndpointRequest- AConsumerthat will call methods onCreatePrivateGraphEndpointRequest.Builderto create a request.- Returns:
- Result of the CreatePrivateGraphEndpoint operation returned by the service.
- Throws:
ServiceQuotaExceededException- A service quota was exceeded.ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteGraphRequest.builder()- Parameters:
deleteGraphRequest- AConsumerthat will call methods onDeleteGraphRequest.Builderto create a request.- Returns:
- Result of the DeleteGraph operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteGraphSnapshotRequest.builder()- Parameters:
deleteGraphSnapshotRequest- AConsumerthat will call methods onDeleteGraphSnapshotRequest.Builderto create a request.- Returns:
- Result of the DeleteGraphSnapshot operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeletePrivateGraphEndpointRequest.builder()- Parameters:
deletePrivateGraphEndpointRequest- AConsumerthat will call methods onDeletePrivateGraphEndpointRequest.Builderto create a request.- Returns:
- Result of the DeletePrivateGraphEndpoint operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetGraphRequest.builder()- Parameters:
getGraphRequest- AConsumerthat will call methods onGetGraphRequest.Builderto create a request.- Returns:
- Result of the GetGraph operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetGraphSnapshotRequest.builder()- Parameters:
getGraphSnapshotRequest- AConsumerthat will call methods onGetGraphSnapshotRequest.Builderto create a request.- Returns:
- Result of the GetGraphSnapshot operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetImportTaskRequest.builder()- Parameters:
getImportTaskRequest- AConsumerthat will call methods onGetImportTaskRequest.Builderto create a request.- Returns:
- Result of the GetImportTask operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetPrivateGraphEndpointRequest.builder()- Parameters:
getPrivateGraphEndpointRequest- AConsumerthat will call methods onGetPrivateGraphEndpointRequest.Builderto create a request.- Returns:
- Result of the GetPrivateGraphEndpoint operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListGraphSnapshotsRequest.builder()- Parameters:
listGraphSnapshotsRequest- AConsumerthat will call methods onListGraphSnapshotsRequest.Builderto create a request.- Returns:
- Result of the ListGraphSnapshots operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListGraphSnapshotsRequest.builder()- Parameters:
listGraphSnapshotsRequest- AConsumerthat will call methods onListGraphSnapshotsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListGraphsRequest.builder()- Parameters:
listGraphsRequest- AConsumerthat will call methods onListGraphsRequest.Builderto create a request.- Returns:
- Result of the ListGraphs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListGraphsRequest.builder()- Parameters:
listGraphsRequest- AConsumerthat will call methods onListGraphsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListImportTasksRequest.builder()- Parameters:
listImportTasksRequest- AConsumerthat will call methods onListImportTasksRequest.Builderto create a request.- Returns:
- Result of the ListImportTasks operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListImportTasksRequest.builder()- Parameters:
listImportTasksRequest- AConsumerthat will call methods onListImportTasksRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListPrivateGraphEndpointsRequest.builder()- Parameters:
listPrivateGraphEndpointsRequest- AConsumerthat will call methods onListPrivateGraphEndpointsRequest.Builderto create a request.- Returns:
- Result of the ListPrivateGraphEndpoints operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListPrivateGraphEndpointsRequest.builder()- Parameters:
listPrivateGraphEndpointsRequest- AConsumerthat will call methods onListPrivateGraphEndpointsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaResetGraphRequest.builder()- Parameters:
resetGraphRequest- AConsumerthat will call methods onResetGraphRequest.Builderto create a request.- Returns:
- Result of the ResetGraph operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ServiceQuotaExceededException- A service quota was exceeded.ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRestoreGraphFromSnapshotRequest.builder()- Parameters:
restoreGraphFromSnapshotRequest- AConsumerthat will call methods onRestoreGraphFromSnapshotRequest.Builderto create a request.- Returns:
- Result of the RestoreGraphFromSnapshot operation returned by the service.
- Throws:
ServiceQuotaExceededException- A service quota was exceeded.ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedInternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateGraphRequest.builder()- Parameters:
updateGraphRequest- AConsumerthat will call methods onUpdateGraphRequest.Builderto create a request.- Returns:
- Result of the UpdateGraph operation returned by the service.
- Throws:
ThrottlingException- The exception was interrupted by throttling.ValidationException- A resource could not be validatedConflictException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default NeptuneGraphWaiter waiter()
Create an instance ofNeptuneGraphWaiterusing 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
static NeptuneGraphClient create()
Create aNeptuneGraphClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static NeptuneGraphClientBuilder builder()
Create a builder that can be used to configure and create aNeptuneGraphClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default NeptuneGraphServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-