Reference documentation and code samples for the Google Cloud Support V2 API class Google::Cloud::Support::V2::SearchCasesRequest.
The request message for the SearchCases endpoint.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#page_size
defpage_size()->::Integer
Returns
(::Integer) — The maximum number of cases fetched with each request. The default page
size is 10.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — The maximum number of cases fetched with each request. The default page
size is 10.
Returns
(::Integer) — The maximum number of cases fetched with each request. The default page
size is 10.
#page_token
defpage_token()->::String
Returns
(::String) — A token identifying the page of results to return. If unspecified, the
first page is retrieved.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — A token identifying the page of results to return. If unspecified, the
first page is retrieved.
Returns
(::String) — A token identifying the page of results to return. If unspecified, the
first page is retrieved.
#parent
defparent()->::String
Returns
(::String) — The name of the parent resource to search for cases under.
#parent=
defparent=(value)->::String
Parameter
value (::String) — The name of the parent resource to search for cases under.
Returns
(::String) — The name of the parent resource to search for cases under.
#query
defquery()->::String
Returns
(::String) —
An expression used to filter cases.
Expressions use the following fields separated by AND and specified with
=:
organization: An organization name in the form
organizations/<organization_id>.
project: A project name in the form projects/<project_id>.
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.
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"
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)
#query=
defquery=(value)->::String
Parameter
value (::String) —
An expression used to filter cases.
Expressions use the following fields separated by AND and specified with
=:
organization: An organization name in the form
organizations/<organization_id>.
project: A project name in the form projects/<project_id>.
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.
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"
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)
Returns
(::String) —
An expression used to filter cases.
Expressions use the following fields separated by AND and specified with
=:
organization: An organization name in the form
organizations/<organization_id>.
project: A project name in the form projects/<project_id>.
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.
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"
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)
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Support V2 API - Class Google::Cloud::Support::V2::SearchCasesRequest (v1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/ruby/docs/reference/google-cloud-support-v2/latest/Google-Cloud-Support-V2-SearchCasesRequest)\n- [1.4.0](/ruby/docs/reference/google-cloud-support-v2/1.4.0/Google-Cloud-Support-V2-SearchCasesRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-support-v2/1.3.0/Google-Cloud-Support-V2-SearchCasesRequest)\n- [1.2.1](/ruby/docs/reference/google-cloud-support-v2/1.2.1/Google-Cloud-Support-V2-SearchCasesRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-support-v2/1.1.0/Google-Cloud-Support-V2-SearchCasesRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-support-v2/1.0.1/Google-Cloud-Support-V2-SearchCasesRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-support-v2/0.4.0/Google-Cloud-Support-V2-SearchCasesRequest)\n- [0.3.2](/ruby/docs/reference/google-cloud-support-v2/0.3.2/Google-Cloud-Support-V2-SearchCasesRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-support-v2/0.2.0/Google-Cloud-Support-V2-SearchCasesRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-support-v2/0.1.0/Google-Cloud-Support-V2-SearchCasesRequest) \nReference documentation and code samples for the Google Cloud Support V2 API class Google::Cloud::Support::V2::SearchCasesRequest.\n\nThe request message for the SearchCases endpoint. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The maximum number of cases fetched with each request. The default page size is 10.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The maximum number of cases fetched with each request. The default page size is 10. \n**Returns**\n\n- (::Integer) --- The maximum number of cases fetched with each request. The default page size is 10.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A token identifying the page of results to return. If unspecified, the first page is retrieved.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A token identifying the page of results to return. If unspecified, the first page is retrieved. \n**Returns**\n\n- (::String) --- A token identifying the page of results to return. If unspecified, the first page is retrieved.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The name of the parent resource to search for cases under.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The name of the parent resource to search for cases under. \n**Returns**\n\n- (::String) --- The name of the parent resource to search for cases under.\n\n### #query\n\n def query() -\u003e ::String\n\n**Returns**\n\n- (::String) --- An expression used to filter cases.\n\n Expressions use the following fields separated by `AND` and specified with\n `=`:\n - `organization`: An organization name in the form `organizations/\u003corganization_id\u003e`.\n - `project`: A project name in the form `projects/\u003cproject_id\u003e`.\n - `state`: Can be `OPEN` or `CLOSED`.\n - `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`.\n - `creator.email`: The email address of the case creator.\n\n You must specify either `organization` or `project`.\n\n To search across `displayName`, `description`, and comments, use a global\n restriction with no keyword or operator. For example, `\"my search\"`.\n\n To search only cases updated after a certain date, use `update_time`\n restricted with that particular date, time, and timezone in ISO datetime\n format. For example, `update_time\u003e\"2020-01-01T00:00:00-05:00\"`.\n `update_time` only supports the greater than operator (`\u003e`).\n\n Examples:\n - `organization=\"organizations/123456789\"`\n - `project=\"projects/my-project-id\"`\n - `project=\"projects/123456789\"`\n - `organization=\"organizations/123456789\" AND state=CLOSED`\n - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"`\n - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`\n\n### #query=\n\n def query=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n An expression used to filter cases.\n\n Expressions use the following fields separated by `AND` and specified with\n `=`:\n - `organization`: An organization name in the form `organizations/\u003corganization_id\u003e`.\n - `project`: A project name in the form `projects/\u003cproject_id\u003e`.\n - `state`: Can be `OPEN` or `CLOSED`.\n - `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`.\n - `creator.email`: The email address of the case creator.\n\n You must specify either `organization` or `project`.\n\n To search across `displayName`, `description`, and comments, use a global\n restriction with no keyword or operator. For example, `\"my search\"`.\n\n To search only cases updated after a certain date, use `update_time`\n restricted with that particular date, time, and timezone in ISO datetime\n format. For example, `update_time\u003e\"2020-01-01T00:00:00-05:00\"`.\n `update_time` only supports the greater than operator (`\u003e`).\n\n Examples:\n - `organization=\"organizations/123456789\"`\n - `project=\"projects/my-project-id\"`\n - `project=\"projects/123456789\"`\n - `organization=\"organizations/123456789\" AND state=CLOSED`\n - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"`\n- `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)` \n**Returns**\n\n- (::String) --- An expression used to filter cases.\n\n Expressions use the following fields separated by `AND` and specified with\n `=`:\n - `organization`: An organization name in the form `organizations/\u003corganization_id\u003e`.\n - `project`: A project name in the form `projects/\u003cproject_id\u003e`.\n - `state`: Can be `OPEN` or `CLOSED`.\n - `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`.\n - `creator.email`: The email address of the case creator.\n\n You must specify either `organization` or `project`.\n\n To search across `displayName`, `description`, and comments, use a global\n restriction with no keyword or operator. For example, `\"my search\"`.\n\n To search only cases updated after a certain date, use `update_time`\n restricted with that particular date, time, and timezone in ISO datetime\n format. For example, `update_time\u003e\"2020-01-01T00:00:00-05:00\"`.\n `update_time` only supports the greater than operator (`\u003e`).\n\n Examples:\n - `organization=\"organizations/123456789\"`\n - `project=\"projects/my-project-id\"`\n - `project=\"projects/123456789\"`\n - `organization=\"organizations/123456789\" AND state=CLOSED`\n - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"`\n - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`"]]
