Occurrences (AWS Java SDK for Amazon Macie 2 1.11.891 API)

java.lang.Object
- com.amazonaws.services.macie2.model.Occurrences

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Occurrences
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides the location of 1-15 occurrences of sensitive data that was detected by managed data identifiers or a custom data identifier and produced a sensitive data finding.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Occurrences()

Constructors
Constructor and Description
`Occurrences()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Occurrences`	`clone()`
`boolean`	`equals(Object obj)`
`List<Cell>`	`getCells()` An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
`List<Range>`	`getLineRanges()` An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file.
`List<Range>`	`getOffsetRanges()` An array of objects, one for each occurrence of sensitive data in a binary text file.
`List<Page>`	`getPages()` An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file.
`List<Record>`	`getRecords()` An array of objects, one for each occurrence of sensitive data in an Apache Parquet file.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCells(Collection<Cell> cells)` An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
`void`	`setLineRanges(Collection<Range> lineRanges)` An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file.
`void`	`setOffsetRanges(Collection<Range> offsetRanges)` An array of objects, one for each occurrence of sensitive data in a binary text file.
`void`	`setPages(Collection<Page> pages)` An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file.
`void`	`setRecords(Collection<Record> records)` An array of objects, one for each occurrence of sensitive data in an Apache Parquet file.
`String`	`toString()` Returns a string representation of this object.
`Occurrences`	`withCells(Cell... cells)` An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
`Occurrences`	`withCells(Collection<Cell> cells)` An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
`Occurrences`	`withLineRanges(Collection<Range> lineRanges)` An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file.
`Occurrences`	`withLineRanges(Range... lineRanges)` An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file.
`Occurrences`	`withOffsetRanges(Collection<Range> offsetRanges)` An array of objects, one for each occurrence of sensitive data in a binary text file.
`Occurrences`	`withOffsetRanges(Range... offsetRanges)` An array of objects, one for each occurrence of sensitive data in a binary text file.
`Occurrences`	`withPages(Collection<Page> pages)` An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file.
`Occurrences`	`withPages(Page... pages)` An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file.
`Occurrences`	`withRecords(Collection<Record> records)` An array of objects, one for each occurrence of sensitive data in an Apache Parquet file.
`Occurrences`	`withRecords(Record... records)` An array of objects, one for each occurrence of sensitive data in an Apache Parquet file.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Occurrences
```
public Occurrences()
```
- Method Detail
  - getCells
```
public List<Cell> getCells()
```
    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell that contains the data. This value is null for all other types of files.
    
    Returns:
    
    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell that contains the data. This value is null for all other types of files.
  - setCells
```
public void setCells(Collection<Cell> cells)
```
    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell that contains the data. This value is null for all other types of files.
    
    Parameters:
    
    cells - An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell that contains the data. This value is null for all other types of files.
  - withCells
```
public Occurrences withCells(Cell... cells)
```
    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell that contains the data. This value is null for all other types of files.
    
    NOTE: This method appends the values to the existing list (if any). Use setCells(java.util.Collection) or withCells(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    cells - An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell that contains the data. This value is null for all other types of files.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCells
```
public Occurrences withCells(Collection<Cell> cells)
```
    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell that contains the data. This value is null for all other types of files.
    
    Parameters:
    
    cells - An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell that contains the data. This value is null for all other types of files.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLineRanges
```
public List<Range> getLineRanges()
```
    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
    
    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: full names and addresses in a Microsoft Excel workbook, CSV file, or TSV file; data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.
    
    Returns:
    
    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
    
    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: full names and addresses in a Microsoft Excel workbook, CSV file, or TSV file; data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.
  - setLineRanges
```
public void setLineRanges(Collection<Range> lineRanges)
```
    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
    
    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: full names and addresses in a Microsoft Excel workbook, CSV file, or TSV file; data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.
    
    Parameters:
    
    lineRanges - An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
    
    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: full names and addresses in a Microsoft Excel workbook, CSV file, or TSV file; data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.
  - withLineRanges
```
public Occurrences withLineRanges(Range... lineRanges)
```
    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
    
    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: full names and addresses in a Microsoft Excel workbook, CSV file, or TSV file; data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.
    
    NOTE: This method appends the values to the existing list (if any). Use setLineRanges(java.util.Collection) or withLineRanges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    lineRanges - An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
    
    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: full names and addresses in a Microsoft Excel workbook, CSV file, or TSV file; data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLineRanges
```
public Occurrences withLineRanges(Collection<Range> lineRanges)
```
    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
    
    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: full names and addresses in a Microsoft Excel workbook, CSV file, or TSV file; data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.
    
    Parameters:
    
    lineRanges - An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
    
    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: full names and addresses in a Microsoft Excel workbook, CSV file, or TSV file; data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOffsetRanges
```
public List<Range> getOffsetRanges()
```
    An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.
    
    This value is typically null. For binary text files, Macie adds location data to a lineRanges.Range or Page object, depending on the file type.
    
    Returns:
    
    An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.
    
    This value is typically null. For binary text files, Macie adds location data to a lineRanges.Range or Page object, depending on the file type.
  - setOffsetRanges
```
public void setOffsetRanges(Collection<Range> offsetRanges)
```
    An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.
    
    This value is typically null. For binary text files, Macie adds location data to a lineRanges.Range or Page object, depending on the file type.
    
    Parameters:
    
    offsetRanges - An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.
    
    This value is typically null. For binary text files, Macie adds location data to a lineRanges.Range or Page object, depending on the file type.
  - withOffsetRanges
```
public Occurrences withOffsetRanges(Range... offsetRanges)
```
    An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.
    
    This value is typically null. For binary text files, Macie adds location data to a lineRanges.Range or Page object, depending on the file type.
    
    NOTE: This method appends the values to the existing list (if any). Use setOffsetRanges(java.util.Collection) or withOffsetRanges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    offsetRanges - An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.
    
    This value is typically null. For binary text files, Macie adds location data to a lineRanges.Range or Page object, depending on the file type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOffsetRanges
```
public Occurrences withOffsetRanges(Collection<Range> offsetRanges)
```
    An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.
    
    This value is typically null. For binary text files, Macie adds location data to a lineRanges.Range or Page object, depending on the file type.
    
    Parameters:
    
    offsetRanges - An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.
    
    This value is typically null. For binary text files, Macie adds location data to a lineRanges.Range or Page object, depending on the file type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPages
```
public List<Page> getPages()
```
    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
    
    Returns:
    
    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
  - setPages
```
public void setPages(Collection<Page> pages)
```
    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
    
    Parameters:
    
    pages - An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
  - withPages
```
public Occurrences withPages(Page... pages)
```
    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
    
    NOTE: This method appends the values to the existing list (if any). Use setPages(java.util.Collection) or withPages(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    pages - An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPages
```
public Occurrences withPages(Collection<Page> pages)
```
    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
    
    Parameters:
    
    pages - An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRecords
```
public List<Record> getRecords()
```
    An array of objects, one for each occurrence of sensitive data in an Apache Parquet file. Each object specifies the row that contains the data. This value is null for all other types of files.
    
    Returns:
    
    An array of objects, one for each occurrence of sensitive data in an Apache Parquet file. Each object specifies the row that contains the data. This value is null for all other types of files.
  - setRecords
```
public void setRecords(Collection<Record> records)
```
    An array of objects, one for each occurrence of sensitive data in an Apache Parquet file. Each object specifies the row that contains the data. This value is null for all other types of files.
    
    Parameters:
    
    records - An array of objects, one for each occurrence of sensitive data in an Apache Parquet file. Each object specifies the row that contains the data. This value is null for all other types of files.
  - withRecords
```
public Occurrences withRecords(Record... records)
```
    An array of objects, one for each occurrence of sensitive data in an Apache Parquet file. Each object specifies the row that contains the data. This value is null for all other types of files.
    
    NOTE: This method appends the values to the existing list (if any). Use setRecords(java.util.Collection) or withRecords(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    records - An array of objects, one for each occurrence of sensitive data in an Apache Parquet file. Each object specifies the row that contains the data. This value is null for all other types of files.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRecords
```
public Occurrences withRecords(Collection<Record> records)
```
    An array of objects, one for each occurrence of sensitive data in an Apache Parquet file. Each object specifies the row that contains the data. This value is null for all other types of files.
    
    Parameters:
    
    records - An array of objects, one for each occurrence of sensitive data in an Apache Parquet file. Each object specifies the row that contains the data. This value is null for all other types of files.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Occurrences clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Occurrences

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Occurrences

Method Detail

getCells

setCells

withCells

withCells

getLineRanges

setLineRanges

withLineRanges

withLineRanges

getOffsetRanges

setOffsetRanges

withOffsetRanges

withOffsetRanges

getPages

setPages

withPages

withPages

getRecords

setRecords

withRecords

withRecords

toString

equals

hashCode

clone

marshall