Blame - docs/dyn/cloudbilling_v1.projects.html - platform/external/python/google-api-python-client

blob: 3bb26fbe8647a4dbe3b352ee1733027568d63875 [file] [log] [blame]

Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	75	<h1><a href="cloudbilling_v1.html">Cloud Billing API</a> . <a href="cloudbilling_v1.projects.html">projects</a></h1>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	78	<code><a href="#getBillingInfo">getBillingInfo(name, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	79	<p class="firstline">Gets the billing information for a project. The current authenticated user</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#updateBillingInfo">updateBillingInfo(name, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	82	<p class="firstline">Sets or updates the billing account associated with a project. You specify</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	83	<h3>Method Details</h3>
				84	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	85	<code class="details" id="getBillingInfo">getBillingInfo(name, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	86	<pre>Gets the billing information for a project. The current authenticated user
				87	must have [permission to view the
				88	project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo
				89	).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	90
				91	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	92	name: string, Required. The resource name of the project for which billing information is
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	93	retrieved. For example, `projects/tokyo-rain-123`. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	94	x__xgafv: string, V1 error format.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	95	Allowed values
				96	1 - v1 error format
				97	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	98
				99	Returns:
				100	An object of the form:
				101
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	102	{ # Encapsulation of billing information for a GCP Console project. A project
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	103	# has at most one associated billing account at a time (but a billing account
				104	# can be assigned to multiple projects).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	105	"billingAccountName": "A String", # The resource name of the billing account associated with the project, if
				106	# any. For example, `billingAccounts/012345-567890-ABCDEF`.
				107	"projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
				108	# `tokyo-rain-123`. This is a convenience field so that you don't need to
				109	# parse the `name` field to obtain a project ID. This field is read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	110	"name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	111	# `projects/{project_id}/billingInfo`. For example, the resource name for the
				112	# billing information for project `tokyo-rain-123` would be
				113	# `projects/tokyo-rain-123/billingInfo`. This field is read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	114	"billingEnabled": True or False, # True if the project is associated with an open billing account, to which
				115	# usage on the project is charged. False if the project is associated with a
				116	# closed billing account, or no billing account at all, and therefore cannot
				117	# use paid services. This field is read-only.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	118	}</pre>
				119	</div>
				120
				121	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	122	<code class="details" id="updateBillingInfo">updateBillingInfo(name, body=None, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	123	<pre>Sets or updates the billing account associated with a project. You specify
				124	the new billing account by setting the `billing_account_name` in the
				125	`ProjectBillingInfo` resource to the resource name of a billing account.
				126	Associating a project with an open billing account enables billing on the
				127	project and allows charges for resource usage. If the project already had a
				128	billing account, this method changes the billing account used for resource
				129	usage charges.
				130
				131	Note: Incurred charges that have not yet been reported in the transaction
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	132	history of the GCP Console might be billed to the new billing
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	133	account, even if the charge occurred before the new billing account was
				134	assigned to the project.
				135
				136	The current authenticated user must have ownership privileges for both the
				137	[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo
				138	) and the [billing
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	139	account](https://cloud.google.com/billing/docs/how-to/billing-access).
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	140
				141	You can disable billing on the project by setting the
				142	`billing_account_name` field to empty. This action disassociates the
				143	current billing account from the project. Any billable activity of your
				144	in-use services will stop, and your application could stop functioning as
				145	expected. Any unbilled charges to date will be billed to the previously
				146	associated account. The current authenticated user must be either an owner
				147	of the project or an owner of the billing account for the project.
				148
				149	Note that associating a project with a closed billing account will have
				150	much the same effect as disabling billing on the project: any paid
				151	resources used by the project will be shut down. Thus, unless you wish to
				152	disable billing, you should always call this method with the name of an
				153	open billing account.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	154
				155	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	156	name: string, Required. The resource name of the project associated with the billing information
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	157	that you want to update. For example, `projects/tokyo-rain-123`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	158	body: object, The request body.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	159	The object takes the form of:
				160
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	161	{ # Encapsulation of billing information for a GCP Console project. A project
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	162	# has at most one associated billing account at a time (but a billing account
				163	# can be assigned to multiple projects).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	164	"billingAccountName": "A String", # The resource name of the billing account associated with the project, if
				165	# any. For example, `billingAccounts/012345-567890-ABCDEF`.
				166	"projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
				167	# `tokyo-rain-123`. This is a convenience field so that you don't need to
				168	# parse the `name` field to obtain a project ID. This field is read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	169	"name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	170	# `projects/{project_id}/billingInfo`. For example, the resource name for the
				171	# billing information for project `tokyo-rain-123` would be
				172	# `projects/tokyo-rain-123/billingInfo`. This field is read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	173	"billingEnabled": True or False, # True if the project is associated with an open billing account, to which
				174	# usage on the project is charged. False if the project is associated with a
				175	# closed billing account, or no billing account at all, and therefore cannot
				176	# use paid services. This field is read-only.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	177	}
				178
				179	x__xgafv: string, V1 error format.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	180	Allowed values
				181	1 - v1 error format
				182	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	183
				184	Returns:
				185	An object of the form:
				186
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	187	{ # Encapsulation of billing information for a GCP Console project. A project
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	188	# has at most one associated billing account at a time (but a billing account
				189	# can be assigned to multiple projects).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	190	"billingAccountName": "A String", # The resource name of the billing account associated with the project, if
				191	# any. For example, `billingAccounts/012345-567890-ABCDEF`.
				192	"projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
				193	# `tokyo-rain-123`. This is a convenience field so that you don't need to
				194	# parse the `name` field to obtain a project ID. This field is read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	195	"name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	196	# `projects/{project_id}/billingInfo`. For example, the resource name for the
				197	# billing information for project `tokyo-rain-123` would be
				198	# `projects/tokyo-rain-123/billingInfo`. This field is read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	199	"billingEnabled": True or False, # True if the project is associated with an open billing account, to which
				200	# usage on the project is charged. False if the project is associated with a
				201	# closed billing account, or no billing account at all, and therefore cannot
				202	# use paid services. This field is read-only.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	203	}</pre>
				204	</div>
				205
				206	</body></html>