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

<h1><a href="serviceconsumermanagement_v1beta1.html">Service Consumer Management API</a> . <a href="serviceconsumermanagement_v1beta1.services.html">services</a> . <a href="serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.html">consumerQuotaMetrics</a> . <a href="serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.html">limits</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.producerOverrides.html">producerOverrides()</a></code>

79

</p>

80

<p class="firstline">Returns the producerOverrides Resource.</p>

81

82

83

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

84

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

85

<h3>Method Details</h3>

86

87

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

88

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

89

90

Args:

91

name: string, The resource name of the quota limit, returned by a

92

ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.

93

94

An example name would be:

95

`services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` (required)

96

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

97

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

104

105

{ # Consumer quota settings for a quota limit.

Bu Sun Kim

d059ad8

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

[diff] [blame^]

106

"unit": "A String", # The limit unit.

107

#

108

# An example unit would be:

109

# `1/{project}/{region}`

110

# Note that `{project}` and `{region}` are not placeholders in this example;

111

# the literal characters `{` and `}` occur in the string.

112

"metric": "A String", # The name of the parent metric of this limit.

113

#

114

# An example name would be:

115

# `compute.googleapis.com/cpus`

Bu Sun Kim

6502091

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

[diff] [blame]

116

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

117

"name": "A String", # The resource name of the quota limit.

118

#

119

# An example name would be:

120

# `services/compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`

121

#

122

# The resource name is intended to be opaque and should not be parsed for

123

# its component strings, since its representation could change in the future.

Bu Sun Kim

6502091

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

[diff] [blame]

124

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension,

125

# ordered from least specific to most specific (for example, the global

126

# default bucket, with no quota dimensions, will always appear first).

127

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

128

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

129

# are no overrides.

Bu Sun Kim

6502091

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

[diff] [blame]

130

"dimensions": { # The dimensions of this quota bucket.

131

#

132

# If this map is empty, this is the global bucket, which is the default quota

133

# value applied to all requests that do not have a more specific override.

134

#

135

# If this map is nonempty, the default limit, effective limit, and quota

136

# overrides apply only to requests that have the dimensions given in the map.

137

#

138

# For example, if the map has key "region" and value "us-east-1", then the

139

# specified effective limit is only effective in that region, and the

140

# specified overrides apply only in that region.

141

"a_key": "A String",

142

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

143

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

144

# configuration.

Bu Sun Kim

d059ad8

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

[diff] [blame^]

145

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

146

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example:

147

# "organizations/12345" or "folders/67890".

148

# Used by admin overrides only.

149

"dimensions": { #

150

# If this map is nonempty, then this override applies only to specific values

151

# for dimensions defined in the limit unit.

152

#

153

# For example, an override on a limit with the unit 1/{project}/{region}

154

# could contain an entry with the key "region" and the value "us-east-1";

155

# the override is only applied to quota consumed in that region.

156

#

157

# This map has the following restrictions:

158

#

159

# * Keys that are not defined in the limit's unit are not valid keys.

160

# Any string appearing in {brackets} in the unit (besides {project} or

161

# {user}) is a defined key.

162

# * "project" is not a valid key; the project is already specified in

163

# the parent resource name.

164

# * "user" is not a valid key; the API does not support quota overrides

165

# that apply only to a specific user.

166

# * If "region" appears as a key, its value must be a valid Cloud region.

167

# * If "zone" appears as a key, its value must be a valid Cloud zone.

168

# * If any valid key other than "region" or "zone" appears in the map, then

169

# all valid keys other than "region" or "zone" must also appear in the

# map.

"a_key": "A String",

},

"overrideValue": "A String", # The overriding quota limit value.

174

# Can be any nonnegative integer, or -1 (unlimited quota).

175

"metric": "A String", # The name of the metric to which this override applies.

176

#

177

# An example name would be:

178

# `compute.googleapis.com/cpus`

179

"unit": "A String", # The limit unit of the limit to which this override applies.

180

#

181

# An example unit would be:

182

# `1/{project}/{region}`

183

# Note that `{project}` and `{region}` are not placeholders in this example;

184

# the literal characters `{` and `}` occur in the string.

185

"name": "A String", # The resource name of the producer override.

186

# An example name would be:

187

# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

188

},

189

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

190

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example:

191

# "organizations/12345" or "folders/67890".

192

# Used by admin overrides only.

193

"dimensions": { #

194

# If this map is nonempty, then this override applies only to specific values

195

# for dimensions defined in the limit unit.

196

#

197

# For example, an override on a limit with the unit 1/{project}/{region}

198

# could contain an entry with the key "region" and the value "us-east-1";

199

# the override is only applied to quota consumed in that region.

200

#

201

# This map has the following restrictions:

202

#

203

# * Keys that are not defined in the limit's unit are not valid keys.

204

# Any string appearing in {brackets} in the unit (besides {project} or

205

# {user}) is a defined key.

206

# * "project" is not a valid key; the project is already specified in

207

# the parent resource name.

208

# * "user" is not a valid key; the API does not support quota overrides

209

# that apply only to a specific user.

210

# * If "region" appears as a key, its value must be a valid Cloud region.

211

# * If "zone" appears as a key, its value must be a valid Cloud zone.

212

# * If any valid key other than "region" or "zone" appears in the map, then

213

# all valid keys other than "region" or "zone" must also appear in the

# map.

"a_key": "A String",

},

"overrideValue": "A String", # The overriding quota limit value.

218

# Can be any nonnegative integer, or -1 (unlimited quota).

219

"metric": "A String", # The name of the metric to which this override applies.

220

#

221

# An example name would be:

222

# `compute.googleapis.com/cpus`

223

"unit": "A String", # The limit unit of the limit to which this override applies.

224

#

225

# An example unit would be:

226

# `1/{project}/{region}`

227

# Note that `{project}` and `{region}` are not placeholders in this example;

228

# the literal characters `{` and `}` occur in the string.

229

"name": "A String", # The resource name of the producer override.

230

# An example name would be:

231

# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

232

},

