Class GetAbuseReportStatusResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetAbuseReportStatusResponse.Builder,GetAbuseReportStatusResponse>

@Generated("software.amazon.awssdk:codegen") public final class GetAbuseReportStatusResponse extends AbuseSignalResponse implements ToCopyableBuilder<GetAbuseReportStatusResponse.Builder,GetAbuseReportStatusResponse>

The response from a GetAbuseReportStatus request. Contains the report's current status, when you submitted it, and when its status last changed.

  • Method Details

    • reportId

      public final String reportId()

      The unique identifier of the abuse report.

      Returns:
      The unique identifier of the abuse report.
    • correlationId

      public final String correlationId()

      The reporter-provided correlation ID for cross-referencing.

      Returns:
      The reporter-provided correlation ID for cross-referencing.
    • status

      public final ReportSubmissionStatus status()

      The current processing status of the abuse report. Valid values are QUEUED (the report has been received and queued for processing), PROCESSING (the report has been received and is being processed), and COMPLETED (downstream resolution is finished).

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

      Returns:
      The current processing status of the abuse report. Valid values are QUEUED (the report has been received and queued for processing), PROCESSING (the report has been received and is being processed), and COMPLETED (downstream resolution is finished).
      See Also:
    • statusAsString

      public final String statusAsString()

      The current processing status of the abuse report. Valid values are QUEUED (the report has been received and queued for processing), PROCESSING (the report has been received and is being processed), and COMPLETED (downstream resolution is finished).

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

      Returns:
      The current processing status of the abuse report. Valid values are QUEUED (the report has been received and queued for processing), PROCESSING (the report has been received and is being processed), and COMPLETED (downstream resolution is finished).
      See Also:
    • description

      public final String description()

      A human-readable description of the current status.

      Returns:
      A human-readable description of the current status.
    • reasonCode

      public final ReasonCode reasonCode()

      A code that explains the resolution outcome. This value is returned only after the report reaches the terminal COMPLETED status; it is absent while the report is QUEUED or PROCESSING. Treat an unrecognized value as opaque, because the set of reason codes is append-only.

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

      Returns:
      A code that explains the resolution outcome. This value is returned only after the report reaches the terminal COMPLETED status; it is absent while the report is QUEUED or PROCESSING. Treat an unrecognized value as opaque, because the set of reason codes is append-only.
      See Also:
    • reasonCodeAsString

      public final String reasonCodeAsString()

      A code that explains the resolution outcome. This value is returned only after the report reaches the terminal COMPLETED status; it is absent while the report is QUEUED or PROCESSING. Treat an unrecognized value as opaque, because the set of reason codes is append-only.

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

      Returns:
      A code that explains the resolution outcome. This value is returned only after the report reaches the terminal COMPLETED status; it is absent while the report is QUEUED or PROCESSING. Treat an unrecognized value as opaque, because the set of reason codes is append-only.
      See Also:
    • submittedAt

      public final Instant submittedAt()

      The date and time when the abuse report was submitted.

      Returns:
      The date and time when the abuse report was submitted.
    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The date and time when the status was last updated.

      Returns:
      The date and time when the status was last updated.
    • 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<GetAbuseReportStatusResponse.Builder,GetAbuseReportStatusResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

      public static GetAbuseReportStatusResponse.Builder builder()
    • serializableBuilderClass

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