GoogleCloudBillingBudgetsV1Filter

import type { GoogleCloudBillingBudgetsV1Filter } from "https://googleapis.deno.dev/v1/billingbudgets:v1.ts";

A filter for a budget, limiting the scope of the cost to calculate.

interface GoogleCloudBillingBudgetsV1Filter {

calendarPeriod?:

| "CALENDAR_PERIOD_UNSPECIFIED"

| "MONTH"

| "QUARTER"

| "YEAR";

creditTypes?: string[];

creditTypesTreatment?:

| "CREDIT_TYPES_TREATMENT_UNSPECIFIED"

| "INCLUDE_ALL_CREDITS"

| "EXCLUDE_ALL_CREDITS"

| "INCLUDE_SPECIFIED_CREDITS";

customPeriod?: GoogleCloudBillingBudgetsV1CustomPeriod;

labels?: {

[key: string]: any[];

};

projects?: string[];

resourceAncestors?: string[];

services?: string[];

subaccounts?: string[];

}

§Properties

calendarPeriod?: "CALENDAR_PERIOD_UNSPECIFIED" | "MONTH" | "QUARTER" | "YEAR"

[src]

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.

creditTypes?: string[]

[src]

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 list of acceptable credit type values. If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.

creditTypesTreatment?: "CREDIT_TYPES_TREATMENT_UNSPECIFIED" | "INCLUDE_ALL_CREDITS" | "EXCLUDE_ALL_CREDITS" | "INCLUDE_SPECIFIED_CREDITS"

[src]

Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

customPeriod?: GoogleCloudBillingBudgetsV1CustomPeriod

[src]

Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur.

labels?: {

[key: string]: any[];

}

[src]

Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single "key": value pair. Example: { "name": "wrench" }. Currently, multiple entries or multiple values per entry are not allowed.

projects?: string[]

[src]

Optional. A set of projects of the form projects/{project}, 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.

resourceAncestors?: string[]

[src]

Optional. A set of folder and organization names of the form folders/{folderId} or organizations/{organizationId}, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget doesn't apply to those projects.

services?: string[]

[src]

Optional. A set of services of the form services/{service_id}, 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.

subaccounts?: string[]

[src]

Optional. A set of subaccounts of the form billingAccounts/{account_id}, 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.