Google Cloud Quotas V1 Client - Class ListQuotaPreferencesRequest (0.2.3)

Reference documentation and code samples for the Google Cloud Quotas V1 Client class ListQuotaPreferencesRequest.

Message for requesting list of QuotaPreferences

Generated from protobuf message google.api.cloudquotas.v1.ListQuotaPreferencesRequest

Namespace

Google \ Cloud \ CloudQuotas \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Parent value of QuotaPreference resources. Listing across different resource containers (such as 'projects/-') is not allowed. When the value starts with 'folders' or 'organizations', it lists the QuotaPreferences for org quotas in the container. It does not list the QuotaPreferences in the descendant projects of the container. Example parents: projects/123/locations/global

↳ page_size int

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

↳ page_token string

Optional. A token identifying a page of results the server should return.

↳ filter string

Optional. Filter result QuotaPreferences by their state, type, create/update time range. Example filters: reconciling=true AND request_type=CLOUD_CONSOLE, reconciling=true OR creation_time>2022-12-03T10:30:00

↳ order_by string

Optional. How to order of the results. By default, the results are ordered by create time. Example orders: quota_id, service, create_time

getParent

Required. Parent value of QuotaPreference resources.

Listing across different resource containers (such as 'projects/-') is not allowed. When the value starts with 'folders' or 'organizations', it lists the QuotaPreferences for org quotas in the container. It does not list the QuotaPreferences in the descendant projects of the container. Example parents: projects/123/locations/global

Returns
Type Description
string

setParent

Required. Parent value of QuotaPreference resources.

Listing across different resource containers (such as 'projects/-') is not allowed. When the value starts with 'folders' or 'organizations', it lists the QuotaPreferences for org quotas in the container. It does not list the QuotaPreferences in the descendant projects of the container. Example parents: projects/123/locations/global

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Returns
Type Description
int

setPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A token identifying a page of results the server should return.

Returns
Type Description
string

setPageToken

Optional. A token identifying a page of results the server should return.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filter result QuotaPreferences by their state, type, create/update time range.

Example filters: reconciling=true AND request_type=CLOUD_CONSOLE, reconciling=true OR creation_time>2022-12-03T10:30:00

Returns
Type Description
string

setFilter

Optional. Filter result QuotaPreferences by their state, type, create/update time range.

Example filters: reconciling=true AND request_type=CLOUD_CONSOLE, reconciling=true OR creation_time>2022-12-03T10:30:00

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. How to order of the results. By default, the results are ordered by create time.

Example orders: quota_id, service, create_time

Returns
Type Description
string

setOrderBy

Optional. How to order of the results. By default, the results are ordered by create time.

Example orders: quota_id, service, create_time

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Parent value of QuotaPreference resources. Listing across different resource containers (such as 'projects/-') is not allowed.

When the value starts with 'folders' or 'organizations', it lists the QuotaPreferences for org quotas in the container. It does not list the QuotaPreferences in the descendant projects of the container.

Example parents: projects/123/locations/global Please see Google\Cloud\CloudQuotas\V1\CloudQuotasClient::locationName() for help formatting this field.

Returns
Type Description
Google\Cloud\CloudQuotas\V1\ListQuotaPreferencesRequest