Package software.amazon.awssdk.services.macie2.model

Interface Occurrences.Builder

    • Method Detail

      • cells

        Occurrences.Builder cells​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cells

        Occurrences.Builder cells​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cells

        Occurrences.Builder cells​(Consumer<Cell.Builder>... 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.

        This is a convenience method that creates an instance of the Cell.Builder avoiding the need to create one manually via Cell.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #cells(List).

        Parameters:
        cells - a consumer that will call methods on Cell.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #cells(java.util.Collection)

      • lineRanges

        Occurrences.Builder lineRanges​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lineRanges

        Occurrences.Builder lineRanges​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lineRanges

        Occurrences.Builder lineRanges​(Consumer<Range.Builder>... 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.

        This is a convenience method that creates an instance of the Range.Builder avoiding the need to create one manually via Range.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #lineRanges(List).

        Parameters:
        lineRanges - a consumer that will call methods on Range.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #lineRanges(java.util.Collection)

      • offsetRanges

        Occurrences.Builder offsetRanges​(Collection<Range> offsetRanges)

        Reserved for future use.

        Parameters:
        offsetRanges -

        Reserved for future use.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • offsetRanges

        Occurrences.Builder offsetRanges​(Range... offsetRanges)

        Reserved for future use.

        Parameters:
        offsetRanges -

        Reserved for future use.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • offsetRanges

        Occurrences.Builder offsetRanges​(Consumer<Range.Builder>... offsetRanges)

        Reserved for future use.

        This is a convenience method that creates an instance of the Range.Builder avoiding the need to create one manually via Range.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #offsetRanges(List).

        Parameters:
        offsetRanges - a consumer that will call methods on Range.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #offsetRanges(java.util.Collection)

      • pages

        Occurrences.Builder pages​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pages

        Occurrences.Builder pages​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pages

        Occurrences.Builder pages​(Consumer<Page.Builder>... 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.

        This is a convenience method that creates an instance of the Page.Builder avoiding the need to create one manually via Page.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #pages(List).

        Parameters:
        pages - a consumer that will call methods on Page.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #pages(java.util.Collection)

      • records

        Occurrences.Builder records​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • records

        Occurrences.Builder records​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • records

        Occurrences.Builder records​(Consumer<Record.Builder>... 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.

        This is a convenience method that creates an instance of the Record.Builder avoiding the need to create one manually via Record.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #records(List).

        Parameters:
        records - a consumer that will call methods on Record.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #records(java.util.Collection)