233

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

234

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example:

235

# "organizations/12345" or "folders/67890".

236

# Used by admin overrides only.

237

"dimensions": { #

238

# If this map is nonempty, then this override applies only to specific values

239

# for dimensions defined in the limit unit.

240

#

241

# For example, an override on a limit with the unit 1/{project}/{region}

242

# could contain an entry with the key "region" and the value "us-east-1";

243

# the override is only applied to quota consumed in that region.

244

#

245

# This map has the following restrictions:

246

#

247

# * Keys that are not defined in the limit's unit are not valid keys.

248

# Any string appearing in {brackets} in the unit (besides {project} or

249

# {user}) is a defined key.

250

# * "project" is not a valid key; the project is already specified in

251

# the parent resource name.

252

# * "user" is not a valid key; the API does not support quota overrides

253

# that apply only to a specific user.

254

# * If "region" appears as a key, its value must be a valid Cloud region.

255

# * If "zone" appears as a key, its value must be a valid Cloud zone.

256

# * If any valid key other than "region" or "zone" appears in the map, then

257

# all valid keys other than "region" or "zone" must also appear in the

# map.

"a_key": "A String",

},

"overrideValue": "A String", # The overriding quota limit value.

262

# Can be any nonnegative integer, or -1 (unlimited quota).

263

"metric": "A String", # The name of the metric to which this override applies.

264

#

265

# An example name would be:

266

# `compute.googleapis.com/cpus`

267

"unit": "A String", # The limit unit of the limit to which this override applies.

268

#

269

# An example unit would be:

270

# `1/{project}/{region}`

271

# Note that `{project}` and `{region}` are not placeholders in this example;

272

# the literal characters `{` and `}` occur in the string.

273

"name": "A String", # The resource name of the producer override.

274

# An example name would be:

275

# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`

276

},

Bu Sun Kim

6502091

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

[diff] [blame]

277

},

278

],

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

</body></html>