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

<h1><a href="serviceusage_v1beta1.html">Service Usage API</a> . <a href="serviceusage_v1beta1.services.html">services</a> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.html">consumerQuotaMetrics</a> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html">limits</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.adminOverrides.html">adminOverrides()</a></code>

79

</p>

80

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

81

82

83

<code><a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.consumerOverrides.html">consumerOverrides()</a></code>

84

</p>

85

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

86

87

88

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

89

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

90

<h3>Method Details</h3>

91

92

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

93

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

94

95

Args:

96

name: string, The resource name of the quota limit.

97

98

Use the quota limit resource name returned by previous

99

ListConsumerQuotaMetrics and GetConsumerQuotaMetric API calls. (required)

100

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

101

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

108

109

{ # Consumer quota settings for a quota limit.

110

"allowsAdminOverrides": True or False, # Whether admin overrides are allowed on this limit

111

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

112

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

113

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

114

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

115

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

116

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

117

#

118

# An example unit would be:

119

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

120

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

121

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

122

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

123

#

124

# An example name would be:

125

# `compute.googleapis.com/cpus`

126

"dimensions": { # If this map is nonempty, then this override applies only to specific values

127

# for dimensions defined in the limit unit.

128

#

129

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

130

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

131

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

132

#

133

# This map has the following restrictions:

134

#

135

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

136

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

137

# {user}) is a defined key.

138

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

139

# the parent resource name.

140

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

141

# that apply only to a specific user.

142

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

143

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

144

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

145

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

# map.

"a_key": "A String",

},

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

150

# This name is generated by the server when the override is created.

151

#

152

# Example names would be:

153

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

154

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

155

#

156

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

157

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

158

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

159

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

160

},

161

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

162

# configuration.

163

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

164

# are no overrides.

165

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

166

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

167

#

168

# An example unit would be:

169

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

170

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

171

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

172

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

173

#

174

# An example name would be:

175

# `compute.googleapis.com/cpus`

176

"dimensions": { # If this map is nonempty, then this override applies only to specific values

177

# for dimensions defined in the limit unit.

178

#

179

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

180

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

181

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

182

#

183

# This map has the following restrictions:

184

#

185

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

186

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

187

# {user}) is a defined key.

188

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

189

# the parent resource name.

190

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

191

# that apply only to a specific user.

192

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

193

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

194

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

195

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

# map.

"a_key": "A String",

},

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

200

# This name is generated by the server when the override is created.

201

#

202

# Example names would be:

203

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

204

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

205

#

206

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

207

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

208

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

209

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

210

},

211

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

212

#

213

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

214

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

215

#

216

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

217

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

218

#

219

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

220

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

221

# specified overrides apply only in that region.

222

"a_key": "A String",

223

},

224

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

225

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

226

#

227

# An example unit would be:

228

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

229

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

230

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

231

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

232

#

233

# An example name would be:

234

# `compute.googleapis.com/cpus`

235

"dimensions": { # If this map is nonempty, then this override applies only to specific values

236

# for dimensions defined in the limit unit.

237

#

238

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

239

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

240

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

241

#

242

# This map has the following restrictions:

243

#

244

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

245

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

246

# {user}) is a defined key.

247

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

248

# the parent resource name.

249

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

250

# that apply only to a specific user.

251

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

252

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

253

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

254

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

# map.

"a_key": "A String",

},

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

259

# This name is generated by the server when the override is created.

260

#

261

# Example names would be:

262

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

263

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

264

#

265

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

266

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

267

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

268

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

269

},