Stackdriver Logging V2 Client - Class ListBucketsRequest (1.27.1)

Reference documentation and code samples for the Stackdriver Logging V2 Client class ListBucketsRequest.

The parameters to ListBuckets.

Generated from protobuf message google.logging.v2.ListBucketsRequest

Namespace

Google \ Cloud \ Logging \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets.
`↳ page_token`	`string` Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.
`↳ page_size`	`int` Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.

getParent

Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of [LOCATION_ID] will return all buckets.

Returns
Type	Description
`string`

setParent

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageToken

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

Returns
Type	Description
`string`

setPageToken

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

Returns
Type	Description
`int`

setPageSize

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

parent

string

Required. The parent resource whose buckets are to be listed:

"projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]"

Note: The locations portion of the resource must be specified, but supplying the character - in place of [LOCATION_ID] will return all buckets. Please see Google\Cloud\Logging\V2\ConfigServiceV2Client::organizationLocationName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Logging\V2\ListBucketsRequest`