Reference documentation and code samples for the Google Cloud Asset V1 Client class AnalyzeIamPolicyRequest.
A request message for AssetService.AnalyzeIamPolicy.
Generated from protobuf message google.cloud.asset.v1.AnalyzeIamPolicyRequest
Namespace
Google \ Cloud \ Asset \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ analysis_query |
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery
Required. The request query. |
↳ saved_analysis_query |
string
Optional. The name of a saved query, which must be in the format of: * projects/project_number/savedQueries/saved_query_id * folders/folder_number/savedQueries/saved_query_id * organizations/organization_number/savedQueries/saved_query_id If both |
↳ execution_timeout |
Google\Protobuf\Duration
Optional. Amount of time executable has to complete. See JSON representation of Duration. If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty. |
getAnalysisQuery
Required. The request query.
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery|null |
hasAnalysisQuery
clearAnalysisQuery
setAnalysisQuery
Required. The request query.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery
|
Returns | |
---|---|
Type | Description |
$this |
getSavedAnalysisQuery
Optional. The name of a saved query, which must be in the format of:
- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_id
If both
analysis_query
andsaved_analysis_query
are provided, they will be merged together with thesaved_analysis_query
as base and theanalysis_query
as overrides. For more details of the merge behavior, please refer to the MergeFrom page.
Note that you cannot override primitive fields with default value, such as 0 or empty string, etc., because we use proto3, which doesn't support field presence yet.
Returns | |
---|---|
Type | Description |
string |
setSavedAnalysisQuery
Optional. The name of a saved query, which must be in the format of:
- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_id
If both
analysis_query
andsaved_analysis_query
are provided, they will be merged together with thesaved_analysis_query
as base and theanalysis_query
as overrides. For more details of the merge behavior, please refer to the MergeFrom page.
Note that you cannot override primitive fields with default value, such as 0 or empty string, etc., because we use proto3, which doesn't support field presence yet.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getExecutionTimeout
Optional. Amount of time executable has to complete. See JSON representation of Duration.
If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasExecutionTimeout
clearExecutionTimeout
setExecutionTimeout
Optional. Amount of time executable has to complete. See JSON representation of Duration.
If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |