Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / cloudresourcemanager_v1beta1.projects.html
blob: c5166c68ca986bcf1caaa8dea22aa3c465f47ffb [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[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="cloudresourcemanager_v1beta1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1beta1.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a project resource. Initially, the project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the project. Several APIs are activated automatically for the project, including Google Cloud Storage.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(projectId, x__xgafv=None)</a></code></p>
82<p class="firstline">Marks the project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the project if it has a lifecycle state of [ACTIVE][cloudresourcemanager.projects.v1beta2.LifecycleState.ACTIVE] when this method is called. Otherwise this method does nothing (since all other states are phases of deletion). This method changes the project's lifecycle state from [ACTIVE][cloudresourcemanager.projects.v1beta2.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [cloudresourcemanager.projects.v1beta2.Projects.GetProject], and the project remains visible to [ListProjects] [cloudresourcemanager.projects.v1beta2.Projects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [cloudresourcemanager.projects.v1beta2.Projects.GetProject] and [ListProjects] [cloudresourcemanager.projects.v1beta2.Projects.ListProjects] methods. The caller must have modify permissions for this project.</p>
83<p class="toc_element">
84 <code><a href="#get">get(projectId, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this project.</p>
86<p class="toc_element">
87 <code><a href="#list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#undelete">undelete(projectId, x__xgafv=None)</a></code></p>
94<p class="firstline">Restores the project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a project that has a lifecycle state of [DELETE_REQUESTED] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_IN_PROGRESS], the project cannot be restored. The caller must have modify permissions for this project.</p>
95<p class="toc_element">
96 <code><a href="#update">update(projectId, body, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates the attributes of the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this project.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="create">create(body, x__xgafv=None)</code>
101 <pre>Creates a project resource. Initially, the project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the project. Several APIs are activated automatically for the project, including Google Cloud Storage.
102
103Args:
104 body: object, The request body. (required)
105 The object takes the form of:
106
107{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources. Projects are subordinate to Customers.
108 "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
109 "projectId": "A String", # The unique, user-assigned id of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: "tokyo-rain-123" Read-only after creation.
110 "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
111 "a_key": "A String",
112 },
113 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
114 "lifecycleState": "A String", # The project lifecycle state. Read-only.
115 "createTime": "A String", # Creation time. Read-only.
116}
117
118 x__xgafv: string, V1 error format.
119
120Returns:
121 An object of the form:
122
123 { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources. Projects are subordinate to Customers.
124 "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
125 "projectId": "A String", # The unique, user-assigned id of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: "tokyo-rain-123" Read-only after creation.
126 "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
127 "a_key": "A String",
128 },
129 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
130 "lifecycleState": "A String", # The project lifecycle state. Read-only.
131 "createTime": "A String", # Creation time. Read-only.
132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="delete">delete(projectId, x__xgafv=None)</code>
137 <pre>Marks the project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the project if it has a lifecycle state of [ACTIVE][cloudresourcemanager.projects.v1beta2.LifecycleState.ACTIVE] when this method is called. Otherwise this method does nothing (since all other states are phases of deletion). This method changes the project's lifecycle state from [ACTIVE][cloudresourcemanager.projects.v1beta2.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [cloudresourcemanager.projects.v1beta2.Projects.GetProject], and the project remains visible to [ListProjects] [cloudresourcemanager.projects.v1beta2.Projects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [cloudresourcemanager.projects.v1beta2.Projects.GetProject] and [ListProjects] [cloudresourcemanager.projects.v1beta2.Projects.ListProjects] methods. The caller must have modify permissions for this project.
138
139Args:
140 projectId: string, The project ID (for example, `foo-bar-123`). Required. (required)
141 x__xgafv: string, V1 error format.
142
143Returns:
144 An object of the form:
145
146 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
147 }</pre>
148</div>
149
150<div class="method">
151 <code class="details" id="get">get(projectId, x__xgafv=None)</code>
152 <pre>Retrieves the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this project.
153
154Args:
155 projectId: string, The project ID (for example, `my-project-123`). Required. (required)
156 x__xgafv: string, V1 error format.
157
158Returns:
159 An object of the form:
160
161 { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources. Projects are subordinate to Customers.
162 "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
163 "projectId": "A String", # The unique, user-assigned id of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: "tokyo-rain-123" Read-only after creation.
164 "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
165 "a_key": "A String",
166 },
167 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
168 "lifecycleState": "A String", # The project lifecycle state. Read-only.
169 "createTime": "A String", # Creation time. Read-only.
170 }</pre>
171</div>
172
173<div class="method">
174 <code class="details" id="list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
175 <pre>Lists projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.
176
177Args:
178 pageSize: integer, The maximum number of Projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default. Note: pagination is not yet supported; the server ignores this field. Optional.
179 filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: name id labels. where is a the name of a label Examples: name:* ==> The project has a name. name:Howl ==> The project’s name is `Howl` or 'howl'. name:HOWL ==> Equivalent to above. NAME:howl ==> Equivalent to above. labels.color:* ==> The project has the label "color". labels.color:red ==> The project’s label `color` has the value `red`. labels.color:red label.size:big ==> The project's label `color` has the value `red` and its label `size` has the value `big`. Optional.
180 pageToken: string, A pagination token returned from a previous call to ListProject that indicates from where listing should continue. Note: pagination is not yet supported; the server ignores this field. Optional.
181 x__xgafv: string, V1 error format.
182
183Returns:
184 An object of the form:
185
186 { # A page of the response received from the [ListProjects][cloudresourcemanager.projects.v1beta1.Projects.ListProjects] method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
187 "nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. Note: pagination is not yet supported; the server will not set this field.
188 "projects": [ # The list of projects that matched the list filter. This list can be paginated.
189 { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources. Projects are subordinate to Customers.
190 "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
191 "projectId": "A String", # The unique, user-assigned id of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: "tokyo-rain-123" Read-only after creation.
192 "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
193 "a_key": "A String",
194 },
195 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
196 "lifecycleState": "A String", # The project lifecycle state. Read-only.
197 "createTime": "A String", # Creation time. Read-only.
198 },
199 ],
200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
205 <pre>Retrieves the next page of results.
206
207Args:
208 previous_request: The request for the previous page. (required)
209 previous_response: The response from the request for the previous page. (required)
210
211Returns:
212 A request object that you can call 'execute()' on to request the next
213 page. Returns None if there are no more items in the collection.
214 </pre>
215</div>
216
217<div class="method">
218 <code class="details" id="undelete">undelete(projectId, x__xgafv=None)</code>
219 <pre>Restores the project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a project that has a lifecycle state of [DELETE_REQUESTED] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [cloudresourcemanager.projects.v1beta2.LifecycleState.DELETE_IN_PROGRESS], the project cannot be restored. The caller must have modify permissions for this project.
220
221Args:
222 projectId: string, The project ID (for example, `foo-bar-123`). Required. (required)
223 x__xgafv: string, V1 error format.
224
225Returns:
226 An object of the form:
227
228 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
229 }</pre>
230</div>
231
232<div class="method">
233 <code class="details" id="update">update(projectId, body, x__xgafv=None)</code>
234 <pre>Updates the attributes of the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this project.
235
236Args:
237 projectId: string, The project ID (for example, `my-project-123`). Required. (required)
238 body: object, The request body. (required)
239 The object takes the form of:
240
241{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources. Projects are subordinate to Customers.
242 "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
243 "projectId": "A String", # The unique, user-assigned id of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: "tokyo-rain-123" Read-only after creation.
244 "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
245 "a_key": "A String",
246 },
247 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
248 "lifecycleState": "A String", # The project lifecycle state. Read-only.
249 "createTime": "A String", # Creation time. Read-only.
250}
251
252 x__xgafv: string, V1 error format.
253
254Returns:
255 An object of the form:
256
257 { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources. Projects are subordinate to Customers.
258 "name": "A String", # The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lower- and upper-case letters, numbers, hyphen, single-quote, double-quotes, space, and exclamation point. Example: "My Project" Read-write.
259 "projectId": "A String", # The unique, user-assigned id of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: "tokyo-rain-123" Read-only after creation.
260 "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Note that additional character may be included in labels in the future. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
261 "a_key": "A String",
262 },
263 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262. Read-only.
264 "lifecycleState": "A String", # The project lifecycle state. Read-only.
265 "createTime": "A String", # Creation time. Read-only.
266 }</pre>
267</div>
268
269</body></html>