Interface GetImportTaskResponse.Builder

  • Method Details

    • graphId

      The unique identifier of the Neptune Analytics graph.

      Parameters:
      graphId - The unique identifier of the Neptune Analytics graph.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskId

      The unique identifier of the import task.

      Parameters:
      taskId - The unique identifier of the import task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • parquetType

      GetImportTaskResponse.Builder parquetType(String parquetType)

      The parquet type of the import task.

      Parameters:
      parquetType - The parquet type of the import task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • parquetType

      GetImportTaskResponse.Builder parquetType(ParquetType parquetType)

      The parquet type of the import task.

      Parameters:
      parquetType - The parquet type of the import task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • roleArn

      The ARN of the IAM role that will allow access to the data that is to be imported.

      Parameters:
      roleArn - The ARN of the IAM role that will allow access to the data that is to be imported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • importOptions

      GetImportTaskResponse.Builder importOptions(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • importOptions

      default GetImportTaskResponse.Builder importOptions(Consumer<ImportOptions.Builder> 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.

      This is a convenience method that creates an instance of the ImportOptions.Builder avoiding the need to create one manually via ImportOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to importOptions(ImportOptions).

      Parameters:
      importOptions - a consumer that will call methods on ImportOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • importTaskDetails

      GetImportTaskResponse.Builder importTaskDetails(ImportTaskDetails importTaskDetails)

      Contains details about the specified import task.

      Parameters:
      importTaskDetails - Contains details about the specified import task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • importTaskDetails

      default GetImportTaskResponse.Builder importTaskDetails(Consumer<ImportTaskDetails.Builder> importTaskDetails)

      Contains details about the specified import task.

      This is a convenience method that creates an instance of the ImportTaskDetails.Builder avoiding the need to create one manually via ImportTaskDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to importTaskDetails(ImportTaskDetails).

      Parameters:
      importTaskDetails - a consumer that will call methods on ImportTaskDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • attemptNumber

      GetImportTaskResponse.Builder attemptNumber(Integer attemptNumber)

      The number of the current attempts to execute the import task.

      Parameters:
      attemptNumber - The number of the current attempts to execute the import task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • statusReason

      GetImportTaskResponse.Builder statusReason(String statusReason)

      The reason that the import task has this status value.

      Parameters:
      statusReason - The reason that the import task has this status value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.