public final class SearchCasesRequest extends GeneratedMessageV3 implements SearchCasesRequestOrBuilder
The request message for the SearchCases endpoint.
Protobuf type google.cloud.support.v2.SearchCasesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static 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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchCasesRequest.Builder newBuilder()
newBuilder(SearchCasesRequest prototype)
public static SearchCasesRequest.Builder newBuilder(SearchCasesRequest prototype)
public static SearchCasesRequest parseDelimitedFrom(InputStream input)
public static SearchCasesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchCasesRequest parseFrom(byte[] data)
Parameter |
---|
Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchCasesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseFrom(CodedInputStream input)
public static SearchCasesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseFrom(InputStream input)
public static SearchCasesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchCasesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchCasesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchCasesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
---|
Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public SearchCasesRequest getDefaultInstanceForType()
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()
Overrides
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 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.
|
getSerializedSize()
public int getSerializedSize()
Returns |
---|
Type | Description |
int | |
Overrides
hashCode()
Returns |
---|
Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchCasesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchCasesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public SearchCasesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides