Debian Codegraph @

docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="discoveryengine_v1beta.html">Discovery Engine API</a> . <a href="discoveryengine_v1beta.projects.html">projects</a> . <a href="discoveryengine_v1beta.projects.locations.html">locations</a> . <a href="discoveryengine_v1beta.projects.locations.sampleQuerySets.html">sampleQuerySets</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="discoveryengine_v1beta.projects.locations.sampleQuerySets.operations.html">operations()</a></code>
79 </p>
80 <p class="firstline">Returns the operations Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html">sampleQueries()</a></code>
84 </p>
85 <p class="firstline">Returns the sampleQueries Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="#close">close()</a></code></p>
89 <p class="firstline">Close httplib2 connections.</p>
90 <p class="toc_element">
91 <code><a href="#create">create(parent, body=None, sampleQuerySetId=None, x__xgafv=None)</a></code></p>
92 <p class="firstline">Creates a SampleQuerySet</p>
93 <p class="toc_element">
94 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
95 <p class="firstline">Deletes a SampleQuerySet.</p>
96 <p class="toc_element">
97 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
98 <p class="firstline">Gets a SampleQuerySet.</p>
99 <p class="toc_element">
100 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
101 <p class="firstline">Gets a list of SampleQuerySets.</p>
102 <p class="toc_element">
103 <code><a href="#list_next">list_next()</a></code></p>
104 <p class="firstline">Retrieves the next page of results.</p>
105 <p class="toc_element">
106 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
107 <p class="firstline">Updates a SampleQuerySet.</p>
108 <h3>Method Details</h3>
109 <div class="method">
110 <code class="details" id="close">close()</code>
111 <pre>Close httplib2 connections.</pre>
112 </div>
113
114 <div class="method">
115 <code class="details" id="create">create(parent, body=None, sampleQuerySetId=None, x__xgafv=None)</code>
116 <pre>Creates a SampleQuerySet
117
118 Args:
119 parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
120 body: object, The request body.
121 The object takes the form of:
122
123 { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
124 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the SampleQuerySet was created at.
125 &quot;description&quot;: &quot;A String&quot;, # The description of the SampleQuerySet.
126 &quot;displayName&quot;: &quot;A String&quot;, # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
127 &quot;name&quot;: &quot;A String&quot;, # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
128 }
129
130 sampleQuerySetId: string, Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136 Returns:
137 An object of the form:
138
139 { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
140 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the SampleQuerySet was created at.
141 &quot;description&quot;: &quot;A String&quot;, # The description of the SampleQuerySet.
142 &quot;displayName&quot;: &quot;A String&quot;, # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
143 &quot;name&quot;: &quot;A String&quot;, # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
144 }</pre>
145 </div>
146
147 <div class="method">
148 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
149 <pre>Deletes a SampleQuerySet.
150
151 Args:
152 name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. (required)
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158 Returns:
159 An object of the form:
160
161 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
162 }</pre>
163 </div>
164
165 <div class="method">
166 <code class="details" id="get">get(name, x__xgafv=None)</code>
167 <pre>Gets a SampleQuerySet.
168
169 Args:
170 name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. (required)
171 x__xgafv: string, V1 error format.
172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
175
176 Returns:
177 An object of the form:
178
179 { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
180 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the SampleQuerySet was created at.
181 &quot;description&quot;: &quot;A String&quot;, # The description of the SampleQuerySet.
182 &quot;displayName&quot;: &quot;A String&quot;, # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
183 &quot;name&quot;: &quot;A String&quot;, # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
184 }</pre>
185 </div>
186
187 <div class="method">
188 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
189 <pre>Gets a list of SampleQuerySets.
190
191 Args:
192 parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
193 pageSize: integer, Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
194 pageToken: string, A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
199
200 Returns:
201 An object of the form:
202
203 { # Response message for SampleQuerySetService.ListSampleQuerySets method.
204 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
205 &quot;sampleQuerySets&quot;: [ # The SampleQuerySets.
206 { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
207 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the SampleQuerySet was created at.
208 &quot;description&quot;: &quot;A String&quot;, # The description of the SampleQuerySet.
209 &quot;displayName&quot;: &quot;A String&quot;, # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
210 &quot;name&quot;: &quot;A String&quot;, # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
211 },
212 ],
213 }</pre>
214 </div>
215
216 <div class="method">
217 <code class="details" id="list_next">list_next()</code>
218 <pre>Retrieves the next page of results.
219
220 Args:
221 previous_request: The request for the previous page. (required)
222 previous_response: The response from the request for the previous page. (required)
223
224 Returns:
225 A request object that you can call &#x27;execute()&#x27; on to request the next
226 page. Returns None if there are no more items in the collection.
227 </pre>
228 </div>
229
230 <div class="method">
231 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
232 <pre>Updates a SampleQuerySet.
233
234 Args:
235 name: string, Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
236 body: object, The request body.
237 The object takes the form of:
238
239 { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
240 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the SampleQuerySet was created at.
241 &quot;description&quot;: &quot;A String&quot;, # The description of the SampleQuerySet.
242 &quot;displayName&quot;: &quot;A String&quot;, # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
243 &quot;name&quot;: &quot;A String&quot;, # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
244 }
245
246 updateMask: string, Indicates which fields in the provided imported &#x27;sample query set&#x27; to update. If not set, will by default update all fields.
247 x__xgafv: string, V1 error format.
248 Allowed values
249 1 - v1 error format
250 2 - v2 error format
251
252 Returns:
253 An object of the form:
254
255 { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
256 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the SampleQuerySet was created at.
257 &quot;description&quot;: &quot;A String&quot;, # The description of the SampleQuerySet.
258 &quot;displayName&quot;: &quot;A String&quot;, # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
259 &quot;name&quot;: &quot;A String&quot;, # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
260 }</pre>
261 </div>
262
263 </body></html>