Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7700bbffda386345cc4426ef413fc643f6368ef4 / . / docs / dyn / toolresults_v1beta3.projects.html
blob: f9afae584caa182305acc8bb2f1bae8c66beb825 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]86 <code><a href="#getSettings">getSettings(projectId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87<p class="firstline">Gets the Tool Results settings for a project. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from project</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]88<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]89 <code><a href="#initializeSettings">initializeSettings(projectId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]90<p class="firstline">Creates resources for settings which have not yet been set. Currently, 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. The 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. If 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. May return any canonical error codes, including the following: - PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]91<h3>Method Details</h3>
92<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]93 <code class="details" id="close">close()</code>
94 <pre>Close httplib2 connections.</pre>
95</div>
96
97<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]98 <code class="details" id="getSettings">getSettings(projectId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]99 <pre>Gets the Tool Results settings for a project. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from project
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]100
101Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]102 projectId: string, A Project id. Required. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]107
108Returns:
109 An object of the form:
110
111 { # Per-project settings for the Tool Results service.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]112 &quot;defaultBucket&quot;: &quot;A String&quot;, # The name of the Google Cloud Storage bucket to which results are written. By default, this is unset. In update request: optional In response: optional
113 &quot;name&quot;: &quot;A String&quot;, # The name of the project&#x27;s settings. Always of the form: projects/{project-id}/settings In update request: never set In response: always set
114}</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]115</div>
116
117<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118 <code class="details" id="initializeSettings">initializeSettings(projectId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]119 <pre>Creates resources for settings which have not yet been set. Currently, 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. The 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. If there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn&#x27;t have the permission to access the bucket or the bucket is deleted, a new bucket will be created. May return any canonical error codes, including the following: - PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]120
121Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 projectId: string, A Project id. Required. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 x__xgafv: string, V1 error format.
124 Allowed values
125 1 - v1 error format
126 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]127
128Returns:
129 An object of the form:
130
131 { # Per-project settings for the Tool Results service.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]132 &quot;defaultBucket&quot;: &quot;A String&quot;, # The name of the Google Cloud Storage bucket to which results are written. By default, this is unset. In update request: optional In response: optional
133 &quot;name&quot;: &quot;A String&quot;, # The name of the project&#x27;s settings. Always of the form: projects/{project-id}/settings In update request: never set In response: always set
134}</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]135</div>
136
137</body></html>