Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / cloudbilling_v1.billingAccounts.projects.html
blob: 64533e55b10219d81d39598cc4f0f22c74b7d9d8 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="cloudbilling_v1.html">Cloud Billing API</a> . <a href="cloudbilling_v1.billingAccounts.html">billingAccounts</a> . <a href="cloudbilling_v1.billingAccounts.projects.html">projects</a></h1>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]78 <code><a href="#list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Lists the projects associated with a billing account. The current</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]85 <code class="details" id="list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]86 <pre>Lists the projects associated with a billing account. The current
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87authenticated user must have the `billing.resourceAssociations.list` IAM
88permission, which is often given to billing account
89[viewers](https://cloud.google.com/billing/docs/how-to/billing-access).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]90
91Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]92 name: string, Required. The resource name of the billing account associated with the projects that
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]93you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]94 pageSize: integer, Requested page size. The maximum page size is 100; this is also the
95default.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]96 pageToken: string, A token identifying a page of results to be returned. This should be a
97`next_page_token` value returned from a previous `ListProjectBillingInfo`
98call. If unspecified, the first page of results is returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]99 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]103
104Returns:
105 An object of the form:
106
107 { # Request message for `ListProjectBillingInfoResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 &quot;projectBillingInfo&quot;: [ # A list of `ProjectBillingInfo` resources representing the projects
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109 # associated with the billing account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 { # Encapsulation of billing information for a GCP Console project. A project
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]111 # has at most one associated billing account at a time (but a billing account
112 # can be assigned to multiple projects).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]113 &quot;billingAccountName&quot;: &quot;A String&quot;, # The resource name of the billing account associated with the project, if
114 # any. For example, `billingAccounts/012345-567890-ABCDEF`.
115 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project that this `ProjectBillingInfo` represents, such as
116 # `tokyo-rain-123`. This is a convenience field so that you don&#x27;t need to
117 # parse the `name` field to obtain a project ID. This field is read-only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118 &quot;name&quot;: &quot;A String&quot;, # The resource name for the `ProjectBillingInfo`; has the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]119 # `projects/{project_id}/billingInfo`. For example, the resource name for the
120 # billing information for project `tokyo-rain-123` would be
121 # `projects/tokyo-rain-123/billingInfo`. This field is read-only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 &quot;billingEnabled&quot;: True or False, # True if the project is associated with an open billing account, to which
123 # usage on the project is charged. False if the project is associated with a
124 # closed billing account, or no billing account at all, and therefore cannot
125 # use paid services. This field is read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]126 },
127 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]128 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. To retrieve the next page,
129 # call `ListProjectBillingInfo` again with the `page_token` field set to this
130 # value. This field is empty if there are no more results to retrieve.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]131 }</pre>
132</div>
133
134<div class="method">
135 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
136 <pre>Retrieves the next page of results.
137
138Args:
139 previous_request: The request for the previous page. (required)
140 previous_response: The response from the request for the previous page. (required)
141
142Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 A request object that you can call &#x27;execute()&#x27; on to request the next
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]144 page. Returns None if there are no more items in the collection.
145 </pre>
146</div>
147
148</body></html>