public final class SearchCasesRequest extends GeneratedMessageV3 implements SearchCasesRequestOrBuilder
The request message for the SearchCases endpoint.
Protobuf type google.cloud.support.v2.SearchCasesRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchCasesRequestImplements
SearchCasesRequestOrBuilderStatic Fields
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 |
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static SearchCasesRequest getDefaultInstance()
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static SearchCasesRequest.Builder newBuilder()
Returns | |
---|---|
Type | Description |
SearchCasesRequest.Builder |
newBuilder(SearchCasesRequest prototype)
public static SearchCasesRequest.Builder newBuilder(SearchCasesRequest prototype)
Parameter | |
---|---|
Name | Description |
prototype |
SearchCasesRequest |
Returns | |
---|---|
Type | Description |
SearchCasesRequest.Builder |
parseDelimitedFrom(InputStream input)
public static SearchCasesRequest parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static SearchCasesRequest parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static SearchCasesRequest parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static SearchCasesRequest parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static SearchCasesRequest parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static SearchCasesRequest parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<SearchCasesRequest> parser()
Returns | |
---|---|
Type | Description |
Parser<SearchCasesRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public SearchCasesRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
SearchCasesRequest |
getPageSize()
public 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 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 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 String getParent()
The fully qualified name of parent resource to search cases under.
string parent = 4;
Returns | |
---|---|
Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()
The fully qualified name of parent resource to search cases under.
string parent = 4;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for parent. |
getParserForType()
public Parser<SearchCasesRequest> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<SearchCasesRequest> |
getQuery()
public 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 formorganizations/<organization_id>
.project
: A project name in the formprojects/<project_id>
.state
: The accepted values areOPEN
orCLOSED
.priority
: The accepted values areP0
,P1
,P2
,P3
, orP4
. You can specify multiple values for priority using theOR
operator. For example,priority=P1 OR priority=P2
.creator.email
: The email address of the case creator.billingAccount
: A billing account in the formbillingAccounts/<billing_account_id>
You must specify either
organization
orproject
.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 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 formorganizations/<organization_id>
.project
: A project name in the formprojects/<project_id>
.state
: The accepted values areOPEN
orCLOSED
.priority
: The accepted values areP0
,P1
,P2
,P3
, orP4
. You can specify multiple values for priority using theOR
operator. For example,priority=P1 OR priority=P2
.creator.email
: The email address of the case creator.billingAccount
: A billing account in the formbillingAccounts/<billing_account_id>
You must specify either
organization
orproject
.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. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public SearchCasesRequest.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
SearchCasesRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchCasesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
SearchCasesRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public SearchCasesRequest.Builder toBuilder()
Returns | |
---|---|
Type | Description |
SearchCasesRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |