mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
437 lines
20 KiB
HTML
437 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Budgets Patch - CloudBillingBudget v3.0.0+20220227</title>
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
<style>
|
|
body {font-size: 90%;}
|
|
pre, code {font-size: 100%;}
|
|
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
|
</style>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> CloudBillingBudget v3.0.0+20220227</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Billing Accounts</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../billing-accounts_budgets-create">Budgets Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../billing-accounts_budgets-delete">Budgets Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../billing-accounts_budgets-get">Budgets Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../billing-accounts_budgets-list">Budgets List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Budgets Patch</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href=".."></a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
<li>Budgets Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/billingbudgets1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Updates a budget and returns the updated budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. Budget fields that are not exposed in this API will not be changed by this method.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/cloud-billing</em></li>
|
|
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-billing</em>.
|
|
You can set the scope for this method like this: <code>billingbudgets1 --scope <scope> billing-accounts budgets-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form <code>billingAccounts/{billingAccountId}/budgets/{budgetId}</code>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>GoogleCloudBillingBudgetsV1Budget:
|
|
amount:
|
|
specified-amount:
|
|
currency-code: string
|
|
nanos: integer
|
|
units: string
|
|
budget-filter:
|
|
calendar-period: string
|
|
credit-types: [string]
|
|
credit-types-treatment: string
|
|
custom-period:
|
|
end-date:
|
|
day: integer
|
|
month: integer
|
|
year: integer
|
|
start-date:
|
|
day: integer
|
|
month: integer
|
|
year: integer
|
|
projects: [string]
|
|
services: [string]
|
|
subaccounts: [string]
|
|
display-name: string
|
|
etag: string
|
|
name: string
|
|
notifications-rule:
|
|
disable-default-iam-recipients: boolean
|
|
monitoring-notification-channels: [string]
|
|
pubsub-topic: string
|
|
schema-version: string
|
|
|
|
</code></pre>
|
|
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r .amount.specified-amount currency-code=ipsum</code><ul>
|
|
<li>The three-letter currency code defined in ISO 4217.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>nanos=8</code><ul>
|
|
<li>Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If <code>units</code> is positive, <code>nanos</code> must be positive or zero. If <code>units</code> is zero, <code>nanos</code> can be positive, zero, or negative. If <code>units</code> is negative, <code>nanos</code> must be negative or zero. For example $-1.75 is represented as <code>units</code>=-1 and <code>nanos</code>=-750,000,000.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>units=ut</code></p>
|
|
<ul>
|
|
<li>The whole units of the amount. For example if <code>currencyCode</code> is <code>&#34;USD&#34;</code>, then 1 unit is one US dollar.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...budget-filter calendar-period=gubergren</code></p>
|
|
<ul>
|
|
<li>Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>credit-types=rebum.</code><ul>
|
|
<li>Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See <a href="https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type">a list of acceptable credit type values</a>. If Filter.credit_types_treatment is <strong>not</strong> INCLUDE_SPECIFIED_CREDITS, this field must be empty.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>credit-types-treatment=est</code><ul>
|
|
<li>Optional. If not set, default behavior is <code>INCLUDE_ALL_CREDITS</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>custom-period.end-date day=51</code><ul>
|
|
<li>Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>month=51</code><ul>
|
|
<li>Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>year=94</code></p>
|
|
<ul>
|
|
<li>Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..start-date day=39</code></p>
|
|
<ul>
|
|
<li>Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>month=84</code><ul>
|
|
<li>Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>year=2</code></p>
|
|
<ul>
|
|
<li>Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... projects=lorem</code></p>
|
|
<ul>
|
|
<li>Optional. A set of projects of the form <code>projects/{project}</code>, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. Only zero or one project can be specified currently.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>services=eos</code><ul>
|
|
<li>Optional. A set of services of the form <code>services/{service_id}</code>, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>subaccounts=labore</code></p>
|
|
<ul>
|
|
<li>Optional. A set of subaccounts of the form <code>billingAccounts/{account_id}</code>, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. display-name=sed</code></p>
|
|
<ul>
|
|
<li>User data for display name in UI. The name must be less than or equal to 60 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>etag=duo</code><ul>
|
|
<li>Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=sed</code><ul>
|
|
<li>Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form <code>billingAccounts/{billingAccountId}/budgets/{budgetId}</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>notifications-rule disable-default-iam-recipients=true</code><ul>
|
|
<li>Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>monitoring-notification-channels=stet</code><ul>
|
|
<li>Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the <code>DefaultIamRecipients</code> who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form <code>projects/{project_id}/notificationChannels/{channel_id}</code>. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you <em>must create the monitoring notification channels before you link them to a budget</em>. For guidance on setting up notification channels to use with budgets, see <a href="https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients">Customize budget alert email recipients</a>. For Cloud Billing budget alerts, you <em>must use email notification channels</em>. The other types of notification channels are <em>not</em> supported, such as Slack, SMS, or PagerDuty. If you want to <a href="https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack">send budget notifications to Slack</a>, use a pubsubTopic and configure <a href="https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications">programmatic notifications</a>.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pubsub-topic=kasd</code><ul>
|
|
<li>Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form <code>projects/{project_id}/topics/{topic_id}</code>. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the <a href="#thresholdrule">threshold rules</a> you've set. Note that if you want your <a href="https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format">Pub/Sub JSON object</a> to contain data for <code>alertThresholdExceeded</code>, you need at least one <a href="#thresholdrule">alert threshold rule</a>. When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see <a href="https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications">Manage programmatic budget alert notifications</a>. 2. Grant the API caller the <code>pubsub.topics.setIamPolicy</code> permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see <a href="https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task">Permissions required for this task</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>schema-version=et</code><ul>
|
|
<li>Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p update-mask=string</strong><ul>
|
|
<li>Optional. Indicates which fields in the provided budget to update. Read-only fields (such as <code>name</code>) cannot be changed. If this is not provided, then only fields with non-default values from the request are updated. See https://developers.google.com/protocol-buffers/docs/proto3#default for more details about default values.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
|
|
<a href="../billing-accounts_budgets-list" class="btn btn-neutral" title="Budgets List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
<!-- Copyright etc -->
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
<span><a href="../billing-accounts_budgets-list" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |