Class: Azure::ApiManagement::Mgmt::V2016_10_10::Models::ReportRecordContract

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb

Overview

Report data.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#api_id ⇒ String

Returns API identifier path. /apis/apiId.

Returns:

  • (String) —

    API identifier path. /apis/apiId



44
45
46
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 44

def api_id
  @api_id
end

#api_region ⇒ String

Returns API region identifier.

Returns:

  • (String) —

    API region identifier.



51
52
53
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 51

def api_region
  @api_region
end

#api_time_avg ⇒ Float

Returns Average time it took to process request.

Returns:

  • (Float) —

    Average time it took to process request.



89
90
91
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 89

def api_time_avg
  @api_time_avg
end

#api_time_max ⇒ Float

Returns Maximum time it took to process request.

Returns:

  • (Float) —

    Maximum time it took to process request.



95
96
97
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 95

def api_time_max
  @api_time_max
end

#api_time_min ⇒ Float

Returns Minimum time it took to process request.

Returns:

  • (Float) —

    Minimum time it took to process request.



92
93
94
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 92

def api_time_min
  @api_time_min
end

#bandwidth ⇒ Integer

Returns Bandwidth consumed.

Returns:

  • (Integer) —

    Bandwidth consumed.



79
80
81
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 79

def bandwidth
  @bandwidth
end

#cache_hit_count ⇒ Integer

policy.

Returns:

  • (Integer) —

    Number of times when content was served from cache



83
84
85
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 83

def cache_hit_count
  @cache_hit_count
end

#cache_miss_count ⇒ Integer

Returns Number of times content was fetched from backend.

Returns:

  • (Integer) —

    Number of times content was fetched from backend.



86
87
88
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 86

def cache_miss_count
  @cache_miss_count
end

#call_count_blocked ⇒ Integer

This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests

Returns:

  • (Integer) —

    Number of calls blocked due to invalid credentials.



65
66
67
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 65

def call_count_blocked
  @call_count_blocked
end

#call_count_failed ⇒ Integer

errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600

Returns:

  • (Integer) —

    Number of calls failed due to proxy or backend



70
71
72
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 70

def call_count_failed
  @call_count_failed
end

#call_count_other ⇒ Integer

Returns Number of other calls.

Returns:

  • (Integer) —

    Number of other calls.



73
74
75
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 73

def call_count_other
  @call_count_other
end

#call_count_success ⇒ Integer

returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect

Returns:

  • (Integer) —

    Number of successful calls. This includes calls



60
61
62
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 60

def call_count_success
  @call_count_success
end

#call_count_total ⇒ Integer

Returns Total number of calls.

Returns:

  • (Integer) —

    Total number of calls.



76
77
78
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 76

def call_count_total
  @call_count_total
end

#country ⇒ String

Returns Country to which this record data is related.

Returns:

  • (String) —

    Country to which this record data is related.



29
30
31
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 29

def country
  @country
end

#interval ⇒ Integer

Returns Length of aggregation period.

Returns:

  • (Integer) —

    Length of aggregation period.



26
27
28
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 26

def interval
  @interval
end

#name ⇒ String

API, operation or developer name.

Returns:

  • (String) —

    Name depending on report endpoint specifies product,



17
18
19
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 17

def name
  @name
end

#operation_id ⇒ String

/apis/apiId/operations/operationId

Returns:

  • (String) —

    Operation identifier path.



48
49
50
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 48

def operation_id
  @operation_id
end

#product_id ⇒ String

Returns Product identifier path. /products/productId.

Returns:

  • (String) —

    Product identifier path. /products/productId



41
42
43
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 41

def product_id
  @product_id
end

#region ⇒ String

Returns Country region to which this record data is related.

Returns:

  • (String) —

    Country region to which this record data is related.



32
33
34
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 32

def region
  @region
end

#service_time_avg ⇒ Float

Returns Average time it took to process request on backend.

Returns:

  • (Float) —

    Average time it took to process request on backend.



98
99
100
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 98

def service_time_avg
  @service_time_avg
end

#service_time_max ⇒ Float

Returns Maximum time it took to process request on backend.

Returns:

  • (Float) —

    Maximum time it took to process request on backend.



104
105
106
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 104

def service_time_max
  @service_time_max
end

#service_time_min ⇒ Float

Returns Minimum time it took to process request on backend.

Returns:

  • (Float) —

    Minimum time it took to process request on backend.



101
102
103
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 101

def service_time_min
  @service_time_min
end

