This repository has been archived by the owner on Oct 3, 2023. It is now read-only.
/
SearchFoldersRequestOrBuilder.java
141 lines (136 loc) · 5.33 KB
/
SearchFoldersRequestOrBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/resourcemanager/v3/folders.proto
package com.google.cloud.resourcemanager.v3;
public interface SearchFoldersRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.resourcemanager.v3.SearchFoldersRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
* <pre>
* Optional. The maximum number of folders to return in the response.
* If unspecified, server picks an appropriate default.
* </pre>
*
* <code>int32 page_size = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
*
* @return The pageSize.
*/
int getPageSize();
/**
*
*
* <pre>
* Optional. A pagination token returned from a previous call to `SearchFolders`
* that indicates from where search should continue.
* </pre>
*
* <code>string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
*
* @return The pageToken.
*/
java.lang.String getPageToken();
/**
*
*
* <pre>
* Optional. A pagination token returned from a previous call to `SearchFolders`
* that indicates from where search should continue.
* </pre>
*
* <code>string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
*
* @return The bytes for pageToken.
*/
com.google.protobuf.ByteString getPageTokenBytes();
/**
*
*
* <pre>
* Optional. Search criteria used to select the folders to return.
* If no search criteria is specified then all accessible folders will be
* returned.
* Query expressions can be used to restrict results based upon displayName,
* state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR`
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
* * Query `state=ACTIVE` returns Folder resources with
* `state` set to `ACTIVE`.
* * Query `parent=folders/123` returns Folder resources that have
* `folders/123` as a parent resource.
* * Query `parent=folders/123 AND state=ACTIVE` returns active
* Folder resources that have `folders/123` as a parent resource.
* * Query `displayName=\\"Test String\\"` returns Folder resources with
* display names that include both "Test" and "String".
* </pre>
*
* <code>string query = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
*
* @return The query.
*/
java.lang.String getQuery();
/**
*
*
* <pre>
* Optional. Search criteria used to select the folders to return.
* If no search criteria is specified then all accessible folders will be
* returned.
* Query expressions can be used to restrict results based upon displayName,
* state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR`
* can be used along with the suffix wildcard symbol `*`.
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
* Some example queries are:
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
* * Query `state=ACTIVE` returns Folder resources with
* `state` set to `ACTIVE`.
* * Query `parent=folders/123` returns Folder resources that have
* `folders/123` as a parent resource.
* * Query `parent=folders/123 AND state=ACTIVE` returns active
* Folder resources that have `folders/123` as a parent resource.
* * Query `displayName=\\"Test String\\"` returns Folder resources with
* display names that include both "Test" and "String".
* </pre>
*
* <code>string query = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
*
* @return The bytes for query.
*/
com.google.protobuf.ByteString getQueryBytes();
}