Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / toolresults_v1beta3.projects.html
blob: f139325fc5a48dd953b15ba3c1875bda6be96a5e [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#getSettings">getSettings(projectId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]79<p class="firstline">Gets the Tool Results settings for a project.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#initializeSettings">initializeSettings(projectId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]82<p class="firstline">Creates resources for settings which have not yet been set.</p>
83<h3>Method Details</h3>
84<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]85 <code class="details" id="getSettings">getSettings(projectId, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]86 <pre>Gets the Tool Results settings for a project.
87
88May return any of the following canonical error codes:
89
90- PERMISSION_DENIED - if the user is not authorized to read from project
91
92Args:
93 projectId: string, A Project id.
94
95Required. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]100
101Returns:
102 An object of the form:
103
104 { # Per-project settings for the Tool Results service.
105 "defaultBucket": "A String", # The name of the Google Cloud Storage bucket to which results are written.
106 #
107 # By default, this is unset.
108 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]109 # In update request: optional
110 # In response: optional
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]111 "name": "A String", # The name of the project's settings.
112 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]113 # Always of the form:
114 # projects/{project-id}/settings
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]115 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]116 # In update request: never set
117 # In response: always set
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]118 }</pre>
119</div>
120
121<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 <code class="details" id="initializeSettings">initializeSettings(projectId, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]123 <pre>Creates resources for settings which have not yet been set.
124
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125Currently, this creates a single resource: a Google Cloud Storage bucket,
126to be used as the default bucket for this project. The bucket is created
127in an FTL-own storage project. Except for in rare cases, calling this
128method in parallel from multiple clients will only create a single bucket.
129In order to avoid unnecessary storage charges, the bucket is configured to
130automatically delete objects older than 90 days.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]131
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132The bucket is created with the following permissions:
133- Owner access for owners of central storage project (FTL-owned)
134- Writer access for owners/editors of customer project
135- Reader access for viewers of customer project
136The default ACL on objects created in the bucket is:
137- Owner access for owners of central storage project
138- Reader access for owners/editors/viewers of customer project
139See Google Cloud Storage documentation for more details.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]140
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]141If there is already a default bucket set and the project can access the
142bucket, this call does nothing. However, if the project doesn't have the
143permission to access the bucket or the bucket is deleted, a new bucket
144will be created.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]145
146May return any canonical error codes, including the following:
147
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]148- PERMISSION_DENIED - if the user is not authorized to write to project
149- Any error code raised by Google Cloud Storage
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]150
151Args:
152 projectId: string, A Project id.
153
154Required. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]155 x__xgafv: string, V1 error format.
156 Allowed values
157 1 - v1 error format
158 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]159
160Returns:
161 An object of the form:
162
163 { # Per-project settings for the Tool Results service.
164 "defaultBucket": "A String", # The name of the Google Cloud Storage bucket to which results are written.
165 #
166 # By default, this is unset.
167 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]168 # In update request: optional
169 # In response: optional
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]170 "name": "A String", # The name of the project's settings.
171 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]172 # Always of the form:
173 # projects/{project-id}/settings
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]174 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]175 # In update request: never set
176 # In response: always set
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]177 }</pre>
178</div>
179
180</body></html>