File: firebaseappdistribution_v1alpha.projects.apps.testCases.html

package info (click to toggle)
python-googleapi 2.182.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 533,852 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (366 lines) | stat: -rw-r--r-- 17,682 bytes parent folder | download
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="firebaseappdistribution_v1alpha.html">Firebase App Distribution API</a> . <a href="firebaseappdistribution_v1alpha.projects.html">projects</a> . <a href="firebaseappdistribution_v1alpha.projects.apps.html">apps</a> . <a href="firebaseappdistribution_v1alpha.projects.apps.testCases.html">testCases</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete test cases.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, testCaseId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a new test case.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a test case.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a test case.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List test cases.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a test case.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
  <pre>Delete test cases.

Args:
  parent: string, Required. The parent resource where these test cases will be deleted. Format: `projects/{project_number}/apps/{app_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for `DeleteTestCase`.
  &quot;names&quot;: [ # Required. The name of the test cases to delete. A maximum number of 1000 test cases can be deleted in one batch Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
    &quot;A String&quot;,
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, testCaseId=None, x__xgafv=None)</code>
  <pre>Create a new test case.

Args:
  parent: string, Required. The parent resource where this test case will be created. Format: `projects/{project_number}/apps/{app_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # AI test cases
  &quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test.
    &quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
      { # A step to be accomplished by the AI
        &quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
        &quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
        &quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
        &quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
        &quot;testCase&quot;: &quot;A String&quot;, # Output only. The test case that contained this step. Note: The test case may have changed or been deleted since this step was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
      },
    ],
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the test case was created
  &quot;dependentTestCases&quot;: [ # Output only. Other test cases that depend on this test case as a prerequisite.
    &quot;A String&quot;,
  ],
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the test case.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
  &quot;prerequisiteTestCase&quot;: &quot;A String&quot;, # Optional. Test case that must be run before this test case.
}

  testCaseId: string, Optional. The ID to use for the test case, which will become the final component of the test case&#x27;s resource name. This value should be 4-63 characters, and valid characters are /a-z-/.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AI test cases
  &quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test.
    &quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
      { # A step to be accomplished by the AI
        &quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
        &quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
        &quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
        &quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
        &quot;testCase&quot;: &quot;A String&quot;, # Output only. The test case that contained this step. Note: The test case may have changed or been deleted since this step was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
      },
    ],
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the test case was created
  &quot;dependentTestCases&quot;: [ # Output only. Other test cases that depend on this test case as a prerequisite.
    &quot;A String&quot;,
  ],
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the test case.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
  &quot;prerequisiteTestCase&quot;: &quot;A String&quot;, # Optional. Test case that must be run before this test case.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Delete a test case.

Args:
  name: string, Required. The name of the test case resource to delete. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Get a test case.

Args:
  name: string, Required. The name of the test case resource to retrieve. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AI test cases
  &quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test.
    &quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
      { # A step to be accomplished by the AI
        &quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
        &quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
        &quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
        &quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
        &quot;testCase&quot;: &quot;A String&quot;, # Output only. The test case that contained this step. Note: The test case may have changed or been deleted since this step was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
      },
    ],
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the test case was created
  &quot;dependentTestCases&quot;: [ # Output only. Other test cases that depend on this test case as a prerequisite.
    &quot;A String&quot;,
  ],
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the test case.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
  &quot;prerequisiteTestCase&quot;: &quot;A String&quot;, # Optional. Test case that must be run before this test case.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>List test cases.

Args:
  parent: string, Required. The parent resource from which to list test cases. Format: `projects/{project_number}/apps/{app_id}` (required)
  pageSize: integer, Optional. The maximum number of test cases to return. The service may return fewer than this value. If unspecified, at most 50 test cases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListTestCases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTestCases` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for `ListTestCases`.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  &quot;testCases&quot;: [ # The test cases from the specified app.
    { # AI test cases
      &quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test.
        &quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
          { # A step to be accomplished by the AI
            &quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
            &quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
            &quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
            &quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
            &quot;testCase&quot;: &quot;A String&quot;, # Output only. The test case that contained this step. Note: The test case may have changed or been deleted since this step was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
          },
        ],
      },
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the test case was created
      &quot;dependentTestCases&quot;: [ # Output only. Other test cases that depend on this test case as a prerequisite.
        &quot;A String&quot;,
      ],
      &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the test case.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
      &quot;prerequisiteTestCase&quot;: &quot;A String&quot;, # Optional. Test case that must be run before this test case.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
  <pre>Update a test case.

Args:
  name: string, Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # AI test cases
  &quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test.
    &quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
      { # A step to be accomplished by the AI
        &quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
        &quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
        &quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
        &quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
        &quot;testCase&quot;: &quot;A String&quot;, # Output only. The test case that contained this step. Note: The test case may have changed or been deleted since this step was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
      },
    ],
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the test case was created
  &quot;dependentTestCases&quot;: [ # Output only. Other test cases that depend on this test case as a prerequisite.
    &quot;A String&quot;,
  ],
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the test case.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
  &quot;prerequisiteTestCase&quot;: &quot;A String&quot;, # Optional. Test case that must be run before this test case.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AI test cases
  &quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test.
    &quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
      { # A step to be accomplished by the AI
        &quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
        &quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
        &quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
        &quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
        &quot;testCase&quot;: &quot;A String&quot;, # Output only. The test case that contained this step. Note: The test case may have changed or been deleted since this step was created. Format: `projects/{project_number}/apps/{app}/testCases/{test_case}`
      },
    ],
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the test case was created
  &quot;dependentTestCases&quot;: [ # Output only. Other test cases that depend on this test case as a prerequisite.
    &quot;A String&quot;,
  ],
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the test case.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
  &quot;prerequisiteTestCase&quot;: &quot;A String&quot;, # Optional. Test case that must be run before this test case.
}</pre>
</div>

</body></html>