fastly 8.9.0 → 9.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (124) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +32 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +15 -4
  5. data/docs/AccessKey.md +12 -0
  6. data/docs/AccessKeyResponse.md +15 -0
  7. data/docs/AclsInComputeApi.md +2 -2
  8. data/docs/Backend.md +2 -2
  9. data/docs/BackendApi.md +8 -8
  10. data/docs/BackendResponse.md +2 -2
  11. data/docs/BillingUsageMetricsApi.md +13 -19
  12. data/docs/ComputeAclUpdate.md +10 -0
  13. data/docs/DimensionAttributesCountryStats.md +12 -0
  14. data/docs/DimensionAttributesRate.md +10 -0
  15. data/docs/DimensionBrowser.md +10 -0
  16. data/docs/DimensionContentType.md +10 -0
  17. data/docs/DimensionCountry.md +10 -0
  18. data/docs/DimensionDevice.md +10 -0
  19. data/docs/DimensionOs.md +10 -0
  20. data/docs/DimensionResponse.md +10 -0
  21. data/docs/DimensionStatusCode.md +10 -0
  22. data/docs/DimensionUrl.md +10 -0
  23. data/docs/EnabledProductsApi.md +5 -5
  24. data/docs/FilterFieldItem.md +12 -0
  25. data/docs/GetLogInsightsResponse.md +11 -0
  26. data/docs/GetLogRecordsResponse.md +11 -0
  27. data/docs/GetLogRecordsResponseMeta.md +10 -0
  28. data/docs/GetLogRecordsResponseMetaFilters.md +16 -0
  29. data/docs/InsightsApi.md +69 -0
  30. data/docs/KvStoreItemApi.md +2 -0
  31. data/docs/LogExplorerApi.md +65 -0
  32. data/docs/LogInsights.md +12 -0
  33. data/docs/LogInsightsDimensionAttributes.md +49 -0
  34. data/docs/LogInsightsDimensions.md +61 -0
  35. data/docs/LogInsightsMeta.md +10 -0
  36. data/docs/LogInsightsMetaFilter.md +14 -0
  37. data/docs/LogInsightsValues.md +65 -0
  38. data/docs/LogPropertyServiceId.md +9 -0
  39. data/docs/LogRecord.md +37 -0
  40. data/docs/LoggingGrafanacloudlogsAdditional.md +14 -0
  41. data/docs/LoggingGrafanacloudlogsApi.md +259 -0
  42. data/docs/LoggingGrafanacloudlogsResponse.md +23 -0
  43. data/docs/ObjectStorageAccessKeysApi.md +163 -0
  44. data/docs/RealtimeEntryAggregated.md +3 -7
  45. data/docs/RealtimeMeasurements.md +3 -7
  46. data/docs/Results.md +3 -7
  47. data/docs/SetConfiguration.md +1 -0
  48. data/docs/Usagemetric.md +18 -0
  49. data/docs/Usagemetrics.md +10 -0
  50. data/docs/ValueField.md +59 -0
  51. data/docs/Values503Responses.md +12 -0
  52. data/docs/ValuesBandwidth.md +11 -0
  53. data/docs/ValuesBrowser.md +11 -0
  54. data/docs/ValuesCacheHitRatio.md +10 -0
  55. data/docs/ValuesCountryStats.md +12 -0
  56. data/docs/ValuesDuration.md +12 -0
  57. data/docs/ValuesMisses.md +10 -0
  58. data/docs/ValuesRate.md +10 -0
  59. data/docs/ValuesRequests.md +10 -0
  60. data/docs/ValuesStatusCodes.md +12 -0
  61. data/lib/fastly/api/acls_in_compute_api.rb +3 -3
  62. data/lib/fastly/api/backend_api.rb +8 -8
  63. data/lib/fastly/api/billing_usage_metrics_api.rb +30 -57
  64. data/lib/fastly/api/enabled_products_api.rb +10 -10
  65. data/lib/fastly/api/insights_api.rb +125 -0
  66. data/lib/fastly/api/kv_store_item_api.rb +3 -0
  67. data/lib/fastly/api/log_explorer_api.rb +109 -0
  68. data/lib/fastly/api/logging_grafanacloudlogs_api.rb +471 -0
  69. data/lib/fastly/api/object_storage_access_keys_api.rb +263 -0
  70. data/lib/fastly/configuration.rb +67 -1
  71. data/lib/fastly/models/access_key.rb +248 -0
  72. data/lib/fastly/models/access_key_response.rb +269 -0
  73. data/lib/fastly/models/backend.rb +2 -2
  74. data/lib/fastly/models/backend_response.rb +2 -2
  75. data/lib/fastly/models/compute_acl_list_entries.rb +1 -1
  76. data/lib/fastly/models/compute_acl_lookup.rb +1 -1
  77. data/lib/fastly/models/compute_acl_update.rb +219 -0
  78. data/lib/fastly/models/compute_acl_update_entry.rb +1 -1
  79. data/lib/fastly/models/dimension_attributes_country_stats.rb +237 -0
  80. data/lib/fastly/models/dimension_attributes_rate.rb +217 -0
  81. data/lib/fastly/models/dimension_browser.rb +217 -0
  82. data/lib/fastly/models/dimension_content_type.rb +217 -0
  83. data/lib/fastly/models/dimension_country.rb +217 -0
  84. data/lib/fastly/models/dimension_device.rb +217 -0
  85. data/lib/fastly/models/dimension_os.rb +217 -0
  86. data/lib/fastly/models/dimension_response.rb +217 -0
  87. data/lib/fastly/models/dimension_status_code.rb +217 -0
  88. data/lib/fastly/models/dimension_url.rb +217 -0
  89. data/lib/fastly/models/filter_field_item.rb +271 -0
  90. data/lib/fastly/models/get_log_insights_response.rb +227 -0
  91. data/lib/fastly/models/get_log_records_response.rb +227 -0
  92. data/lib/fastly/models/get_log_records_response_meta.rb +216 -0
  93. data/lib/fastly/models/get_log_records_response_meta_filters.rb +307 -0
  94. data/lib/fastly/models/log_insights.rb +234 -0
  95. data/lib/fastly/models/log_insights_dimension_attributes.rb +103 -0
  96. data/lib/fastly/models/log_insights_dimensions.rb +109 -0
  97. data/lib/fastly/models/log_insights_meta.rb +217 -0
  98. data/lib/fastly/models/log_insights_meta_filter.rb +284 -0
  99. data/lib/fastly/models/log_insights_values.rb +111 -0
  100. data/lib/fastly/models/log_property_service_id.rb +208 -0
  101. data/lib/fastly/models/log_record.rb +486 -0
  102. data/lib/fastly/models/logging_grafanacloudlogs_additional.rb +257 -0
  103. data/lib/fastly/models/logging_grafanacloudlogs_response.rb +408 -0
  104. data/lib/fastly/models/realtime_entry_aggregated.rb +34 -74
  105. data/lib/fastly/models/realtime_measurements.rb +34 -74
  106. data/lib/fastly/models/results.rb +31 -71
  107. data/lib/fastly/models/set_configuration.rb +14 -4
  108. data/lib/fastly/models/usagemetric.rb +297 -0
  109. data/lib/fastly/models/usagemetrics.rb +218 -0
  110. data/lib/fastly/models/value_field.rb +108 -0
  111. data/lib/fastly/models/values503_responses.rb +237 -0
  112. data/lib/fastly/models/values_bandwidth.rb +227 -0
  113. data/lib/fastly/models/values_browser.rb +227 -0
  114. data/lib/fastly/models/values_cache_hit_ratio.rb +217 -0
  115. data/lib/fastly/models/values_country_stats.rb +237 -0
  116. data/lib/fastly/models/values_duration.rb +237 -0
  117. data/lib/fastly/models/values_misses.rb +217 -0
  118. data/lib/fastly/models/values_rate.rb +217 -0
  119. data/lib/fastly/models/values_requests.rb +217 -0
  120. data/lib/fastly/models/values_status_codes.rb +237 -0
  121. data/lib/fastly/version.rb +1 -1
  122. data/lib/fastly.rb +45 -0
  123. data/sig.json +1 -1
  124. metadata +92 -2
