1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/privacy/dlp/v2/storage.proto 18 19 package com.google.privacy.dlp.v2; 20 21 public interface CloudStorageOptionsOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.CloudStorageOptions) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The set of one or more files to scan. 31 * </pre> 32 * 33 * <code>.google.privacy.dlp.v2.CloudStorageOptions.FileSet file_set = 1;</code> 34 * 35 * @return Whether the fileSet field is set. 36 */ hasFileSet()37 boolean hasFileSet(); 38 /** 39 * 40 * 41 * <pre> 42 * The set of one or more files to scan. 43 * </pre> 44 * 45 * <code>.google.privacy.dlp.v2.CloudStorageOptions.FileSet file_set = 1;</code> 46 * 47 * @return The fileSet. 48 */ getFileSet()49 com.google.privacy.dlp.v2.CloudStorageOptions.FileSet getFileSet(); 50 /** 51 * 52 * 53 * <pre> 54 * The set of one or more files to scan. 55 * </pre> 56 * 57 * <code>.google.privacy.dlp.v2.CloudStorageOptions.FileSet file_set = 1;</code> 58 */ getFileSetOrBuilder()59 com.google.privacy.dlp.v2.CloudStorageOptions.FileSetOrBuilder getFileSetOrBuilder(); 60 61 /** 62 * 63 * 64 * <pre> 65 * Max number of bytes to scan from a file. If a scanned file's size is bigger 66 * than this value then the rest of the bytes are omitted. Only one 67 * of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. 68 * Cannot be set if de-identification is requested. 69 * </pre> 70 * 71 * <code>int64 bytes_limit_per_file = 4;</code> 72 * 73 * @return The bytesLimitPerFile. 74 */ getBytesLimitPerFile()75 long getBytesLimitPerFile(); 76 77 /** 78 * 79 * 80 * <pre> 81 * Max percentage of bytes to scan from a file. The rest are omitted. The 82 * number of bytes scanned is rounded down. Must be between 0 and 100, 83 * inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one 84 * of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. 85 * Cannot be set if de-identification is requested. 86 * </pre> 87 * 88 * <code>int32 bytes_limit_per_file_percent = 8;</code> 89 * 90 * @return The bytesLimitPerFilePercent. 91 */ getBytesLimitPerFilePercent()92 int getBytesLimitPerFilePercent(); 93 94 /** 95 * 96 * 97 * <pre> 98 * List of file type groups to include in the scan. 99 * If empty, all files are scanned and available data format processors 100 * are applied. In addition, the binary content of the selected files 101 * is always scanned as well. 102 * Images are scanned only as binary if the specified region 103 * does not support image inspection and no file_types were specified. 104 * Image inspection is restricted to 'global', 'us', 'asia', and 'europe'. 105 * </pre> 106 * 107 * <code>repeated .google.privacy.dlp.v2.FileType file_types = 5;</code> 108 * 109 * @return A list containing the fileTypes. 110 */ getFileTypesList()111 java.util.List<com.google.privacy.dlp.v2.FileType> getFileTypesList(); 112 /** 113 * 114 * 115 * <pre> 116 * List of file type groups to include in the scan. 117 * If empty, all files are scanned and available data format processors 118 * are applied. In addition, the binary content of the selected files 119 * is always scanned as well. 120 * Images are scanned only as binary if the specified region 121 * does not support image inspection and no file_types were specified. 122 * Image inspection is restricted to 'global', 'us', 'asia', and 'europe'. 123 * </pre> 124 * 125 * <code>repeated .google.privacy.dlp.v2.FileType file_types = 5;</code> 126 * 127 * @return The count of fileTypes. 128 */ getFileTypesCount()129 int getFileTypesCount(); 130 /** 131 * 132 * 133 * <pre> 134 * List of file type groups to include in the scan. 135 * If empty, all files are scanned and available data format processors 136 * are applied. In addition, the binary content of the selected files 137 * is always scanned as well. 138 * Images are scanned only as binary if the specified region 139 * does not support image inspection and no file_types were specified. 140 * Image inspection is restricted to 'global', 'us', 'asia', and 'europe'. 141 * </pre> 142 * 143 * <code>repeated .google.privacy.dlp.v2.FileType file_types = 5;</code> 144 * 145 * @param index The index of the element to return. 146 * @return The fileTypes at the given index. 147 */ getFileTypes(int index)148 com.google.privacy.dlp.v2.FileType getFileTypes(int index); 149 /** 150 * 151 * 152 * <pre> 153 * List of file type groups to include in the scan. 154 * If empty, all files are scanned and available data format processors 155 * are applied. In addition, the binary content of the selected files 156 * is always scanned as well. 157 * Images are scanned only as binary if the specified region 158 * does not support image inspection and no file_types were specified. 159 * Image inspection is restricted to 'global', 'us', 'asia', and 'europe'. 160 * </pre> 161 * 162 * <code>repeated .google.privacy.dlp.v2.FileType file_types = 5;</code> 163 * 164 * @return A list containing the enum numeric values on the wire for fileTypes. 165 */ getFileTypesValueList()166 java.util.List<java.lang.Integer> getFileTypesValueList(); 167 /** 168 * 169 * 170 * <pre> 171 * List of file type groups to include in the scan. 172 * If empty, all files are scanned and available data format processors 173 * are applied. In addition, the binary content of the selected files 174 * is always scanned as well. 175 * Images are scanned only as binary if the specified region 176 * does not support image inspection and no file_types were specified. 177 * Image inspection is restricted to 'global', 'us', 'asia', and 'europe'. 178 * </pre> 179 * 180 * <code>repeated .google.privacy.dlp.v2.FileType file_types = 5;</code> 181 * 182 * @param index The index of the value to return. 183 * @return The enum numeric value on the wire of fileTypes at the given index. 184 */ getFileTypesValue(int index)185 int getFileTypesValue(int index); 186 187 /** 188 * <code>.google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6;</code> 189 * 190 * @return The enum numeric value on the wire for sampleMethod. 191 */ getSampleMethodValue()192 int getSampleMethodValue(); 193 /** 194 * <code>.google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6;</code> 195 * 196 * @return The sampleMethod. 197 */ getSampleMethod()198 com.google.privacy.dlp.v2.CloudStorageOptions.SampleMethod getSampleMethod(); 199 200 /** 201 * 202 * 203 * <pre> 204 * Limits the number of files to scan to this percentage of the input FileSet. 205 * Number of files scanned is rounded down. Must be between 0 and 100, 206 * inclusively. Both 0 and 100 means no limit. Defaults to 0. 207 * </pre> 208 * 209 * <code>int32 files_limit_percent = 7;</code> 210 * 211 * @return The filesLimitPercent. 212 */ getFilesLimitPercent()213 int getFilesLimitPercent(); 214 } 215