Reference documentation and code samples for the Google Cloud Support V2 Client class PBCase.
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 .
Generated from protobuf message google.cloud.support.v2.Case
Namespace
Google \ Cloud \ Support \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The resource name for the case.
↳ display_name
string
The short summary of the issue reported in this case.
↳ description
string
A broad description of the issue.
↳ classification
↳ time_zone
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.
↳ subscriber_email_addresses
array
The email addresses to receive updates on this case.
↳ state
int
Output only. The current status of the support case.
↳ create_time
↳ update_time
↳ creator
Actor
The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
↳ contact_email
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.
↳ escalated
bool
Whether the case is currently escalated.
↳ test_case
bool
Whether this case was created for internal API testing and should not be acted on by the support team.
↳ language_code
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
↳ priority
int
The priority of this case.
getName
Identifier. The resource name for the case.
string
setName
Identifier. The resource name for the case.
var
string
$this
getDisplayName
The short summary of the issue reported in this case.
string
setDisplayName
The short summary of the issue reported in this case.
var
string
$this
getDescription
A broad description of the issue.
string
setDescription
A broad description of the issue.
var
string
$this
getClassification
The issue classification applicable to this case.
hasClassification
clearClassification
setClassification
The issue classification applicable to this case.
$this
getTimeZone
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
setTimeZone
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.
var
string
$this
getSubscriberEmailAddresses
The email addresses to receive updates on this case.
setSubscriberEmailAddresses
The email addresses to receive updates on this case.
var
string[]
$this
getState
Output only. The current status of the support case.
int
setState
Output only. The current status of the support case.
var
int
$this
getCreateTime
Output only. The time this case was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time this case was created.
$this
getUpdateTime
Output only. The time this case was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time this case was last updated.
$this
getCreator
The user who created the case.
Note: The name and email will be obfuscated if the case was created by Google Support.
hasCreator
clearCreator
setCreator
The user who created the case.
Note: The name and email will be obfuscated if the case was created by Google Support.
$this
getContactEmail
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
setContactEmail
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.
var
string
$this
getEscalated
Whether the case is currently escalated.
bool
setEscalated
Whether the case is currently escalated.
var
bool
$this
getTestCase
Whether this case was created for internal API testing and should not be acted on by the support team.
bool
setTestCase
Whether this case was created for internal API testing and should not be acted on by the support team.
var
bool
$this
getLanguageCode
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
setLanguageCode
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
var
string
$this
getPriority
The priority of this case.
int
setPriority
The priority of this case.
var
int
$this
