Google Cloud Policy Simulator V1 Client - Class ResourceContext (1.2.0)

Reference documentation and code samples for the Google Cloud Policy Simulator V1 Client class ResourceContext.

ResourceContext provides the context we know about a resource.

It is similar in concept to google.cloud.asset.v1.Resource, but focuses on the information specifically used by Simulator.

Generated from protobuf message google.cloud.policysimulator.v1.ResourceContext

Namespace

Google \ Cloud \ PolicySimulator \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ resource string

The full name of the resource. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 See Resource names for more information.

↳ asset_type string

The asset type of the resource as defined by CAIS. Example: compute.googleapis.com/Firewall See Supported asset types for more information.

↳ ancestors array

The ancestry path of the resource in Google Cloud resource hierarchy, represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the resource is a project, folder, or organization, the ancestry path starts from the resource itself. Example: ["projects/123456789", "folders/5432", "organizations/1234"]

getResource

The full name of the resource. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 See Resource names for more information.

Returns
Type Description
string

setResource

The full name of the resource. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 See Resource names for more information.

Parameter
Name Description
var string
Returns
Type Description
$this

getAssetType

The asset type of the resource as defined by CAIS.

Example: compute.googleapis.com/Firewall See Supported asset types for more information.

Returns
Type Description
string

setAssetType

The asset type of the resource as defined by CAIS.

Example: compute.googleapis.com/Firewall See Supported asset types for more information.

Parameter
Name Description
var string
Returns
Type Description
$this

getAncestors

The ancestry path of the resource in Google Cloud resource hierarchy, represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the resource is a project, folder, or organization, the ancestry path starts from the resource itself.

Example: ["projects/123456789", "folders/5432", "organizations/1234"]

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAncestors

The ancestry path of the resource in Google Cloud resource hierarchy, represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the resource is a project, folder, or organization, the ancestry path starts from the resource itself.

Example: ["projects/123456789", "folders/5432", "organizations/1234"]

Parameter
Name Description
var string[]
Returns
Type Description
$this