analyzeIamPolicyLongrunning method
- AnalyzeIamPolicyLongrunningRequest request,
- String scope, {
- String? $fields,
Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination.
For Cloud Storage destination, the output format is the JSON format that represents a AnalyzeIamPolicyResponse. This method implements the google.longrunning.Operation, which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the metadata for the long-running operation.
request
- The metadata request object.
Request parameters:
scope
- Required. The relative name of the root asset. Only resources
and IAM policies within the scope will be analyzed. This can only be an
organization number (such as "organizations/123"), a folder number (such
as "folders/123"), a project ID (such as "projects/my-project-id"), or a
project number (such as "projects/12345"). To know how to get organization
ID, visit
here .
To know how to get folder or project ID, visit
here .
Value must have pattern ^\[^/\]+/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Operation.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<Operation> analyzeIamPolicyLongrunning(
AnalyzeIamPolicyLongrunningRequest request,
core.String scope, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ =
'v1/' + core.Uri.encodeFull('$scope') + ':analyzeIamPolicyLongrunning';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}