Reference documentation and code samples for the Google Cloud Support V2 Client class SearchCasesRequest.
The request message for the SearchCases endpoint.
Generated from protobuf message google.cloud.support.v2.SearchCasesRequest
Namespace
Google \ Cloud \ Support \ V2Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
The fully qualified name of parent resource to search cases under. |
↳ query |
string
An expression written in filter language. A query uses the following fields with the operators equals ( |
↳ page_size |
int
The maximum number of cases fetched with each request. The default page size is 10. |
↳ page_token |
string
A token identifying the page of results to return. If unspecified, the first page is retrieved. |
getParent
The fully qualified name of parent resource to search cases under.
Returns | |
---|---|
Type | Description |
string |
setParent
The fully qualified name of parent resource to search cases under.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getQuery
An expression written in filter language.
A query uses the following fields with the operators equals (=
) and
AND
:
organization
: An organization name in the formorganizations/<organization_id>
.project
: A project name in the formprojects/<project_id>
.state
: The accepted values areOPEN
orCLOSED
.priority
: The accepted values areP0
,P1
,P2
,P3
, orP4
. You can specify multiple values for priority using theOR
operator. For example,priority=P1 OR priority=P2
.creator.email
: The email address of the case creator.billingAccount
: A billing account in the formbillingAccounts/<billing_account_id>
You must specify eitherorganization
orproject
. To search acrossdisplayName
,description
, and comments, use a global restriction with no keyword or operator. For example,"my search"
. To search only cases updated after a certain date, useupdate_time
restricted with that particular date, time, and timezone in ISO datetime format. For example,update_time>"2020-01-01T00:00:00-05:00"
.update_time
only supports the greater than operator (>
). Examples:organization="organizations/123456789"
project="projects/my-project-id"
project="projects/123456789"
billing_account="billingAccounts/123456-A0B0C0-CUZ789"
organization="organizations/123456789" AND state=CLOSED
project="projects/my-project-id" AND creator.email="tester@example.com"
project="projects/my-project-id" AND (priority=P0 OR priority=P1)
Returns | |
---|---|
Type | Description |
string |
setQuery
An expression written in filter language.
A query uses the following fields with the operators equals (=
) and
AND
:
organization
: An organization name in the formorganizations/<organization_id>
.project
: A project name in the formprojects/<project_id>
.state
: The accepted values areOPEN
orCLOSED
.priority
: The accepted values areP0
,P1
,P2
,P3
, orP4
. You can specify multiple values for priority using theOR
operator. For example,priority=P1 OR priority=P2
.creator.email
: The email address of the case creator.billingAccount
: A billing account in the formbillingAccounts/<billing_account_id>
You must specify eitherorganization
orproject
. To search acrossdisplayName
,description
, and comments, use a global restriction with no keyword or operator. For example,"my search"
. To search only cases updated after a certain date, useupdate_time
restricted with that particular date, time, and timezone in ISO datetime format. For example,update_time>"2020-01-01T00:00:00-05:00"
.update_time
only supports the greater than operator (>
). Examples:organization="organizations/123456789"
project="projects/my-project-id"
project="projects/123456789"
billing_account="billingAccounts/123456-A0B0C0-CUZ789"
organization="organizations/123456789" AND state=CLOSED
project="projects/my-project-id" AND creator.email="tester@example.com"
project="projects/my-project-id" 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. The default page size is 10.
Returns | |
---|---|
Type | Description |
int |
setPageSize
The maximum number of cases fetched with each request. The default page size is 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 |