Google Cloud Security Command Center V1 Client - Class Resource (2.2.1)

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

Information related to the Google Cloud resource.

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

Namespace

Google \ Cloud \ SecurityCenter \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name

↳ display_name
string

The human readable name of the resource.

↳ type
string

The full resource type of the resource.

↳ project
string

The full resource name of project that the resource belongs to.

↳ project_display_name
string

The project ID that the resource belongs to.

↳ parent
string

The full resource name of resource's parent.

↳ parent_display_name
string

The human readable name of resource's parent.

↳ folders
array< Folder >

Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.

↳ cloud_provider
int

Indicates which cloud provider the resource resides in.

↳ organization
string

Indicates which organization or tenant in the cloud provider the finding applies to.

↳ service
string

The parent service or product from which the resource is provided, for example, GKE or SNS.

↳ location
string

The region or location of the service (if applicable).

↳ aws_metadata
AwsMetadata

The AWS metadata associated with the finding.

↳ azure_metadata
AzureMetadata

The Azure metadata associated with the finding.

↳ resource_path
ResourcePath

Provides the path to the resource within the resource hierarchy.

↳ resource_path_string
string

A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.

getName

The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name

Returns
Type
Description
string

setName

The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

The human readable name of the resource.

Returns
Type
Description
string

setDisplayName

The human readable name of the resource.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getType

The full resource type of the resource.

Returns
Type
Description
string

setType

The full resource type of the resource.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getProject

The full resource name of project that the resource belongs to.

Returns
Type
Description
string

setProject

The full resource name of project that the resource belongs to.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getProjectDisplayName

The project ID that the resource belongs to.

Returns
Type
Description
string

setProjectDisplayName

The project ID that the resource belongs to.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getParent

The full resource name of resource's parent.

Returns
Type
Description
string

setParent

The full resource name of resource's parent.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getParentDisplayName

The human readable name of resource's parent.

Returns
Type
Description
string

setParentDisplayName

The human readable name of resource's parent.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFolders

Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.

Returns
Type
Description

setFolders

Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.

Parameter
Name
Description
var
array< Folder >
Returns
Type
Description
$this

getCloudProvider

Indicates which cloud provider the resource resides in.

Returns
Type
Description
int

setCloudProvider

Indicates which cloud provider the resource resides in.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getOrganization

Indicates which organization or tenant in the cloud provider the finding applies to.

Returns
Type
Description
string

setOrganization

Indicates which organization or tenant in the cloud provider the finding applies to.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getService

The parent service or product from which the resource is provided, for example, GKE or SNS.

Returns
Type
Description
string

setService

The parent service or product from which the resource is provided, for example, GKE or SNS.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLocation

The region or location of the service (if applicable).

Returns
Type
Description
string

setLocation

The region or location of the service (if applicable).

Parameter
Name
Description
var
string
Returns
Type
Description
$this

The AWS metadata associated with the finding.

Returns
Type
Description
AwsMetadata |null

The AWS metadata associated with the finding.

Parameter
Name
Description
Returns
Type
Description
$this

The Azure metadata associated with the finding.

Returns
Type
Description

The Azure metadata associated with the finding.

Parameter
Name
Description
Returns
Type
Description
$this

getResourcePath

Provides the path to the resource within the resource hierarchy.

Returns
Type
Description
ResourcePath |null

hasResourcePath

clearResourcePath

setResourcePath

Provides the path to the resource within the resource hierarchy.

Parameter
Name
Description
Returns
Type
Description
$this

getResourcePathString

A string representation of the resource path.

For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.

Returns
Type
Description
string

setResourcePathString

A string representation of the resource path.

For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: