Google Cloud Service Control V1 Client - Class CheckError (1.3.0)

Reference documentation and code samples for the Google Cloud Service Control V1 Client class CheckError.

Defines the errors to be returned in google.api.servicecontrol.v1.CheckResponse.check_errors.

Generated from protobuf message google.api.servicecontrol.v1.CheckError

Namespace

Google \ Cloud \ ServiceControl \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ code int

The error code.

↳ subject string

Subject to whom this error applies. See the specific code enum for more details on this field. For example: - "project:

↳ detail string

Free-form text providing details on the error cause of the error.

↳ status Google\Rpc\Status

Contains public information about the check error. If available, status.code will be non zero and client can propagate it out as public error.

getCode

The error code.

Returns
TypeDescription
int

setCode

The error code.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSubject

Subject to whom this error applies. See the specific code enum for more details on this field. For example:

  • "project:
  • "folder:
  • "organization:
Returns
TypeDescription
string

setSubject

Subject to whom this error applies. See the specific code enum for more details on this field. For example:

  • "project:
  • "folder:
  • "organization:
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDetail

Free-form text providing details on the error cause of the error.

Returns
TypeDescription
string

setDetail

Free-form text providing details on the error cause of the error.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatus

Contains public information about the check error. If available, status.code will be non zero and client can propagate it out as public error.

Returns
TypeDescription
Google\Rpc\Status|null

hasStatus

clearStatus

setStatus

Contains public information about the check error. If available, status.code will be non zero and client can propagate it out as public error.

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