Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / toolresults_v1beta3.projects.html
blob: 48691c60b5415e6e6845b6ffc0b9b90d5a52a3f6 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="toolresults_v1beta3.html">Cloud Tool Results API</a> . <a href="toolresults_v1beta3.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="toolresults_v1beta3.projects.histories.html">histories()</a></code>
79</p>
80<p class="firstline">Returns the histories Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="#getSettings">getSettings(projectId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]84<p class="firstline">Gets the Tool Results settings for a project.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]86 <code><a href="#initializeSettings">initializeSettings(projectId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]87<p class="firstline">Creates resources for settings which have not yet been set.</p>
88<h3>Method Details</h3>
89<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code class="details" id="getSettings">getSettings(projectId, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]91 <pre>Gets the Tool Results settings for a project.
92
93May return any of the following canonical error codes:
94
95- PERMISSION_DENIED - if the user is not authorized to read from project
96
97Args:
98 projectId: string, A Project id.
99
100Required. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]105
106Returns:
107 An object of the form:
108
109 { # Per-project settings for the Tool Results service.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 &quot;defaultBucket&quot;: &quot;A String&quot;, # The name of the Google Cloud Storage bucket to which results are written.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]111 #
112 # By default, this is unset.
113 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]114 # In update request: optional
115 # In response: optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 &quot;name&quot;: &quot;A String&quot;, # The name of the project&#x27;s settings.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]117 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118 # Always of the form:
119 # projects/{project-id}/settings
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]120 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]121 # In update request: never set
122 # In response: always set
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]123 }</pre>
124</div>
125
126<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]127 <code class="details" id="initializeSettings">initializeSettings(projectId, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]128 <pre>Creates resources for settings which have not yet been set.
129
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]130Currently, this creates a single resource: a Google Cloud Storage bucket,
131to be used as the default bucket for this project. The bucket is created
132in an FTL-own storage project. Except for in rare cases, calling this
133method in parallel from multiple clients will only create a single bucket.
134In order to avoid unnecessary storage charges, the bucket is configured to
135automatically delete objects older than 90 days.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]136
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]137The bucket is created with the following permissions:
138- Owner access for owners of central storage project (FTL-owned)
139- Writer access for owners/editors of customer project
140- Reader access for viewers of customer project
141The default ACL on objects created in the bucket is:
142- Owner access for owners of central storage project
143- Reader access for owners/editors/viewers of customer project
144See Google Cloud Storage documentation for more details.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]145
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]146If there is already a default bucket set and the project can access the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147bucket, this call does nothing. However, if the project doesn&#x27;t have the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148permission to access the bucket or the bucket is deleted, a new bucket
149will be created.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]150
151May return any canonical error codes, including the following:
152
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]153- PERMISSION_DENIED - if the user is not authorized to write to project
154- Any error code raised by Google Cloud Storage
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]155
156Args:
157 projectId: string, A Project id.
158
159Required. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]160 x__xgafv: string, V1 error format.
161 Allowed values
162 1 - v1 error format
163 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]164
165Returns:
166 An object of the form:
167
168 { # Per-project settings for the Tool Results service.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 &quot;defaultBucket&quot;: &quot;A String&quot;, # The name of the Google Cloud Storage bucket to which results are written.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]170 #
171 # By default, this is unset.
172 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]173 # In update request: optional
174 # In response: optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 &quot;name&quot;: &quot;A String&quot;, # The name of the project&#x27;s settings.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]176 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]177 # Always of the form:
178 # projects/{project-id}/settings
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]179 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]180 # In update request: never set
181 # In response: always set
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]182 }</pre>
183</div>
184
185</body></html>