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.

106

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

107

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

108

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

109

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

110

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

111

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

112

# are no overrides.

113

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

114

# configuration.

115

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

116

#

117

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

118

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

119

#

120

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

121

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

122

#

123

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

124

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

125

# specified overrides apply only in that region.

126

"a_key": "A String",

127

},

128

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

129

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

130

#

131

# An example unit would be:

132

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

133

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

134

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

135

"dimensions": { #

136

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

137

# for dimensions defined in the limit unit.

138

#

139

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

140

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

141

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

142

#

143

# This map has the following restrictions:

144

#

145

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

146

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

147

# {user}) is a defined key.

148

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

149

# the parent resource name.

150

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

151

# that apply only to a specific user.

152

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

153

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

154

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

155

# 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 producer override.

160

# An example name would be:

161

# `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.

163

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

164

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

165

#

166

# An example name would be:

167

# `compute.googleapis.com/cpus`

168

},

169

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

170

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

171

#

172

# An example unit would be:

173

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

174

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

175

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

176

"dimensions": { #

177

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

178

# for dimensions defined in the limit unit.

179

#

180

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

181

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

182

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

183

#

184

# This map has the following restrictions:

185

#

186

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

187

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

188

# {user}) is a defined key.

189

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

190

# the parent resource name.

191

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

192

# that apply only to a specific user.

193

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

194

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

195

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

196

# 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 producer override.

201

# An example name would be:

202

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

203

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

204

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

205

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

206

#

207

# An example name would be:

208

# `compute.googleapis.com/cpus`

209

},

210

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

211

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

212

#

213

# An example unit would be:

214

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

215

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

216

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

217

"dimensions": { #

218

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

219

# for dimensions defined in the limit unit.

220

#

221

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

222

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

223

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

224

#

225

# This map has the following restrictions:

226

#

227

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

228

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

229

# {user}) is a defined key.

230

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

231

# the parent resource name.

232

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

233

# that apply only to a specific user.

234

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

235

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

236

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

237

# 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 producer override.

242

# An example name would be:

243

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

244

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

245

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

246

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

247

#

248

# An example name would be:

249

# `compute.googleapis.com/cpus`