Google Cloud Datastream V1 Client - Class Error (1.0.5)

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
NameDescription
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
TypeDescription
string

setReason

A title that explains the reason for the error.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getErrorUuid

A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

Returns
TypeDescription
string

setErrorUuid

A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMessage

A message containing more information about the error that occurred.

Returns
TypeDescription
string

setMessage

A message containing more information about the error that occurred.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getErrorTime

The time when the error occurred.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasErrorTime

clearErrorTime

setErrorTime

The time when the error occurred.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getDetails

Additional information about the error.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setDetails

Additional information about the error.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this