@@ -0,0 +1,259 @@
1
+ # Fastly::LoggingGrafanacloudlogsApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::LoggingGrafanacloudlogsApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ > [!NOTE]
12
+ > All URIs are relative to `https://api.fastly.com`
13
+
14
+ Method | HTTP request | Description
15
+ ------ | ------------ | -----------
16
+ [**create_log_grafanacloudlogs**](LoggingGrafanacloudlogsApi.md#create_log_grafanacloudlogs) | **POST** /service/{service_id}/version/{version_id}/logging/grafanacloudlogs | Create a Grafana Cloud Logs log endpoint
17
+ [**delete_log_grafanacloudlogs**](LoggingGrafanacloudlogsApi.md#delete_log_grafanacloudlogs) | **DELETE** /service/{service_id}/version/{version_id}/logging/grafanacloudlogs/{logging_grafanacloudlogs_name} | Delete the Grafana Cloud Logs log endpoint
18
+ [**get_log_grafanacloudlogs**](LoggingGrafanacloudlogsApi.md#get_log_grafanacloudlogs) | **GET** /service/{service_id}/version/{version_id}/logging/grafanacloudlogs/{logging_grafanacloudlogs_name} | Get a Grafana Cloud Logs log endpoint
19
+ [**list_log_grafanacloudlogs**](LoggingGrafanacloudlogsApi.md#list_log_grafanacloudlogs) | **GET** /service/{service_id}/version/{version_id}/logging/grafanacloudlogs | List Grafana Cloud Logs log endpoints
20
+ [**update_log_grafanacloudlogs**](LoggingGrafanacloudlogsApi.md#update_log_grafanacloudlogs) | **PUT** /service/{service_id}/version/{version_id}/logging/grafanacloudlogs/{logging_grafanacloudlogs_name} | Update a Grafana Cloud Logs log endpoint
21
+
22
+
23
+ ## `create_log_grafanacloudlogs()`
24
+
25
+ ```ruby
26
+ create_log_grafanacloudlogs(opts): <LoggingGrafanacloudlogsResponse> # Create a Grafana Cloud Logs log endpoint
27
+ ```
28
+
29
+ Create a Grafana Cloud Logs logging object for a particular service and version.
30
+
31
+ ### Examples
32
+
33
+ ```ruby
34
+ api_instance = Fastly::LoggingGrafanacloudlogsApi.new
35
+ opts = {
36
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
37
+ version_id: 56, # Integer | Integer identifying a service version.
38
+ name: 'name_example', # String | The name for the real-time logging configuration.
39
+ placement: 'none', # String | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.
40
+ response_condition: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
41
+ format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
42
+ format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
43
+ user: 'user_example', # String | The Grafana Cloud Logs Dataset you want to log to.
44
+ url: 'url_example', # String | The URL of the Loki instance in your Grafana stack.
45
+ token: 'token_example', # String | The Grafana Access Policy token with `logs:write` access scoped to your Loki instance.
46
+ index: 'index_example', # String | The Stream Labels, a JSON string used to identify the stream.
47
+ }
48
+
49
+ begin
50
+ # Create a Grafana Cloud Logs log endpoint
51
+ result = api_instance.create_log_grafanacloudlogs(opts)
52
+ p result
53
+ rescue Fastly::ApiError => e
54
+ puts "Error when calling LoggingGrafanacloudlogsApi->create_log_grafanacloudlogs: #{e}"
55
+ end
56
+ ```
57
+
58
+ ### Options
59
+
60
+ | Name | Type | Description | Notes |
61
+ | ---- | ---- | ----------- | ----- |
62
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
63
+ | **version_id** | **Integer** | Integer identifying a service version. | |
64
+ | **name** | **String** | The name for the real-time logging configuration. | [optional] |
65
+ | **placement** | **String** | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`. | [optional] |
66
+ | **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
67
+ | **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional] |
68
+ | **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
69
+ | **user** | **String** | The Grafana Cloud Logs Dataset you want to log to. | [optional] |
70
+ | **url** | **String** | The URL of the Loki instance in your Grafana stack. | [optional] |
71
+ | **token** | **String** | The Grafana Access Policy token with `logs:write` access scoped to your Loki instance. | [optional] |
72
+ | **index** | **String** | The Stream Labels, a JSON string used to identify the stream. | [optional] |
73
+
74
+ ### Return type
75
+
76
+ [**LoggingGrafanacloudlogsResponse**](LoggingGrafanacloudlogsResponse.md)
77
+
78
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
79
+ [[Back to README]](../../README.md)
80
+ ## `delete_log_grafanacloudlogs()`
81
+
82
+ ```ruby
83
+ delete_log_grafanacloudlogs(opts): <InlineResponse200> # Delete the Grafana Cloud Logs log endpoint
84
+ ```
85
+
86
+ Delete the Grafana Cloud Logs logging object for a particular service and version.
87
+
88
+ ### Examples
89
+
90
+ ```ruby
91
+ api_instance = Fastly::LoggingGrafanacloudlogsApi.new
92
+ opts = {
93
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
94
+ version_id: 56, # Integer | Integer identifying a service version.
95
+ logging_grafanacloudlogs_name: 'logging_grafanacloudlogs_name_example', # String | The name for the real-time logging configuration.
96
+ }
97
+
98
+ begin
99
+ # Delete the Grafana Cloud Logs log endpoint
100
+ result = api_instance.delete_log_grafanacloudlogs(opts)
101
+ p result
102
+ rescue Fastly::ApiError => e
103
+ puts "Error when calling LoggingGrafanacloudlogsApi->delete_log_grafanacloudlogs: #{e}"
104
+ end
105
+ ```
106
+
107
+ ### Options
108
+
109
+ | Name | Type | Description | Notes |
110
+ | ---- | ---- | ----------- | ----- |
111
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
112
+ | **version_id** | **Integer** | Integer identifying a service version. | |
113
+ | **logging_grafanacloudlogs_name** | **String** | The name for the real-time logging configuration. | |
114
+
115
+ ### Return type
116
+
117
+ [**InlineResponse200**](InlineResponse200.md)
118
+
119
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
120
+ [[Back to README]](../../README.md)
121
+ ## `get_log_grafanacloudlogs()`
122
+
123
+ ```ruby
124
+ get_log_grafanacloudlogs(opts): <LoggingGrafanacloudlogsResponse> # Get a Grafana Cloud Logs log endpoint
125
+ ```
126
+
127
+ Get the details of a Grafana Cloud Logs logging object for a particular service and version.
128
+
129
+ ### Examples
130
+
131
+ ```ruby
132
+ api_instance = Fastly::LoggingGrafanacloudlogsApi.new
133
+ opts = {
134
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
135
+ version_id: 56, # Integer | Integer identifying a service version.
136
+ logging_grafanacloudlogs_name: 'logging_grafanacloudlogs_name_example', # String | The name for the real-time logging configuration.
137
+ }
138
+
139
+ begin
140
+ # Get a Grafana Cloud Logs log endpoint
141
+ result = api_instance.get_log_grafanacloudlogs(opts)
142
+ p result
143
+ rescue Fastly::ApiError => e
144
+ puts "Error when calling LoggingGrafanacloudlogsApi->get_log_grafanacloudlogs: #{e}"
145
+ end
146
+ ```
147
+
148
+ ### Options
149
+
150
+ | Name | Type | Description | Notes |
151
+ | ---- | ---- | ----------- | ----- |
152
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
153
+ | **version_id** | **Integer** | Integer identifying a service version. | |
154
+ | **logging_grafanacloudlogs_name** | **String** | The name for the real-time logging configuration. | |
155
+
156
+ ### Return type
157
+
158
+ [**LoggingGrafanacloudlogsResponse**](LoggingGrafanacloudlogsResponse.md)
159
+
160
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
161
+ [[Back to README]](../../README.md)
162
+ ## `list_log_grafanacloudlogs()`
163
+
164
+ ```ruby
165
+ list_log_grafanacloudlogs(opts): <Array<LoggingGrafanacloudlogsResponse>> # List Grafana Cloud Logs log endpoints
166
+ ```
167
+
168
+ List all of the Grafana Cloud Logs logging objects for a particular service and version.
169
+
170
+ ### Examples
171
+
172
+ ```ruby
173
+ api_instance = Fastly::LoggingGrafanacloudlogsApi.new
174
+ opts = {
175
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
176
+ version_id: 56, # Integer | Integer identifying a service version.
177
+ }
178
+
179
+ begin
180
+ # List Grafana Cloud Logs log endpoints
181
+ result = api_instance.list_log_grafanacloudlogs(opts)
182
+ p result
183
+ rescue Fastly::ApiError => e
184
+ puts "Error when calling LoggingGrafanacloudlogsApi->list_log_grafanacloudlogs: #{e}"
185
+ end
186
+ ```
187
+
188
+ ### Options
189
+
190
+ | Name | Type | Description | Notes |
191
+ | ---- | ---- | ----------- | ----- |
192
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
193
+ | **version_id** | **Integer** | Integer identifying a service version. | |
194
+
195
+ ### Return type
196
+
197
+ [**Array&lt;LoggingGrafanacloudlogsResponse&gt;**](LoggingGrafanacloudlogsResponse.md)
198
+
199
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
200
+ [[Back to README]](../../README.md)
201
+ ## `update_log_grafanacloudlogs()`
202
+
203
+ ```ruby
204
+ update_log_grafanacloudlogs(opts): <LoggingGrafanacloudlogsResponse> # Update a Grafana Cloud Logs log endpoint
205
+ ```
206
+
207
+ Update a Grafana Cloud Logs logging object for a particular service and version.
208
+
209
+ ### Examples
210
+
211
+ ```ruby
212
+ api_instance = Fastly::LoggingGrafanacloudlogsApi.new
213
+ opts = {
214
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
215
+ version_id: 56, # Integer | Integer identifying a service version.
216
+ logging_grafanacloudlogs_name: 'logging_grafanacloudlogs_name_example', # String | The name for the real-time logging configuration.
217
+ name: 'name_example', # String | The name for the real-time logging configuration.
218
+ placement: 'none', # String | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.
219
+ response_condition: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
220
+ format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
221
+ format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
222
+ user: 'user_example', # String | The Grafana Cloud Logs Dataset you want to log to.
223
+ url: 'url_example', # String | The URL of the Loki instance in your Grafana stack.
224
+ token: 'token_example', # String | The Grafana Access Policy token with `logs:write` access scoped to your Loki instance.
225
+ index: 'index_example', # String | The Stream Labels, a JSON string used to identify the stream.
226
+ }
227
+
228
+ begin
229
+ # Update a Grafana Cloud Logs log endpoint
230
+ result = api_instance.update_log_grafanacloudlogs(opts)
231
+ p result
232
+ rescue Fastly::ApiError => e
233
+ puts "Error when calling LoggingGrafanacloudlogsApi->update_log_grafanacloudlogs: #{e}"
234
+ end
235
+ ```
236
+
237
+ ### Options
238
+
239
+ | Name | Type | Description | Notes |
240
+ | ---- | ---- | ----------- | ----- |
241
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
242
+ | **version_id** | **Integer** | Integer identifying a service version. | |
243
+ | **logging_grafanacloudlogs_name** | **String** | The name for the real-time logging configuration. | |
244
+ | **name** | **String** | The name for the real-time logging configuration. | [optional] |
245
+ | **placement** | **String** | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`. | [optional] |
246
+ | **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
247
+ | **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional] |
248
+ | **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
249
+ | **user** | **String** | The Grafana Cloud Logs Dataset you want to log to. | [optional] |
250
+ | **url** | **String** | The URL of the Loki instance in your Grafana stack. | [optional] |
251
+ | **token** | **String** | The Grafana Access Policy token with `logs:write` access scoped to your Loki instance. | [optional] |
252
+ | **index** | **String** | The Stream Labels, a JSON string used to identify the stream. | [optional] |
253
+
254
+ ### Return type
255
+
256
+ [**LoggingGrafanacloudlogsResponse**](LoggingGrafanacloudlogsResponse.md)
257
+
258
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
259
+ [[Back to README]](../../README.md)
@@ -0,0 +1,23 @@
1
+ # Fastly::LoggingGrafanacloudlogsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The name for the real-time logging configuration. | [optional] |
8
+ | **placement** | **String** | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`. | [optional] |
9
+ | **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
10
+ | **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional] |
11
+ | **format_version** | **String** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to &#39;2&#39;] |
12
+ | **user** | **String** | The Grafana Cloud Logs Dataset you want to log to. | [optional] |
13
+ | **url** | **String** | The URL of the Loki instance in your Grafana stack. | [optional] |
14
+ | **token** | **String** | The Grafana Access Policy token with `logs:write` access scoped to your Loki instance. | [optional] |
15
+ | **index** | **String** | The Stream Labels, a JSON string used to identify the stream. | [optional] |
16
+ | **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
17
+ | **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
18
+ | **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
19
+ | **service_id** | **String** | | [optional][readonly] |
20
+ | **version** | **String** | | [optional][readonly] |
21
+
22
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
23
+
@@ -0,0 +1,163 @@
1
+ # Fastly::ObjectStorageAccessKeysApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::ObjectStorageAccessKeysApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ > [!NOTE]
12
+ > All URIs are relative to `https://api.fastly.com`
13
+
14
+ Method | HTTP request | Description
15
+ ------ | ------------ | -----------
16
+ [**create_access_key**](ObjectStorageAccessKeysApi.md#create_access_key) | **POST** /resources/object-storage/access-keys | Create an access key
17
+ [**delete_access_key**](ObjectStorageAccessKeysApi.md#delete_access_key) | **DELETE** /resources/object-storage/access-keys/{access_key} | Delete an access key
18
+ [**get_access_key**](ObjectStorageAccessKeysApi.md#get_access_key) | **GET** /resources/object-storage/access-keys/{access_key} | Get an access key
19
+ [**list_access_keys**](ObjectStorageAccessKeysApi.md#list_access_keys) | **GET** /resources/object-storage/access-keys | List access keys
20
+
21
+
22
+ ## `create_access_key()`
23
+
24
+ ```ruby
25
+ create_access_key(opts): <AccessKeyResponse> # Create an access key
26
+ ```
27
+
28
+ Create an access key.
29
+
30
+ ### Examples
31
+
32
+ ```ruby
33
+ api_instance = Fastly::ObjectStorageAccessKeysApi.new
34
+ opts = {
35
+ access_key: Fastly::AccessKey.new({description: 'description_example', permission: 'permission_example'}), # AccessKey |
36
+ }
37
+
38
+ begin
39
+ # Create an access key
40
+ result = api_instance.create_access_key(opts)
41
+ p result
42
+ rescue Fastly::ApiError => e
43
+ puts "Error when calling ObjectStorageAccessKeysApi->create_access_key: #{e}"
44
+ end
45
+ ```
46
+
47
+ ### Options
48
+
49
+ | Name | Type | Description | Notes |
50
+ | ---- | ---- | ----------- | ----- |
51
+ | **access_key** | [**AccessKey**](AccessKey.md) | | [optional] |
52
+
53
+ ### Return type
54
+
55
+ [**AccessKeyResponse**](AccessKeyResponse.md)
56
+
57
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
58
+ [[Back to README]](../../README.md)
59
+ ## `delete_access_key()`
60
+
61
+ ```ruby
62
+ delete_access_key(opts) # Delete an access key
63
+ ```
64
+
65
+ Delete an access key.
66
+
67
+ ### Examples
68
+
69
+ ```ruby
70
+ api_instance = Fastly::ObjectStorageAccessKeysApi.new
71
+ opts = {
72
+ access_key: 'access_key_example', # String |
73
+ }
74
+
75
+ begin
76
+ # Delete an access key
77
+ api_instance.delete_access_key(opts)
78
+ rescue Fastly::ApiError => e
79
+ puts "Error when calling ObjectStorageAccessKeysApi->delete_access_key: #{e}"
80
+ end
81
+ ```
82
+
83
+ ### Options
84
+
85
+ | Name | Type | Description | Notes |
86
+ | ---- | ---- | ----------- | ----- |
87
+ | **access_key** | **String** | | |
88
+
89
+ ### Return type
90
+
91
+ nil (empty response body)
92
+
93
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
94
+ [[Back to README]](../../README.md)
95
+ ## `get_access_key()`
96
+
97
+ ```ruby
98
+ get_access_key(opts): <AccessKey> # Get an access key
99
+ ```
100
+
101
+ Get an access key by its identifier.
102
+
103
+ ### Examples
104
+
105
+ ```ruby
106
+ api_instance = Fastly::ObjectStorageAccessKeysApi.new
107
+ opts = {
108
+ access_key: 'access_key_example', # String |
109
+ }
110
+
111
+ begin
112
+ # Get an access key
113
+ result = api_instance.get_access_key(opts)
114
+ p result
115
+ rescue Fastly::ApiError => e
116
+ puts "Error when calling ObjectStorageAccessKeysApi->get_access_key: #{e}"
117
+ end
118
+ ```
119
+
120
+ ### Options
121
+
122
+ | Name | Type | Description | Notes |
123
+ | ---- | ---- | ----------- | ----- |
124
+ | **access_key** | **String** | | |
125
+
126
+ ### Return type
127
+
128
+ [**AccessKey**](AccessKey.md)
129
+
130
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
131
+ [[Back to README]](../../README.md)
132
+ ## `list_access_keys()`
133
+
134
+ ```ruby
135
+ list_access_keys: <AccessKeyResponse> # List access keys
136
+ ```
137
+
138
+ List access keys.
139
+
140
+ ### Examples
141
+
142
+ ```ruby
143
+ api_instance = Fastly::ObjectStorageAccessKeysApi.new
144
+
145
+ begin
146
+ # List access keys
147
+ result = api_instance.list_access_keys
148
+ p result
149
+ rescue Fastly::ApiError => e
150
+ puts "Error when calling ObjectStorageAccessKeysApi->list_access_keys: #{e}"
151
+ end
152
+ ```
153
+
154
+ ### Options
155
+
156
+ This endpoint does not need any parameter.
157
+
158
+ ### Return type
159
+
160
+ [**AccessKeyResponse**](AccessKeyResponse.md)
161
+
162
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
163
+ [[Back to README]](../../README.md)
@@ -233,13 +233,6 @@
233
233
  | **bot_challenge_complete_tokens_issued** | **Integer** | The number of challenge-complete tokens issued. For example, issuing a challenge-complete token after a series of CAPTCHA challenges ending in success. | [optional] |
234
234
  | **ddos_action_downgrade** | **Integer** | The number of times the downgrade action was taken. The downgrade action restricts the client to http1. | [optional] |
235
235
  | **ddos_action_downgraded_connections** | **Integer** | The number of connections the downgrade action was applied to. The downgrade action restricts the connection to http1. | [optional] |
236
- | **vcl_on_compute_hit_requests** | **Integer** | Number of cache hits for a VCL service running on Compute. | [optional] |
237
- | **vcl_on_compute_miss_requests** | **Integer** | Number of cache misses for a VCL service running on Compute. | [optional] |
238
- | **vcl_on_compute_pass_requests** | **Integer** | Number of requests that passed through the CDN without being cached for a VCL service running on Compute. | [optional] |
239
- | **vcl_on_compute_error_requests** | **Integer** | Number of cache errors for a VCL service running on Compute. | [optional] |
240
- | **vcl_on_compute_synth_requests** | **Integer** | Number of requests that returned a synthetic response (i.e., response objects created with the `synthetic` VCL statement) for a VCL service running on Compute. | [optional] |
241
- | **vcl_on_compute_edge_hit_requests** | **Integer** | Number of requests sent by end users to Fastly that resulted in a hit at the edge for a VCL service running on Compute. | [optional] |
242
- | **vcl_on_compute_edge_miss_requests** | **Integer** | Number of requests sent by end users to Fastly that resulted in a miss at the edge for a VCL service running on Compute. | [optional] |
243
236
  | **all_hit_requests** | **Integer** | Number of cache hits for a VCL service. | [optional] |
244
237
  | **all_miss_requests** | **Integer** | Number of cache misses for a VCL service. | [optional] |
245
238
  | **all_pass_requests** | **Integer** | Number of requests that passed through the CDN without being cached for a VCL service. | [optional] |
@@ -254,6 +247,9 @@
254
247
  | **all_status_5xx** | **Integer** | Number of \&quot;Server Error\&quot; codes delivered for all sources. | [optional] |
255
248
  | **origin_offload** | **Float** | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((`edge_resp_body_bytes` + `edge_resp_header_bytes`) - (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes`)) / (`edge_resp_body_bytes` + `edge_resp_header_bytes`). | [optional] |
256
249
  | **request_denied_get_head_body** | **Integer** | Number of requests where Fastly responded with 400 due to the request being a GET or HEAD request containing a body. | [optional] |
250
+ | **service_ddos_requests_detected** | **Integer** | Number of requests classified as a DDoS attack against a customer origin or service. | [optional] |
251
+ | **service_ddos_requests_mitigated** | **Integer** | Number of requests classified as a DDoS attack against a customer origin or service that were mitigated by the Fastly platform. | [optional] |
252
+ | **service_ddos_requests_allowed** | **Integer** | Number of requests analyzed for DDoS attacks against a customer origin or service, but with no DDoS detected. | [optional] |
257
253
 
258
254
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
259
255
 
@@ -233,13 +233,6 @@
233
233
  | **bot_challenge_complete_tokens_issued** | **Integer** | The number of challenge-complete tokens issued. For example, issuing a challenge-complete token after a series of CAPTCHA challenges ending in success. | [optional] |
234
234
  | **ddos_action_downgrade** | **Integer** | The number of times the downgrade action was taken. The downgrade action restricts the client to http1. | [optional] |
235
235
  | **ddos_action_downgraded_connections** | **Integer** | The number of connections the downgrade action was applied to. The downgrade action restricts the connection to http1. | [optional] |
236
- | **vcl_on_compute_hit_requests** | **Integer** | Number of cache hits for a VCL service running on Compute. | [optional] |
237
- | **vcl_on_compute_miss_requests** | **Integer** | Number of cache misses for a VCL service running on Compute. | [optional] |
238
- | **vcl_on_compute_pass_requests** | **Integer** | Number of requests that passed through the CDN without being cached for a VCL service running on Compute. | [optional] |
239
- | **vcl_on_compute_error_requests** | **Integer** | Number of cache errors for a VCL service running on Compute. | [optional] |
240
- | **vcl_on_compute_synth_requests** | **Integer** | Number of requests that returned a synthetic response (i.e., response objects created with the `synthetic` VCL statement) for a VCL service running on Compute. | [optional] |
241
- | **vcl_on_compute_edge_hit_requests** | **Integer** | Number of requests sent by end users to Fastly that resulted in a hit at the edge for a VCL service running on Compute. | [optional] |
242
- | **vcl_on_compute_edge_miss_requests** | **Integer** | Number of requests sent by end users to Fastly that resulted in a miss at the edge for a VCL service running on Compute. | [optional] |
243
236
  | **all_hit_requests** | **Integer** | Number of cache hits for a VCL service. | [optional] |
244
237
  | **all_miss_requests** | **Integer** | Number of cache misses for a VCL service. | [optional] |
245
238
  | **all_pass_requests** | **Integer** | Number of requests that passed through the CDN without being cached for a VCL service. | [optional] |
@@ -254,6 +247,9 @@
254
247
  | **all_status_5xx** | **Integer** | Number of \&quot;Server Error\&quot; codes delivered for all sources. | [optional] |
255
248
  | **origin_offload** | **Float** | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((`edge_resp_body_bytes` + `edge_resp_header_bytes`) - (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes`)) / (`edge_resp_body_bytes` + `edge_resp_header_bytes`). | [optional] |
256
249
  | **request_denied_get_head_body** | **Integer** | Number of requests where Fastly responded with 400 due to the request being a GET or HEAD request containing a body. | [optional] |
250
+ | **service_ddos_requests_detected** | **Integer** | Number of requests classified as a DDoS attack against a customer origin or service. | [optional] |
251
+ | **service_ddos_requests_mitigated** | **Integer** | Number of requests classified as a DDoS attack against a customer origin or service that were mitigated by the Fastly platform. | [optional] |
252
+ | **service_ddos_requests_allowed** | **Integer** | Number of requests analyzed for DDoS attacks against a customer origin or service, but with no DDoS detected. | [optional] |
257
253
 
258
254
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
259
255
 
data/docs/Results.md CHANGED
@@ -233,13 +233,6 @@
233
233
  | **bot_challenges_failed** | **Integer** | The number of failed challenge solutions processed. For example, an incorrect CAPTCHA solution. | [optional] |
234
234
  | **ddos_action_downgrade** | **Integer** | The number of times the downgrade action was taken. The downgrade action restricts the client to http1. | [optional] |
235
235
  | **ddos_action_downgraded_connections** | **Integer** | The number of connections the downgrade action was applied to. The downgrade action restricts the connection to http1. | [optional] |
236
- | **vcl_on_compute_hit_requests** | **Integer** | Number of cache hits for a VCL service running on Compute. | [optional] |
237
- | **vcl_on_compute_miss_requests** | **Integer** | Number of cache misses for a VCL service running on Compute. | [optional] |
238
- | **vcl_on_compute_pass_requests** | **Integer** | Number of requests that passed through the CDN without being cached for a VCL service running on Compute. | [optional] |
239
- | **vcl_on_compute_error_requests** | **Integer** | Number of cache errors for a VCL service running on Compute. | [optional] |
240
- | **vcl_on_compute_synth_requests** | **Integer** | Number of requests that returned a synthetic response (i.e., response objects created with the `synthetic` VCL statement) for a VCL service running on Compute. | [optional] |
241
- | **vcl_on_compute_edge_hit_requests** | **Integer** | Number of requests sent by end users to Fastly that resulted in a hit at the edge for a VCL service running on Compute. | [optional] |
242
- | **vcl_on_compute_edge_miss_requests** | **Integer** | Number of requests sent by end users to Fastly that resulted in a miss at the edge for a VCL service running on Compute. | [optional] |
243
236
  | **all_hit_requests** | **Integer** | Number of cache hits for a VCL service. | [optional] |
244
237
  | **all_miss_requests** | **Integer** | Number of cache misses for a VCL service. | [optional] |
245
238
  | **all_pass_requests** | **Integer** | Number of requests that passed through the CDN without being cached for a VCL service. | [optional] |
@@ -254,6 +247,9 @@
254
247
  | **all_status_5xx** | **Integer** | Number of \&quot;Server Error\&quot; codes delivered for all sources. | [optional] |
255
248
  | **origin_offload** | **Float** | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((`edge_resp_body_bytes` + `edge_resp_header_bytes`) - (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes`)) / (`edge_resp_body_bytes` + `edge_resp_header_bytes`). | [optional] |
256
249
  | **request_denied_get_head_body** | **Integer** | Number of requests where Fastly responded with 400 due to the request being a GET or HEAD request containing a body. | [optional] |
250
+ | **service_ddos_requests_detected** | **Integer** | Number of requests classified as a DDoS attack against a customer origin or service. | [optional] |
251
+ | **service_ddos_requests_mitigated** | **Integer** | Number of requests classified as a DDoS attack against a customer origin or service that were mitigated by the Fastly platform. | [optional] |
252
+ | **service_ddos_requests_allowed** | **Integer** | Number of requests analyzed for DDoS attacks against a customer origin or service, but with no DDoS detected. | [optional] |
257
253
  | **service_id** | **String** | | [optional][readonly] |
258
254
  | **start_time** | **Integer** | Timestamp for the start of the time period being reported | [optional] |
259
255
 
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **workspace_id** | **String** | The new workspace_id. Required in the `PUT` request body when `product_id` is `ngwaf`. Optional in the `PATCH` request body for `ngwaf`. | [optional] |
8
8
  | **traffic_ramp** | **String** | The new traffic ramp. Optional in the `PATCH` request body for `ngwaf`. | [optional] |
9
+ | **mode** | **String** | The new mode to run the product in. One of `block`, `log`, or `off`. Optional in the `PATCH` request body for `ddos_protection`. | [optional] |
9
10
 
10
11
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11
12
 
@@ -0,0 +1,18 @@
1
+ # Fastly::Usagemetric
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **month** | **String** | The year and month of the usage element. | [optional] |
8
+ | **usage_type** | **String** | The usage type identifier for the usage. This is a single, billable metric for the product. | [optional] |
9
+ | **name** | **String** | Full name of the product usage type as it might appear on a customer&#39;s invoice. | [optional] |
10
+ | **region** | **String** | The geographical area applicable for regionally based products. | [optional] |
11
+ | **unit** | **String** | The unit for the usage as shown on an invoice. If there is no explicit unit, this field will be \&quot;unit\&quot; (e.g., a request with `product_id` of &#39;cdn_usage&#39; and `usage_type` of &#39;North America Requests&#39; has no unit, and will return \&quot;unit\&quot;). | [optional] |
12
+ | **quantity** | **Float** | The quantity of the usage for the product. | [optional] |
13
+ | **raw_quantity** | **Float** | The raw units measured for the product. | [optional] |
14
+ | **product_id** | **String** | The product identifier associated with the usage type. This corresponds to a Fastly product offering. | [optional] |
15
+ | **last_updated_at** | **String** | The date when the usage metric was last updated. | [optional] |
16
+
17
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
18
+
@@ -0,0 +1,10 @@
1
+ # Fastly::Usagemetrics
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;Usagemetric&gt;**](Usagemetric.md) | | [optional] |
8
+
9
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
+
@@ -0,0 +1,59 @@
1
+ # Fastly::ValueField
2
+
3
+ ## Class instance methods
4
+
5
+ ### `fastly_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'fastly'
13
+
14
+ Fastly::ValueField.fastly_one_of
15
+ # =>
16
+ # [
17
+ # :'Array<Float>',
18
+ # :'Array<Integer>',
19
+ # :'Array<String>',
20
+ # :'Boolean',
21
+ # :'Float',
22
+ # :'Integer',
23
+ # :'String'
24
+ # ]
25
+ ```
26
+
27
+ ### build
28
+
29
+ Find the appropriate object from the `fastly_one_of` list and casts the data into it.
30
+
31
+ #### Example
32
+
33
+ ```ruby
34
+ require 'fastly'
35
+
36
+ Fastly::ValueField.build(data)
37
+ # => #<Array<Float>:0x00007fdd4aab02a0>
38
+
39
+ Fastly::ValueField.build(data_that_doesnt_match)
40
+ # => nil
41
+ ```
42
+
43
+ #### Parameters
44
+
45
+ | Name | Type | Description |
46
+ | ---- | ---- | ----------- |
47
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
48
+
49
+ #### Return type
50
+
51
+ - `Array<Float>`
52
+ - `Array<Integer>`
53
+ - `Array<String>`
54
+ - `Boolean`
55
+ - `Float`
56
+ - `Integer`
57
+ - `String`
58
+ - `nil` (if no type matches)
59
+
@@ -0,0 +1,12 @@
1
+ # Fastly::Values503Responses
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **url** | **String** | The HTTP request path. | [optional] |
8
+ | **rate_per_url** | **Float** | The rate at which the reason in this dimension occurs among responses to this URL with a 503 status code. | [optional] |
9
+ | **_503_rate_per_url** | **Float** | The rate at which 503 status codes are returned for this URL. | [optional] |
10
+
11
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
+
@@ -0,0 +1,11 @@
1
+ # Fastly::ValuesBandwidth
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **average_bandwidth_bytes** | **Float** | The average bandwidth in bytes for responses to requests to the URL in the current dimension. | [optional] |
8
+ | **bandwidth_percentage** | **Float** | The total bandwidth percentage for all responses to requests to the URL in the current dimension. | [optional] |
9
+
10
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11
+
@@ -0,0 +1,11 @@
1
+ # Fastly::ValuesBrowser
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **browser_version** | **String** | The version of the client&#39;s browser. | [optional] |
8
+ | **rate** | **Float** | The percentage of requests by this version of the browser specified in the dimension. | [optional] |
9
+
10
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11
+