Interface SearchCasesRequestOrBuilder (0.32.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 fully qualified name of parent resource to search cases under.

string parent = 4;

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

The fully qualified name of parent resource to search cases under.

string parent = 4;

Returns
Type Description
ByteString

The bytes for parent.

getQuery()

public abstract String 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 form organizations/<organization_id>.
  • project: A project name in the form projects/<project_id>.
  • 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.
  • billingAccount: A billing account in the form billingAccounts/<billing_account_id>

    You must specify either organization or project.

    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 (>).

    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)

string query = 1;

Returns
Type Description
String

The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

An expression written in filter language.

A query uses the following fields with the operators equals (=) and AND:

  • organization: An organization name in the form organizations/<organization_id>.
  • project: A project name in the form projects/<project_id>.
  • 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.
  • billingAccount: A billing account in the form billingAccounts/<billing_account_id>

    You must specify either organization or project.

    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 (>).

    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)

string query = 1;

Returns
Type Description
ByteString

The bytes for query.