Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / sourcerepo_v1.projects.html
blob: ae5617bb1370d0aabf3e57682d3096ad2f34b8f5 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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="sourcerepo_v1.html">Cloud Source Repositories API</a> . <a href="sourcerepo_v1.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="sourcerepo_v1.projects.repos.html">repos()</a></code>
79</p>
80<p class="firstline">Returns the repos Resource.</p>
81
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Returns the Cloud Source Repositories configuration of the project.</p>
88<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]89 <code><a href="#updateConfig">updateConfig(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90<p class="firstline">Updates the Cloud Source Repositories configuration of the project.</p>
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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
99 <pre>Returns the Cloud Source Repositories configuration of the project.
100
101Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]102 name: string, The name of the requested project. Values are of the form `projects/`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108Returns:
109 An object of the form:
110
111 { # Cloud Source Repositories configuration of a project.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112 &quot;pubsubConfigs&quot;: { # How this project publishes a change in the repositories through Cloud Pub/Sub. Keyed by the topic names.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;a_key&quot;: { # Configuration to publish a Cloud Pub/Sub message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 &quot;messageFormat&quot;: &quot;A String&quot;, # The format of the Cloud Pub/Sub messages.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]115 &quot;serviceAccountEmail&quot;: &quot;A String&quot;, # Email address of the service account used for publishing Cloud Pub/Sub messages. This service account needs to be in the same project as the PubsubConfig. When added, the caller needs to have iam.serviceAccounts.actAs permission on this service account. If unspecified, it defaults to the compute engine default service account.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]116 &quot;topic&quot;: &quot;A String&quot;, # A topic of Cloud Pub/Sub. Values are of the form `projects//topics/`. The project needs to be the same project as this config is in.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 },
118 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]119 &quot;name&quot;: &quot;A String&quot;, # The name of the project. Values are of the form `projects/`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]120 &quot;enablePrivateKeyCheck&quot;: True or False, # Reject a Git push that contains a private key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 }</pre>
122</div>
123
124<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]125 <code class="details" id="updateConfig">updateConfig(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126 <pre>Updates the Cloud Source Repositories configuration of the project.
127
128Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129 name: string, The name of the requested project. Values are of the form `projects/`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]130 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 The object takes the form of:
132
133{ # Request for UpdateProjectConfig.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]134 &quot;updateMask&quot;: &quot;A String&quot;, # A FieldMask specifying which fields of the project_config to modify. Only the fields in the mask will be modified. If no mask is provided, this request is no-op.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 &quot;projectConfig&quot;: { # Cloud Source Repositories configuration of a project. # The new configuration for the project.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]136 &quot;pubsubConfigs&quot;: { # How this project publishes a change in the repositories through Cloud Pub/Sub. Keyed by the topic names.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;a_key&quot;: { # Configuration to publish a Cloud Pub/Sub message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]138 &quot;messageFormat&quot;: &quot;A String&quot;, # The format of the Cloud Pub/Sub messages.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]139 &quot;serviceAccountEmail&quot;: &quot;A String&quot;, # Email address of the service account used for publishing Cloud Pub/Sub messages. This service account needs to be in the same project as the PubsubConfig. When added, the caller needs to have iam.serviceAccounts.actAs permission on this service account. If unspecified, it defaults to the compute engine default service account.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]140 &quot;topic&quot;: &quot;A String&quot;, # A topic of Cloud Pub/Sub. Values are of the form `projects//topics/`. The project needs to be the same project as this config is in.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 },
142 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]143 &quot;name&quot;: &quot;A String&quot;, # The name of the project. Values are of the form `projects/`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]144 &quot;enablePrivateKeyCheck&quot;: True or False, # Reject a Git push that contains a private key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 }
147
148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
152
153Returns:
154 An object of the form:
155
156 { # Cloud Source Repositories configuration of a project.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]157 &quot;pubsubConfigs&quot;: { # How this project publishes a change in the repositories through Cloud Pub/Sub. Keyed by the topic names.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 &quot;a_key&quot;: { # Configuration to publish a Cloud Pub/Sub message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]159 &quot;messageFormat&quot;: &quot;A String&quot;, # The format of the Cloud Pub/Sub messages.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]160 &quot;serviceAccountEmail&quot;: &quot;A String&quot;, # Email address of the service account used for publishing Cloud Pub/Sub messages. This service account needs to be in the same project as the PubsubConfig. When added, the caller needs to have iam.serviceAccounts.actAs permission on this service account. If unspecified, it defaults to the compute engine default service account.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]161 &quot;topic&quot;: &quot;A String&quot;, # A topic of Cloud Pub/Sub. Values are of the form `projects//topics/`. The project needs to be the same project as this config is in.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 },
163 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]164 &quot;name&quot;: &quot;A String&quot;, # The name of the project. Values are of the form `projects/`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]165 &quot;enablePrivateKeyCheck&quot;: True or False, # Reject a Git push that contains a private key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 }</pre>
167</div>
168
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]169</body></html>