Google Cloud Vm Migration V1 Client - Class MigrationError (0.5.2)

Reference documentation and code samples for the Google Cloud Vm Migration V1 Client class MigrationError.

Represents migration resource error information that can be used with google.rpc.Status message. MigrationError is used to present the user with error information in migration operations.

Generated from protobuf message google.cloud.vmmigration.v1.MigrationError

Namespace

Google \ Cloud \ VMMigration \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ code int

Output only. The error code.

↳ error_message Google\Rpc\LocalizedMessage

Output only. The localized error message.

↳ action_item Google\Rpc\LocalizedMessage

Output only. Suggested action for solving the error.

↳ help_links array<Google\Rpc\Help\Link>

Output only. URL(s) pointing to additional information on handling the current error.

↳ error_time Google\Protobuf\Timestamp

Output only. The time the error occurred.

getCode

Output only. The error code.

Returns
TypeDescription
int

setCode

Output only. The error code.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getErrorMessage

Output only. The localized error message.

Returns
TypeDescription
Google\Rpc\LocalizedMessage|null

hasErrorMessage

clearErrorMessage

setErrorMessage

Output only. The localized error message.

Parameter
NameDescription
var Google\Rpc\LocalizedMessage
Returns
TypeDescription
$this

getActionItem

Output only. Suggested action for solving the error.

Returns
TypeDescription
Google\Rpc\LocalizedMessage|null

hasActionItem

clearActionItem

setActionItem

Output only. Suggested action for solving the error.

Parameter
NameDescription
var Google\Rpc\LocalizedMessage
Returns
TypeDescription
$this

Output only. URL(s) pointing to additional information on handling the current error.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

Output only. URL(s) pointing to additional information on handling the current error.

Parameter
NameDescription
var array<Google\Rpc\Help\Link>
Returns
TypeDescription
$this

getErrorTime

Output only. The time the error occurred.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasErrorTime

clearErrorTime

setErrorTime

Output only. The time the error occurred.

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