# Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::CloudStorageOptions (v1.17.0)

1.17.0 (latest) 1.16.1 1.15.2 1.14.0 1.13.0 1.12.1 1.11.0 1.10.0 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.1 1.2.0 1.1.0 1.0.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.2 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.1 0.12.0 0.11.0 0.10.0 0.9.0 0.8.1 Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::CloudStorageOptions.

Options defining a file or a set of files within a Cloud Storage
bucket.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #bytes_limit_per_file

    def bytes_limit_per_file() -> ::Integer

**Returns**

- (::Integer) --- Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits
  on bytes scanned per
  file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).

### #bytes_limit_per_file=

    def bytes_limit_per_file=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits
  on bytes scanned per
  file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).
**Returns**

- (::Integer) --- Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits
  on bytes scanned per
  file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).

### #bytes_limit_per_file_percent

    def bytes_limit_per_file_percent() -> ::Integer

**Returns**

- (::Integer) --- Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits
  on bytes scanned per
  file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).

### #bytes_limit_per_file_percent=

    def bytes_limit_per_file_percent=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits
  on bytes scanned per
  file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).
**Returns**

- (::Integer) --- Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits
  on bytes scanned per
  file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).

### #file_set

    def file_set() -> ::Google::Cloud::Dlp::V2::CloudStorageOptions::FileSet

**Returns**

- ([::Google::Cloud::Dlp::V2::CloudStorageOptions::FileSet](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dlp-v2/latest/Google-Cloud-Dlp-V2-CloudStorageOptions-FileSet)) --- The set of one or more files to scan.

### #file_set=

    def file_set=(value) -> ::Google::Cloud::Dlp::V2::CloudStorageOptions::FileSet

**Parameter**

- **value** ([::Google::Cloud::Dlp::V2::CloudStorageOptions::FileSet](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dlp-v2/latest/Google-Cloud-Dlp-V2-CloudStorageOptions-FileSet)) --- The set of one or more files to scan.
**Returns**

- ([::Google::Cloud::Dlp::V2::CloudStorageOptions::FileSet](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dlp-v2/latest/Google-Cloud-Dlp-V2-CloudStorageOptions-FileSet)) --- The set of one or more files to scan.

### #file_types

    def file_types() -> ::Array<::Google::Cloud::Dlp::V2::FileType>

**Returns**

- (::Array\<[::Google::Cloud::Dlp::V2::FileType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dlp-v2/latest/Google-Cloud-Dlp-V2-FileType)\>) --- List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

### #file_types=

    def file_types=(value) -> ::Array<::Google::Cloud::Dlp::V2::FileType>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Dlp::V2::FileType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dlp-v2/latest/Google-Cloud-Dlp-V2-FileType)\>) --- List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.
**Returns**

- (::Array\<[::Google::Cloud::Dlp::V2::FileType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dlp-v2/latest/Google-Cloud-Dlp-V2-FileType)\>) --- List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.

### #files_limit_percent

    def files_limit_percent() -> ::Integer

**Returns**

- (::Integer) --- Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.

### #files_limit_percent=

    def files_limit_percent=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.
**Returns**

- (::Integer) --- Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.

### #sample_method

    def sample_method() -> ::Google::Cloud::Dlp::V2::CloudStorageOptions::SampleMethod

**Returns**

- ([::Google::Cloud::Dlp::V2::CloudStorageOptions::SampleMethod](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dlp-v2/latest/Google-Cloud-Dlp-V2-CloudStorageOptions-SampleMethod)) --- How to sample the data.

### #sample_method=

    def sample_method=(value) -> ::Google::Cloud::Dlp::V2::CloudStorageOptions::SampleMethod

**Parameter**

- **value** ([::Google::Cloud::Dlp::V2::CloudStorageOptions::SampleMethod](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dlp-v2/latest/Google-Cloud-Dlp-V2-CloudStorageOptions-SampleMethod)) --- How to sample the data.
**Returns**

- ([::Google::Cloud::Dlp::V2::CloudStorageOptions::SampleMethod](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dlp-v2/latest/Google-Cloud-Dlp-V2-CloudStorageOptions-SampleMethod)) --- How to sample the data.