Google Cloud Billing Budgets V1 Client - Class Filter (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Billing Budgets V1 Client class Filter.

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

Generated from protobuf message google.cloud.billing.budgets.v1.Filter

Namespace

Google \ Cloud \ Billing \ Budgets \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ projects array

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.
↳ resource_ancestors array

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.
↳ credit_types array

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.
↳ credit_types_treatment int

Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.
↳ services array

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 array

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.
↳ labels array|Google\Protobuf\Internal\MapField

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.
↳ calendar_period int

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.
↳ custom_period Google\Cloud\Billing\Budgets\V1\CustomPeriod

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

getProjects

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setProjects

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getResourceAncestors

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setResourceAncestors

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getCreditTypes

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setCreditTypes

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getCreditTypesTreatment

Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

Returns
Type Description
int

setCreditTypesTreatment

Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

Parameter
Name Description
var int
Returns
Type Description
$this

getServices

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setServices

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getSubaccounts

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSubaccounts

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getLabels

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.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getCalendarPeriod

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.

Returns
Type Description
int

hasCalendarPeriod

setCalendarPeriod

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getCustomPeriod

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

Returns
Type Description
Google\Cloud\Billing\Budgets\V1\CustomPeriod|null

hasCustomPeriod

setCustomPeriod

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

Parameter
Name Description
var Google\Cloud\Billing\Budgets\V1\CustomPeriod
Returns
Type Description
$this

getUsagePeriod

Returns
Type Description
string