Compute V1 Client - Class LocalizedMessage (1.19.0)

Reference documentation and code samples for the Compute V1 Client class LocalizedMessage.

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

Generated from protobuf message google.cloud.compute.v1.LocalizedMessage

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ locale string

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"

↳ message string

The localized error message in the above locale.

getLocale

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"

Returns
Type Description
string

hasLocale

clearLocale

setLocale

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"

Parameter
Name Description
var string
Returns
Type Description
$this

getMessage

The localized error message in the above locale.

Returns
Type Description
string

hasMessage

clearMessage

setMessage

The localized error message in the above locale.

Parameter
Name Description
var string
Returns
Type Description
$this