Google Cloud Support V2beta Client - Class SearchCasesRequest (1.7.0)

Reference documentation and code samples for the Google Cloud Support V2beta Client class SearchCasesRequest.

The request message for the SearchCases endpoint.

Generated from protobuf message google.cloud.support.v2beta.SearchCasesRequest

Namespace

Google \ Cloud \ Support \ V2beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

The name of the parent resource to search for cases under.
↳ query string

An expression used to filter cases. 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. To search across displayName, 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, use update_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 (>). If you are using the v2 version of the API, you must specify the case parent in the parent field. If you provide an empty query, all cases under the parent resource will be returned. If you are using the v2beta version of the API, you must specify the case parent in the query field using one of the two fields below, which are only available for v2beta. The parent field will be ignored. - organization: An organization name in the form organizations/<organization_id>. - project: A project name in the form projects/<project_id>. Examples: For v2: - state=CLOSED - state=OPEN AND creator.email="tester\@example.com" - state=OPEN AND (priority=P0 OR priority=P1) - update_time>"2020-01-01T00:00:00-05:00" For v2beta: - organization="organizations/123456789" - project="projects/my-project-id" - project="projects/123456789" - 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)
↳ 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 name of the parent resource to search for cases under.

Returns
Type Description
string

setParent

The name of the parent resource to search for cases under.

Parameter
Name Description
var string
Returns
Type Description
$this

getQuery

An expression used to filter cases.

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. To search across displayName, 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, use update_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 (>). If you are using the v2 version of the API, you must specify the case parent in the parent field. If you provide an empty query, all cases under the parent resource will be returned. If you are using the v2beta version of the API, you must specify the case parent in the query field using one of the two fields below, which are only available for v2beta. The parent field will be ignored.
  • organization: An organization name in the form organizations/<organization_id>.
  • project: A project name in the form projects/<project_id>. Examples: For v2:
  • state=CLOSED
  • state=OPEN AND creator.email="tester\@example.com"
  • state=OPEN AND (priority=P0 OR priority=P1)
  • update_time>"2020-01-01T00:00:00-05:00" For v2beta:
  • organization="organizations/123456789"
  • project="projects/my-project-id"
  • project="projects/123456789"
  • 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 used to filter cases.

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. To search across displayName, 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, use update_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 (>). If you are using the v2 version of the API, you must specify the case parent in the parent field. If you provide an empty query, all cases under the parent resource will be returned. If you are using the v2beta version of the API, you must specify the case parent in the query field using one of the two fields below, which are only available for v2beta. The parent field will be ignored.
  • organization: An organization name in the form organizations/<organization_id>.
  • project: A project name in the form projects/<project_id>. Examples: For v2:
  • state=CLOSED
  • state=OPEN AND creator.email="tester\@example.com"
  • state=OPEN AND (priority=P0 OR priority=P1)
  • update_time>"2020-01-01T00:00:00-05:00" For v2beta:
  • organization="organizations/123456789"
  • project="projects/my-project-id"
  • project="projects/123456789"
  • 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