Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / sourcerepo_v1.projects.html
blob: 63df79e05f58ab4e5c499b0fb1d0adcfd0892a5d [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">
83 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
84<p class="firstline">Returns the Cloud Source Repositories configuration of the project.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]86 <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]87<p class="firstline">Updates the Cloud Source Repositories configuration of the project.</p>
88<h3>Method Details</h3>
89<div class="method">
90 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
91 <pre>Returns the Cloud Source Repositories configuration of the project.
92
93Args:
94 name: string, The name of the requested project. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]95`projects/&lt;project&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
100
101Returns:
102 An object of the form:
103
104 { # Cloud Source Repositories configuration of a project.
105 "enablePrivateKeyCheck": True or False, # Reject a Git push that contains a private key.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]106 "name": "A String", # The name of the project. Values are of the form `projects/&lt;project&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107 "pubsubConfigs": { # How this project publishes a change in the repositories through Cloud
108 # Pub/Sub. Keyed by the topic names.
109 "a_key": { # Configuration to publish a Cloud Pub/Sub message.
110 "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 # `projects/&lt;project&gt;/topics/&lt;topic&gt;`. The project needs to be the same
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 # project as this config is in.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
114 # messages. This service account needs to be in the same project as the
115 # PubsubConfig. When added, the caller needs to have
116 # iam.serviceAccounts.actAs permission on this service account. If
117 # unspecified, it defaults to the compute engine default service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 },
120 },
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:
129 name: string, The name of the requested project. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130`projects/&lt;project&gt;`. (required)
131 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 The object takes the form of:
133
134{ # Request for UpdateProjectConfig.
135 "projectConfig": { # Cloud Source Repositories configuration of a project. # The new configuration for the project.
136 "enablePrivateKeyCheck": True or False, # Reject a Git push that contains a private key.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]137 "name": "A String", # The name of the project. Values are of the form `projects/&lt;project&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 "pubsubConfigs": { # How this project publishes a change in the repositories through Cloud
139 # Pub/Sub. Keyed by the topic names.
140 "a_key": { # Configuration to publish a Cloud Pub/Sub message.
141 "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]142 # `projects/&lt;project&gt;/topics/&lt;topic&gt;`. The project needs to be the same
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 # project as this config is in.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
145 # messages. This service account needs to be in the same project as the
146 # PubsubConfig. When added, the caller needs to have
147 # iam.serviceAccounts.actAs permission on this service account. If
148 # unspecified, it defaults to the compute engine default service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]149 "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 },
151 },
152 },
153 "updateMask": "A String", # A FieldMask specifying which fields of the project_config to modify. Only
154 # the fields in the mask will be modified. If no mask is provided, this
155 # request is no-op.
156 }
157
158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163Returns:
164 An object of the form:
165
166 { # Cloud Source Repositories configuration of a project.
167 "enablePrivateKeyCheck": True or False, # Reject a Git push that contains a private key.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]168 "name": "A String", # The name of the project. Values are of the form `projects/&lt;project&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 "pubsubConfigs": { # How this project publishes a change in the repositories through Cloud
170 # Pub/Sub. Keyed by the topic names.
171 "a_key": { # Configuration to publish a Cloud Pub/Sub message.
172 "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]173 # `projects/&lt;project&gt;/topics/&lt;topic&gt;`. The project needs to be the same
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]174 # project as this config is in.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
176 # messages. This service account needs to be in the same project as the
177 # PubsubConfig. When added, the caller needs to have
178 # iam.serviceAccounts.actAs permission on this service account. If
179 # unspecified, it defaults to the compute engine default service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 },
182 },
183 }</pre>
184</div>
185
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]186</body></html>