Google Cloud Config V1 Client - Class TerraformError (0.5.2)

Reference documentation and code samples for the Google Cloud Config V1 Client class TerraformError.

Errors encountered during actuation using Terraform

Generated from protobuf message google.cloud.config.v1.TerraformError

Namespace

Google \ Cloud \ Config \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ resource_address string

Address of the resource associated with the error, e.g. google_compute_network.vpc_network.

↳ http_response_code int

HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.

↳ error_description string

A human-readable error description.

↳ error Google\Rpc\Status

Original error response from underlying Google API, if available.

getResourceAddress

Address of the resource associated with the error, e.g. google_compute_network.vpc_network.

Returns
Type Description
string

setResourceAddress

Address of the resource associated with the error, e.g. google_compute_network.vpc_network.

Parameter
Name Description
var string
Returns
Type Description
$this

getHttpResponseCode

HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.

Returns
Type Description
int

setHttpResponseCode

HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.

Parameter
Name Description
var int
Returns
Type Description
$this

getErrorDescription

A human-readable error description.

Returns
Type Description
string

setErrorDescription

A human-readable error description.

Parameter
Name Description
var string
Returns
Type Description
$this

getError

Original error response from underlying Google API, if available.

Returns
Type Description
Google\Rpc\Status|null

hasError

clearError

setError

Original error response from underlying Google API, if available.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this