Reference documentation and code samples for the Google Cloud Datastream V1 Client class Error.
Represent a user-facing Error.
Generated from protobuf message google.cloud.datastream.v1.Error
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ reason |
string
A title that explains the reason for the error. |
↳ error_uuid |
string
A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
↳ message |
string
A message containing more information about the error that occurred. |
↳ error_time |
Google\Protobuf\Timestamp
The time when the error occurred. |
↳ details |
array|Google\Protobuf\Internal\MapField
Additional information about the error. |
getReason
A title that explains the reason for the error.
| Returns | |
|---|---|
| Type | Description |
string | |
setReason
A title that explains the reason for the error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getErrorUuid
A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
| Returns | |
|---|---|
| Type | Description |
string | |
setErrorUuid
A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMessage
A message containing more information about the error that occurred.
| Returns | |
|---|---|
| Type | Description |
string | |
setMessage
A message containing more information about the error that occurred.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getErrorTime
The time when the error occurred.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasErrorTime
clearErrorTime
setErrorTime
The time when the error occurred.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDetails
Additional information about the error.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setDetails
Additional information about the error.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |