fastly 8.9.0 → 9.0.0

data/docs/InsightsApi.md

@@ -0,0 +1,69 @@
+# Fastly::InsightsApi
+
+
+```ruby
+require 'fastly'
+api_instance = Fastly::InsightsApi.new
+```
+
+## Methods
+
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
+[**get_log_insights**](InsightsApi.md#get_log_insights) | **GET** /observability/log-insights | Retrieve log insights
+
+
+## `get_log_insights()`
+
+```ruby
+get_log_insights(opts): <GetLogInsightsResponse> # Retrieve log insights
+```
+
+Retrieves statistics from sampled log records.
+
+### Examples
+
+```ruby
+api_instance = Fastly::InsightsApi.new
+opts = {
+    visualization: 'top-url-by-bandwidth', # String | 
+    service_id: 'service_id_example', # String | 
+    start: 'start_example', # String | 
+    _end: '_end_example', # String | 
+    pops: 'pops_example', # String | 
+    domain: 'domain_example', # String | 
+    domain_exact_match: true, # Boolean | 
+    limit: 8.14, # Float | 
+}
+
+begin
+  # Retrieve log insights
+  result = api_instance.get_log_insights(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling InsightsApi->get_log_insights: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **visualization** | **String** |  |  |
+| **service_id** | **String** |  |  |
+| **start** | **String** |  |  |
+| **_end** | **String** |  |  |
+| **pops** | **String** |  | [optional] |
+| **domain** | **String** |  | [optional] |
+| **domain_exact_match** | **Boolean** |  | [optional] |
+| **limit** | **Float** |  | [optional] |
+
+### Return type
+
+[**GetLogInsightsResponse**](GetLogInsightsResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)

data/docs/KvStoreItemApi.md

@@ -74,6 +74,7 @@ opts = {
     cursor: 'cursor_example', # String | 
     limit: 56, # Integer | 
     prefix: 'prefix_example', # String | 
+    consistency: 'consistency_example', # String | 
 }
 
 begin
@@ -93,6 +94,7 @@ end
 | **cursor** | **String** |  | [optional] |
 | **limit** | **Integer** |  | [optional][default to 100] |
 | **prefix** | **String** |  | [optional] |
+| **consistency** | **String** |  | [optional] |
 
 ### Return type
 

data/docs/LogExplorerApi.md

@@ -0,0 +1,65 @@
+# Fastly::LogExplorerApi
+
+
+```ruby
+require 'fastly'
+api_instance = Fastly::LogExplorerApi.new
+```
+
+## Methods
+
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
+[**get_log_records**](LogExplorerApi.md#get_log_records) | **GET** /observability/log-explorer | Retrieve log records
+
+
+## `get_log_records()`
+
+```ruby
+get_log_records(opts): <GetLogRecordsResponse> # Retrieve log records
+```
+
+Retrieves log records.
+
+### Examples
+
+```ruby
+api_instance = Fastly::LogExplorerApi.new
+opts = {
+    service_id: 'service_id_example', # String | 
+    start: 'start_example', # String | 
+    _end: '_end_example', # String | 
+    limit: 8.14, # Float | 
+    next_cursor: 'next_cursor_example', # String | 
+    filter: 'filter_example', # String | 
+}
+
+begin
+  # Retrieve log records
+  result = api_instance.get_log_records(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling LogExplorerApi->get_log_records: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service_id** | **String** |  |  |
+| **start** | **String** |  |  |
+| **_end** | **String** |  |  |
+| **limit** | **Float** |  | [optional] |
+| **next_cursor** | **String** |  | [optional] |
+| **filter** | **String** |  | [optional] |
+
+### Return type
+
+[**GetLogRecordsResponse**](GetLogRecordsResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)

data/docs/LogInsights.md

@@ -0,0 +1,12 @@
+# Fastly::LogInsights
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dimensions** | [**LogInsightsDimensions**](LogInsightsDimensions.md) |  | [optional] |
+| **dimension_attributes** | [**LogInsightsDimensionAttributes**](LogInsightsDimensionAttributes.md) |  | [optional] |
+| **values** | [**LogInsightsValues**](LogInsightsValues.md) |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/LogInsightsDimensionAttributes.md

@@ -0,0 +1,49 @@
+# Fastly::LogInsightsDimensionAttributes
+
+## Class instance methods
+
+### `fastly_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'fastly'
+
+Fastly::LogInsightsDimensionAttributes.fastly_one_of
+# =>
+# [
+#   :'DimensionAttributesCountryStats',
+#   :'DimensionAttributesRate'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `fastly_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'fastly'
+
+Fastly::LogInsightsDimensionAttributes.build(data)
+# => #<DimensionAttributesCountryStats:0x00007fdd4aab02a0>
+
+Fastly::LogInsightsDimensionAttributes.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `DimensionAttributesCountryStats`
+- `DimensionAttributesRate`
+- `nil` (if no type matches)
+

data/docs/LogInsightsDimensions.md

@@ -0,0 +1,61 @@
+# Fastly::LogInsightsDimensions
+
+## Class instance methods
+
+### `fastly_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'fastly'
+
+Fastly::LogInsightsDimensions.fastly_one_of
+# =>
+# [
+#   :'DimensionBrowser',
+#   :'DimensionContentType',
+#   :'DimensionCountry',
+#   :'DimensionDevice',
+#   :'DimensionOs',
+#   :'DimensionResponse',
+#   :'DimensionStatusCode',
+#   :'DimensionUrl'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `fastly_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'fastly'
+
+Fastly::LogInsightsDimensions.build(data)
+# => #<DimensionBrowser:0x00007fdd4aab02a0>
+
+Fastly::LogInsightsDimensions.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `DimensionBrowser`
+- `DimensionContentType`
+- `DimensionCountry`
+- `DimensionDevice`
+- `DimensionOs`
+- `DimensionResponse`
+- `DimensionStatusCode`
+- `DimensionUrl`
+- `nil` (if no type matches)
+

data/docs/LogInsightsMeta.md

@@ -0,0 +1,10 @@
+# Fastly::LogInsightsMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filters** | [**LogInsightsMetaFilter**](LogInsightsMetaFilter.md) |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/LogInsightsMetaFilter.md

@@ -0,0 +1,14 @@
+# Fastly::LogInsightsMetaFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service_id** | **String** | Specifies the ID of the service for which data should be returned. | [optional] |
+| **start** | **String** | Start time for the query as supplied in the request. | [optional] |
+| **_end** | **String** | End time for the query as supplied in the request. | [optional] |
+| **domain_exact_match** | **Boolean** | Value of the `domain_exact_match` filter as supplied in the request. | [optional] |
+| **limit** | **Integer** | Number of records per page. | [optional][default to 20] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/LogInsightsValues.md

@@ -0,0 +1,65 @@
+# Fastly::LogInsightsValues
+
+## Class instance methods
+
+### `fastly_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'fastly'
+
+Fastly::LogInsightsValues.fastly_one_of
+# =>
+# [
+#   :'Values503Responses',
+#   :'ValuesBandwidth',
+#   :'ValuesBrowser',
+#   :'ValuesCacheHitRatio',
+#   :'ValuesCountryStats',
+#   :'ValuesDuration',
+#   :'ValuesMisses',
+#   :'ValuesRate',
+#   :'ValuesRequests',
+#   :'ValuesStatusCodes'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `fastly_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'fastly'
+
+Fastly::LogInsightsValues.build(data)
+# => #<Values503Responses:0x00007fdd4aab02a0>
+
+Fastly::LogInsightsValues.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Values503Responses`
+- `ValuesBandwidth`
+- `ValuesBrowser`
+- `ValuesCacheHitRatio`
+- `ValuesCountryStats`
+- `ValuesDuration`
+- `ValuesMisses`
+- `ValuesRate`
+- `ValuesRequests`
+- `ValuesStatusCodes`
+- `nil` (if no type matches)
+

data/docs/LogPropertyServiceId.md

@@ -0,0 +1,9 @@
+# Fastly::LogPropertyServiceId
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/LogRecord.md

@@ -0,0 +1,37 @@
+# Fastly::LogRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | The ID of the Fastly customer that owns the service. | [optional][readonly] |
+| **service_id** | [**LogPropertyServiceId**](LogPropertyServiceId.md) |  | [optional] |
+| **timestamp** | **Time** | Timestamp of the request in ISO 8601 format. | [optional] |
+| **client_as_number** | **Integer** | The autonomous system (AS) number of the client. | [optional][readonly] |
+| **client_region** | **String** | The client's country subdivision code as found in ISO 3166-2. | [optional][readonly] |
+| **client_country_code** | **String** | The two-letter ISO 3166-1 country code for the client. | [optional][readonly] |
+| **client_os_name** | **String** | The name of the operating system installed on the client device. | [optional][readonly] |
+| **client_device_type** | **String** | The type of the client's device. | [optional][readonly] |
+| **client_browser_name** | **String** | The name of the browser in use on the client device. | [optional][readonly] |
+| **client_browser_version** | **String** | The version of the browser in use on client device. | [optional][readonly] |
+| **fastly_pop** | **String** | The name of the Fastly POP that served this request. | [optional][readonly] |
+| **origin_host** | **String** | The name of the origin host that served this request. | [optional][readonly] |
+| **request_protocol** | **String** | HTTP protocol version in use for this request. For example, HTTP/1.1. | [optional][readonly] |
+| **request_host** | **String** | The name of the request host used for this request. | [optional][readonly] |
+| **request_path** | **String** | The URL path supplied for this request. | [optional][readonly] |
+| **request_method** | **String** | HTTP method sent by the client such as \"GET\" or \"POST\". | [optional][readonly] |
+| **response_bytes_body** | **Integer** | Body bytes sent to the client in the response. | [optional][readonly] |
+| **response_bytes_header** | **Integer** | Header bytes sent to the client in the response. | [optional][readonly] |
+| **response_content_length** | **Integer** | Total bytes sent to the client in the response. | [optional][readonly] |
+| **response_content_type** | **String** | The content type of the response sent to the client. | [optional][readonly] |
+| **response_reason** | **String** | The HTTP reason phrase returned for this request, if any. | [optional][readonly] |
+| **response_state** | **String** | The state of the request with optional suffixes describing special cases. | [optional][readonly] |
+| **response_status** | **Integer** | The HTTP response code returned for this request. | [optional][readonly] |
+| **response_time** | **Float** | The time since the request started in seconds. | [optional][readonly] |
+| **response_x_cache** | **String** | Indicates whether the request was a HIT or a MISS. | [optional][readonly] |
+| **is_cache_hit** | **Boolean** | Indicates whether this request was fulfilled from cache. | [optional][readonly] |
+| **is_edge** | **Boolean** | Indicates whether the request was handled by a Fastly edge POP. | [optional][readonly] |
+| **is_shield** | **Boolean** | Indicates whether the request was handled by a Fastly shield POP. | [optional][readonly] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/LoggingGrafanacloudlogsAdditional.md

@@ -0,0 +1,14 @@
+# Fastly::LoggingGrafanacloudlogsAdditional
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional] |
+| **user** | **String** | The Grafana Cloud Logs Dataset you want to log to. | [optional] |
+| **url** | **String** | The URL of the Loki instance in your Grafana stack. | [optional] |
+| **token** | **String** | The Grafana Access Policy token with `logs:write` access scoped to your Loki instance. | [optional] |
+| **index** | **String** | The Stream Labels, a JSON string used to identify the stream. | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+