Class Occurrences

java.lang.Object
software.amazon.awssdk.services.macie2.model.Occurrences
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Occurrences.Builder,Occurrences>
@Generated("software.amazon.awssdk:codegen") public final class Occurrences extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Occurrences.Builder,Occurrences>

Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitive data finding.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    Occurrences.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Occurrences.Builder
    builder()
     
    final List<Cell>
    cells()
    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
    final boolean
    equals(Object obj)
     
    final boolean
    equalsBySdkFields(Object obj)
    Indicates whether some other object is "equal to" this one by SDK fields.
    final <T> Optional<T>
    getValueForField(String fieldName, Class<T> clazz)
     
    final boolean
    hasCells()
    For responses, this returns true if the service returned a value for the Cells property.
    final int
    hashCode()
     
    final boolean
    hasLineRanges()
    For responses, this returns true if the service returned a value for the LineRanges property.
    final boolean
    hasOffsetRanges()
    For responses, this returns true if the service returned a value for the OffsetRanges property.
    final boolean
    hasPages()
    For responses, this returns true if the service returned a value for the Pages property.
    final boolean
    hasRecords()
    For responses, this returns true if the service returned a value for the Records property.
    final List<Range>
    lineRanges()
    An array of objects, one for each occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file.
    final List<Range>
    offsetRanges()
    Reserved for future use.
    final List<Page>
    pages()
    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file.
    final List<Record>
    records()
    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.
    final List<SdkField<?>>
    sdkFields()
     
    static Class<? extends Occurrences.Builder>
    serializableBuilderClass()
     
    Occurrences.Builder
    toBuilder()
    Take this object and create a builder that contains all of the current property values of this object.
    final String
    toString()
    Returns a string representation of this object.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

    copy

  • Method Details

    • hasCells

      public final boolean hasCells()
      For responses, this returns true if the service returned a value for the Cells property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • cells

      public final List<Cell> cells()

      An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

      Each Cell object specifies a cell or field that contains the sensitive data.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCells() method.

      Returns:
      An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

      Each Cell object specifies a cell or field that contains the sensitive data.

    • hasLineRanges

      public final boolean hasLineRanges()
      For responses, this returns true if the service returned a value for the LineRanges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • lineRanges

      public final List<Range> lineRanges()

      An array of objects, one for each occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

      This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLineRanges() method.

      Returns:
      An array of objects, one for each occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

      This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

    • hasOffsetRanges

      public final boolean hasOffsetRanges()
      For responses, this returns true if the service returned a value for the OffsetRanges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • offsetRanges

      public final List<Range> offsetRanges()

      Reserved for future use.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOffsetRanges() method.

      Returns:

      Reserved for future use.

    • hasPages

      public final boolean hasPages()
      For responses, this returns true if the service returned a value for the Pages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • pages

      public final List<Page> pages()

      An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

      Each Page object specifies a page that contains the sensitive data.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPages() method.

      Returns:
      An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

      Each Page object specifies a page that contains the sensitive data.

    • hasRecords

      public final boolean hasRecords()
      For responses, this returns true if the service returned a value for the Records property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • records

      public final List<Record> records()

      An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

      For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRecords() method.

      Returns:
      An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

      For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.

    • toBuilder

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

    • builder

      public static Occurrences.Builder builder()

    • serializableBuilderClass

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

    • 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.