Debian Codegraph @

docs/dyn/firebaseappdistribution_v1alpha.projects.apps.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="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></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="firebaseappdistribution_v1alpha.projects.apps.releases.html">releases()</a></code>
79 </p>
80 <p class="firstline">Returns the releases Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="firebaseappdistribution_v1alpha.projects.apps.testCases.html">testCases()</a></code>
84 </p>
85 <p class="firstline">Returns the testCases 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="#getTestConfig">getTestConfig(name, x__xgafv=None)</a></code></p>
92 <p class="firstline">Gets configuration for automated tests.</p>
93 <p class="toc_element">
94 <code><a href="#updateTestConfig">updateTestConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
95 <p class="firstline">Updates automated test configuration.</p>
96 <h3>Method Details</h3>
97 <div class="method">
98 <code class="details" id="close">close()</code>
99 <pre>Close httplib2 connections.</pre>
100 </div>
101
102 <div class="method">
103 <code class="details" id="getTestConfig">getTestConfig(name, x__xgafv=None)</code>
104 <pre>Gets configuration for automated tests.
105
106 Args:
107 name: string, Required. The name of the `TestConfig` resource to retrieve. Format: `projects/{project_number}/apps/{app}/testConfig` (required)
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113 Returns:
114 An object of the form:
115
116 { # Configuration for automated tests
117 &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the AI driven test. Required if the release test is created with multiple goals.
118 &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the test configuration resource. Format: `projects/{project_number}/apps/{app}/testConfig`
119 &quot;resultsBucket&quot;: &quot;A String&quot;, # Optional. The custom Cloud Storage bucket where test results are stored. Format: `projects/{project_number}/buckets/{bucket}` If not provided, the default test lab bucket is used.
120 &quot;roboCrawler&quot;: { # Configuration for Robo crawler # Optional. Configuration for Robo crawler
121 &quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test
122 &quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
123 { # A step to be accomplished by the AI
124 &quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
125 &quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
126 &quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
127 &quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A visual description of the screen&#x27;s expected state after the step has been successfully completed. This is referred to as the &quot;final screen assertion&quot; in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps.
128 &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}`
129 },
130 ],
131 },
132 &quot;loginCredential&quot;: { # Login credential for automated tests # Optional. Login credential for automated tests
133 &quot;fieldHints&quot;: { # Hints to the crawler for identifying input fields # Optional. Hints to the crawler for identifying input fields
134 &quot;passwordResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the password UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
135 &quot;usernameResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the username UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
136 },
137 &quot;google&quot;: True or False, # Optional. Are these credentials for Google?
138 &quot;password&quot;: &quot;A String&quot;, # Optional. Password for automated tests
139 &quot;username&quot;: &quot;A String&quot;, # Optional. Username for automated tests
140 },
141 },
142 &quot;testDevices&quot;: [ # Optional. Tests will be run on this list of devices
143 { # A device on which automated tests can be run.
144 &quot;locale&quot;: &quot;A String&quot;, # Optional. The locale of the device (e.g. &quot;en_US&quot; for US English) during the test.
145 &quot;model&quot;: &quot;A String&quot;, # Required. The device model.
146 &quot;orientation&quot;: &quot;A String&quot;, # Optional. The orientation of the device during the test.
147 &quot;version&quot;: &quot;A String&quot;, # Required. The version of the device (API level on Android).
148 },
149 ],
150 }</pre>
151 </div>
152
153 <div class="method">
154 <code class="details" id="updateTestConfig">updateTestConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
155 <pre>Updates automated test configuration.
156
157 Args:
158 name: string, Identifier. The name of the test configuration resource. Format: `projects/{project_number}/apps/{app}/testConfig` (required)
159 body: object, The request body.
160 The object takes the form of:
161
162 { # Configuration for automated tests
163 &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the AI driven test. Required if the release test is created with multiple goals.
164 &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the test configuration resource. Format: `projects/{project_number}/apps/{app}/testConfig`
165 &quot;resultsBucket&quot;: &quot;A String&quot;, # Optional. The custom Cloud Storage bucket where test results are stored. Format: `projects/{project_number}/buckets/{bucket}` If not provided, the default test lab bucket is used.
166 &quot;roboCrawler&quot;: { # Configuration for Robo crawler # Optional. Configuration for Robo crawler
167 &quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test
168 &quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
169 { # A step to be accomplished by the AI
170 &quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
171 &quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
172 &quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
173 &quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A visual description of the screen&#x27;s expected state after the step has been successfully completed. This is referred to as the &quot;final screen assertion&quot; in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps.
174 &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}`
175 },
176 ],
177 },
178 &quot;loginCredential&quot;: { # Login credential for automated tests # Optional. Login credential for automated tests
179 &quot;fieldHints&quot;: { # Hints to the crawler for identifying input fields # Optional. Hints to the crawler for identifying input fields
180 &quot;passwordResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the password UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
181 &quot;usernameResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the username UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
182 },
183 &quot;google&quot;: True or False, # Optional. Are these credentials for Google?
184 &quot;password&quot;: &quot;A String&quot;, # Optional. Password for automated tests
185 &quot;username&quot;: &quot;A String&quot;, # Optional. Username for automated tests
186 },
187 },
188 &quot;testDevices&quot;: [ # Optional. Tests will be run on this list of devices
189 { # A device on which automated tests can be run.
190 &quot;locale&quot;: &quot;A String&quot;, # Optional. The locale of the device (e.g. &quot;en_US&quot; for US English) during the test.
191 &quot;model&quot;: &quot;A String&quot;, # Required. The device model.
192 &quot;orientation&quot;: &quot;A String&quot;, # Optional. The orientation of the device during the test.
193 &quot;version&quot;: &quot;A String&quot;, # Required. The version of the device (API level on Android).
194 },
195 ],
196 }
197
198 updateMask: string, Optional. The list of fields to update.
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204 Returns:
205 An object of the form:
206
207 { # Configuration for automated tests
208 &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the AI driven test. Required if the release test is created with multiple goals.
209 &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the test configuration resource. Format: `projects/{project_number}/apps/{app}/testConfig`
210 &quot;resultsBucket&quot;: &quot;A String&quot;, # Optional. The custom Cloud Storage bucket where test results are stored. Format: `projects/{project_number}/buckets/{bucket}` If not provided, the default test lab bucket is used.
211 &quot;roboCrawler&quot;: { # Configuration for Robo crawler # Optional. Configuration for Robo crawler
212 &quot;aiInstructions&quot;: { # Optional. Instructions for AI driven test
213 &quot;steps&quot;: [ # Required. Steps to be accomplished by the AI
214 { # A step to be accomplished by the AI
215 &quot;assertion&quot;: &quot;A String&quot;, # An assertion to be checked by the AI
216 &quot;goal&quot;: &quot;A String&quot;, # A goal to be accomplished by the AI
217 &quot;hint&quot;: &quot;A String&quot;, # Optional. Hint text containing suggestions to help the agent accomplish the goal
218 &quot;successCriteria&quot;: &quot;A String&quot;, # Optional. A visual description of the screen&#x27;s expected state after the step has been successfully completed. This is referred to as the &quot;final screen assertion&quot; in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps.
219 &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}`
220 },
221 ],
222 },
223 &quot;loginCredential&quot;: { # Login credential for automated tests # Optional. Login credential for automated tests
224 &quot;fieldHints&quot;: { # Hints to the crawler for identifying input fields # Optional. Hints to the crawler for identifying input fields
225 &quot;passwordResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the password UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
226 &quot;usernameResourceName&quot;: &quot;A String&quot;, # Required. The Android resource name of the username UI element. For example, in Java: R.string.foo in xml: @string/foo Only the &quot;foo&quot; part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
227 },
228 &quot;google&quot;: True or False, # Optional. Are these credentials for Google?
229 &quot;password&quot;: &quot;A String&quot;, # Optional. Password for automated tests
230 &quot;username&quot;: &quot;A String&quot;, # Optional. Username for automated tests
231 },
232 },
233 &quot;testDevices&quot;: [ # Optional. Tests will be run on this list of devices
234 { # A device on which automated tests can be run.
235 &quot;locale&quot;: &quot;A String&quot;, # Optional. The locale of the device (e.g. &quot;en_US&quot; for US English) during the test.
236 &quot;model&quot;: &quot;A String&quot;, # Required. The device model.
237 &quot;orientation&quot;: &quot;A String&quot;, # Optional. The orientation of the device during the test.
238 &quot;version&quot;: &quot;A String&quot;, # Required. The version of the device (API level on Android).
239 },
240 ],
241 }</pre>
242 </div>
243
244 </body></html>