mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-30 05:43:43 +01:00
52 lines
24 KiB
HTML
52 lines
24 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_cloudbilling1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_cloudbilling1::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../google_cloudbilling1/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_cloudbilling1</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_cloudbilling1</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/google_cloudbilling1/api.rs.html#1-4451" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.AggregationInfo.html" title="google_cloudbilling1::api::AggregationInfo struct">AggregationInfo</a></td><td class="docblock-short"><p>Represents the aggregation level and interval for pricing of a single SKU.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AuditConfig.html" title="google_cloudbilling1::api::AuditConfig struct">AuditConfig</a></td><td class="docblock-short"><p>Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both <code>allServices</code> and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AuditLogConfig.html" title="google_cloudbilling1::api::AuditLogConfig struct">AuditLogConfig</a></td><td class="docblock-short"><p>Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BillingAccount.html" title="google_cloudbilling1::api::BillingAccount struct">BillingAccount</a></td><td class="docblock-short"><p>A billing account in the <a href="https://console.cloud.google.com/">Google Cloud Console</a>. You can assign a billing account to one or more projects.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BillingAccountCreateCall.html" title="google_cloudbilling1::api::BillingAccountCreateCall struct">BillingAccountCreateCall</a></td><td class="docblock-short"><p>This method creates <a href="https://cloud.google.com/billing/docs/concepts#subaccounts">billing subaccounts</a>. Google Cloud resellers should use the Channel Services APIs, <a href="https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create">accounts.customers.create</a> and <a href="https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create">accounts.customers.entitlements.create</a>. When creating a subaccount, the current authenticated user must have the <code>billing.accounts.update</code> IAM permission on the parent account, which is typically given to billing account <a href="https://cloud.google.com/billing/docs/how-to/billing-access">administrators</a>. This method will return an error if the parent account has not been provisioned as a reseller account.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BillingAccountGetCall.html" title="google_cloudbilling1::api::BillingAccountGetCall struct">BillingAccountGetCall</a></td><td class="docblock-short"><p>Gets information about a billing account. The current authenticated user must be a <a href="https://cloud.google.com/billing/docs/how-to/billing-access">viewer of the billing account</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BillingAccountGetIamPolicyCall.html" title="google_cloudbilling1::api::BillingAccountGetIamPolicyCall struct">BillingAccountGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a billing account. The caller must have the <code>billing.accounts.getIamPolicy</code> permission on the account, which is often given to billing account <a href="https://cloud.google.com/billing/docs/how-to/billing-access">viewers</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BillingAccountListCall.html" title="google_cloudbilling1::api::BillingAccountListCall struct">BillingAccountListCall</a></td><td class="docblock-short"><p>Lists the billing accounts that the current authenticated user has permission to <a href="https://cloud.google.com/billing/docs/how-to/billing-access">view</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BillingAccountMethods.html" title="google_cloudbilling1::api::BillingAccountMethods struct">BillingAccountMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>billingAccount</em> resources.
|
||
It is not used directly, but through the <code>Cloudbilling</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BillingAccountPatchCall.html" title="google_cloudbilling1::api::BillingAccountPatchCall struct">BillingAccountPatchCall</a></td><td class="docblock-short"><p>Updates a billing account's fields. Currently the only field that can be edited is <code>display_name</code>. The current authenticated user must have the <code>billing.accounts.update</code> IAM permission, which is typically given to the <a href="https://cloud.google.com/billing/docs/how-to/billing-access">administrator</a> of the billing account.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BillingAccountProjectListCall.html" title="google_cloudbilling1::api::BillingAccountProjectListCall struct">BillingAccountProjectListCall</a></td><td class="docblock-short"><p>Lists the projects associated with a billing account. The current authenticated user must have the <code>billing.resourceAssociations.list</code> IAM permission, which is often given to billing account <a href="https://cloud.google.com/billing/docs/how-to/billing-access">viewers</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BillingAccountSetIamPolicyCall.html" title="google_cloudbilling1::api::BillingAccountSetIamPolicyCall struct">BillingAccountSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the <code>billing.accounts.setIamPolicy</code> permission on the account, which is often given to billing account <a href="https://cloud.google.com/billing/docs/how-to/billing-access">administrators</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BillingAccountTestIamPermissionCall.html" title="google_cloudbilling1::api::BillingAccountTestIamPermissionCall struct">BillingAccountTestIamPermissionCall</a></td><td class="docblock-short"><p>Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Binding.html" title="google_cloudbilling1::api::Binding struct">Binding</a></td><td class="docblock-short"><p>Associates <code>members</code> with a <code>role</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Category.html" title="google_cloudbilling1::api::Category struct">Category</a></td><td class="docblock-short"><p>Represents the category hierarchy of a SKU.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Cloudbilling.html" title="google_cloudbilling1::api::Cloudbilling struct">Cloudbilling</a></td><td class="docblock-short"><p>Central instance to access all Cloudbilling related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_cloudbilling1::api::Expr struct">Expr</a></td><td class="docblock-short"><p>Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GeoTaxonomy.html" title="google_cloudbilling1::api::GeoTaxonomy struct">GeoTaxonomy</a></td><td class="docblock-short"><p>Encapsulates the geographic taxonomy data for a sku.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListBillingAccountsResponse.html" title="google_cloudbilling1::api::ListBillingAccountsResponse struct">ListBillingAccountsResponse</a></td><td class="docblock-short"><p>Response message for <code>ListBillingAccounts</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListProjectBillingInfoResponse.html" title="google_cloudbilling1::api::ListProjectBillingInfoResponse struct">ListProjectBillingInfoResponse</a></td><td class="docblock-short"><p>Request message for <code>ListProjectBillingInfoResponse</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListServicesResponse.html" title="google_cloudbilling1::api::ListServicesResponse struct">ListServicesResponse</a></td><td class="docblock-short"><p>Response message for <code>ListServices</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListSkusResponse.html" title="google_cloudbilling1::api::ListSkusResponse struct">ListSkusResponse</a></td><td class="docblock-short"><p>Response message for <code>ListSkus</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Money.html" title="google_cloudbilling1::api::Money struct">Money</a></td><td class="docblock-short"><p>Represents an amount of money with its currency type.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_cloudbilling1::api::Policy struct">Policy</a></td><td class="docblock-short"><p>An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A <code>Policy</code> is a collection of <code>bindings</code>. A <code>binding</code> binds one or more <code>members</code> to a single <code>role</code>. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A <code>role</code> is a named list of permissions; each <code>role</code> can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a <code>binding</code> can also specify a <code>condition</code>, which is a logical expression that allows access to a resource only if the expression evaluates to <code>true</code>. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>. <strong>JSON example:</strong> { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } <strong>YAML example:</strong> bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the <a href="https://cloud.google.com/iam/docs/">IAM documentation</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PricingExpression.html" title="google_cloudbilling1::api::PricingExpression struct">PricingExpression</a></td><td class="docblock-short"><p>Expresses a mathematical pricing formula. For Example:- <code>usage_unit: GBy</code> <code>tiered_rates:</code> <code>[start_usage_amount: 20, unit_price: $10]</code> <code>[start_usage_amount: 100, unit_price: $5]</code> The above expresses a pricing formula where the first 20GB is free, the next 80GB is priced at $10 per GB followed by $5 per GB for additional usage.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PricingInfo.html" title="google_cloudbilling1::api::PricingInfo struct">PricingInfo</a></td><td class="docblock-short"><p>Represents the pricing information for a SKU at a single point of time.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectBillingInfo.html" title="google_cloudbilling1::api::ProjectBillingInfo struct">ProjectBillingInfo</a></td><td class="docblock-short"><p>Encapsulation of billing information for a Google Cloud Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectGetBillingInfoCall.html" title="google_cloudbilling1::api::ProjectGetBillingInfoCall struct">ProjectGetBillingInfoCall</a></td><td class="docblock-short"><p>Gets the billing information for a project. The current authenticated user must have <a href="https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo">permission to view the project</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_cloudbilling1::api::ProjectMethods struct">ProjectMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>project</em> resources.
|
||
It is not used directly, but through the <code>Cloudbilling</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectUpdateBillingInfoCall.html" title="google_cloudbilling1::api::ProjectUpdateBillingInfoCall struct">ProjectUpdateBillingInfoCall</a></td><td class="docblock-short"><p>Sets or updates the billing account associated with a project. You specify the new billing account by setting the <code>billing_account_name</code> in the <code>ProjectBillingInfo</code> resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. <em>Note:</em> Incurred charges that have not yet been reported in the transaction history of the Google Cloud Console might be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the <a href="https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo">project</a> and the <a href="https://cloud.google.com/billing/docs/how-to/billing-access">billing account</a>. You can disable billing on the project by setting the <code>billing_account_name</code> field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a <em>closed</em> billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an <em>open</em> billing account.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Service.html" title="google_cloudbilling1::api::Service struct">Service</a></td><td class="docblock-short"><p>Encapsulates a single service in Google Cloud Platform.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ServiceListCall.html" title="google_cloudbilling1::api::ServiceListCall struct">ServiceListCall</a></td><td class="docblock-short"><p>Lists all public cloud services.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ServiceMethods.html" title="google_cloudbilling1::api::ServiceMethods struct">ServiceMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>service</em> resources.
|
||
It is not used directly, but through the <code>Cloudbilling</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ServiceSkuListCall.html" title="google_cloudbilling1::api::ServiceSkuListCall struct">ServiceSkuListCall</a></td><td class="docblock-short"><p>Lists all publicly available SKUs for a given cloud service.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_cloudbilling1::api::SetIamPolicyRequest struct">SetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>SetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Sku.html" title="google_cloudbilling1::api::Sku struct">Sku</a></td><td class="docblock-short"><p>Encapsulates a single SKU in Google Cloud Platform</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsRequest.html" title="google_cloudbilling1::api::TestIamPermissionsRequest struct">TestIamPermissionsRequest</a></td><td class="docblock-short"><p>Request message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsResponse.html" title="google_cloudbilling1::api::TestIamPermissionsResponse struct">TestIamPermissionsResponse</a></td><td class="docblock-short"><p>Response message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TierRate.html" title="google_cloudbilling1::api::TierRate struct">TierRate</a></td><td class="docblock-short"><p>The price rate indicating starting usage and its corresponding price.</p>
|
||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_cloudbilling1::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
|
||
A scope is needed when requesting an
|
||
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_cloudbilling1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |