fastly 8.10.0 → 9.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (118) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +27 -1
  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/BillingUsageMetricsApi.md +13 -19
  9. data/docs/ComputeAclUpdate.md +10 -0
  10. data/docs/DimensionAttributesCountryStats.md +12 -0
  11. data/docs/DimensionAttributesRate.md +10 -0
  12. data/docs/DimensionBrowser.md +10 -0
  13. data/docs/DimensionContentType.md +10 -0
  14. data/docs/DimensionCountry.md +10 -0
  15. data/docs/DimensionDevice.md +10 -0
  16. data/docs/DimensionOs.md +10 -0
  17. data/docs/DimensionResponse.md +10 -0
  18. data/docs/DimensionStatusCode.md +10 -0
  19. data/docs/DimensionUrl.md +10 -0
  20. data/docs/EnabledProductsApi.md +5 -5
  21. data/docs/FilterFieldItem.md +12 -0
  22. data/docs/GetLogInsightsResponse.md +11 -0
  23. data/docs/GetLogRecordsResponse.md +11 -0
  24. data/docs/GetLogRecordsResponseMeta.md +10 -0
  25. data/docs/GetLogRecordsResponseMetaFilters.md +16 -0
  26. data/docs/InsightsApi.md +69 -0
  27. data/docs/KvStoreItemApi.md +2 -0
  28. data/docs/LogExplorerApi.md +65 -0
  29. data/docs/LogInsights.md +12 -0
  30. data/docs/LogInsightsDimensionAttributes.md +49 -0
  31. data/docs/LogInsightsDimensions.md +61 -0
  32. data/docs/LogInsightsMeta.md +10 -0
  33. data/docs/LogInsightsMetaFilter.md +14 -0
  34. data/docs/LogInsightsValues.md +65 -0
  35. data/docs/LogPropertyServiceId.md +9 -0
  36. data/docs/LogRecord.md +37 -0
  37. data/docs/LoggingGrafanacloudlogsAdditional.md +14 -0
  38. data/docs/LoggingGrafanacloudlogsApi.md +259 -0
  39. data/docs/LoggingGrafanacloudlogsResponse.md +23 -0
  40. data/docs/ObjectStorageAccessKeysApi.md +163 -0
  41. data/docs/RealtimeEntryAggregated.md +3 -7
  42. data/docs/RealtimeMeasurements.md +3 -7
  43. data/docs/Results.md +3 -7
  44. data/docs/SetConfiguration.md +1 -0
  45. data/docs/Usagemetric.md +18 -0
  46. data/docs/Usagemetrics.md +10 -0
  47. data/docs/ValueField.md +59 -0
  48. data/docs/Values503Responses.md +12 -0
  49. data/docs/ValuesBandwidth.md +11 -0
  50. data/docs/ValuesBrowser.md +11 -0
  51. data/docs/ValuesCacheHitRatio.md +10 -0
  52. data/docs/ValuesCountryStats.md +12 -0
  53. data/docs/ValuesDuration.md +12 -0
  54. data/docs/ValuesMisses.md +10 -0
  55. data/docs/ValuesRate.md +10 -0
  56. data/docs/ValuesRequests.md +10 -0
  57. data/docs/ValuesStatusCodes.md +12 -0
  58. data/lib/fastly/api/acls_in_compute_api.rb +3 -3
  59. data/lib/fastly/api/billing_usage_metrics_api.rb +30 -57
  60. data/lib/fastly/api/enabled_products_api.rb +10 -10
  61. data/lib/fastly/api/insights_api.rb +125 -0
  62. data/lib/fastly/api/kv_store_item_api.rb +3 -0
  63. data/lib/fastly/api/log_explorer_api.rb +109 -0
  64. data/lib/fastly/api/logging_grafanacloudlogs_api.rb +471 -0
  65. data/lib/fastly/api/object_storage_access_keys_api.rb +263 -0
  66. data/lib/fastly/configuration.rb +67 -1
  67. data/lib/fastly/models/access_key.rb +248 -0
  68. data/lib/fastly/models/access_key_response.rb +269 -0
  69. data/lib/fastly/models/compute_acl_list_entries.rb +1 -1
  70. data/lib/fastly/models/compute_acl_lookup.rb +1 -1
  71. data/lib/fastly/models/compute_acl_update.rb +219 -0
  72. data/lib/fastly/models/compute_acl_update_entry.rb +1 -1
  73. data/lib/fastly/models/dimension_attributes_country_stats.rb +237 -0
  74. data/lib/fastly/models/dimension_attributes_rate.rb +217 -0
  75. data/lib/fastly/models/dimension_browser.rb +217 -0
  76. data/lib/fastly/models/dimension_content_type.rb +217 -0
  77. data/lib/fastly/models/dimension_country.rb +217 -0
  78. data/lib/fastly/models/dimension_device.rb +217 -0
  79. data/lib/fastly/models/dimension_os.rb +217 -0
  80. data/lib/fastly/models/dimension_response.rb +217 -0
  81. data/lib/fastly/models/dimension_status_code.rb +217 -0
  82. data/lib/fastly/models/dimension_url.rb +217 -0
  83. data/lib/fastly/models/filter_field_item.rb +271 -0
  84. data/lib/fastly/models/get_log_insights_response.rb +227 -0
  85. data/lib/fastly/models/get_log_records_response.rb +227 -0
  86. data/lib/fastly/models/get_log_records_response_meta.rb +216 -0
  87. data/lib/fastly/models/get_log_records_response_meta_filters.rb +307 -0
  88. data/lib/fastly/models/log_insights.rb +234 -0
  89. data/lib/fastly/models/log_insights_dimension_attributes.rb +103 -0
  90. data/lib/fastly/models/log_insights_dimensions.rb +109 -0
  91. data/lib/fastly/models/log_insights_meta.rb +217 -0
  92. data/lib/fastly/models/log_insights_meta_filter.rb +284 -0
  93. data/lib/fastly/models/log_insights_values.rb +111 -0
  94. data/lib/fastly/models/log_property_service_id.rb +208 -0
  95. data/lib/fastly/models/log_record.rb +486 -0
  96. data/lib/fastly/models/logging_grafanacloudlogs_additional.rb +257 -0
  97. data/lib/fastly/models/logging_grafanacloudlogs_response.rb +408 -0
  98. data/lib/fastly/models/realtime_entry_aggregated.rb +34 -74
  99. data/lib/fastly/models/realtime_measurements.rb +34 -74
  100. data/lib/fastly/models/results.rb +31 -71
  101. data/lib/fastly/models/set_configuration.rb +14 -4
  102. data/lib/fastly/models/usagemetric.rb +297 -0
  103. data/lib/fastly/models/usagemetrics.rb +218 -0
  104. data/lib/fastly/models/value_field.rb +108 -0
  105. data/lib/fastly/models/values503_responses.rb +237 -0
  106. data/lib/fastly/models/values_bandwidth.rb +227 -0
  107. data/lib/fastly/models/values_browser.rb +227 -0
  108. data/lib/fastly/models/values_cache_hit_ratio.rb +217 -0
  109. data/lib/fastly/models/values_country_stats.rb +237 -0
  110. data/lib/fastly/models/values_duration.rb +237 -0
  111. data/lib/fastly/models/values_misses.rb +217 -0
  112. data/lib/fastly/models/values_rate.rb +217 -0
  113. data/lib/fastly/models/values_requests.rb +217 -0
  114. data/lib/fastly/models/values_status_codes.rb +237 -0
  115. data/lib/fastly/version.rb +1 -1
  116. data/lib/fastly.rb +45 -0
  117. data/sig.json +1 -1
  118. metadata +92 -2
@@ -0,0 +1,65 @@
1
+ # Fastly::LogExplorerApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::LogExplorerApi.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
+ [**get_log_records**](LogExplorerApi.md#get_log_records) | **GET** /observability/log-explorer | Retrieve log records
17
+
18
+
19
+ ## `get_log_records()`
20
+
21
+ ```ruby
22
+ get_log_records(opts): <GetLogRecordsResponse> # Retrieve log records
23
+ ```
24
+
25
+ Retrieves log records.
26
+
27
+ ### Examples
28
+
29
+ ```ruby
30
+ api_instance = Fastly::LogExplorerApi.new
31
+ opts = {
32
+ service_id: 'service_id_example', # String |
33
+ start: 'start_example', # String |
34
+ _end: '_end_example', # String |
35
+ limit: 8.14, # Float |
36
+ next_cursor: 'next_cursor_example', # String |
37
+ filter: 'filter_example', # String |
38
+ }
39
+
40
+ begin
41
+ # Retrieve log records
42
+ result = api_instance.get_log_records(opts)
43
+ p result
44
+ rescue Fastly::ApiError => e
45
+ puts "Error when calling LogExplorerApi->get_log_records: #{e}"
46
+ end
47
+ ```
48
+
49
+ ### Options
50
+
51
+ | Name | Type | Description | Notes |
52
+ | ---- | ---- | ----------- | ----- |
53
+ | **service_id** | **String** | | |
54
+ | **start** | **String** | | |
55
+ | **_end** | **String** | | |
56
+ | **limit** | **Float** | | [optional] |
57
+ | **next_cursor** | **String** | | [optional] |
58
+ | **filter** | **String** | | [optional] |
59
+
60
+ ### Return type
61
+
62
+ [**GetLogRecordsResponse**](GetLogRecordsResponse.md)
63
+
64
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
65
+ [[Back to README]](../../README.md)
@@ -0,0 +1,12 @@
1
+ # Fastly::LogInsights
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dimensions** | [**LogInsightsDimensions**](LogInsightsDimensions.md) | | [optional] |
8
+ | **dimension_attributes** | [**LogInsightsDimensionAttributes**](LogInsightsDimensionAttributes.md) | | [optional] |
9
+ | **values** | [**LogInsightsValues**](LogInsightsValues.md) | | [optional] |
10
+
11
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
+
@@ -0,0 +1,49 @@
1
+ # Fastly::LogInsightsDimensionAttributes
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::LogInsightsDimensionAttributes.fastly_one_of
15
+ # =>
16
+ # [
17
+ # :'DimensionAttributesCountryStats',
18
+ # :'DimensionAttributesRate'
19
+ # ]
20
+ ```
21
+
22
+ ### build
23
+
24
+ Find the appropriate object from the `fastly_one_of` list and casts the data into it.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'fastly'
30
+
31
+ Fastly::LogInsightsDimensionAttributes.build(data)
32
+ # => #<DimensionAttributesCountryStats:0x00007fdd4aab02a0>
33
+
34
+ Fastly::LogInsightsDimensionAttributes.build(data_that_doesnt_match)
35
+ # => nil
36
+ ```
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
+
44
+ #### Return type
45
+
46
+ - `DimensionAttributesCountryStats`
47
+ - `DimensionAttributesRate`
48
+ - `nil` (if no type matches)
49
+
@@ -0,0 +1,61 @@
1
+ # Fastly::LogInsightsDimensions
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::LogInsightsDimensions.fastly_one_of
15
+ # =>
16
+ # [
17
+ # :'DimensionBrowser',
18
+ # :'DimensionContentType',
19
+ # :'DimensionCountry',
20
+ # :'DimensionDevice',
21
+ # :'DimensionOs',
22
+ # :'DimensionResponse',
23
+ # :'DimensionStatusCode',
24
+ # :'DimensionUrl'
25
+ # ]
26
+ ```
27
+
28
+ ### build
29
+
30
+ Find the appropriate object from the `fastly_one_of` list and casts the data into it.
31
+
32
+ #### Example
33
+
34
+ ```ruby
35
+ require 'fastly'
36
+
37
+ Fastly::LogInsightsDimensions.build(data)
38
+ # => #<DimensionBrowser:0x00007fdd4aab02a0>
39
+
40
+ Fastly::LogInsightsDimensions.build(data_that_doesnt_match)
41
+ # => nil
42
+ ```
43
+
44
+ #### Parameters
45
+
46
+ | Name | Type | Description |
47
+ | ---- | ---- | ----------- |
48
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
49
+
50
+ #### Return type
51
+
52
+ - `DimensionBrowser`
53
+ - `DimensionContentType`
54
+ - `DimensionCountry`
55
+ - `DimensionDevice`
56
+ - `DimensionOs`
57
+ - `DimensionResponse`
58
+ - `DimensionStatusCode`
59
+ - `DimensionUrl`
60
+ - `nil` (if no type matches)
61
+
@@ -0,0 +1,10 @@
1
+ # Fastly::LogInsightsMeta
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **filters** | [**LogInsightsMetaFilter**](LogInsightsMetaFilter.md) | | [optional] |
8
+
9
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
+
@@ -0,0 +1,14 @@
1
+ # Fastly::LogInsightsMetaFilter
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **service_id** | **String** | Specifies the ID of the service for which data should be returned. | [optional] |
8
+ | **start** | **String** | Start time for the query as supplied in the request. | [optional] |
9
+ | **_end** | **String** | End time for the query as supplied in the request. | [optional] |
10
+ | **domain_exact_match** | **Boolean** | Value of the `domain_exact_match` filter as supplied in the request. | [optional] |
11
+ | **limit** | **Integer** | Number of records per page. | [optional][default to 20] |
12
+
13
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
14
+
@@ -0,0 +1,65 @@
1
+ # Fastly::LogInsightsValues
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::LogInsightsValues.fastly_one_of
15
+ # =>
16
+ # [
17
+ # :'Values503Responses',
18
+ # :'ValuesBandwidth',
19
+ # :'ValuesBrowser',
20
+ # :'ValuesCacheHitRatio',
21
+ # :'ValuesCountryStats',
22
+ # :'ValuesDuration',
23
+ # :'ValuesMisses',
24
+ # :'ValuesRate',
25
+ # :'ValuesRequests',
26
+ # :'ValuesStatusCodes'
27
+ # ]
28
+ ```
29
+
30
+ ### build
31
+
32
+ Find the appropriate object from the `fastly_one_of` list and casts the data into it.
33
+
34
+ #### Example
35
+
36
+ ```ruby
37
+ require 'fastly'
38
+
39
+ Fastly::LogInsightsValues.build(data)
40
+ # => #<Values503Responses:0x00007fdd4aab02a0>
41
+
42
+ Fastly::LogInsightsValues.build(data_that_doesnt_match)
43
+ # => nil
44
+ ```
45
+
46
+ #### Parameters
47
+
48
+ | Name | Type | Description |
49
+ | ---- | ---- | ----------- |
50
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
51
+
52
+ #### Return type
53
+
54
+ - `Values503Responses`
55
+ - `ValuesBandwidth`
56
+ - `ValuesBrowser`
57
+ - `ValuesCacheHitRatio`
58
+ - `ValuesCountryStats`
59
+ - `ValuesDuration`
60
+ - `ValuesMisses`
61
+ - `ValuesRate`
62
+ - `ValuesRequests`
63
+ - `ValuesStatusCodes`
64
+ - `nil` (if no type matches)
65
+
@@ -0,0 +1,9 @@
1
+ # Fastly::LogPropertyServiceId
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
9
+
data/docs/LogRecord.md ADDED
@@ -0,0 +1,37 @@
1
+ # Fastly::LogRecord
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **customer_id** | **String** | The ID of the Fastly customer that owns the service. | [optional][readonly] |
8
+ | **service_id** | [**LogPropertyServiceId**](LogPropertyServiceId.md) | | [optional] |
9
+ | **timestamp** | **Time** | Timestamp of the request in ISO 8601 format. | [optional] |
10
+ | **client_as_number** | **Integer** | The autonomous system (AS) number of the client. | [optional][readonly] |
11
+ | **client_region** | **String** | The client&#39;s country subdivision code as found in ISO 3166-2. | [optional][readonly] |
12
+ | **client_country_code** | **String** | The two-letter ISO 3166-1 country code for the client. | [optional][readonly] |
13
+ | **client_os_name** | **String** | The name of the operating system installed on the client device. | [optional][readonly] |
14
+ | **client_device_type** | **String** | The type of the client&#39;s device. | [optional][readonly] |
15
+ | **client_browser_name** | **String** | The name of the browser in use on the client device. | [optional][readonly] |
16
+ | **client_browser_version** | **String** | The version of the browser in use on client device. | [optional][readonly] |
17
+ | **fastly_pop** | **String** | The name of the Fastly POP that served this request. | [optional][readonly] |
18
+ | **origin_host** | **String** | The name of the origin host that served this request. | [optional][readonly] |
19
+ | **request_protocol** | **String** | HTTP protocol version in use for this request. For example, HTTP/1.1. | [optional][readonly] |
20
+ | **request_host** | **String** | The name of the request host used for this request. | [optional][readonly] |
21
+ | **request_path** | **String** | The URL path supplied for this request. | [optional][readonly] |
22
+ | **request_method** | **String** | HTTP method sent by the client such as \&quot;GET\&quot; or \&quot;POST\&quot;. | [optional][readonly] |
23
+ | **response_bytes_body** | **Integer** | Body bytes sent to the client in the response. | [optional][readonly] |
24
+ | **response_bytes_header** | **Integer** | Header bytes sent to the client in the response. | [optional][readonly] |
25
+ | **response_content_length** | **Integer** | Total bytes sent to the client in the response. | [optional][readonly] |
26
+ | **response_content_type** | **String** | The content type of the response sent to the client. | [optional][readonly] |
27
+ | **response_reason** | **String** | The HTTP reason phrase returned for this request, if any. | [optional][readonly] |
28
+ | **response_state** | **String** | The state of the request with optional suffixes describing special cases. | [optional][readonly] |
29
+ | **response_status** | **Integer** | The HTTP response code returned for this request. | [optional][readonly] |
30
+ | **response_time** | **Float** | The time since the request started in seconds. | [optional][readonly] |
31
+ | **response_x_cache** | **String** | Indicates whether the request was a HIT or a MISS. | [optional][readonly] |
32
+ | **is_cache_hit** | **Boolean** | Indicates whether this request was fulfilled from cache. | [optional][readonly] |
33
+ | **is_edge** | **Boolean** | Indicates whether the request was handled by a Fastly edge POP. | [optional][readonly] |
34
+ | **is_shield** | **Boolean** | Indicates whether the request was handled by a Fastly shield POP. | [optional][readonly] |
35
+
36
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
37
+
@@ -0,0 +1,14 @@
1
+ # Fastly::LoggingGrafanacloudlogsAdditional
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional] |
8
+ | **user** | **String** | The Grafana Cloud Logs Dataset you want to log to. | [optional] |
9
+ | **url** | **String** | The URL of the Loki instance in your Grafana stack. | [optional] |
10
+ | **token** | **String** | The Grafana Access Policy token with `logs:write` access scoped to your Loki instance. | [optional] |
11
+ | **index** | **String** | The Stream Labels, a JSON string used to identify the stream. | [optional] |
12
+
13
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
14
+
@@ -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
+