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
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. Name of billing account to list budgets under. Values are of the formbillingAccounts/{billingAccountId}.
↳ scope
string
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_size
int
Optional. The maximum number of budgets to return per page. The default and maximum value are 100.
↳ page_token
string
Optional. The value returned by the lastListBudgetsResponsewhich indicates that this is a continuation of a priorListBudgetscall, and that the system should return the next page of data.
getParent
Required. Name of billing account to list budgets under. Values
are of the formbillingAccounts/{billingAccountId}.
Returns
Type
Description
string
setParent
Required. Name of billing account to list budgets under. Values
are of the formbillingAccounts/{billingAccountId}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getScope
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.
Returns
Type
Description
string
setScope
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of budgets to return per page.
The default and maximum value are 100.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of budgets to return per page.
The default and maximum value are 100.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. The value returned by the lastListBudgetsResponsewhich
indicates that this is a continuation of a priorListBudgetscall,
and that the system should return the next page of data.
Returns
Type
Description
string
setPageToken
Optional. The value returned by the lastListBudgetsResponsewhich
indicates that this is a continuation of a priorListBudgetscall,
and that the system should return the next page of data.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. Name of billing account to list budgets under. Values
are of the formbillingAccounts/{billingAccountId}. Please seeBudgetServiceClient::billingAccountName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Billing Budgets V1 Client - Class ListBudgetsRequest (2.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.5 (latest)](/php/docs/reference/cloud-billing-budgets/latest/V1.ListBudgetsRequest)\n- [2.0.4](/php/docs/reference/cloud-billing-budgets/2.0.4/V1.ListBudgetsRequest)\n- [1.4.5](/php/docs/reference/cloud-billing-budgets/1.4.5/V1.ListBudgetsRequest)\n- [1.3.1](/php/docs/reference/cloud-billing-budgets/1.3.1/V1.ListBudgetsRequest)\n- [1.2.2](/php/docs/reference/cloud-billing-budgets/1.2.2/V1.ListBudgetsRequest)\n- [1.1.0](/php/docs/reference/cloud-billing-budgets/1.1.0/V1.ListBudgetsRequest)\n- [1.0.5](/php/docs/reference/cloud-billing-budgets/1.0.5/V1.ListBudgetsRequest) \nReference documentation and code samples for the Google Cloud Billing Budgets V1 Client class ListBudgetsRequest.\n\nRequest for ListBudgets\n\nGenerated from protobuf message `google.cloud.billing.budgets.v1.ListBudgetsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Billing \\\\ Budgets \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Name of billing account to list budgets under. Values\nare of the form `billingAccounts/{billingAccountId}`.\n\n### setParent\n\nRequired. Name of billing account to list budgets under. Values\nare of the form `billingAccounts/{billingAccountId}`.\n\n### getScope\n\nOptional. Set the scope of the budgets to be returned, in the format of the\nresource name. The scope of a budget is the cost that it tracks, such as\ncosts for a single project, or the costs for all projects in a folder. Only\nproject scope (in the format of \"projects/project-id\" or \"projects/123\") is\nsupported in this field. When this field is set to a project's resource\nname, the budgets returned are tracking the costs for that project.\n\n### setScope\n\nOptional. Set the scope of the budgets to be returned, in the format of the\nresource name. The scope of a budget is the cost that it tracks, such as\ncosts for a single project, or the costs for all projects in a folder. Only\nproject scope (in the format of \"projects/project-id\" or \"projects/123\") is\nsupported in this field. When this field is set to a project's resource\nname, the budgets returned are tracking the costs for that project.\n\n### getPageSize\n\nOptional. The maximum number of budgets to return per page.\n\nThe default and maximum value are 100.\n\n### setPageSize\n\nOptional. The maximum number of budgets to return per page.\n\nThe default and maximum value are 100.\n\n### getPageToken\n\nOptional. The value returned by the last `ListBudgetsResponse` which\nindicates that this is a continuation of a prior `ListBudgets` call,\nand that the system should return the next page of data.\n\n### setPageToken\n\nOptional. The value returned by the last `ListBudgetsResponse` which\nindicates that this is a continuation of a prior `ListBudgets` call,\nand that the system should return the next page of data.\n\n### static::build"]]
