Interface SearchCasesRequestOrBuilder (0.78.0)

0.78.0 (latest) 0.77.0 0.75.0 0.72.0 0.71.0 0.69.0 0.67.0 0.66.0 0.65.0 0.64.0 0.62.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.54.0 0.52.0 0.51.0 0.48.0 0.47.0 0.46.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface SearchCasesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPageSize()

public abstract int getPageSize()

The maximum number of cases fetched with each request. The default page size is 10.

int32 page_size = 2;

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

A token identifying the page of results to return. If unspecified, the first page is retrieved.

string page_token = 3;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

A token identifying the page of results to return. If unspecified, the first page is retrieved.

string page_token = 3;

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String getParent()

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

string parent = 4;

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 4;

Returns
Type	Description
ByteString	The bytes for parent.

getQuery()

public abstract String 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="[e-mail]"
• 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="[e-mail]"
• project="projects/my-project-id" AND (priority=P0 OR priority=P1)

string query = 1;

Returns
Type	Description
String	The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

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="[e-mail]"
• 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="[e-mail]"
• project="projects/my-project-id" AND (priority=P0 OR priority=P1)

string query = 1;

Returns
Type	Description
ByteString	The bytes for query.