public final class SearchCasesRequest extends GeneratedMessage implements SearchCasesRequestOrBuilder
The request message for the SearchCases endpoint.
Protobuf type google.cloud.support.v2beta.SearchCasesRequest
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,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 name of the parent resource to search for cases under.
string parent = 4;
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public ByteString getParentBytes()
The name of the parent resource to search for cases under.
string parent = 4;
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<SearchCasesRequest> getParserForType()
Overrides
getQuery()
An expression used to filter cases.
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.
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 (>).
If you are using the v2 version of the API, you must specify the case
parent in the parent field. If you provide an empty query, all cases
under the parent resource will be returned.
If you are using the v2beta version of the API, you must specify the case
parent in the query field using one of the two fields below, which are
only available for v2beta. The parent field will be ignored.
organization: An organization name in the form
organizations/<organization_id>.
project: A project name in the form projects/<project_id>.
Examples:
For v2:
state=CLOSED
state=OPEN AND creator.email="tester@example.com"
state=OPEN AND (priority=P0 OR priority=P1)
update_time>"2020-01-01T00:00:00-05:00"
For v2beta:
organization="organizations/123456789"
project="projects/my-project-id"
project="projects/123456789"
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 used to filter cases.
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.
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 (>).
If you are using the v2 version of the API, you must specify the case
parent in the parent field. If you provide an empty query, all cases
under the parent resource will be returned.
If you are using the v2beta version of the API, you must specify the case
parent in the query field using one of the two fields below, which are
only available for v2beta. The parent field will be ignored.
organization: An organization name in the form
organizations/<organization_id>.
project: A project name in the form projects/<project_id>.
Examples:
For v2:
state=CLOSED
state=OPEN AND creator.email="tester@example.com"
state=OPEN AND (priority=P0 OR priority=P1)
update_time>"2020-01-01T00:00:00-05:00"
For v2beta:
organization="organizations/123456789"
project="projects/my-project-id"
project="projects/123456789"
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchCasesRequest.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected SearchCasesRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public SearchCasesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides