• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 ListJobTriggersRequestOrBuilder
22     extends
23     // @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.ListJobTriggersRequest)
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:&lt;br/&gt;
35    *   `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
36    * + Projects scope, no location specified (defaults to global):&lt;br/&gt;
37    *   `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
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 = 1 [(.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:&lt;br/&gt;
60    *   `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;`/locations/`&lt;var&gt;LOCATION_ID&lt;/var&gt;
61    * + Projects scope, no location specified (defaults to global):&lt;br/&gt;
62    *   `projects/`&lt;var&gt;PROJECT_ID&lt;/var&gt;
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 = 1 [(.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    * Page token to continue retrieval. Comes from previous call
82    * to ListJobTriggers. `order_by` field must not
83    * change for subsequent calls.
84    * </pre>
85    *
86    * <code>string page_token = 2;</code>
87    *
88    * @return The pageToken.
89    */
getPageToken()90   java.lang.String getPageToken();
91   /**
92    *
93    *
94    * <pre>
95    * Page token to continue retrieval. Comes from previous call
96    * to ListJobTriggers. `order_by` field must not
97    * change for subsequent calls.
98    * </pre>
99    *
100    * <code>string page_token = 2;</code>
101    *
102    * @return The bytes for pageToken.
103    */
getPageTokenBytes()104   com.google.protobuf.ByteString getPageTokenBytes();
105 
106   /**
107    *
108    *
109    * <pre>
110    * Size of the page, can be limited by a server.
111    * </pre>
112    *
113    * <code>int32 page_size = 3;</code>
114    *
115    * @return The pageSize.
116    */
getPageSize()117   int getPageSize();
118 
119   /**
120    *
121    *
122    * <pre>
123    * Comma separated list of triggeredJob fields to order by,
124    * followed by `asc` or `desc` postfix. This list is case-insensitive,
125    * default sorting order is ascending, redundant space characters are
126    * insignificant.
127    * Example: `name asc,update_time, create_time desc`
128    * Supported fields are:
129    * - `create_time`: corresponds to the time the JobTrigger was created.
130    * - `update_time`: corresponds to the time the JobTrigger was last updated.
131    * - `last_run_time`: corresponds to the last time the JobTrigger ran.
132    * - `name`: corresponds to the JobTrigger's name.
133    * - `display_name`: corresponds to the JobTrigger's display name.
134    * - `status`: corresponds to JobTrigger's status.
135    * </pre>
136    *
137    * <code>string order_by = 4;</code>
138    *
139    * @return The orderBy.
140    */
getOrderBy()141   java.lang.String getOrderBy();
142   /**
143    *
144    *
145    * <pre>
146    * Comma separated list of triggeredJob fields to order by,
147    * followed by `asc` or `desc` postfix. This list is case-insensitive,
148    * default sorting order is ascending, redundant space characters are
149    * insignificant.
150    * Example: `name asc,update_time, create_time desc`
151    * Supported fields are:
152    * - `create_time`: corresponds to the time the JobTrigger was created.
153    * - `update_time`: corresponds to the time the JobTrigger was last updated.
154    * - `last_run_time`: corresponds to the last time the JobTrigger ran.
155    * - `name`: corresponds to the JobTrigger's name.
156    * - `display_name`: corresponds to the JobTrigger's display name.
157    * - `status`: corresponds to JobTrigger's status.
158    * </pre>
159    *
160    * <code>string order_by = 4;</code>
161    *
162    * @return The bytes for orderBy.
163    */
getOrderByBytes()164   com.google.protobuf.ByteString getOrderByBytes();
165 
166   /**
167    *
168    *
169    * <pre>
170    * Allows filtering.
171    * Supported syntax:
172    * * Filter expressions are made up of one or more restrictions.
173    * * Restrictions can be combined by `AND` or `OR` logical operators. A
174    * sequence of restrictions implicitly uses `AND`.
175    * * A restriction has the form of `{field} {operator} {value}`.
176    * * Supported fields/values for inspect triggers:
177    *     - `status` - HEALTHY|PAUSED|CANCELLED
178    *     - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
179    *     - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by
180    *     quotation marks. Nanoseconds are ignored.
181    *     - 'error_count' - Number of errors that have occurred while running.
182    * * The operator must be `=` or `!=` for status and inspected_storage.
183    * Examples:
184    * * inspected_storage = cloud_storage AND status = HEALTHY
185    * * inspected_storage = cloud_storage OR inspected_storage = bigquery
186    * * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)
187    * * last_run_time &gt; &#92;"2017-12-12T00:00:00+00:00&#92;"
188    * The length of this field should be no more than 500 characters.
189    * </pre>
190    *
191    * <code>string filter = 5;</code>
192    *
193    * @return The filter.
194    */
getFilter()195   java.lang.String getFilter();
196   /**
197    *
198    *
199    * <pre>
200    * Allows filtering.
201    * Supported syntax:
202    * * Filter expressions are made up of one or more restrictions.
203    * * Restrictions can be combined by `AND` or `OR` logical operators. A
204    * sequence of restrictions implicitly uses `AND`.
205    * * A restriction has the form of `{field} {operator} {value}`.
206    * * Supported fields/values for inspect triggers:
207    *     - `status` - HEALTHY|PAUSED|CANCELLED
208    *     - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
209    *     - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by
210    *     quotation marks. Nanoseconds are ignored.
211    *     - 'error_count' - Number of errors that have occurred while running.
212    * * The operator must be `=` or `!=` for status and inspected_storage.
213    * Examples:
214    * * inspected_storage = cloud_storage AND status = HEALTHY
215    * * inspected_storage = cloud_storage OR inspected_storage = bigquery
216    * * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)
217    * * last_run_time &gt; &#92;"2017-12-12T00:00:00+00:00&#92;"
218    * The length of this field should be no more than 500 characters.
219    * </pre>
220    *
221    * <code>string filter = 5;</code>
222    *
223    * @return The bytes for filter.
224    */
getFilterBytes()225   com.google.protobuf.ByteString getFilterBytes();
226 
227   /**
228    *
229    *
230    * <pre>
231    * The type of jobs. Will use `DlpJobType.INSPECT` if not set.
232    * </pre>
233    *
234    * <code>.google.privacy.dlp.v2.DlpJobType type = 6;</code>
235    *
236    * @return The enum numeric value on the wire for type.
237    */
getTypeValue()238   int getTypeValue();
239   /**
240    *
241    *
242    * <pre>
243    * The type of jobs. Will use `DlpJobType.INSPECT` if not set.
244    * </pre>
245    *
246    * <code>.google.privacy.dlp.v2.DlpJobType type = 6;</code>
247    *
248    * @return The type.
249    */
getType()250   com.google.privacy.dlp.v2.DlpJobType getType();
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