Google Cloud Chronicle V1 Client - Class FeedFailureDetails (0.7.1)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class FeedFailureDetails.

FeedFailureDetails contains details about the errors thrown by chronicle for the feeds. These are user visible details. These details help user identify the root cause and take appropriate action for the feed errors.

Generated from protobuf message google.cloud.chronicle.v1.FeedFailureDetails

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ error_code string

Output only. error_code contains the error code for the feed. The field is populated for the feeds with failed status.

↳ http_error_code int

Output only. http_error_code contains the HTTP error code for the feed failure. feed transfer failure may or may not result in http error code.

↳ error_cause string

Output only. error_cause contains the information regarding the failure cause.

↳ error_action string

Output only. error_action contains the user action prescribed for remediation of feed error.

getErrorCode

Output only. error_code contains the error code for the feed. The field is populated for the feeds with failed status.

Returns
Type Description
string

setErrorCode

Output only. error_code contains the error code for the feed. The field is populated for the feeds with failed status.

Parameter
Name Description
var string
Returns
Type Description
$this

getHttpErrorCode

Output only. http_error_code contains the HTTP error code for the feed failure. feed transfer failure may or may not result in http error code.

Returns
Type Description
int

setHttpErrorCode

Output only. http_error_code contains the HTTP error code for the feed failure. feed transfer failure may or may not result in http error code.

Parameter
Name Description
var int
Returns
Type Description
$this

getErrorCause

Output only. error_cause contains the information regarding the failure cause.

Returns
Type Description
string

setErrorCause

Output only. error_cause contains the information regarding the failure cause.

Parameter
Name Description
var string
Returns
Type Description
$this

getErrorAction

Output only. error_action contains the user action prescribed for remediation of feed error.

Returns
Type Description
string

setErrorAction

Output only. error_action contains the user action prescribed for remediation of feed error.

Parameter
Name Description
var string
Returns
Type Description
$this