Reference documentation and code samples for the Google Cloud Support V2 Client class ListCasesRequest.
The request message for the ListCases endpoint.
Generated from protobuf messagegoogle.cloud.support.v2.ListCasesRequest
Namespace
Google \ Cloud \ Support \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The name of a parent to list cases under.
↳ filter
string
An expression used to filter cases. If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter. Expressions use the following fields separated byANDand specified with=: -state: Can beOPENorCLOSED. -priority: Can beP0,P1,P2,P3, orP4. You can specify multiple values for priority using theORoperator. For example,priority=P1 OR priority=P2. -creator.email: The email address of the case creator. EXAMPLES: -state=CLOSED-state=OPEN AND creator.email="tester@example.com"-state=OPEN AND (priority=P0 OR priority=P1)
↳ page_size
int
The maximum number of cases fetched with each request. Defaults to 10.
↳ page_token
string
A token identifying the page of results to return. If unspecified, the first page is retrieved.
getParent
Required. The name of a parent to list cases under.
Returns
Type
Description
string
setParent
Required. The name of a parent to list cases under.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
An expression used to filter cases.
If it's an empty string, then no filtering happens. Otherwise, the endpoint
returns the cases that match the filter.
Expressions use the following fields separated byANDand specified with=:
state: Can beOPENorCLOSED.
priority: Can beP0,P1,P2,P3, orP4. You
can specify multiple values for priority using theORoperator. For
example,priority=P1 OR priority=P2.
creator.email: The email address of the case creator.
EXAMPLES:
state=CLOSED
state=OPEN AND creator.email="tester@example.com"
state=OPEN AND (priority=P0 OR priority=P1)
Returns
Type
Description
string
setFilter
An expression used to filter cases.
If it's an empty string, then no filtering happens. Otherwise, the endpoint
returns the cases that match the filter.
Expressions use the following fields separated byANDand specified with=:
state: Can beOPENorCLOSED.
priority: Can beP0,P1,P2,P3, orP4. You
can specify multiple values for priority using theORoperator. For
example,priority=P1 OR priority=P2.
creator.email: The email address of the case creator.
EXAMPLES:
state=CLOSED
state=OPEN AND creator.email="tester@example.com"
state=OPEN AND (priority=P0 OR priority=P1)
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The maximum number of cases fetched with each request. Defaults to 10.
Returns
Type
Description
int
setPageSize
The maximum number of cases fetched with each request. Defaults to 10.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
A token identifying the page of results to return. If unspecified, the
first page is retrieved.
Returns
Type
Description
string
setPageToken
A token identifying the page of results to return. If unspecified, the
first page is retrieved.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The name of a parent to list cases under. Please seeCaseServiceClient::projectName()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 Support V2 Client - Class ListCasesRequest (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-support/latest/V2.ListCasesRequest)\n- [1.2.0](/php/docs/reference/cloud-support/1.2.0/V2.ListCasesRequest)\n- [1.1.0](/php/docs/reference/cloud-support/1.1.0/V2.ListCasesRequest)\n- [1.0.3](/php/docs/reference/cloud-support/1.0.3/V2.ListCasesRequest)\n- [0.2.5](/php/docs/reference/cloud-support/0.2.5/V2.ListCasesRequest)\n- [0.1.2](/php/docs/reference/cloud-support/0.1.2/V2.ListCasesRequest) \nReference documentation and code samples for the Google Cloud Support V2 Client class ListCasesRequest.\n\nThe request message for the ListCases endpoint.\n\nGenerated from protobuf message `google.cloud.support.v2.ListCasesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Support \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The name of a parent to list cases under.\n\n### setParent\n\nRequired. The name of a parent to list cases under.\n\n### getFilter\n\nAn expression used to filter cases.\n\nIf it's an empty string, then no filtering happens. Otherwise, the endpoint\nreturns the cases that match the filter.\nExpressions use the following fields separated by `AND` and specified with\n`=`:\n\n- `state`: Can be `OPEN` or `CLOSED`.\n- `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`.\n- `creator.email`: The email address of the case creator. EXAMPLES:\n- `state=CLOSED`\n- `state=OPEN AND creator.email=\"tester@example.com\"`\n- `state=OPEN AND (priority=P0 OR priority=P1)`\n\n### setFilter\n\nAn expression used to filter cases.\n\nIf it's an empty string, then no filtering happens. Otherwise, the endpoint\nreturns the cases that match the filter.\nExpressions use the following fields separated by `AND` and specified with\n`=`:\n\n- `state`: Can be `OPEN` or `CLOSED`.\n- `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`.\n- `creator.email`: The email address of the case creator. EXAMPLES:\n- `state=CLOSED`\n- `state=OPEN AND creator.email=\"tester@example.com\"`\n- `state=OPEN AND (priority=P0 OR priority=P1)`\n\n### getPageSize\n\nThe maximum number of cases fetched with each request. Defaults to 10.\n\n### setPageSize\n\nThe maximum number of cases fetched with each request. Defaults to 10.\n\n### getPageToken\n\nA token identifying the page of results to return. If unspecified, the\nfirst page is retrieved.\n\n### setPageToken\n\nA token identifying the page of results to return. If unspecified, the\nfirst page is retrieved.\n\n### static::build"]]
