Cloud Billing Budget v1beta1 API - Class Filter (2.0.0-beta05)

public sealed class Filter : IMessage<Filter>, IEquatable<Filter>, IDeepCloneable<Filter>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Billing Budget v1beta1 API class Filter.

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

Inheritance

object > Filter

Namespace

Google.Cloud.Billing.Budgets.V1Beta1

Assembly

Google.Cloud.Billing.Budgets.V1Beta1.dll

Constructors

Filter()

public Filter()

Filter(Filter)

public Filter(Filter other)
Parameter
NameDescription
otherFilter

Properties

CalendarPeriod

public CalendarPeriod CalendarPeriod { get; set; }

Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.

Property Value
TypeDescription
CalendarPeriod

CreditTypes

public RepeatedField<string> CreditTypes { get; }

Optional. If [Filter.credit_types_treatment][google.cloud.billing.budgets.v1beta1.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][google.cloud.billing.budgets.v1beta1.Filter.credit_types_treatment] is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.

Property Value
TypeDescription
RepeatedFieldstring

CreditTypesTreatment

public Filter.Types.CreditTypesTreatment CreditTypesTreatment { get; set; }

Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

Property Value
TypeDescription
FilterTypesCreditTypesTreatment

CustomPeriod

public CustomPeriod CustomPeriod { get; set; }

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

Property Value
TypeDescription
CustomPeriod

HasCalendarPeriod

public bool HasCalendarPeriod { get; }

Gets whether the "calendar_period" field is set

Property Value
TypeDescription
bool

Labels

public MapField<string, ListValue> Labels { get; }

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 will include 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.

Property Value
TypeDescription
MapFieldstringListValue

Projects

public RepeatedField<string> Projects { get; }

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 will include all usage for the billing account, regardless of which project the usage occurred on.

Property Value
TypeDescription
RepeatedFieldstring

ResourceAncestors

public RepeatedField<string> ResourceAncestors { get; }

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.

Property Value
TypeDescription
RepeatedFieldstring

Services

public RepeatedField<string> Services { get; }

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 will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.

Property Value
TypeDescription
RepeatedFieldstring

Subaccounts

public RepeatedField<string> Subaccounts { get; }

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 will be included. If omitted, the report will include usage from the parent account and all subaccounts, if they exist.

Property Value
TypeDescription
RepeatedFieldstring

UsagePeriodCase

public Filter.UsagePeriodOneofCase UsagePeriodCase { get; }
Property Value
TypeDescription
FilterUsagePeriodOneofCase