Interface ListCasesRequestOrBuilder (0.39.0)

public interface ListCasesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String 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)

string filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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)

string filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract int getPageSize()

The maximum number of cases fetched with each request. Defaults to 10.

int32 page_size = 4;

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 = 5;

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 = 5;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.