Reference documentation and code samples for the Google Cloud Asset V1 Client class IamPolicyAnalysis.
An analysis message to group the query and results.
Generated from protobuf message google.cloud.asset.v1.AnalyzeIamPolicyResponse.IamPolicyAnalysis
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ analysis_query |
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery
The analysis query. |
↳ analysis_results |
array<Google\Cloud\Asset\V1\IamPolicyAnalysisResult>
A list of IamPolicyAnalysisResult that matches the analysis query, or empty if no result is found. |
↳ fully_explored |
bool
Represents whether all entries in the analysis_results have been fully explored to answer the query. |
↳ non_critical_errors |
array<Google\Cloud\Asset\V1\IamPolicyAnalysisState>
A list of non-critical errors happened during the query handling. |
getAnalysisQuery
The analysis query.
Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery analysis_query = 1;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery|null | |
hasAnalysisQuery
clearAnalysisQuery
setAnalysisQuery
The analysis query.
Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery analysis_query = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnalysisResults
A list of IamPolicyAnalysisResult that matches the analysis query, or empty if no result is found.
Generated from protobuf field repeated .google.cloud.asset.v1.IamPolicyAnalysisResult analysis_results = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAnalysisResults
A list of IamPolicyAnalysisResult that matches the analysis query, or empty if no result is found.
Generated from protobuf field repeated .google.cloud.asset.v1.IamPolicyAnalysisResult analysis_results = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Asset\V1\IamPolicyAnalysisResult>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFullyExplored
Represents whether all entries in the analysis_results have been fully explored to answer the query.
Generated from protobuf field bool fully_explored = 3;
| Returns | |
|---|---|
| Type | Description |
bool | |
setFullyExplored
Represents whether all entries in the analysis_results have been fully explored to answer the query.
Generated from protobuf field bool fully_explored = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNonCriticalErrors
A list of non-critical errors happened during the query handling.
Generated from protobuf field repeated .google.cloud.asset.v1.IamPolicyAnalysisState non_critical_errors = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setNonCriticalErrors
A list of non-critical errors happened during the query handling.
Generated from protobuf field repeated .google.cloud.asset.v1.IamPolicyAnalysisState non_critical_errors = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Asset\V1\IamPolicyAnalysisState>
|
| Returns | |
|---|---|
| Type | Description |
$this | |