Class CancelExportTaskResponse

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.CancelExportTaskResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CancelExportTaskResponse.Builder,CancelExportTaskResponse>
@Generated("software.amazon.awssdk:codegen") public final class CancelExportTaskResponse extends NeptuneGraphResponse implements ToCopyableBuilder<CancelExportTaskResponse.Builder,CancelExportTaskResponse>

  • Method Details

    • graphId

      public final String graphId()

      The source graph identifier of the cancelled export task.

      Returns:
      The source graph identifier of the cancelled export task.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role that will allow the exporting of data to the destination.

      Returns:
      The ARN of the IAM role that will allow the exporting of data to the destination.

    • taskId

      public final String taskId()

      The unique identifier of the export task.

      Returns:
      The unique identifier of the export task.

    • status

      public final ExportTaskStatus status()

      The current status of the export task. The status is CANCELLING when the export task is cancelled.

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

      Returns:
      The current status of the export task. The status is CANCELLING when the export task is cancelled.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the export task. The status is CANCELLING when the export task is cancelled.

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

      Returns:
      The current status of the export task. The status is CANCELLING when the export task is cancelled.
      See Also:

    • format

      public final ExportFormat format()

      The format of the cancelled export task.

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

      Returns:
      The format of the cancelled export task.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the cancelled export task.

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

      Returns:
      The format of the cancelled export task.
      See Also:

    • destination

      public final String destination()

      The Amazon S3 URI of the cancelled export task where data will be exported to.

      Returns:
      The Amazon S3 URI of the cancelled export task where data will be exported to.

    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

      The KMS key identifier of the cancelled export task.

      Returns:
      The KMS key identifier of the cancelled export task.

    • parquetType

      public final ParquetType parquetType()

      The parquet type of the cancelled export task.

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

      Returns:
      The parquet type of the cancelled export task.
      See Also:

    • parquetTypeAsString

      public final String parquetTypeAsString()

      The parquet type of the cancelled export task.

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

      Returns:
      The parquet type of the cancelled export task.
      See Also:

    • statusReason

      public final String statusReason()

      The reason that the export task has this status value.

      Returns:
      The reason that the export task has this status value.

    • toBuilder

      public CancelExportTaskResponse.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<CancelExportTaskResponse.Builder,CancelExportTaskResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CancelExportTaskResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CancelExportTaskResponse.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.