Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ba8c235185d73c50911d3e1ef511904b474fee2 / . / docs / dyn / toolresults_v1beta3.projects.html
blob: f45a7cdb8e8cc01e956b0c21dadc1989fda871c8 [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">
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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]83 <code><a href="#getSettings">getSettings(projectId)</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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]86 <code><a href="#initializeSettings">initializeSettings(projectId)</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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]90 <code class="details" id="getSettings">getSettings(projectId)</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)
101
102Returns:
103 An object of the form:
104
105 { # Per-project settings for the Tool Results service.
106 "defaultBucket": "A String", # The name of the Google Cloud Storage bucket to which results are written.
107 #
108 # By default, this is unset.
109 #
110 # In update request: optional In response: optional
111 "name": "A String", # The name of the project's settings.
112 #
113 # Always of the form: projects/{project-id}/settings
114 #
115 # In update request: never set In response: always set
116 }</pre>
117</div>
118
119<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]120 <code class="details" id="initializeSettings">initializeSettings(projectId)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]121 <pre>Creates resources for settings which have not yet been set.
122
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]123Currently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]124
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]125The bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]126
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]127If there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]128
129May return any canonical error codes, including the following:
130
131- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage
132
133Args:
134 projectId: string, A Project id.
135
136Required. (required)
137
138Returns:
139 An object of the form:
140
141 { # Per-project settings for the Tool Results service.
142 "defaultBucket": "A String", # The name of the Google Cloud Storage bucket to which results are written.
143 #
144 # By default, this is unset.
145 #
146 # In update request: optional In response: optional
147 "name": "A String", # The name of the project's settings.
148 #
149 # Always of the form: projects/{project-id}/settings
150 #
151 # In update request: never set In response: always set
152 }</pre>
153</div>
154
155</body></html>