Reference documentation and code samples for the Google Cloud Support V2BETA API class Google::Cloud::Support::V2beta::Case.
A Case is an object that contains the details of a support case. It
contains fields for the time it was created, its priority, its
classification, and more. Cases can also have comments and attachments that
get added over time.
A case is parented by a Google Cloud organization or project.
Organizations are identified by a number, so the name of a case parented by
an organization would look like this:
organizations/123/cases/456
Projects have two unique identifiers, an ID and a number, and they look like
this:
projects/abc/cases/456
projects/123/cases/456
You can use either of them when calling the API. To learn more
about project identifiers, see AIP-2510.
(::String) — A user-supplied email address to send case update notifications for. This
should only be used in BYOID flows, where we cannot infer the user's email
address directly from their EUCs.
#contact_email=
defcontact_email=(value)->::String
Parameter
value (::String) — A user-supplied email address to send case update notifications for. This
should only be used in BYOID flows, where we cannot infer the user's email
address directly from their EUCs.
Returns
(::String) — A user-supplied email address to send case update notifications for. This
should only be used in BYOID flows, where we cannot infer the user's email
address directly from their EUCs.
Note: The name and email will be obfuscated if the case was created by
Google Support.
#description
defdescription()->::String
Returns
(::String) — A broad description of the issue.
#description=
defdescription=(value)->::String
Parameter
value (::String) — A broad description of the issue.
Returns
(::String) — A broad description of the issue.
#display_name
defdisplay_name()->::String
Returns
(::String) — The short summary of the issue reported in this case.
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::String) — The short summary of the issue reported in this case.
Returns
(::String) — The short summary of the issue reported in this case.
#escalated
defescalated()->::Boolean
Returns
(::Boolean) — Whether the case is currently escalated.
#escalated=
defescalated=(value)->::Boolean
Parameter
value (::Boolean) — Whether the case is currently escalated.
Returns
(::Boolean) — Whether the case is currently escalated.
#language_code
deflanguage_code()->::String
Returns
(::String) — The language the user has requested to receive support in. This should be a
BCP 47 language code (e.g., "en", "zh-CN", "zh-TW", "ja", "ko").
If no language or an unsupported language is specified, this field defaults
to English (en).
Language selection during case creation may affect your available support
options. For a list of supported languages and their support working hours,
see: https://cloud.google.com/support/docs/language-working-hours
#language_code=
deflanguage_code=(value)->::String
Parameter
value (::String) — The language the user has requested to receive support in. This should be a
BCP 47 language code (e.g., "en", "zh-CN", "zh-TW", "ja", "ko").
If no language or an unsupported language is specified, this field defaults
to English (en).
Language selection during case creation may affect your available support
options. For a list of supported languages and their support working hours,
see: https://cloud.google.com/support/docs/language-working-hours
Returns
(::String) — The language the user has requested to receive support in. This should be a
BCP 47 language code (e.g., "en", "zh-CN", "zh-TW", "ja", "ko").
If no language or an unsupported language is specified, this field defaults
to English (en).
Language selection during case creation may affect your available support
options. For a list of supported languages and their support working hours,
see: https://cloud.google.com/support/docs/language-working-hours
#name
defname()->::String
Returns
(::String) — Identifier. The resource name for the case.
#name=
defname=(value)->::String
Parameter
value (::String) — Identifier. The resource name for the case.
Returns
(::String) — Identifier. The resource name for the case.
value (::Array<::String>) — The email addresses to receive updates on this case.
Returns
(::Array<::String>) — The email addresses to receive updates on this case.
#test_case
deftest_case()->::Boolean
Returns
(::Boolean) — Whether this case was created for internal API testing and should not be
acted on by the support team.
#test_case=
deftest_case=(value)->::Boolean
Parameter
value (::Boolean) — Whether this case was created for internal API testing and should not be
acted on by the support team.
Returns
(::Boolean) — Whether this case was created for internal API testing and should not be
acted on by the support team.
#time_zone
deftime_zone()->::String
Returns
(::String) — The timezone of the user who created the support case.
It should be in a format IANA recognizes: https://www.iana.org/time-zones.
There is no additional validation done by the API.
#time_zone=
deftime_zone=(value)->::String
Parameter
value (::String) — The timezone of the user who created the support case.
It should be in a format IANA recognizes: https://www.iana.org/time-zones.
There is no additional validation done by the API.
Returns
(::String) — The timezone of the user who created the support case.
It should be in a format IANA recognizes: https://www.iana.org/time-zones.
There is no additional validation done by the API.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Support V2BETA API - Class Google::Cloud::Support::V2beta::Case (v0.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.2.0 (latest)](/ruby/docs/reference/google-cloud-support-v2beta/latest/Google-Cloud-Support-V2beta-Case)\n- [0.1.1](/ruby/docs/reference/google-cloud-support-v2beta/0.1.1/Google-Cloud-Support-V2beta-Case) \nReference documentation and code samples for the Google Cloud Support V2BETA API class Google::Cloud::Support::V2beta::Case.\n\nA Case is an object that contains the details of a support case. It\ncontains fields for the time it was created, its priority, its\nclassification, and more. Cases can also have comments and attachments that\nget added over time.\n\n\nA case is parented by a Google Cloud organization or project.\n\nOrganizations are identified by a number, so the name of a case parented by\nan organization would look like this:\n\n`\norganizations/123/cases/456\n`\n\nProjects have two unique identifiers, an ID and a number, and they look like\nthis:\n\n`\nprojects/abc/cases/456\n`\n\n`\nprojects/123/cases/456\n`\n\n\u003cbr /\u003e\n\nYou can use either of them when calling the API. To learn more\nabout project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510). \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### #classification\n\n def classification() -\u003e ::Google::Cloud::Support::V2beta::CaseClassification\n\n**Returns**\n\n- ([::Google::Cloud::Support::V2beta::CaseClassification](./Google-Cloud-Support-V2beta-CaseClassification)) --- The issue classification applicable to this case.\n\n### #classification=\n\n def classification=(value) -\u003e ::Google::Cloud::Support::V2beta::CaseClassification\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Support::V2beta::CaseClassification](./Google-Cloud-Support-V2beta-CaseClassification)) --- The issue classification applicable to this case. \n**Returns**\n\n- ([::Google::Cloud::Support::V2beta::CaseClassification](./Google-Cloud-Support-V2beta-CaseClassification)) --- The issue classification applicable to this case.\n\n### #contact_email\n\n def contact_email() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs.\n\n### #contact_email=\n\n def contact_email=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. \n**Returns**\n\n- (::String) --- A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time this case was created.\n\n### #creator\n\n def creator() -\u003e ::Google::Cloud::Support::V2beta::Actor\n\n**Returns**\n\n- ([::Google::Cloud::Support::V2beta::Actor](./Google-Cloud-Support-V2beta-Actor)) --- The user who created the case.\n\n\n Note: The name and email will be obfuscated if the case was created by\n Google Support.\n\n### #creator=\n\n def creator=(value) -\u003e ::Google::Cloud::Support::V2beta::Actor\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Support::V2beta::Actor](./Google-Cloud-Support-V2beta-Actor)) --- The user who created the case.\n\n\n Note: The name and email will be obfuscated if the case was created by\nGoogle Support. \n**Returns**\n\n- ([::Google::Cloud::Support::V2beta::Actor](./Google-Cloud-Support-V2beta-Actor)) --- The user who created the case.\n\n\n Note: The name and email will be obfuscated if the case was created by\n Google Support.\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A broad description of the issue.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A broad description of the issue. \n**Returns**\n\n- (::String) --- A broad description of the issue.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The short summary of the issue reported in this case.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The short summary of the issue reported in this case. \n**Returns**\n\n- (::String) --- The short summary of the issue reported in this case.\n\n### #escalated\n\n def escalated() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Whether the case is currently escalated.\n\n### #escalated=\n\n def escalated=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Whether the case is currently escalated. \n**Returns**\n\n- (::Boolean) --- Whether the case is currently escalated.\n\n### #language_code\n\n def language_code() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `\"en\"`, `\"zh-CN\"`, `\"zh-TW\"`, `\"ja\"`, `\"ko\"`). If no language or an unsupported language is specified, this field defaults to English (en).\n\n\n Language selection during case creation may affect your available support\n options. For a list of supported languages and their support working hours,\n see: https://cloud.google.com/support/docs/language-working-hours\n\n### #language_code=\n\n def language_code=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `\"en\"`, `\"zh-CN\"`, `\"zh-TW\"`, `\"ja\"`, `\"ko\"`). If no language or an unsupported language is specified, this field defaults to English (en).\n\n\n Language selection during case creation may affect your available support\n options. For a list of supported languages and their support working hours,\nsee: https://cloud.google.com/support/docs/language-working-hours \n**Returns**\n\n- (::String) --- The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `\"en\"`, `\"zh-CN\"`, `\"zh-TW\"`, `\"ja\"`, `\"ko\"`). If no language or an unsupported language is specified, this field defaults to English (en).\n\n\n Language selection during case creation may affect your available support\n options. For a list of supported languages and their support working hours,\n see: https://cloud.google.com/support/docs/language-working-hours\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Identifier. The resource name for the case.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Identifier. The resource name for the case. \n**Returns**\n\n- (::String) --- Identifier. The resource name for the case.\n\n### #priority\n\n def priority() -\u003e ::Google::Cloud::Support::V2beta::Case::Priority\n\n**Returns**\n\n- ([::Google::Cloud::Support::V2beta::Case::Priority](./Google-Cloud-Support-V2beta-Case-Priority)) --- The priority of this case.\n\n### #priority=\n\n def priority=(value) -\u003e ::Google::Cloud::Support::V2beta::Case::Priority\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Support::V2beta::Case::Priority](./Google-Cloud-Support-V2beta-Case-Priority)) --- The priority of this case. \n**Returns**\n\n- ([::Google::Cloud::Support::V2beta::Case::Priority](./Google-Cloud-Support-V2beta-Case-Priority)) --- The priority of this case.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Support::V2beta::Case::State\n\n**Returns**\n\n- ([::Google::Cloud::Support::V2beta::Case::State](./Google-Cloud-Support-V2beta-Case-State)) --- Output only. The current status of the support case.\n\n### #subscriber_email_addresses\n\n def subscriber_email_addresses() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- The email addresses to receive updates on this case.\n\n### #subscriber_email_addresses=\n\n def subscriber_email_addresses=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- The email addresses to receive updates on this case. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- The email addresses to receive updates on this case.\n\n### #test_case\n\n def test_case() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Whether this case was created for internal API testing and should not be acted on by the support team.\n\n### #test_case=\n\n def test_case=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Whether this case was created for internal API testing and should not be acted on by the support team. \n**Returns**\n\n- (::Boolean) --- Whether this case was created for internal API testing and should not be acted on by the support team.\n\n### #time_zone\n\n def time_zone() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.\n\n### #time_zone=\n\n def time_zone=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API. \n**Returns**\n\n- (::String) --- The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time this case was last updated."]]
