Class ReportData
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ReportData.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static ReportDataCreate an instance of this class withxarf()initialized to the given value.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()static Class<? extends ReportData.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.type()Retrieve an enum value representing which member of this object is populated.final Documentxarf()A JSON object that conforms to the XARF v4 specification.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
categoryandtypefields that classify the report (for example,categorycontentwithtypephishing). 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
descriptionfield to explain why and name the laws concerned.Testing your integration
To test your integration, add the tag
lifecycle:testto 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
categoryandtypefields that classify the report (for example,categorycontentwithtypephishing). 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
descriptionfield to explain why and name the laws concerned.Testing your integration
To test your integration, add the tag
lifecycle:testto 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
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ReportData.Builder,ReportData> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
fromXarf
Create an instance of this class withxarf()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
categoryandtypefields that classify the report (for example,categorycontentwithtypephishing). 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
descriptionfield to explain why and name the laws concerned.Testing your integration
To test your integration, add the tag
lifecycle:testto 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 requiredcategoryandtypefields that classify the report (for example,categorycontentwithtypephishing). 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
descriptionfield to explain why and name the laws concerned.Testing your integration
To test your integration, add the tag
lifecycle:testto 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
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beReportData.Type.UNKNOWN_TO_SDK_VERSIONif 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 beReportData.Type.UNKNOWN_TO_SDK_VERSIONif zero members are set, andnullif more than one member is set. -
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-