Google Cloud Support V2 Client - Class ListCasesRequest (1.2.0)

Reference documentation and code samples for the Google Cloud Support V2 Client class ListCasesRequest.

The request message for the ListCases endpoint.

Generated from protobuf message google.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 by AND and specified with =: - state: Can be OPEN or CLOSED. - 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. - creator.email: The email address of the case creator. EXAMPLES: - state=CLOSED - state=OPEN AND creator.email="[email protected]" - 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 by AND and specified with =:

  • state: Can be OPEN or CLOSED.
  • 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.
  • creator.email: The email address of the case creator. EXAMPLES:
  • state=CLOSED
  • state=OPEN AND creator.email="[email protected]"
  • 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 by AND and specified with =:

  • state: Can be OPEN or CLOSED.
  • 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.
  • creator.email: The email address of the case creator. EXAMPLES:
  • state=CLOSED
  • state=OPEN AND creator.email="[email protected]"
  • 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 see CaseServiceClient::projectName() for help formatting this field.
Returns
Type Description
ListCasesRequest