Package software.amazon.awssdk.services.neptunegraph.model

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>

  • Method Details

    • 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 or OPENCYPHER, which identies the openCypher load format.

      If the service returns an enum value that is not available in the current SDK version, format will return Format.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

      Returns:
      Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.
      See Also:

    • formatAsString

      public final String formatAsString()

      Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

      If the service returns an enum value that is not available in the current SDK version, format will return Format.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

      Returns:
      Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.
      See Also:

    • 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 use get-graphs to 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, status will return ImportTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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 use get-graphs to 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:

    • 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 use get-graphs to 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, status will return ImportTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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 use get-graphs to 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:

    • importOptions

      public final ImportOptions importOptions()

      Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, 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 failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetImportTaskResponse.Builder,GetImportTaskResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetImportTaskResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetImportTaskResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.