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/dlp.proto 18 19 package com.google.privacy.dlp.v2; 20 21 public interface ListDlpJobsRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.ListDlpJobsRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. Parent resource name. 31 * The format of this value varies depending on whether you have [specified a 32 * processing 33 * location](https://cloud.google.com/dlp/docs/specifying-location): 34 * + Projects scope, location specified:<br/> 35 * `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var> 36 * + Projects scope, no location specified (defaults to global):<br/> 37 * `projects/`<var>PROJECT_ID</var> 38 * The following example `parent` string specifies a parent project with the 39 * identifier `example-project`, and specifies the `europe-west3` location 40 * for processing data: 41 * parent=projects/example-project/locations/europe-west3 42 * </pre> 43 * 44 * <code> 45 * string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 46 * </code> 47 * 48 * @return The parent. 49 */ getParent()50 java.lang.String getParent(); 51 /** 52 * 53 * 54 * <pre> 55 * Required. Parent resource name. 56 * The format of this value varies depending on whether you have [specified a 57 * processing 58 * location](https://cloud.google.com/dlp/docs/specifying-location): 59 * + Projects scope, location specified:<br/> 60 * `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var> 61 * + Projects scope, no location specified (defaults to global):<br/> 62 * `projects/`<var>PROJECT_ID</var> 63 * The following example `parent` string specifies a parent project with the 64 * identifier `example-project`, and specifies the `europe-west3` location 65 * for processing data: 66 * parent=projects/example-project/locations/europe-west3 67 * </pre> 68 * 69 * <code> 70 * string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 71 * </code> 72 * 73 * @return The bytes for parent. 74 */ getParentBytes()75 com.google.protobuf.ByteString getParentBytes(); 76 77 /** 78 * 79 * 80 * <pre> 81 * Allows filtering. 82 * Supported syntax: 83 * * Filter expressions are made up of one or more restrictions. 84 * * Restrictions can be combined by `AND` or `OR` logical operators. A 85 * sequence of restrictions implicitly uses `AND`. 86 * * A restriction has the form of `{field} {operator} {value}`. 87 * * Supported fields/values for inspect jobs: 88 * - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED 89 * - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY 90 * - `trigger_name` - The name of the trigger that created the job. 91 * - 'end_time` - Corresponds to the time the job finished. 92 * - 'start_time` - Corresponds to the time the job finished. 93 * * Supported fields for risk analysis jobs: 94 * - `state` - RUNNING|CANCELED|FINISHED|FAILED 95 * - 'end_time` - Corresponds to the time the job finished. 96 * - 'start_time` - Corresponds to the time the job finished. 97 * * The operator must be `=` or `!=`. 98 * Examples: 99 * * inspected_storage = cloud_storage AND state = done 100 * * inspected_storage = cloud_storage OR inspected_storage = bigquery 101 * * inspected_storage = cloud_storage AND (state = done OR state = canceled) 102 * * end_time > \"2017-12-12T00:00:00+00:00\" 103 * The length of this field should be no more than 500 characters. 104 * </pre> 105 * 106 * <code>string filter = 1;</code> 107 * 108 * @return The filter. 109 */ getFilter()110 java.lang.String getFilter(); 111 /** 112 * 113 * 114 * <pre> 115 * Allows filtering. 116 * Supported syntax: 117 * * Filter expressions are made up of one or more restrictions. 118 * * Restrictions can be combined by `AND` or `OR` logical operators. A 119 * sequence of restrictions implicitly uses `AND`. 120 * * A restriction has the form of `{field} {operator} {value}`. 121 * * Supported fields/values for inspect jobs: 122 * - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED 123 * - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY 124 * - `trigger_name` - The name of the trigger that created the job. 125 * - 'end_time` - Corresponds to the time the job finished. 126 * - 'start_time` - Corresponds to the time the job finished. 127 * * Supported fields for risk analysis jobs: 128 * - `state` - RUNNING|CANCELED|FINISHED|FAILED 129 * - 'end_time` - Corresponds to the time the job finished. 130 * - 'start_time` - Corresponds to the time the job finished. 131 * * The operator must be `=` or `!=`. 132 * Examples: 133 * * inspected_storage = cloud_storage AND state = done 134 * * inspected_storage = cloud_storage OR inspected_storage = bigquery 135 * * inspected_storage = cloud_storage AND (state = done OR state = canceled) 136 * * end_time > \"2017-12-12T00:00:00+00:00\" 137 * The length of this field should be no more than 500 characters. 138 * </pre> 139 * 140 * <code>string filter = 1;</code> 141 * 142 * @return The bytes for filter. 143 */ getFilterBytes()144 com.google.protobuf.ByteString getFilterBytes(); 145 146 /** 147 * 148 * 149 * <pre> 150 * The standard list page size. 151 * </pre> 152 * 153 * <code>int32 page_size = 2;</code> 154 * 155 * @return The pageSize. 156 */ getPageSize()157 int getPageSize(); 158 159 /** 160 * 161 * 162 * <pre> 163 * The standard list page token. 164 * </pre> 165 * 166 * <code>string page_token = 3;</code> 167 * 168 * @return The pageToken. 169 */ getPageToken()170 java.lang.String getPageToken(); 171 /** 172 * 173 * 174 * <pre> 175 * The standard list page token. 176 * </pre> 177 * 178 * <code>string page_token = 3;</code> 179 * 180 * @return The bytes for pageToken. 181 */ getPageTokenBytes()182 com.google.protobuf.ByteString getPageTokenBytes(); 183 184 /** 185 * 186 * 187 * <pre> 188 * The type of job. Defaults to `DlpJobType.INSPECT` 189 * </pre> 190 * 191 * <code>.google.privacy.dlp.v2.DlpJobType type = 5;</code> 192 * 193 * @return The enum numeric value on the wire for type. 194 */ getTypeValue()195 int getTypeValue(); 196 /** 197 * 198 * 199 * <pre> 200 * The type of job. Defaults to `DlpJobType.INSPECT` 201 * </pre> 202 * 203 * <code>.google.privacy.dlp.v2.DlpJobType type = 5;</code> 204 * 205 * @return The type. 206 */ getType()207 com.google.privacy.dlp.v2.DlpJobType getType(); 208 209 /** 210 * 211 * 212 * <pre> 213 * Comma separated list of fields to order by, 214 * followed by `asc` or `desc` postfix. This list is case-insensitive, 215 * default sorting order is ascending, redundant space characters are 216 * insignificant. 217 * Example: `name asc, end_time asc, create_time desc` 218 * Supported fields are: 219 * - `create_time`: corresponds to the time the job was created. 220 * - `end_time`: corresponds to the time the job ended. 221 * - `name`: corresponds to the job's name. 222 * - `state`: corresponds to `state` 223 * </pre> 224 * 225 * <code>string order_by = 6;</code> 226 * 227 * @return The orderBy. 228 */ getOrderBy()229 java.lang.String getOrderBy(); 230 /** 231 * 232 * 233 * <pre> 234 * Comma separated list of fields to order by, 235 * followed by `asc` or `desc` postfix. This list is case-insensitive, 236 * default sorting order is ascending, redundant space characters are 237 * insignificant. 238 * Example: `name asc, end_time asc, create_time desc` 239 * Supported fields are: 240 * - `create_time`: corresponds to the time the job was created. 241 * - `end_time`: corresponds to the time the job ended. 242 * - `name`: corresponds to the job's name. 243 * - `state`: corresponds to `state` 244 * </pre> 245 * 246 * <code>string order_by = 6;</code> 247 * 248 * @return The bytes for orderBy. 249 */ getOrderByBytes()250 com.google.protobuf.ByteString getOrderByBytes(); 251 252 /** 253 * 254 * 255 * <pre> 256 * Deprecated. This field has no effect. 257 * </pre> 258 * 259 * <code>string location_id = 7;</code> 260 * 261 * @return The locationId. 262 */ getLocationId()263 java.lang.String getLocationId(); 264 /** 265 * 266 * 267 * <pre> 268 * Deprecated. This field has no effect. 269 * </pre> 270 * 271 * <code>string location_id = 7;</code> 272 * 273 * @return The bytes for locationId. 274 */ getLocationIdBytes()275 com.google.protobuf.ByteString getLocationIdBytes(); 276 } 277