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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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, |
getCode
The error code.
| Returns | |
|---|---|
| Type | Description |
int |
|
setCode
The error code.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDetail
Free-form text providing details on the error cause of the error.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDetail
Free-form text providing details on the error cause of the error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this |
|