REST Resource: consumerPolicies

Resource: ConsumerPolicy

Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.

JSON representation
{
  "name": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "enableRules": [
    {
      object (EnableRule)
    }
  ],
  "annotations": {
    string: string,
    ...
  }
}
Fields
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.

etag

string

Output only. An opaque tag indicating the current version of the policy, used for concurrency control.

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 uses 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".

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 uses 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".

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.

annotations

map (key: string, value: string)

Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. AIP-128

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

analyze

The method google.api.serviceusage.v2alpha.ServiceUsage.AnalyzeConsumerPolicy is not available in Trusted Cloud by S3NS.

get

The method google.api.serviceusage.v2alpha.ServiceUsage.GetConsumerPolicy is not available in Trusted Cloud by S3NS.

patch

The method google.api.serviceusage.v2alpha.ServiceUsage.UpdateConsumerPolicy is not available in Trusted Cloud by S3NS.