Reference documentation and code samples for the Google Cloud Support V2 API class Google::Cloud::Support::V2::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#classification
def classification() -> ::Google::Cloud::Support::V2::CaseClassification- (::Google::Cloud::Support::V2::CaseClassification) — The issue classification applicable to this case.
#classification=
def classification=(value) -> ::Google::Cloud::Support::V2::CaseClassification- value (::Google::Cloud::Support::V2::CaseClassification) — The issue classification applicable to this case.
- (::Google::Cloud::Support::V2::CaseClassification) — The issue classification applicable to this case.
#contact_email
def contact_email() -> ::String- (::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=
def contact_email=(value) -> ::String- 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.
- (::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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. The time this case was created.
#creator
def creator() -> ::Google::Cloud::Support::V2::Actor-
(::Google::Cloud::Support::V2::Actor) — The user who created the case.
Note: The name and email will be obfuscated if the case was created by Google Support.
#creator=
def creator=(value) -> ::Google::Cloud::Support::V2::Actor-
value (::Google::Cloud::Support::V2::Actor) — The user who created the case.
Note: The name and email will be obfuscated if the case was created by Google Support.
-
(::Google::Cloud::Support::V2::Actor) — The user who created the case.
Note: The name and email will be obfuscated if the case was created by Google Support.
#description
def description() -> ::String- (::String) — A broad description of the issue.
#description=
def description=(value) -> ::String- value (::String) — A broad description of the issue.
- (::String) — A broad description of the issue.
#display_name
def display_name() -> ::String- (::String) — The short summary of the issue reported in this case.
#display_name=
def display_name=(value) -> ::String- value (::String) — The short summary of the issue reported in this case.
- (::String) — The short summary of the issue reported in this case.
#escalated
def escalated() -> ::Boolean- (::Boolean) — Whether the case is currently escalated.
#escalated=
def escalated=(value) -> ::Boolean- value (::Boolean) — Whether the case is currently escalated.
- (::Boolean) — Whether the case is currently escalated.
#language_code
def language_code() -> ::String-
(::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=
def language_code=(value) -> ::String-
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
-
(::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
def name() -> ::String- (::String) — Identifier. The resource name for the case.
#name=
def name=(value) -> ::String- value (::String) — Identifier. The resource name for the case.
- (::String) — Identifier. The resource name for the case.
#priority
def priority() -> ::Google::Cloud::Support::V2::Case::Priority- (::Google::Cloud::Support::V2::Case::Priority) — The priority of this case.
#priority=
def priority=(value) -> ::Google::Cloud::Support::V2::Case::Priority- value (::Google::Cloud::Support::V2::Case::Priority) — The priority of this case.
- (::Google::Cloud::Support::V2::Case::Priority) — The priority of this case.
#state
def state() -> ::Google::Cloud::Support::V2::Case::State- (::Google::Cloud::Support::V2::Case::State) — Output only. The current status of the support case.
#subscriber_email_addresses
def subscriber_email_addresses() -> ::Array<::String>- (::Array<::String>) — The email addresses to receive updates on this case.
#subscriber_email_addresses=
def subscriber_email_addresses=(value) -> ::Array<::String>- value (::Array<::String>) — The email addresses to receive updates on this case.
- (::Array<::String>) — The email addresses to receive updates on this case.
#test_case
def test_case() -> ::Boolean- (::Boolean) — Whether this case was created for internal API testing and should not be acted on by the support team.
#test_case=
def test_case=(value) -> ::Boolean- value (::Boolean) — Whether this case was created for internal API testing and should not be acted on by the support team.
- (::Boolean) — Whether this case was created for internal API testing and should not be acted on by the support team.
#time_zone
def time_zone() -> ::String- (::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=
def time_zone=(value) -> ::String- 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.
- (::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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. The time this case was last updated.