Google Cloud Support V2 Client - Class ListCasesRequest (0.2.5)

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 fully qualified name of parent resource to list cases under.
↳ filter string

An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases. Filter expressions use the following fields with the operators equals (=) and AND: - state: The accepted values are OPEN or CLOSED. - priority: The accepted values are 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="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 fully qualified name of parent resource to list cases under.

Returns
Type Description
string

setParent

Required. The fully qualified name of parent resource to list cases under.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases.

Filter expressions use the following fields with the operators equals (=) and AND:

  • state: The accepted values are OPEN or CLOSED.
  • priority: The accepted values are 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="tester@example.com"
  • state=OPEN AND (priority=P0 OR priority=P1)
Returns
Type Description
string

setFilter

An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases.

Filter expressions use the following fields with the operators equals (=) and AND:

  • state: The accepted values are OPEN or CLOSED.
  • priority: The accepted values are 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="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 fully qualified name of parent resource to list cases under. Please see Google\Cloud\Support\V2\CaseServiceClient::projectName() for help formatting this field.
Returns
Type Description
Google\Cloud\Support\V2\ListCasesRequest