Class ReportData

java.lang.Object
software.amazon.awssdk.services.abusesignal.model.ReportData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReportData.Builder,ReportData>

@Generated("software.amazon.awssdk:codegen") public final class ReportData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReportData.Builder,ReportData>

The abuse report data in XARF format. This is a union type, so exactly one member must be specified.

See Also:
  • Method Details

    • xarf

      public final Document xarf()

      A JSON object that conforms to the XARF v4 specification. At a minimum, the document must include the XARF core fields, including the required category and type fields that classify the report (for example, category content with type phishing). For the XARF core fields and detailed schema definitions of each report type, see the XARF v4 Technical Specification on the XARF website.

      Never include images, video, or copies of child sexual abuse or child sexual exploitation material in a report, in any field and for any report type. Send URLs, hash values, and reference identifiers only.

      If you suspect that activity is illegal, use the XARF description field to explain why and name the laws concerned.

      Testing your integration

      To test your integration, add the tag lifecycle:test to the report. Amazon Web Services validates test reports and returns a report ID and status in the same way as other reports, but doesn't process them as abuse reports. Amazon Web Services deletes test reports shortly after submission.

      Use test values only, such as example.com and the IP address ranges reserved for documentation (192.0.2.0/24, 198.51.100.0/24 and 203.0.113.0/24). Don't add this tag to a real abuse report.

      Tag keys that begin with aws: are reserved.

      Returns:
      A JSON object that conforms to the XARF v4 specification. At a minimum, the document must include the XARF core fields, including the required category and type fields that classify the report (for example, category content with type phishing). For the XARF core fields and detailed schema definitions of each report type, see the XARF v4 Technical Specification on the XARF website.

      Never include images, video, or copies of child sexual abuse or child sexual exploitation material in a report, in any field and for any report type. Send URLs, hash values, and reference identifiers only.

      If you suspect that activity is illegal, use the XARF description field to explain why and name the laws concerned.

      Testing your integration

      To test your integration, add the tag lifecycle:test to the report. Amazon Web Services validates test reports and returns a report ID and status in the same way as other reports, but doesn't process them as abuse reports. Amazon Web Services deletes test reports shortly after submission.

      Use test values only, such as example.com and the IP address ranges reserved for documentation (192.0.2.0/24, 198.51.100.0/24 and 203.0.113.0/24). Don't add this tag to a real abuse report.

      Tag keys that begin with aws: are reserved.

    • toBuilder

      public ReportData.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<ReportData.Builder,ReportData>
      Returns:
      a builder for type T
    • builder

      public static ReportData.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ReportData.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • fromXarf

      public static ReportData fromXarf(Document xarf)
      Create an instance of this class with xarf() initialized to the given value.

      A JSON object that conforms to the XARF v4 specification. At a minimum, the document must include the XARF core fields, including the required category and type fields that classify the report (for example, category content with type phishing). For the XARF core fields and detailed schema definitions of each report type, see the XARF v4 Technical Specification on the XARF website.

      Never include images, video, or copies of child sexual abuse or child sexual exploitation material in a report, in any field and for any report type. Send URLs, hash values, and reference identifiers only.

      If you suspect that activity is illegal, use the XARF description field to explain why and name the laws concerned.

      Testing your integration

      To test your integration, add the tag lifecycle:test to the report. Amazon Web Services validates test reports and returns a report ID and status in the same way as other reports, but doesn't process them as abuse reports. Amazon Web Services deletes test reports shortly after submission.

      Use test values only, such as example.com and the IP address ranges reserved for documentation (192.0.2.0/24, 198.51.100.0/24 and 203.0.113.0/24). Don't add this tag to a real abuse report.

      Tag keys that begin with aws: are reserved.

      Parameters:
      xarf - A JSON object that conforms to the XARF v4 specification. At a minimum, the document must include the XARF core fields, including the required category and type fields that classify the report (for example, category content with type phishing). For the XARF core fields and detailed schema definitions of each report type, see the XARF v4 Technical Specification on the XARF website.

      Never include images, video, or copies of child sexual abuse or child sexual exploitation material in a report, in any field and for any report type. Send URLs, hash values, and reference identifiers only.

      If you suspect that activity is illegal, use the XARF description field to explain why and name the laws concerned.

      Testing your integration

      To test your integration, add the tag lifecycle:test to the report. Amazon Web Services validates test reports and returns a report ID and status in the same way as other reports, but doesn't process them as abuse reports. Amazon Web Services deletes test reports shortly after submission.

      Use test values only, such as example.com and the IP address ranges reserved for documentation (192.0.2.0/24, 198.51.100.0/24 and 203.0.113.0/24). Don't add this tag to a real abuse report.

      Tag keys that begin with aws: are reserved.

    • type

      public ReportData.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ReportData.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ReportData.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.
    • 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.