Blame - docs/dyn/serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

83

<code><a href="#close">close()</a></code></p>

84

<p class="firstline">Close httplib2 connections.</p>

85

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

86

<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>

87

<p class="firstline">Retrieves a summary of quota information for a specific quota metric.</p>

88

89

<code><a href="#importProducerOverrides">importProducerOverrides(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

90

<p class="firstline">Create or update multiple producer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

91

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

92

<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

93

<p class="firstline">Retrieves a summary of all quota information about this consumer that is visible to the service producer, for each quota metric defined by the service. Each metric includes information about all of its defined limits. Each limit includes the limit configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

94

95

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

96

<p class="firstline">Retrieves the next page of results.</p>

97

<h3>Method Details</h3>

98

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

99

<code class="details" id="close">close()</code>

100

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

104

<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>

105

<pre>Retrieves a summary of quota information for a specific quota metric.

106

107

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

108

name: string, The resource name of the quota metric, returned by a ListConsumerQuotaMetrics call. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus` (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

109

view: string, Specifies the level of detail for quota information in the response.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

110

Allowed values

111

QUOTA_VIEW_UNSPECIFIED - No quota view specified. Requests that do not specify a quota view will typically default to the BASIC view.

112

BASIC - Only buckets with overrides are shown in the response.

113

FULL - Include per-location buckets even if they do not have overrides. When the view is FULL, and a limit has regional or zonal quota, the limit will include buckets for all regions or zones that could support overrides, even if none are currently present. In some cases this will cause the response to become very large; callers that do not need this extra information should use the BASIC view instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

114

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

121

122

{ # Consumer quota settings for a quota metric.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

123

"consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric.

124

{ # Consumer quota settings for a quota limit.

125

"isPrecise": True or False, # Whether this limit is precise or imprecise.

126

"metric": "A String", # The name of the parent metric of this limit. An example name would be: `compute.googleapis.com/cpus`

127

"name": "A String", # The resource name of the quota limit. An example name would be: `services/compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.

128

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

129

{ # A quota bucket is a quota provisioning unit for a specific set of dimensions.

130

"adminOverride": { # A quota override # Admin override on this quota bucket.

131

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

132

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

133

"a_key": "A String",

134

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

135

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

136

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

137

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

138

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

139

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

140

"consumerOverride": { # A quota override # Consumer override on this quota bucket.

141

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

142

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

143

"a_key": "A String",

144

},

145

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

146

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

147

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

148

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

149

},

150

"defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service configuration.

151

"dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key "region" and value "us-east-1", then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

152

"a_key": "A String",

153

},

154

"effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there are no overrides.

155

"producerOverride": { # A quota override # Producer override on this quota bucket.

156

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

157

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

158

"a_key": "A String",

159

},

160

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

161

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

162

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

163

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

},

},

],

"unit": "A String", # The limit unit. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

168

},

169

],

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

170

"descendantConsumerQuotaLimits": [ # The quota limits targeting the descendant containers of the consumer in request. If the consumer in request is of type `organizations` or `folders`, the field will list per-project limits in the metric; if the consumer in request is of type `project`, the field will be empty. The `quota_buckets` field of each descendant consumer quota limit will not be populated.

171

{ # Consumer quota settings for a quota limit.

172

"isPrecise": True or False, # Whether this limit is precise or imprecise.

173

"metric": "A String", # The name of the parent metric of this limit. An example name would be: `compute.googleapis.com/cpus`

174

"name": "A String", # The resource name of the quota limit. An example name would be: `services/compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.

175

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

176

{ # A quota bucket is a quota provisioning unit for a specific set of dimensions.

177

"adminOverride": { # A quota override # Admin override on this quota bucket.

178

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

179

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

180

"a_key": "A String",

181

},

182

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

183

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

184

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

185

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

186

},

187

"consumerOverride": { # A quota override # Consumer override on this quota bucket.

188

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

189

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

190

"a_key": "A String",

191

},

192

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

193

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

194

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

195

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

196

},

197

"defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service configuration.

198

"dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key "region" and value "us-east-1", then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

199

"a_key": "A String",

200

},

201

"effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there are no overrides.

202

"producerOverride": { # A quota override # Producer override on this quota bucket.

203

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

204

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

205

"a_key": "A String",

206

},

207

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

208

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

209

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

210

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

},

},

],

"unit": "A String", # The limit unit. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

215

},

216

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

217

"displayName": "A String", # The display name of the metric. An example name would be: "CPUs"

218

"metric": "A String", # The name of the metric. An example name would be: `compute.googleapis.com/cpus`

219

"name": "A String", # The resource name of the quota settings on this metric for this consumer. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/quota/metrics/compute.googleapis.com%2Fcpus The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.

220

"unit": "A String", # The units in which the metric value is reported.

221

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

