Google Cloud Security Command Center V1 Client - Class SetFindingStateRequest (1.19.1)

Reference documentation and code samples for the Google Cloud Security Command Center V1 Client class SetFindingStateRequest.

Request message for updating a finding's state.

Generated from protobuf message google.cloud.securitycenter.v1.SetFindingStateRequest

Namespace

Google \ Cloud \ SecurityCenter \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The relative resource name of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}".

↳ state int

Required. The desired State of the finding.

↳ start_time Google\Protobuf\Timestamp

Required. The time at which the updated state takes effect.

getName

Required. The relative resource name of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}".

Returns
TypeDescription
string

setName

Required. The relative resource name of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Required. The desired State of the finding.

Returns
TypeDescription
int

setState

Required. The desired State of the finding.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStartTime

Required. The time at which the updated state takes effect.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Required. The time at which the updated state takes effect.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
name string

Required. The relative resource name of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". Please see Google\Cloud\SecurityCenter\V1\SecurityCenterClient::findingName() for help formatting this field.

state int

Required. The desired State of the finding. For allowed values, use constants defined on Google\Cloud\SecurityCenter\V1\Finding\State

startTime Google\Protobuf\Timestamp

Required. The time at which the updated state takes effect.

Returns
TypeDescription
Google\Cloud\SecurityCenter\V1\SetFindingStateRequest