Google Cloud Security Command Center V1 Client - Class SecurityMarks (1.20.2)

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

User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.

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

Namespace

Google \ Cloud \ SecurityCenter \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
`↳ marks`	`array\|Google\Protobuf\Internal\MapField` Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
`↳ canonical_name`	`string` The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"

getName

The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".

Returns
Type	Description
`string`

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMarks

Mutable user specified security marks belonging to the parent resource.

Constraints are as follows:

Keys and values are treated as case insensitive
Keys must be between 1 - 256 characters (inclusive)
Keys must be letters, numbers, underscores, or dashes
Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setMarks

Mutable user specified security marks belonging to the parent resource.

Constraints are as follows:

Keys and values are treated as case insensitive
Keys must be between 1 - 256 characters (inclusive)
Keys must be letters, numbers, underscores, or dashes
Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCanonicalName

The canonical name of the marks.

Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"

Returns
Type	Description
`string`

setCanonicalName

The canonical name of the marks.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`