Class ListCasesRequest (0.67.0) 

public final class ListCasesRequest extends GeneratedMessage implements ListCasesRequestOrBuilder

The request message for the ListCases endpoint.

Protobuf type google.cloud.support.v2.ListCasesRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ListCasesRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListCasesRequest getDefaultInstance()
Returns
Type Description
ListCasesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListCasesRequest.Builder newBuilder()
Returns
Type Description
ListCasesRequest.Builder

newBuilder(ListCasesRequest prototype)

public static ListCasesRequest.Builder newBuilder(ListCasesRequest prototype)
Parameter
Name Description
prototype ListCasesRequest
Returns
Type Description
ListCasesRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListCasesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCasesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListCasesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListCasesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListCasesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListCasesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListCasesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCasesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListCasesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCasesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListCasesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListCasesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListCasesRequest> parser()
Returns
Type Description
Parser<ListCasesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListCasesRequest getDefaultInstanceForType()
Returns
Type Description
ListCasesRequest

getFilter()

public String getFilter()

An expression used to filter cases.

If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

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.

    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 ByteString getFilterBytes()

An expression used to filter cases.

If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

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.

    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 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 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 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 String getParent()

Required. The name of a parent to list cases under.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The name of a parent to list cases under.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListCasesRequest> getParserForType()
Returns
Type Description
Parser<ListCasesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListCasesRequest.Builder newBuilderForType()
Returns
Type Description
ListCasesRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ListCasesRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListCasesRequest.Builder
Overrides

toBuilder()

public ListCasesRequest.Builder toBuilder()
Returns
Type Description
ListCasesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException