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