#subscription_id ⇒ String

/subscriptions/subscriptionId

Returns:

  • (String) —

    Subscription identifier path.



55
56
57
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 55

def subscription_id
  @subscription_id
end

#timestamp ⇒ DateTime

the following format: ‘yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.

Returns:

  • (DateTime) —

    Start of aggregation period. The date conforms to



23
24
25
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 23

def timestamp
  @timestamp
end

#user_id ⇒ String

Returns User identifier path. /users/userId.

Returns:

  • (String) —

    User identifier path. /users/userId



38
39
40
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 38

def user_id
  @user_id
end

#zip ⇒ String

Returns Zip code to which this record data is related.

Returns:

  • (String) —

    Zip code to which this record data is related.



35
36
37
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 35

def zip
  @zip
end

Class Method Details

.mapper ⇒ Object

Mapper for ReportRecordContract class as Ruby Hash. This will be used for serialization/deserialization.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/report_record_contract.rb', line 111

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ReportRecordContract',
    type: {
      name: 'Composite',
      class_name: 'ReportRecordContract',
      model_properties: {
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        timestamp: {
          client_side_validation: true,
          required: false,
          serialized_name: 'timestamp',
          type: {
            name: 'DateTime'
          }
        },
        interval: {
          client_side_validation: true,
          required: false,
          serialized_name: 'interval',
          type: {
            name: 'Number'
          }
        },
        country: {
          client_side_validation: true,
          required: false,
          serialized_name: 'country',
          type: {
            name: 'String'
          }
        },
        region: {
          client_side_validation: true,
          required: false,
          serialized_name: 'region',
          type: {
            name: 'String'
          }
        },
        zip: {
          client_side_validation: true,
          required: false,
          serialized_name: 'zip',
          type: {
            name: 'String'
          }
        },
        user_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'userId',
          type: {
            name: 'String'
          }
        },
        product_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'productId',
          type: {
            name: 'String'
          }
        },
        api_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'apiId',
          type: {
            name: 'String'
          }
        },
        operation_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'operationId',
          type: {
            name: 'String'
          }
        },
        api_region: {
          client_side_validation: true,
          required: false,
          serialized_name: 'apiRegion',
          type: {
            name: 'String'
          }
        },
        subscription_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'subscriptionId',
          type: {
            name: 'String'
          }
        },
        call_count_success: {
          client_side_validation: true,
          required: false,
          serialized_name: 'callCountSuccess',
          type: {
            name: 'Number'
          }
        },
        call_count_blocked: {
          client_side_validation: true,
          required: false,
          serialized_name: 'callCountBlocked',
          type: {
            name: 'Number'
          }
        },
        call_count_failed: {
          client_side_validation: true,
          required: false,
          serialized_name: 'callCountFailed',
          type: {
            name: 'Number'
          }
        },
        call_count_other: {
          client_side_validation: true,
          required: false,
          serialized_name: 'callCountOther',
          type: {
            name: 'Number'
          }
        },
        call_count_total: {
          client_side_validation: true,
          required: false,
          serialized_name: 'callCountTotal',
          type: {
            name: 'Number'
          }
        },
        bandwidth: {
          client_side_validation: true,
          required: false,
          serialized_name: 'bandwidth',
          type: {
            name: 'Number'
          }
        },
        cache_hit_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'cacheHitCount',
          type: {
            name: 'Number'
          }
        },
        cache_miss_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'cacheMissCount',
          type: {
            name: 'Number'
          }
        },
        api_time_avg: {
          client_side_validation: true,
          required: false,
          serialized_name: 'apiTimeAvg',
          type: {
            name: 'Double'
          }
        },
        api_time_min: {
          client_side_validation: true,
          required: false,
          serialized_name: 'apiTimeMin',
          type: {
            name: 'Double'
          }
        },
        api_time_max: {
          client_side_validation: true,
          required: false,
          serialized_name: 'apiTimeMax',
          type: {
            name: 'Double'
          }
        },
        service_time_avg: {
          client_side_validation: true,
          required: false,
          serialized_name: 'serviceTimeAvg',
          type: {
            name: 'Double'
          }
        },
        service_time_min: {
          client_side_validation: true,
          required: false,
          serialized_name: 'serviceTimeMin',
          type: {
            name: 'Double'
          }
        },
        service_time_max: {
          client_side_validation: true,
          required: false,
          serialized_name: 'serviceTimeMax',
          type: {
            name: 'Double'
          }
        }
      }
    }
  }
end