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

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

Request for ListBudgets

Generated from protobuf message google.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 form billingAccounts/{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 last ListBudgetsResponse which indicates that this is a continuation of a prior ListBudgets call, 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 form billingAccounts/{billingAccountId}.

Returns
Type Description
string

setParent

Required. Name of billing account to list budgets under. Values are of the form billingAccounts/{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 last ListBudgetsResponse which indicates that this is a continuation of a prior ListBudgets call, and that the system should return the next page of data.

Returns
Type Description
string

setPageToken

Optional. The value returned by the last ListBudgetsResponse which indicates that this is a continuation of a prior ListBudgets call, 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 form billingAccounts/{billingAccountId}. Please see Google\Cloud\Billing\Budgets\V1\BudgetServiceClient::billingAccountName() for help formatting this field.

Returns
Type Description
Google\Cloud\Billing\Budgets\V1\ListBudgetsRequest