<code class="details" id="importProducerOverrides">importProducerOverrides(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

226

<pre>Create or update multiple producer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

228

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

229

parent: string, The resource name of the consumer. An example name would be: `services/compute.googleapis.com/projects/123` (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

230

body: object, The request body.

231

The object takes the form of:

232

233

{ # Request message for ImportProducerOverrides

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

234

"force": True or False, # Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.

235

"forceOnly": [ # The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.

236

"A String",

237

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

238

"inlineSource": { # Import data embedded in the request message # The import data is specified in the request message itself

239

"overrides": [ # The overrides to create. Each override must have a value for 'metric' and 'unit', to specify which metric and which limit the override should be applied to. The 'name' field of the override does not need to be set; it is ignored.

240

{ # A quota override

241

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

242

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

243

"a_key": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

244

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

245

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

246

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

247

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

248

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

},

],

},

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

253

254

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

261

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

262

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

263

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

264

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

265

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

266

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

267

{

268

"a_key": "", # Properties of the object. Contains field @type with type URL.

269

},

270

],

271

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

272

},

273

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

274

"a_key": "", # Properties of the object. Contains field @type with type URL.

275

},

276

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

277

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

278

"a_key": "", # Properties of the object. Contains field @type with type URL.

279

},

280

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

284

<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

285

<pre>Retrieves a summary of all quota information about this consumer that is visible to the service producer, for each quota metric defined by the service. Each metric includes information about all of its defined limits. Each limit includes the limit configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

286

287

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

288

parent: string, Parent of the quotas resource. An example parent would be: `services/serviceconsumermanagement.googleapis.com/projects/123` (required)

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

289

pageSize: integer, Requested size of the next page of data.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

290

pageToken: string, Token identifying which result to start with; returned by a previous list call.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

291

view: string, Specifies the level of detail for quota information in the response.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

292

Allowed values

293

QUOTA_VIEW_UNSPECIFIED - No quota view specified. Requests that do not specify a quota view will typically default to the BASIC view.

294

BASIC - Only buckets with overrides are shown in the response.

295

FULL - Include per-location buckets even if they do not have overrides. When the view is FULL, and a limit has regional or zonal quota, the limit will include buckets for all regions or zones that could support overrides, even if none are currently present. In some cases this will cause the response to become very large; callers that do not need this extra information should use the BASIC view instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

296

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

303

304

{ # Response message for ListConsumerQuotaMetrics.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

305

"metrics": [ # Quota settings for the consumer, organized by quota metric.

306

{ # Consumer quota settings for a quota metric.

307

"consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric.

308

{ # Consumer quota settings for a quota limit.

309

"isPrecise": True or False, # Whether this limit is precise or imprecise.

310

"metric": "A String", # The name of the parent metric of this limit. An example name would be: `compute.googleapis.com/cpus`

311

"name": "A String", # The resource name of the quota limit. An example name would be: `services/compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.

312

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

313

{ # A quota bucket is a quota provisioning unit for a specific set of dimensions.

314

"adminOverride": { # A quota override # Admin override on this quota bucket.

315

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

316

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

317

"a_key": "A String",

318

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

319

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

320

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

321

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

322

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

323

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

324

"consumerOverride": { # A quota override # Consumer override on this quota bucket.

325

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

326

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

327

"a_key": "A String",

328

},

329

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

330

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

331

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

332

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

333

},

334

"defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service configuration.

335

"dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key "region" and value "us-east-1", then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

336

"a_key": "A String",

337

},

338

"effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there are no overrides.

339

"producerOverride": { # A quota override # Producer override on this quota bucket.

340

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

341

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

342

"a_key": "A String",

343

},

344

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

345

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

346

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

347

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

},

},

],

"unit": "A String", # The limit unit. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

352

},

353

],

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

354

"descendantConsumerQuotaLimits": [ # The quota limits targeting the descendant containers of the consumer in request. If the consumer in request is of type `organizations` or `folders`, the field will list per-project limits in the metric; if the consumer in request is of type `project`, the field will be empty. The `quota_buckets` field of each descendant consumer quota limit will not be populated.

355

{ # Consumer quota settings for a quota limit.

356

"isPrecise": True or False, # Whether this limit is precise or imprecise.

357

"metric": "A String", # The name of the parent metric of this limit. An example name would be: `compute.googleapis.com/cpus`

358

"name": "A String", # The resource name of the quota limit. An example name would be: `services/compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.

359

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

360

{ # A quota bucket is a quota provisioning unit for a specific set of dimensions.

361

"adminOverride": { # A quota override # Admin override on this quota bucket.

362

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

363

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

364

"a_key": "A String",

365

},

366

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

367

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

368

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

369

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

370

},

371

"consumerOverride": { # A quota override # Consumer override on this quota bucket.

372

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

373

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

374

"a_key": "A String",

375

},

376

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

377

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

378

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

379

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

380

},

381

"defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service configuration.

382

"dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key "region" and value "us-east-1", then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

383

"a_key": "A String",

384

},

385

"effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there are no overrides.

386

"producerOverride": { # A quota override # Producer override on this quota bucket.

387

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only.

388

"dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.

389

"a_key": "A String",

390

},

391

"metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

392

"name": "A String", # The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

393

"overrideValue": "A String", # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

394

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

},

},

],

"unit": "A String", # The limit unit. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.

399

},

400

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

401

"displayName": "A String", # The display name of the metric. An example name would be: "CPUs"

402

"metric": "A String", # The name of the metric. An example name would be: `compute.googleapis.com/cpus`

403

"name": "A String", # The resource name of the quota settings on this metric for this consumer. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/quota/metrics/compute.googleapis.com%2Fcpus The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.

404

"unit": "A String", # The units in which the metric value is reported.

405

},

406

],

407

"nextPageToken": "A String", # Token identifying which result to start with; returned by a previous list call.

408

}</pre>

Bu Sun Kim