Google Cloud Billing Budgets V1 Client - Class ListBudgetsRequest (2.1.1)

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

Request for ListBudgets

Generated from protobuf messagegoogle.cloud.billing.budgets.v1.ListBudgetsRequest

Namespace

Google \ Cloud \ Billing \ Budgets \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ parentstring

Required. Name of billing account to list budgets under. Values are of the formbillingAccounts/{billingAccountId}.

↳ scopestring

Optional. Set the scope of the budgets to be returned, in the format of the resource name. The scope of a budget is the cost that it tracks, such as costs for a single project, or the costs for all projects in a folder. Only project scope (in the format of "projects/project-id" or "projects/123") is supported in this field. When this field is set to a project's resource name, the budgets returned are tracking the costs for that project.

↳ page_sizeint

Optional. The maximum number of budgets to return per page. The default and maximum value are 100.

↳ page_tokenstring

Optional. The value returned by the lastListBudgetsResponse which indicates that this is a continuation of a priorListBudgets call, and that the system should return the next page of data.

getParent

Required. Name of billing account to list budgets under. Valuesare of the formbillingAccounts/{billingAccountId}.

Returns
TypeDescription
string

setParent

Required. Name of billing account to list budgets under. Valuesare of the formbillingAccounts/{billingAccountId}.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getScope

Optional. Set the scope of the budgets to be returned, in the format of theresource name. The scope of a budget is the cost that it tracks, such ascosts for a single project, or the costs for all projects in a folder. Onlyproject scope (in the format of "projects/project-id" or "projects/123") issupported in this field. When this field is set to a project's resourcename, the budgets returned are tracking the costs for that project.

Returns
TypeDescription
string

setScope

Optional. Set the scope of the budgets to be returned, in the format of theresource name. The scope of a budget is the cost that it tracks, such ascosts for a single project, or the costs for all projects in a folder. Onlyproject scope (in the format of "projects/project-id" or "projects/123") issupported in this field. When this field is set to a project's resourcename, the budgets returned are tracking the costs for that project.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getPageSize

Optional. The maximum number of budgets to return per page.

The default and maximum value are 100.

Returns
TypeDescription
int

setPageSize

Optional. The maximum number of budgets to return per page.

The default and maximum value are 100.

Parameter
NameDescription
varint
Returns
TypeDescription
$this

getPageToken

Optional. The value returned by the lastListBudgetsResponse whichindicates that this is a continuation of a priorListBudgets call,and that the system should return the next page of data.

Returns
TypeDescription
string

setPageToken

Optional. The value returned by the lastListBudgetsResponse whichindicates that this is a continuation of a priorListBudgets call,and that the system should return the next page of data.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parentstring

Required. Name of billing account to list budgets under. Valuesare of the formbillingAccounts/{billingAccountId}. Please seeBudgetServiceClient::billingAccountName() for help formatting this field.

Returns
TypeDescription
ListBudgetsRequest

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.