fastly 8.4.0 → 8.6.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +22 -0
- data/Gemfile.lock +1 -1
- data/README.md +15 -2
- data/docs/{RelationshipTlsDnsRecord.md → AsyncResponse.md} +3 -2
- data/docs/BillingInvoicesApi.md +37 -4
- data/docs/BillingUsageMetricsApi.md +111 -0
- data/docs/ContentApi.md +1 -1
- data/docs/CreateDashboardRequest.md +12 -0
- data/docs/Dashboard.md +17 -0
- data/docs/DashboardItem.md +15 -0
- data/docs/DashboardItemPropertyDataSource.md +11 -0
- data/docs/DashboardItemPropertyDataSourcePropertyConfig.md +10 -0
- data/docs/DashboardItemPropertyVisualization.md +11 -0
- data/docs/DashboardItemPropertyVisualizationPropertyConfig.md +12 -0
- data/docs/{RelationshipTlsDnsRecords.md → DashboardPropertyCreatedBy.md} +1 -2
- data/docs/{RelationshipTlsDnsRecordDnsRecord.md → DashboardPropertyUpdatedBy.md} +1 -2
- data/docs/DomainInspectorMeasurements.md +1 -1
- data/docs/{InvoiceResponse.md → EomInvoiceResponse.md} +1 -1
- data/docs/GetServiceLevelUsageResponse.md +10 -0
- data/docs/GetServiceLevelUsageTypesResponse.md +10 -0
- data/docs/IncludedWithTlsConfiguration.md +10 -0
- data/docs/IncludedWithTlsConfigurationItem.md +12 -0
- data/docs/ListDashboardsResponse.md +11 -0
- data/docs/{ListInvoicesResponse.md → ListEomInvoicesResponse.md} +1 -1
- data/docs/LoggingKafkaAdditional.md +1 -1
- data/docs/LoggingKafkaApi.md +2 -2
- data/docs/LoggingKafkaResponse.md +1 -1
- data/docs/LoggingKafkaResponsePost.md +1 -1
- data/docs/LoggingLogentriesAdditional.md +1 -1
- data/docs/LoggingLogentriesApi.md +4 -4
- data/docs/LoggingLogentriesResponse.md +1 -1
- data/docs/LoggingSplunkAdditional.md +1 -1
- data/docs/LoggingSplunkApi.md +4 -4
- data/docs/LoggingSplunkResponse.md +1 -1
- data/docs/LoggingSyslogAdditional.md +1 -1
- data/docs/LoggingSyslogApi.md +4 -4
- data/docs/LoggingSyslogResponse.md +1 -1
- data/docs/{LoggingUseTls.md → LoggingUseTlsString.md} +1 -1
- data/docs/MtdInvoiceResponse.md +15 -0
- data/docs/Mtdinvoice.md +15 -0
- data/docs/Mtdlineitems.md +18 -0
- data/docs/ObservabilityCustomDashboardsApi.md +203 -0
- data/docs/RealtimeEntryAggregated.md +1 -0
- data/docs/RealtimeMeasurements.md +1 -0
- data/docs/RelationshipDefaultEcdsaTlsCertificate.md +10 -0
- data/docs/RelationshipDefaultEcdsaTlsCertificateDefaultEcdsaCertificate.md +10 -0
- data/docs/RelationshipDefaultEcdsaTlsCertificateDefaultEcdsaCertificateData.md +11 -0
- data/docs/RelationshipDefaultTlsCertificate.md +10 -0
- data/docs/RelationshipDefaultTlsCertificateDefaultCertificate.md +10 -0
- data/docs/RelationshipDefaultTlsCertificateDefaultCertificateData.md +11 -0
- data/docs/RelationshipTlsDnsRecordsRequest.md +10 -0
- data/docs/RelationshipTlsDnsRecordsRequestDnsRecords.md +10 -0
- data/docs/RelationshipTlsDnsRecordsRequestDnsRecordsData.md +11 -0
- data/docs/RelationshipTlsDnsRecordsResponse.md +10 -0
- data/docs/RelationshipTlsDnsRecordsResponseDnsRecords.md +10 -0
- data/docs/{RelationshipMemberTlsDnsRecord.md → RelationshipTlsDnsRecordsResponseDnsRecordsData.md} +1 -1
- data/docs/Results.md +1 -0
- data/docs/Serviceusagemetric.md +13 -0
- data/docs/Serviceusagemetrics.md +10 -0
- data/docs/ServiceusagemetricsData.md +16 -0
- data/docs/Serviceusagetype.md +11 -0
- data/docs/Serviceusagetypes.md +10 -0
- data/docs/TlsCertificateBlobResponse.md +10 -0
- data/docs/TlsCertificatesApi.md +38 -0
- data/docs/TlsDnsRecord.md +1 -2
- data/docs/UpdateDashboardRequest.md +12 -0
- data/docs/Values.md +1 -1
- data/lib/fastly/api/billing_invoices_api.rb +62 -6
- data/lib/fastly/api/billing_usage_metrics_api.rb +213 -0
- data/lib/fastly/api/content_api.rb +2 -2
- data/lib/fastly/api/logging_datadog_api.rb +2 -2
- data/lib/fastly/api/logging_kafka_api.rb +2 -2
- data/lib/fastly/api/logging_logentries_api.rb +4 -4
- data/lib/fastly/api/logging_splunk_api.rb +4 -4
- data/lib/fastly/api/logging_syslog_api.rb +4 -4
- data/lib/fastly/api/observability_custom_dashboards_api.rb +333 -0
- data/lib/fastly/api/tls_certificates_api.rb +63 -0
- data/lib/fastly/configuration.rb +54 -0
- data/lib/fastly/models/async_response.rb +225 -0
- data/lib/fastly/models/create_dashboard_request.rb +245 -0
- data/lib/fastly/models/dashboard.rb +290 -0
- data/lib/fastly/models/dashboard_item.rb +368 -0
- data/lib/fastly/models/dashboard_item_property_data_source.rb +271 -0
- data/lib/fastly/models/dashboard_item_property_data_source_property_config.rb +244 -0
- data/lib/fastly/models/dashboard_item_property_visualization.rb +271 -0
- data/lib/fastly/models/dashboard_item_property_visualization_property_config.rb +303 -0
- data/lib/fastly/models/dashboard_property_created_by.rb +208 -0
- data/lib/fastly/models/dashboard_property_updated_by.rb +208 -0
- data/lib/fastly/models/domain_inspector_measurements.rb +1 -1
- data/lib/fastly/models/{invoice_response.rb → eom_invoice_response.rb} +3 -3
- data/lib/fastly/models/get_service_level_usage_response.rb +223 -0
- data/lib/fastly/models/get_service_level_usage_types_response.rb +225 -0
- data/lib/fastly/models/included_with_tls_configuration.rb +218 -0
- data/lib/fastly/models/included_with_tls_configuration_item.rb +237 -0
- data/lib/fastly/models/invoicelineitems.rb +5 -5
- data/lib/fastly/models/list_dashboards_response.rb +229 -0
- data/lib/fastly/models/{list_invoices_response.rb → list_eom_invoices_response.rb} +3 -3
- data/lib/fastly/models/logging_datadog_additional.rb +2 -2
- data/lib/fastly/models/logging_datadog_response.rb +2 -2
- data/lib/fastly/models/logging_kafka_additional.rb +2 -2
- data/lib/fastly/models/logging_kafka_response.rb +2 -2
- data/lib/fastly/models/logging_kafka_response_post.rb +2 -2
- data/lib/fastly/models/logging_logentries_additional.rb +2 -2
- data/lib/fastly/models/logging_logentries_response.rb +2 -2
- data/lib/fastly/models/logging_splunk_additional.rb +2 -2
- data/lib/fastly/models/logging_splunk_response.rb +2 -2
- data/lib/fastly/models/logging_syslog_additional.rb +2 -2
- data/lib/fastly/models/logging_syslog_response.rb +2 -2
- data/lib/fastly/models/{logging_use_tls.rb → logging_use_tls_string.rb} +5 -5
- data/lib/fastly/models/mtd_invoice_response.rb +275 -0
- data/lib/fastly/models/mtdinvoice.rb +268 -0
- data/lib/fastly/models/mtdlineitems.rb +297 -0
- data/lib/fastly/models/realtime_entry_aggregated.rb +14 -4
- data/lib/fastly/models/realtime_measurements.rb +14 -4
- data/lib/fastly/models/relationship_default_ecdsa_tls_certificate.rb +216 -0
- data/lib/fastly/models/relationship_default_ecdsa_tls_certificate_default_ecdsa_certificate.rb +216 -0
- data/lib/fastly/models/relationship_default_ecdsa_tls_certificate_default_ecdsa_certificate_data.rb +228 -0
- data/lib/fastly/models/relationship_default_tls_certificate.rb +216 -0
- data/lib/fastly/models/relationship_default_tls_certificate_default_certificate.rb +216 -0
- data/lib/fastly/models/relationship_default_tls_certificate_default_certificate_data.rb +228 -0
- data/lib/fastly/models/{relationship_tls_dns_records.rb → relationship_tls_dns_records_request.rb} +4 -4
- data/lib/fastly/models/relationship_tls_dns_records_request_dns_records.rb +218 -0
- data/lib/fastly/models/{relationship_member_tls_dns_record.rb → relationship_tls_dns_records_request_dns_records_data.rb} +3 -3
- data/lib/fastly/models/relationship_tls_dns_records_response.rb +216 -0
- data/lib/fastly/models/relationship_tls_dns_records_response_dns_records.rb +218 -0
- data/lib/fastly/models/relationship_tls_dns_records_response_dns_records_data.rb +227 -0
- data/lib/fastly/models/relationships_for_tls_configuration.rb +1 -1
- data/lib/fastly/models/results.rb +11 -1
- data/lib/fastly/models/serviceusagemetric.rb +246 -0
- data/lib/fastly/models/{relationship_tls_dns_record.rb → serviceusagemetrics.rb} +10 -10
- data/lib/fastly/models/serviceusagemetrics_data.rb +276 -0
- data/lib/fastly/models/serviceusagetype.rb +227 -0
- data/lib/fastly/models/{relationship_tls_dns_record_dns_record.rb → serviceusagetypes.rb} +4 -4
- data/lib/fastly/models/tls_certificate_blob_response.rb +217 -0
- data/lib/fastly/models/tls_dns_record.rb +48 -12
- data/lib/fastly/models/update_dashboard_request.rb +240 -0
- data/lib/fastly/models/values.rb +1 -1
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +42 -7
- data/sig.json +1 -1
- metadata +86 -16
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 448ec99e562b3c1676294cb52992811a2299e596ad7c9b415011f3b02396d4c6
|
|
4
|
+
data.tar.gz: 678b891bd1b3cf0570fdb2c5990258b733a6069c6c0f28bf2d46d000086991de
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7cf5b677d87891764c92af9b2b78f0496b2d55524c3f5aefb99ae277c4c1da4da940aa17f711e5052b94a2c25ebef228b705478c21ac3e0c2c5ae629e7828b7e
|
|
7
|
+
data.tar.gz: 7fe8ba6ef682f2d60f44555b0f125ec342e64fa8bc820b6bbd1a5684f55397da39022063f908dff895712179c1369e187709dbf1d04311f5605c82f7fcc9d648
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [v8.6.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.6.0) (2024-08-04)
|
|
4
|
+
|
|
5
|
+
**Enhancements:**
|
|
6
|
+
|
|
7
|
+
- feat(observability): Adds new Observability Custom Dashboards API
|
|
8
|
+
- feat(billing-invoices): Adds month-to-date invoice information
|
|
9
|
+
- feat(billing-usage-metrics): Adds information on service-level usage.
|
|
10
|
+
- feat(tls): Adds an endpoint to get a TLS certificate blob (Limited Availability)
|
|
11
|
+
- feat(stats): Add `origin_offload` metric
|
|
12
|
+
|
|
13
|
+
## [v8.5.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.5.0) (2024-07-01)
|
|
14
|
+
|
|
15
|
+
**Bug fixes:**
|
|
16
|
+
|
|
17
|
+
- fix(logging): For several endpoints, correct use_tls to be string
|
|
18
|
+
|
|
19
|
+
**Enhancements:**
|
|
20
|
+
|
|
21
|
+
- feat(content): `/content/edge_check` endpoint now returns informational values in `hash` when a timeout occurs or when
|
|
22
|
+
an object is too large.
|
|
23
|
+
- feat(logging-datalog): Added additional regions
|
|
24
|
+
|
|
3
25
|
## [v8.4.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.4.0) (2024-06-27)
|
|
4
26
|
|
|
5
27
|
**Bug fixes:**
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -8,7 +8,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
|
|
|
8
8
|
To install via RubyGems, add the following to your project's `Gemfile`:
|
|
9
9
|
|
|
10
10
|
```ruby
|
|
11
|
-
gem 'fastly', '~> 8.
|
|
11
|
+
gem 'fastly', '~> 8.6.0'
|
|
12
12
|
```
|
|
13
13
|
|
|
14
14
|
Then run `bundle install`.
|
|
@@ -102,7 +102,10 @@ Class | Method | Description
|
|
|
102
102
|
[*Fastly::BillingAddressApi*](docs/BillingAddressApi.md) | [**get_billing_addr**](docs/BillingAddressApi.md#get_billing_addr) | Get a billing address
|
|
103
103
|
[*Fastly::BillingAddressApi*](docs/BillingAddressApi.md) | [**update_billing_addr**](docs/BillingAddressApi.md#update_billing_addr) | Update a billing address
|
|
104
104
|
[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**get_invoice_by_invoice_id**](docs/BillingInvoicesApi.md#get_invoice_by_invoice_id) | Get invoice by ID.
|
|
105
|
+
[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**get_month_to_date_invoice**](docs/BillingInvoicesApi.md#get_month_to_date_invoice) | Get month-to-date invoice.
|
|
105
106
|
[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**list_invoices**](docs/BillingInvoicesApi.md#list_invoices) | List of invoices.
|
|
107
|
+
[*Fastly::BillingUsageMetricsApi*](docs/BillingUsageMetricsApi.md) | [**get_service_level_usage**](docs/BillingUsageMetricsApi.md#get_service_level_usage) | Retrieve service-level usage metrics for a product.
|
|
108
|
+
[*Fastly::BillingUsageMetricsApi*](docs/BillingUsageMetricsApi.md) | [**get_service_level_usage_types**](docs/BillingUsageMetricsApi.md#get_service_level_usage_types) | Retrieve product usage types for a customer.
|
|
106
109
|
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**create_cache_settings**](docs/CacheSettingsApi.md#create_cache_settings) | Create a cache settings object
|
|
107
110
|
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**delete_cache_settings**](docs/CacheSettingsApi.md#delete_cache_settings) | Delete a cache settings object
|
|
108
111
|
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**get_cache_settings**](docs/CacheSettingsApi.md#get_cache_settings) | Get a cache settings object
|
|
@@ -414,6 +417,11 @@ Class | Method | Description
|
|
|
414
417
|
[*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**get_mutual_authentication**](docs/MutualAuthenticationApi.md#get_mutual_authentication) | Get a Mutual Authentication
|
|
415
418
|
[*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**list_mutual_authentications**](docs/MutualAuthenticationApi.md#list_mutual_authentications) | List Mutual Authentications
|
|
416
419
|
[*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**patch_mutual_authentication**](docs/MutualAuthenticationApi.md#patch_mutual_authentication) | Update a Mutual Authentication
|
|
420
|
+
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**create_dashboard**](docs/ObservabilityCustomDashboardsApi.md#create_dashboard) | Create a new dashboard
|
|
421
|
+
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**delete_dashboard**](docs/ObservabilityCustomDashboardsApi.md#delete_dashboard) | Delete an existing dashboard
|
|
422
|
+
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**get_dashboard**](docs/ObservabilityCustomDashboardsApi.md#get_dashboard) | Retrieve a dashboard by ID
|
|
423
|
+
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**list_dashboards**](docs/ObservabilityCustomDashboardsApi.md#list_dashboards) | List all custom dashboards
|
|
424
|
+
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**update_dashboard**](docs/ObservabilityCustomDashboardsApi.md#update_dashboard) | Update an existing dashboard
|
|
417
425
|
[*Fastly::OriginInspectorHistoricalApi*](docs/OriginInspectorHistoricalApi.md) | [**get_origin_inspector_historical**](docs/OriginInspectorHistoricalApi.md#get_origin_inspector_historical) | Get historical origin data for a service
|
|
418
426
|
[*Fastly::OriginInspectorRealtimeApi*](docs/OriginInspectorRealtimeApi.md) | [**get_origin_inspector_last120_seconds**](docs/OriginInspectorRealtimeApi.md#get_origin_inspector_last120_seconds) | Get real-time origin data for the last 120 seconds
|
|
419
427
|
[*Fastly::OriginInspectorRealtimeApi*](docs/OriginInspectorRealtimeApi.md) | [**get_origin_inspector_last_max_entries**](docs/OriginInspectorRealtimeApi.md#get_origin_inspector_last_max_entries) | Get a limited number of real-time origin data entries
|
|
@@ -515,6 +523,7 @@ Class | Method | Description
|
|
|
515
523
|
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**create_tls_cert**](docs/TlsCertificatesApi.md#create_tls_cert) | Create a TLS certificate
|
|
516
524
|
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**delete_tls_cert**](docs/TlsCertificatesApi.md#delete_tls_cert) | Delete a TLS certificate
|
|
517
525
|
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**get_tls_cert**](docs/TlsCertificatesApi.md#get_tls_cert) | Get a TLS certificate
|
|
526
|
+
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**get_tls_cert_blob**](docs/TlsCertificatesApi.md#get_tls_cert_blob) | Get a TLS certificate blob (Limited Availability)
|
|
518
527
|
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**list_tls_certs**](docs/TlsCertificatesApi.md#list_tls_certs) | List TLS certificates
|
|
519
528
|
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**update_tls_cert**](docs/TlsCertificatesApi.md#update_tls_cert) | Update a TLS certificate
|
|
520
529
|
[*Fastly::TlsConfigurationsApi*](docs/TlsConfigurationsApi.md) | [**get_tls_config**](docs/TlsConfigurationsApi.md#get_tls_config) | Get a TLS configuration
|
|
@@ -612,6 +621,8 @@ The fastly-ruby API client currently does not support the following endpoints:
|
|
|
612
621
|
- [`/alerts/definitions/{definition_id}`](https://www.fastly.com/documentation/reference/api/observability/alerts/definitions) (DELETE, GET, PUT)
|
|
613
622
|
- [`/alerts/definitions`](https://www.fastly.com/documentation/reference/api/observability/alerts/definitions) (GET, POST)
|
|
614
623
|
- [`/alerts/history`](https://www.fastly.com/documentation/reference/api/observability/alerts/history) (GET)
|
|
624
|
+
- [`/dns/configurations/{dns_configuration_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
|
|
625
|
+
- [`/dns/configurations`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
|
|
615
626
|
- [`/notifications/integration-types`](https://developer.fastly.com/reference/api/observability/notification) (GET)
|
|
616
627
|
- [`/notifications/integrations/{integration_id}/rotateSigningKey`](https://developer.fastly.com/reference/api/observability/notification) (POST)
|
|
617
628
|
- [`/notifications/integrations/{integration_id}/signingKey`](https://developer.fastly.com/reference/api/observability/notification) (GET)
|
|
@@ -621,7 +632,9 @@ The fastly-ruby API client currently does not support the following endpoints:
|
|
|
621
632
|
- [`/resources/stores/kv/{store_id}/batch`](https://www.fastly.com/documentation/reference/api/services/resources/kv-store-item) (PUT)
|
|
622
633
|
- [`/tls/activations/{tls_activation_id}`](https://www.fastly.com/documentation/reference/api/tls/mutual-tls/activations) (GET, PATCH)
|
|
623
634
|
- [`/tls/activations`](https://www.fastly.com/documentation/reference/api/tls/mutual-tls/activations) (GET)
|
|
624
|
-
- [`/tls/
|
|
635
|
+
- [`/tls/configurations/{tls_configuration_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
|
|
636
|
+
- [`/tls/configurations`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
|
|
637
|
+
- [`/tls/preview/domains/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (GET, PATCH)
|
|
625
638
|
- [`/tls/preview/domains`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
|
|
626
639
|
- [`/v1/channel/{service_id}/ts/h/limit/{max_entries}`](https://www.fastly.com/documentation/reference/api/metrics-stats/origin-insights) (GET)
|
|
627
640
|
- [`/v1/channel/{service_id}/ts/h`](https://www.fastly.com/documentation/reference/api/metrics-stats/origin-insights) (GET)
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
# Fastly::
|
|
1
|
+
# Fastly::AsyncResponse
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **status** | **String** | | [optional] |
|
|
8
9
|
|
|
9
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
11
|
|
data/docs/BillingInvoicesApi.md
CHANGED
|
@@ -14,13 +14,14 @@ api_instance = Fastly::BillingInvoicesApi.new
|
|
|
14
14
|
Method | HTTP request | Description
|
|
15
15
|
------ | ------------ | -----------
|
|
16
16
|
[**get_invoice_by_invoice_id**](BillingInvoicesApi.md#get_invoice_by_invoice_id) | **GET** /billing/v3/invoices/{invoice_id} | Get invoice by ID.
|
|
17
|
+
[**get_month_to_date_invoice**](BillingInvoicesApi.md#get_month_to_date_invoice) | **GET** /billing/v3/invoices/month-to-date | Get month-to-date invoice.
|
|
17
18
|
[**list_invoices**](BillingInvoicesApi.md#list_invoices) | **GET** /billing/v3/invoices | List of invoices.
|
|
18
19
|
|
|
19
20
|
|
|
20
21
|
## `get_invoice_by_invoice_id()`
|
|
21
22
|
|
|
22
23
|
```ruby
|
|
23
|
-
get_invoice_by_invoice_id(opts): <
|
|
24
|
+
get_invoice_by_invoice_id(opts): <EomInvoiceResponse> # Get invoice by ID.
|
|
24
25
|
```
|
|
25
26
|
|
|
26
27
|
Returns invoice associated with the invoice id.
|
|
@@ -50,14 +51,46 @@ end
|
|
|
50
51
|
|
|
51
52
|
### Return type
|
|
52
53
|
|
|
53
|
-
[**
|
|
54
|
+
[**EomInvoiceResponse**](EomInvoiceResponse.md)
|
|
55
|
+
|
|
56
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
57
|
+
[[Back to README]](../../README.md)
|
|
58
|
+
## `get_month_to_date_invoice()`
|
|
59
|
+
|
|
60
|
+
```ruby
|
|
61
|
+
get_month_to_date_invoice: <MtdInvoiceResponse> # Get month-to-date invoice.
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Returns month-to-date invoice for the current month.
|
|
65
|
+
|
|
66
|
+
### Examples
|
|
67
|
+
|
|
68
|
+
```ruby
|
|
69
|
+
api_instance = Fastly::BillingInvoicesApi.new
|
|
70
|
+
|
|
71
|
+
begin
|
|
72
|
+
# Get month-to-date invoice.
|
|
73
|
+
result = api_instance.get_month_to_date_invoice
|
|
74
|
+
p result
|
|
75
|
+
rescue Fastly::ApiError => e
|
|
76
|
+
puts "Error when calling BillingInvoicesApi->get_month_to_date_invoice: #{e}"
|
|
77
|
+
end
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Options
|
|
81
|
+
|
|
82
|
+
This endpoint does not need any parameter.
|
|
83
|
+
|
|
84
|
+
### Return type
|
|
85
|
+
|
|
86
|
+
[**MtdInvoiceResponse**](MtdInvoiceResponse.md)
|
|
54
87
|
|
|
55
88
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
56
89
|
[[Back to README]](../../README.md)
|
|
57
90
|
## `list_invoices()`
|
|
58
91
|
|
|
59
92
|
```ruby
|
|
60
|
-
list_invoices(opts): <
|
|
93
|
+
list_invoices(opts): <ListEomInvoicesResponse> # List of invoices.
|
|
61
94
|
```
|
|
62
95
|
|
|
63
96
|
Returns the list of invoices, sorted by billing start date (newest to oldest).
|
|
@@ -93,7 +126,7 @@ end
|
|
|
93
126
|
|
|
94
127
|
### Return type
|
|
95
128
|
|
|
96
|
-
[**
|
|
129
|
+
[**ListEomInvoicesResponse**](ListEomInvoicesResponse.md)
|
|
97
130
|
|
|
98
131
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
99
132
|
[[Back to README]](../../README.md)
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# Fastly::BillingUsageMetricsApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::BillingUsageMetricsApi.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_service_level_usage**](BillingUsageMetricsApi.md#get_service_level_usage) | **GET** /billing/v2/account_customers/{customer_id}/service-usage-metrics | Retrieve service-level usage metrics for a product.
|
|
17
|
+
[**get_service_level_usage_types**](BillingUsageMetricsApi.md#get_service_level_usage_types) | **GET** /billing/v2/account_customers/{customer_id}/service-usage-types | Retrieve product usage types for a customer.
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## `get_service_level_usage()`
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
get_service_level_usage(opts): <Serviceusagemetrics> # Retrieve service-level usage metrics for a product.
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Returns product usage, broken down by service.
|
|
27
|
+
|
|
28
|
+
### Examples
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
api_instance = Fastly::BillingUsageMetricsApi.new
|
|
32
|
+
opts = {
|
|
33
|
+
customer_id: 'customer_id_example', # String | Alphanumeric string identifying the customer.
|
|
34
|
+
product_id: 'product_id_example', # String | The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests.
|
|
35
|
+
usage_type_name: 'usage_type_name_example', # String | The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests.
|
|
36
|
+
time_granularity: 'time_granularity_example', # String |
|
|
37
|
+
start_date: '2023-01-01', # String |
|
|
38
|
+
end_date: '2023-01-31', # String |
|
|
39
|
+
start_month: '2023-01', # String |
|
|
40
|
+
end_month: '2023-03', # String |
|
|
41
|
+
limit: 'limit_example', # String | Number of results per page. The maximum is 100.
|
|
42
|
+
cursor: 'cursor_example', # String | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
begin
|
|
46
|
+
# Retrieve service-level usage metrics for a product.
|
|
47
|
+
result = api_instance.get_service_level_usage(opts)
|
|
48
|
+
p result
|
|
49
|
+
rescue Fastly::ApiError => e
|
|
50
|
+
puts "Error when calling BillingUsageMetricsApi->get_service_level_usage: #{e}"
|
|
51
|
+
end
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Options
|
|
55
|
+
|
|
56
|
+
| Name | Type | Description | Notes |
|
|
57
|
+
| ---- | ---- | ----------- | ----- |
|
|
58
|
+
| **customer_id** | **String** | Alphanumeric string identifying the customer. | |
|
|
59
|
+
| **product_id** | **String** | The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests. | |
|
|
60
|
+
| **usage_type_name** | **String** | The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests. | |
|
|
61
|
+
| **time_granularity** | **String** | | |
|
|
62
|
+
| **start_date** | **String** | | [optional] |
|
|
63
|
+
| **end_date** | **String** | | [optional] |
|
|
64
|
+
| **start_month** | **String** | | [optional] |
|
|
65
|
+
| **end_month** | **String** | | [optional] |
|
|
66
|
+
| **limit** | **String** | Number of results per page. The maximum is 100. | [optional][default to '5'] |
|
|
67
|
+
| **cursor** | **String** | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty. | [optional] |
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
[**Serviceusagemetrics**](Serviceusagemetrics.md)
|
|
72
|
+
|
|
73
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
74
|
+
[[Back to README]](../../README.md)
|
|
75
|
+
## `get_service_level_usage_types()`
|
|
76
|
+
|
|
77
|
+
```ruby
|
|
78
|
+
get_service_level_usage_types(opts): <Serviceusagetypes> # Retrieve product usage types for a customer.
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Returns product usage types reported by the customer's services.
|
|
82
|
+
|
|
83
|
+
### Examples
|
|
84
|
+
|
|
85
|
+
```ruby
|
|
86
|
+
api_instance = Fastly::BillingUsageMetricsApi.new
|
|
87
|
+
opts = {
|
|
88
|
+
customer_id: 'customer_id_example', # String | Alphanumeric string identifying the customer.
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
begin
|
|
92
|
+
# Retrieve product usage types for a customer.
|
|
93
|
+
result = api_instance.get_service_level_usage_types(opts)
|
|
94
|
+
p result
|
|
95
|
+
rescue Fastly::ApiError => e
|
|
96
|
+
puts "Error when calling BillingUsageMetricsApi->get_service_level_usage_types: #{e}"
|
|
97
|
+
end
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Options
|
|
101
|
+
|
|
102
|
+
| Name | Type | Description | Notes |
|
|
103
|
+
| ---- | ---- | ----------- | ----- |
|
|
104
|
+
| **customer_id** | **String** | Alphanumeric string identifying the customer. | |
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
[**Serviceusagetypes**](Serviceusagetypes.md)
|
|
109
|
+
|
|
110
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
111
|
+
[[Back to README]](../../README.md)
|
data/docs/ContentApi.md
CHANGED
|
@@ -22,7 +22,7 @@ Method | HTTP request | Description
|
|
|
22
22
|
content_check(opts): <Array<Content>> # Check status of content in each POP's cache
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour.
|
|
25
|
+
Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour. If the content takes too long to download, the hash will be set to `error-timeout-$pop`. If the response is too large, it will be set to `warning-too-large-$pop`.
|
|
26
26
|
|
|
27
27
|
### Examples
|
|
28
28
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::CreateDashboardRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | A human-readable name | |
|
|
8
|
+
| **description** | **String** | A short description of the dashboard | [optional] |
|
|
9
|
+
| **items** | [**Array<DashboardItem>**](DashboardItem.md) | A list of [dashboard items](#dashboard-item). | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
data/docs/Dashboard.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Fastly::Dashboard
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Dashboard identifier (UUID) | [optional][readonly] |
|
|
8
|
+
| **name** | **String** | A human-readable name | [optional] |
|
|
9
|
+
| **description** | **String** | A short description of the dashboard | [optional] |
|
|
10
|
+
| **items** | [**Array<DashboardItem>**](DashboardItem.md) | A list of [dashboard items](#dashboard-item). | [optional] |
|
|
11
|
+
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
12
|
+
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
13
|
+
| **created_by** | [**DashboardPropertyCreatedBy**](DashboardPropertyCreatedBy.md) | | [optional] |
|
|
14
|
+
| **updated_by** | [**DashboardPropertyUpdatedBy**](DashboardPropertyUpdatedBy.md) | | [optional] |
|
|
15
|
+
|
|
16
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
17
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Fastly::DashboardItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | A human-readable title for the dashboard item | |
|
|
8
|
+
| **subtitle** | **String** | A human-readable subtitle for the dashboard item. Often a description of the visualization. | |
|
|
9
|
+
| **data_source** | [**DashboardItemPropertyDataSource**](DashboardItemPropertyDataSource.md) | | |
|
|
10
|
+
| **visualization** | [**DashboardItemPropertyVisualization**](DashboardItemPropertyVisualization.md) | | |
|
|
11
|
+
| **id** | **String** | Dashboard item identifier (UUID) | [optional][readonly] |
|
|
12
|
+
| **span** | **Integer** | The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on \"desktop\" screen sizes. | [optional][default to 4] |
|
|
13
|
+
|
|
14
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
15
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::DashboardItemPropertyDataSource
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The source of the data to display. | |
|
|
8
|
+
| **config** | [**DashboardItemPropertyDataSourcePropertyConfig**](DashboardItemPropertyDataSourcePropertyConfig.md) | | |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::DashboardItemPropertyDataSourcePropertyConfig
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **metrics** | **Array<String>** | The metrics to visualize. Valid options are defined by the selected [data source](#field_data_source). | |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::DashboardItemPropertyVisualization
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of visualization to display. | |
|
|
8
|
+
| **config** | [**DashboardItemPropertyVisualizationPropertyConfig**](DashboardItemPropertyVisualizationPropertyConfig.md) | | |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::DashboardItemPropertyVisualizationPropertyConfig
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **plot_type** | **String** | The type of chart to display. | |
|
|
8
|
+
| **format** | **String** | (Optional) The units to use to format the data. | [optional][default to 'number'] |
|
|
9
|
+
| **calculation_method** | **String** | (Optional) The aggregation function to apply to the dataset. | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
# Fastly::
|
|
1
|
+
# Fastly::DashboardPropertyCreatedBy
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **dns_records** | [**RelationshipTlsDnsRecordDnsRecord**](RelationshipTlsDnsRecordDnsRecord.md) | | [optional] |
|
|
8
7
|
|
|
9
8
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
9
|
|
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
# Fastly::
|
|
1
|
+
# Fastly::DashboardPropertyUpdatedBy
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **data** | [**Array<RelationshipMemberTlsDnsRecord>**](RelationshipMemberTlsDnsRecord.md) | | [optional] |
|
|
8
7
|
|
|
9
8
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
9
|
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
| **origin_fetch_resp_body_bytes** | **Integer** | Total body bytes received from origin. | [optional] |
|
|
43
43
|
| **bandwidth** | **Integer** | Total bytes delivered (`resp_header_bytes` + `resp_body_bytes` + `bereq_header_bytes` + `bereq_body_bytes`). | [optional] |
|
|
44
44
|
| **edge_hit_ratio** | **Float** | Ratio of cache hits to cache misses at the edge, between 0 and 1 (`edge_hit_requests` / (`edge_hit_requests` + `edge_miss_requests`)). | [optional] |
|
|
45
|
-
| **origin_offload** | **Float** |
|
|
45
|
+
| **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`). Previously, Origin Offload used a different formula. [Learn more](https://www.fastly.com/documentation/reference/changes/2024/06/add-origin_offload-metric). | [optional] |
|
|
46
46
|
| **origin_status_200** | **Integer** | Number of responses received from origin with status code 200 (Success). | [optional] |
|
|
47
47
|
| **origin_status_204** | **Integer** | Number of responses received from origin with status code 204 (No Content). | [optional] |
|
|
48
48
|
| **origin_status_206** | **Integer** | Number of responses received from origin with status code 206 (Partial Content). | [optional] |
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::GetServiceLevelUsageResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**ServiceusagemetricsData**](ServiceusagemetricsData.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::GetServiceLevelUsageTypesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<Serviceusagetype>**](Serviceusagetype.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::IncludedWithTlsConfiguration
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **included** | [**Array<IncludedWithTlsConfigurationItem>**](IncludedWithTlsConfigurationItem.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::IncludedWithTlsConfigurationItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The IP address or hostname of the DNS record. | [optional] |
|
|
8
|
+
| **type** | [**TypeTlsDnsRecord**](TypeTlsDnsRecord.md) | | [optional][default to 'dns_record'] |
|
|
9
|
+
| **attributes** | [**TlsDnsRecord**](TlsDnsRecord.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::ListDashboardsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<Dashboard>**](Dashboard.md) | | [optional] |
|
|
8
|
+
| **meta** | **Object** | Meta for the pagination. | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
| **auth_method** | **String** | SASL authentication method. | [optional] |
|
|
14
14
|
| **user** | **String** | SASL user. | [optional] |
|
|
15
15
|
| **password** | **String** | SASL password. | [optional] |
|
|
16
|
-
| **use_tls** | [**
|
|
16
|
+
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to '0'] |
|
|
17
17
|
|
|
18
18
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
19
19
|
|
data/docs/LoggingKafkaApi.md
CHANGED
|
@@ -53,7 +53,7 @@ opts = {
|
|
|
53
53
|
auth_method: 'plain', # String | SASL authentication method.
|
|
54
54
|
user: 'user_example', # String | SASL user.
|
|
55
55
|
password: 'password_example', # String | SASL password.
|
|
56
|
-
use_tls: Fastly::
|
|
56
|
+
use_tls: Fastly::LoggingUseTlsString::no_tls, # LoggingUseTlsString |
|
|
57
57
|
}
|
|
58
58
|
|
|
59
59
|
begin
|
|
@@ -89,7 +89,7 @@ end
|
|
|
89
89
|
| **auth_method** | **String** | SASL authentication method. | [optional] |
|
|
90
90
|
| **user** | **String** | SASL user. | [optional] |
|
|
91
91
|
| **password** | **String** | SASL password. | [optional] |
|
|
92
|
-
| **use_tls** | [**
|
|
92
|
+
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to '0'] |
|
|
93
93
|
|
|
94
94
|
### Return type
|
|
95
95
|
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
| **auth_method** | **String** | SASL authentication method. | [optional] |
|
|
28
28
|
| **user** | **String** | SASL user. | [optional] |
|
|
29
29
|
| **password** | **String** | SASL password. | [optional] |
|
|
30
|
-
| **use_tls** | [**
|
|
30
|
+
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to '0'] |
|
|
31
31
|
|
|
32
32
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
33
33
|
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
| **auth_method** | **String** | SASL authentication method. | [optional] |
|
|
28
28
|
| **user** | **String** | SASL user. | [optional] |
|
|
29
29
|
| **password** | **String** | SASL password. | [optional] |
|
|
30
|
-
| **use_tls** | [**
|
|
30
|
+
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to '0'] |
|
|
31
31
|
|
|
32
32
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
33
33
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **port** | **Integer** | The port number. | [optional][default to 20000] |
|
|
8
8
|
| **token** | **String** | Use token based authentication. | [optional] |
|
|
9
|
-
| **use_tls** | [**
|
|
9
|
+
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to '0'] |
|
|
10
10
|
| **region** | **String** | The region to which to stream logs. | [optional] |
|
|
11
11
|
|
|
12
12
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
@@ -42,7 +42,7 @@ opts = {
|
|
|
42
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
43
|
port: 56, # Integer | The port number.
|
|
44
44
|
token: 'token_example', # String | Use token based authentication.
|
|
45
|
-
use_tls: Fastly::
|
|
45
|
+
use_tls: Fastly::LoggingUseTlsString::no_tls, # LoggingUseTlsString |
|
|
46
46
|
region: 'US', # String | The region to which to stream logs.
|
|
47
47
|
}
|
|
48
48
|
|
|
@@ -68,7 +68,7 @@ end
|
|
|
68
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
69
|
| **port** | **Integer** | The port number. | [optional][default to 20000] |
|
|
70
70
|
| **token** | **String** | Use token based authentication. | [optional] |
|
|
71
|
-
| **use_tls** | [**
|
|
71
|
+
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to '0'] |
|
|
72
72
|
| **region** | **String** | The region to which to stream logs. | [optional] |
|
|
73
73
|
|
|
74
74
|
### Return type
|
|
@@ -221,7 +221,7 @@ opts = {
|
|
|
221
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
222
|
port: 56, # Integer | The port number.
|
|
223
223
|
token: 'token_example', # String | Use token based authentication.
|
|
224
|
-
use_tls: Fastly::
|
|
224
|
+
use_tls: Fastly::LoggingUseTlsString::no_tls, # LoggingUseTlsString |
|
|
225
225
|
region: 'US', # String | The region to which to stream logs.
|
|
226
226
|
}
|
|
227
227
|
|
|
@@ -248,7 +248,7 @@ end
|
|
|
248
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
249
|
| **port** | **Integer** | The port number. | [optional][default to 20000] |
|
|
250
250
|
| **token** | **String** | Use token based authentication. | [optional] |
|
|
251
|
-
| **use_tls** | [**
|
|
251
|
+
| **use_tls** | [**LoggingUseTlsString**](LoggingUseTlsString.md) | | [optional][default to '0'] |
|
|
252
252
|
| **region** | **String** | The region to which to stream logs. | [optional] |
|
|
253
253
|
|
|
254
254
|
### Return type
|