Reference documentation and code samples for the Google Cloud Security Command Center V2 Client class Resource.
Information related to the Google Cloud resource.
Generated from protobuf message google.cloud.securitycenter.v2.Resource
Namespace
Google \ Cloud \ SecurityCenter \ V2Methods
__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. |
↳ cloud_provider |
int
Indicates which cloud provider the finding is from. |
↳ service |
string
The service or resource provider associated with the resource. |
↳ location |
string
The region or location of the service (if applicable). |
↳ gcp_metadata |
Google\Cloud\SecurityCenter\V2\GcpMetadata
The GCP metadata associated with the finding. |
↳ aws_metadata |
Google\Cloud\SecurityCenter\V2\AwsMetadata
The AWS metadata associated with the finding. |
↳ azure_metadata |
Google\Cloud\SecurityCenter\V2\AzureMetadata
The Azure metadata associated with the finding. |
↳ resource_path |
Google\Cloud\SecurityCenter\V2\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 |
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 |
|
getCloudProvider
Indicates which cloud provider the finding is from.
| Returns | |
|---|---|
| Type | Description |
int |
|
setCloudProvider
Indicates which cloud provider the finding is from.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getService
The service or resource provider associated with the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setService
The service or resource provider associated with the resource.
| 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 |
|
getGcpMetadata
The GCP metadata associated with the finding.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\SecurityCenter\V2\GcpMetadata|null |
|
hasGcpMetadata
setGcpMetadata
The GCP metadata associated with the finding.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\SecurityCenter\V2\GcpMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAwsMetadata
The AWS metadata associated with the finding.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\SecurityCenter\V2\AwsMetadata|null |
|
hasAwsMetadata
setAwsMetadata
The AWS metadata associated with the finding.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\SecurityCenter\V2\AwsMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAzureMetadata
The Azure metadata associated with the finding.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\SecurityCenter\V2\AzureMetadata|null |
|
hasAzureMetadata
setAzureMetadata
The Azure metadata associated with the finding.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\SecurityCenter\V2\AzureMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResourcePath
Provides the path to the resource within the resource hierarchy.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\SecurityCenter\V2\ResourcePath|null |
|
hasResourcePath
clearResourcePath
setResourcePath
Provides the path to the resource within the resource hierarchy.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\SecurityCenter\V2\ResourcePath
|
| 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 |
|
getCloudProviderMetadata
| Returns | |
|---|---|
| Type | Description |
string |
|