Reference documentation and code samples for the Google Cloud Security Command Center V1 Client class CustomModuleValidationError.
An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.
Generated from protobuf message google.cloud.securitycenter.v1.CustomModuleValidationError
Namespace
Google \ Cloud \ SecurityCenter \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ description |
string
A description of the error, suitable for human consumption. Required. |
↳ field_path |
string
The path, in RFC 8901 JSON Pointer format, to the field that failed validation. This may be left empty if no specific field is affected. |
↳ start |
Position
The initial position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed. |
↳ end |
Position
The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed.. |
getDescription
A description of the error, suitable for human consumption. Required.
Returns | |
---|---|
Type | Description |
string |
setDescription
A description of the error, suitable for human consumption. Required.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFieldPath
The path, in RFC 8901 JSON Pointer format, to the field that failed validation. This may be left empty if no specific field is affected.
Returns | |
---|---|
Type | Description |
string |
setFieldPath
The path, in RFC 8901 JSON Pointer format, to the field that failed validation. This may be left empty if no specific field is affected.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getStart
The initial position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed.
Returns | |
---|---|
Type | Description |
Position|null |
hasStart
clearStart
setStart
The initial position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed.
Parameter | |
---|---|
Name | Description |
var |
Position
|
Returns | |
---|---|
Type | Description |
$this |
getEnd
The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed..
Generated from protobuf field optional .google.cloud.securitycenter.v1.Position end = 4;
Returns | |
---|---|
Type | Description |
Position|null |
hasEnd
clearEnd
setEnd
The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed..
Generated from protobuf field optional .google.cloud.securitycenter.v1.Position end = 4;
Parameter | |
---|---|
Name | Description |
var |
Position
|
Returns | |
---|---|
Type | Description |
$this |