Class GetImportTaskResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.neptunegraph.model.NeptuneGraphResponse
-
- software.amazon.awssdk.services.neptunegraph.model.GetImportTaskResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetImportTaskResponse.Builder,GetImportTaskResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetImportTaskResponse extends NeptuneGraphResponse implements ToCopyableBuilder<GetImportTaskResponse.Builder,GetImportTaskResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetImportTaskResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IntegerattemptNumber()The number of the current attempt to execute the import task.static GetImportTaskResponse.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Formatformat()Specifies the format of S3 data to be imported.StringformatAsString()Specifies the format of S3 data to be imported.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)StringgraphId()The unique identifier of the Neptune Analytics graph.inthashCode()ImportOptionsimportOptions()Contains options for controlling the import process.ImportTaskDetailsimportTaskDetails()Contains details about the specified import task.StringroleArn()The ARN of the IAM role that will allow access to the data that is to be imported.List<SdkField<?>>sdkFields()static Class<? extends GetImportTaskResponse.Builder>serializableBuilderClass()Stringsource()A URL identifying to the location of the data to be imported.ImportTaskStatusstatus()The status of the import task:StringstatusAsString()The status of the import task:StringstatusReason()The reason that the import task has this status value.StringtaskId()The unique identifier of the import task.GetImportTaskResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.neptunegraph.model.NeptuneGraphResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
graphId
public final String graphId()
The unique identifier of the Neptune Analytics graph.
- Returns:
- The unique identifier of the Neptune Analytics graph.
-
taskId
public final String taskId()
The unique identifier of the import task.
- Returns:
- The unique identifier of the import task.
-
source
public final String source()
A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot
- Returns:
- A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot
-
format
public final Format format()
Specifies the format of S3 data to be imported. Valid values are
CSV, which identifies the Gremlin CSV format orOPENCYPHER, which identies the openCypher load format.If the service returns an enum value that is not available in the current SDK version,
formatwill returnFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromformatAsString().- Returns:
- Specifies the format of S3 data to be imported. Valid values are
CSV, which identifies the Gremlin CSV format orOPENCYPHER, which identies the openCypher load format. - See Also:
Format
-
formatAsString
public final String formatAsString()
Specifies the format of S3 data to be imported. Valid values are
CSV, which identifies the Gremlin CSV format orOPENCYPHER, which identies the openCypher load format.If the service returns an enum value that is not available in the current SDK version,
formatwill returnFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromformatAsString().- Returns:
- Specifies the format of S3 data to be imported. Valid values are
CSV, which identifies the Gremlin CSV format orOPENCYPHER, which identies the openCypher load format. - See Also:
Format
-
roleArn
public final String roleArn()
The ARN of the IAM role that will allow access to the data that is to be imported.
- Returns:
- The ARN of the IAM role that will allow access to the data that is to be imported.
-
status
public final ImportTaskStatus status()
The status of the import task:
-
INITIALIZING – The necessary resources needed to create the graph are being prepared.
-
ANALYZING_DATA – The data is being analyzed to determine the optimal infrastructure configuration for the new graph.
-
RE_PROVISIONING – The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.
-
IMPORTING – The data is being loaded.
-
ERROR_ENCOUNTERED – An error has been encountered while trying to create the graph and import the data.
-
ERROR_ENCOUNTERED_ROLLING_BACK – Because of the error that was encountered, the graph is being rolled back and all its resources released.
-
SUCCEEDED – Graph creation and data loading succeeded.
-
FAILED – Graph creation or data loading failed. When the status is
FAILED, you can useget-graphsto get more information about the state of the graph. -
CANCELLING – Because you cancelled the import task, cancellation is in progress.
-
CANCELLED – You have successfully cancelled the import task.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnImportTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the import task:
-
INITIALIZING – The necessary resources needed to create the graph are being prepared.
-
ANALYZING_DATA – The data is being analyzed to determine the optimal infrastructure configuration for the new graph.
-
RE_PROVISIONING – The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.
-
IMPORTING – The data is being loaded.
-
ERROR_ENCOUNTERED – An error has been encountered while trying to create the graph and import the data.
-
ERROR_ENCOUNTERED_ROLLING_BACK – Because of the error that was encountered, the graph is being rolled back and all its resources released.
-
SUCCEEDED – Graph creation and data loading succeeded.
-
FAILED – Graph creation or data loading failed. When the status is
FAILED, you can useget-graphsto get more information about the state of the graph. -
CANCELLING – Because you cancelled the import task, cancellation is in progress.
-
CANCELLED – You have successfully cancelled the import task.
-
- See Also:
ImportTaskStatus
-
-
statusAsString
public final String statusAsString()
The status of the import task:
-
INITIALIZING – The necessary resources needed to create the graph are being prepared.
-
ANALYZING_DATA – The data is being analyzed to determine the optimal infrastructure configuration for the new graph.
-
RE_PROVISIONING – The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.
-
IMPORTING – The data is being loaded.
-
ERROR_ENCOUNTERED – An error has been encountered while trying to create the graph and import the data.
-
ERROR_ENCOUNTERED_ROLLING_BACK – Because of the error that was encountered, the graph is being rolled back and all its resources released.
-
SUCCEEDED – Graph creation and data loading succeeded.
-
FAILED – Graph creation or data loading failed. When the status is
FAILED, you can useget-graphsto get more information about the state of the graph. -
CANCELLING – Because you cancelled the import task, cancellation is in progress.
-
CANCELLED – You have successfully cancelled the import task.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnImportTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the import task:
-
INITIALIZING – The necessary resources needed to create the graph are being prepared.
-
ANALYZING_DATA – The data is being analyzed to determine the optimal infrastructure configuration for the new graph.
-
RE_PROVISIONING – The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.
-
IMPORTING – The data is being loaded.
-
ERROR_ENCOUNTERED – An error has been encountered while trying to create the graph and import the data.
-
ERROR_ENCOUNTERED_ROLLING_BACK – Because of the error that was encountered, the graph is being rolled back and all its resources released.
-
SUCCEEDED – Graph creation and data loading succeeded.
-
FAILED – Graph creation or data loading failed. When the status is
FAILED, you can useget-graphsto get more information about the state of the graph. -
CANCELLING – Because you cancelled the import task, cancellation is in progress.
-
CANCELLED – You have successfully cancelled the import task.
-
- See Also:
ImportTaskStatus
-
-
importOptions
public final ImportOptions importOptions()
Contains options for controlling the import process. For example, if the
failOnErrorkey is set tofalse, the import skips problem data and attempts to continue (whereas if set totrue, the default, or if omitted, the import operation halts immediately when an error is encountered.- Returns:
- Contains options for controlling the import process. For example, if the
failOnErrorkey is set tofalse, the import skips problem data and attempts to continue (whereas if set totrue, the default, or if omitted, the import operation halts immediately when an error is encountered.
-
importTaskDetails
public final ImportTaskDetails importTaskDetails()
Contains details about the specified import task.
- Returns:
- Contains details about the specified import task.
-
attemptNumber
public final Integer attemptNumber()
The number of the current attempt to execute the import task.
- Returns:
- The number of the current attempt to execute the import task.
-
statusReason
public final String statusReason()
The reason that the import task has this status value.
- Returns:
- The reason that the import task has this status value.
-
toBuilder
public GetImportTaskResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetImportTaskResponse.Builder,GetImportTaskResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetImportTaskResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetImportTaskResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-