Method: consumerPolicies.analyze

HTTP request
Path parameters
Request body
- JSON representation
  - JSON representation
Response body
Authorization scopes
AnalysisType

Analyze a consumer policy change without kicking off the actual update. The consumer policy is subject to change before the actual update takes place.

HTTP request

POST https://serviceusage.googleapis.com/v2beta/{proposedPolicy.name=*/*/consumerPolicies/*}:analyze

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`proposedPolicy.name`	`string` Output only. The resource name of the policy. Only the `default` policy is supported: `projects/12345/consumerPolicies/default` , `folders/12345/consumerPolicies/default` , `organizations/12345/consumerPolicies/default` .

proposedPolicy.name

string

Output only. The resource name of the policy. Only the default policy is supported: projects/12345/consumerPolicies/default , folders/12345/consumerPolicies/default , organizations/12345/consumerPolicies/default .

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "proposedPolicy" : { "name" : string , "etag" : string , "createTime" : string , "updateTime" : string , "enableRules" : [ { "services" : [ string ] } ] } , "analysisTypes" : [ enum ( `AnalysisType` ) ] }

 { 
 "proposedPolicy" 
 : 
 { 
 "name" 
 : 
 string 
 , 
 "etag" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "enableRules" 
 : 
 [ 
 { 
 "services" 
 : 
 [ 
 string 
 ] 
 } 
 ] 
 } 
 , 
 "analysisTypes" 
 : 
 [ 
 enum (  AnalysisType 
 
) 
 ] 
 }

Fields
`proposedPolicy.etag`	`string` An opaque tag indicating the current version of the policy, used for concurrency control.
`proposedPolicy.createTime`	`string ( Timestamp format)` Output only. The time the policy was created. For singleton policies, this is the first touch of the policy. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"` , `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"` .
`proposedPolicy.updateTime`	`string ( Timestamp format)` Output only. The time the policy was last updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"` , `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"` .
`proposedPolicy.enableRules[]`	`object ( EnableRule )` Enable rules define usable services, groups, and categories. There can currently be at most one `EnableRule` . This restriction will be lifted in later releases.
`analysisTypes[]`	`enum ( AnalysisType )` The type of analysis to conduct. It returns INVALID_ARGUMENT if the empty list is provided.

Response body

If successful, the response body contains an instance of Operation .

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/cloud-platform.read-only
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

AnalysisType

The enum of analysis types.

Enums
`ANALYSIS_TYPE_UNSPECIFIED`	Unspecified analysis type. Do not use.
`ANALYSIS_TYPE_DEPENDENCY`	The analysis of service dependencies.
`ANALYSIS_TYPE_RESOURCE_USAGE`	The analysis of service resource usage.