fastly 13.0.0 → 14.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +43 -0
- data/Gemfile.lock +4 -4
- data/README.md +21 -6
- data/docs/AttackReport.md +19 -0
- data/docs/AttackSignal.md +12 -0
- data/docs/AttackSource.md +13 -0
- data/docs/Backend.md +6 -6
- data/docs/BackendApi.md +18 -18
- data/docs/BackendResponse.md +6 -6
- data/docs/DdosProtectionApi.md +40 -0
- data/docs/DdosProtectionAttributeStats.md +1 -1
- data/docs/DdosProtectionInvalidRequest.md +13 -0
- data/docs/DdosProtectionNotAuthorized.md +11 -0
- data/docs/DdosProtectionRule.md +1 -1
- data/docs/DdosProtectionRuleAllOf.md +1 -1
- data/docs/DdosProtectionRulePatch.md +10 -0
- data/docs/HistoricalApi.md +2 -0
- data/docs/Invitation.md +1 -1
- data/docs/InvitationCreateData.md +12 -0
- data/docs/InvitationCreateDataAllOf.md +10 -0
- data/docs/{InvitationResponse.md → InvitationCreateResponse.md} +1 -1
- data/docs/{InvitationResponseAllOf.md → InvitationCreateResponseAllOf.md} +1 -1
- data/docs/InvitationData.md +0 -1
- data/docs/InvitationResponseData.md +1 -1
- data/docs/InvitationsApi.md +2 -2
- data/docs/KvStoreApi.md +2 -0
- data/docs/ListAttackReport.md +11 -0
- data/docs/{DdosProtectionTrafficAttribute.md → ListAttackReportMeta.md} +2 -1
- data/docs/{DdosProtectionAction.md → ListSignalReport.md} +2 -1
- data/docs/LogExplorerApi.md +1 -1
- data/docs/LoggingAzureblobApi.md +8 -4
- data/docs/LoggingAzureblobResponse.md +2 -1
- data/docs/LoggingBigqueryAdditional.md +1 -1
- data/docs/LoggingBigqueryApi.md +8 -4
- data/docs/LoggingBigqueryResponse.md +2 -1
- data/docs/LoggingCloudfilesApi.md +8 -4
- data/docs/LoggingCloudfilesResponse.md +2 -1
- data/docs/LoggingCommon.md +2 -1
- data/docs/LoggingCommonResponse.md +2 -1
- data/docs/LoggingCommonResponseAllOf.md +2 -1
- data/docs/LoggingDatadogAdditional.md +1 -1
- data/docs/LoggingDatadogApi.md +8 -4
- data/docs/LoggingDatadogResponse.md +2 -1
- data/docs/LoggingDigitaloceanApi.md +8 -4
- data/docs/LoggingDigitaloceanResponse.md +2 -1
- data/docs/LoggingElasticsearchAdditional.md +1 -1
- data/docs/LoggingElasticsearchApi.md +8 -4
- data/docs/LoggingElasticsearchResponse.md +2 -1
- data/docs/LoggingFtpApi.md +8 -4
- data/docs/LoggingFtpResponse.md +2 -1
- data/docs/LoggingGcsApi.md +8 -4
- data/docs/LoggingGcsResponse.md +2 -1
- data/docs/LoggingGooglePubsubAdditional.md +1 -1
- data/docs/LoggingGooglePubsubResponse.md +2 -1
- data/docs/LoggingGrafanacloudlogsAdditional.md +1 -1
- data/docs/LoggingGrafanacloudlogsApi.md +8 -4
- data/docs/LoggingGrafanacloudlogsResponse.md +2 -1
- data/docs/LoggingHerokuApi.md +8 -4
- data/docs/LoggingHerokuResponse.md +2 -1
- data/docs/LoggingHoneycombAdditional.md +1 -1
- data/docs/LoggingHoneycombApi.md +8 -4
- data/docs/LoggingHoneycombResponse.md +2 -1
- data/docs/LoggingHttpsAdditional.md +1 -1
- data/docs/LoggingHttpsApi.md +8 -4
- data/docs/LoggingHttpsResponse.md +2 -1
- data/docs/LoggingKafkaApi.md +4 -2
- data/docs/LoggingKafkaResponse.md +2 -1
- data/docs/LoggingKafkaResponsePost.md +2 -1
- data/docs/LoggingKinesisAdditional.md +1 -1
- data/docs/LoggingKinesisApi.md +2 -2
- data/docs/LoggingKinesisResponse.md +1 -1
- data/docs/LoggingLogentriesApi.md +8 -4
- data/docs/LoggingLogentriesResponse.md +2 -1
- data/docs/LoggingLogglyApi.md +8 -4
- data/docs/LoggingLogglyResponse.md +2 -1
- data/docs/LoggingLogshuttleApi.md +8 -4
- data/docs/LoggingLogshuttleResponse.md +2 -1
- data/docs/LoggingNewrelicAdditional.md +1 -1
- data/docs/LoggingNewrelicApi.md +8 -4
- data/docs/LoggingNewrelicResponse.md +2 -1
- data/docs/LoggingNewrelicotlpAdditional.md +1 -1
- data/docs/LoggingNewrelicotlpApi.md +8 -4
- data/docs/LoggingNewrelicotlpResponse.md +2 -1
- data/docs/LoggingOpenstackApi.md +8 -4
- data/docs/LoggingOpenstackResponse.md +2 -1
- data/docs/LoggingPapertrailApi.md +8 -4
- data/docs/LoggingPapertrailResponse.md +2 -1
- data/docs/LoggingPubsubApi.md +8 -4
- data/docs/LoggingS3Api.md +8 -4
- data/docs/LoggingS3Response.md +2 -1
- data/docs/LoggingScalyrApi.md +8 -4
- data/docs/LoggingScalyrResponse.md +2 -1
- data/docs/LoggingSftpApi.md +8 -4
- data/docs/LoggingSftpResponse.md +2 -1
- data/docs/LoggingSplunkApi.md +8 -4
- data/docs/LoggingSplunkResponse.md +2 -1
- data/docs/LoggingSumologicApi.md +8 -4
- data/docs/LoggingSumologicResponse.md +2 -1
- data/docs/LoggingSyslogApi.md +8 -4
- data/docs/LoggingSyslogResponse.md +2 -1
- data/docs/NgwafReportsApi.md +99 -0
- data/docs/ObservabilityTimeseriesApi.md +67 -0
- data/docs/PoolAdditional.md +1 -1
- data/docs/PoolApi.md +8 -8
- data/docs/PoolResponse.md +2 -2
- data/docs/PoolResponseCommon.md +1 -1
- data/docs/PoolResponsePost.md +2 -2
- data/docs/PurgeApi.md +1 -1
- data/docs/SignalReport.md +13 -0
- data/docs/TimeseriesGetResponse.md +11 -0
- data/docs/TimeseriesMeta.md +13 -0
- data/docs/TimeseriesResult.md +11 -0
- data/docs/TlsCertificateDataAttributes.md +1 -0
- data/docs/TlsCsrData.md +0 -1
- data/docs/TlsCsrDataAttributes.md +1 -0
- data/docs/TlsSubscriptionsApi.md +0 -2
- data/docs/TopWorkspace.md +12 -0
- data/lib/fastly/api/backend_api.rb +24 -24
- data/lib/fastly/api/ddos_protection_api.rb +70 -0
- data/lib/fastly/api/historical_api.rb +3 -0
- data/lib/fastly/api/invitations_api.rb +3 -3
- data/lib/fastly/api/kv_store_api.rb +3 -0
- data/lib/fastly/api/logging_azureblob_api.rb +18 -4
- data/lib/fastly/api/logging_bigquery_api.rb +18 -4
- data/lib/fastly/api/logging_cloudfiles_api.rb +18 -4
- data/lib/fastly/api/logging_datadog_api.rb +18 -4
- data/lib/fastly/api/logging_digitalocean_api.rb +18 -4
- data/lib/fastly/api/logging_elasticsearch_api.rb +18 -4
- data/lib/fastly/api/logging_ftp_api.rb +18 -4
- data/lib/fastly/api/logging_gcs_api.rb +18 -4
- data/lib/fastly/api/logging_grafanacloudlogs_api.rb +18 -4
- data/lib/fastly/api/logging_heroku_api.rb +18 -4
- data/lib/fastly/api/logging_honeycomb_api.rb +18 -4
- data/lib/fastly/api/logging_https_api.rb +18 -4
- data/lib/fastly/api/logging_kafka_api.rb +9 -2
- data/lib/fastly/api/logging_kinesis_api.rb +2 -2
- data/lib/fastly/api/logging_logentries_api.rb +18 -4
- data/lib/fastly/api/logging_loggly_api.rb +18 -4
- data/lib/fastly/api/logging_logshuttle_api.rb +18 -4
- data/lib/fastly/api/logging_newrelic_api.rb +18 -4
- data/lib/fastly/api/logging_newrelicotlp_api.rb +18 -4
- data/lib/fastly/api/logging_openstack_api.rb +18 -4
- data/lib/fastly/api/logging_papertrail_api.rb +18 -4
- data/lib/fastly/api/logging_pubsub_api.rb +18 -4
- data/lib/fastly/api/logging_s3_api.rb +18 -4
- data/lib/fastly/api/logging_scalyr_api.rb +18 -4
- data/lib/fastly/api/logging_sftp_api.rb +18 -4
- data/lib/fastly/api/logging_splunk_api.rb +18 -4
- data/lib/fastly/api/logging_sumologic_api.rb +18 -4
- data/lib/fastly/api/logging_syslog_api.rb +18 -4
- data/lib/fastly/api/ngwaf_reports_api.rb +161 -0
- data/lib/fastly/api/{observability_timeseries_for_logs_api.rb → observability_timeseries_api.rb} +38 -43
- data/lib/fastly/api/pool_api.rb +8 -8
- data/lib/fastly/api/purge_api.rb +2 -2
- data/lib/fastly/api/tls_subscriptions_api.rb +0 -3
- data/lib/fastly/configuration.rb +19 -1
- data/lib/fastly/models/attack_report.rb +359 -0
- data/lib/fastly/models/attack_signal.rb +252 -0
- data/lib/fastly/models/attack_source.rb +267 -0
- data/lib/fastly/models/backend.rb +9 -4
- data/lib/fastly/models/backend_response.rb +9 -4
- data/lib/fastly/models/ddos_protection_attribute_stats.rb +2 -1
- data/lib/fastly/models/ddos_protection_invalid_request.rb +309 -0
- data/lib/fastly/models/{log_timeseries_filter_field_item.rb → ddos_protection_not_authorized.rb} +24 -36
- data/lib/fastly/models/ddos_protection_rule.rb +2 -1
- data/lib/fastly/models/ddos_protection_rule_all_of.rb +2 -1
- data/lib/fastly/models/{log_timeseries_get_response_meta_filters.rb → ddos_protection_rule_patch.rb} +13 -14
- data/lib/fastly/models/invitation.rb +1 -1
- data/lib/fastly/models/invitation_create_data.rb +244 -0
- data/lib/fastly/models/invitation_create_data_all_of.rb +216 -0
- data/lib/fastly/models/{invitation_response.rb → invitation_create_response.rb} +4 -4
- data/lib/fastly/models/{invitation_response_all_of.rb → invitation_create_response_all_of.rb} +3 -3
- data/lib/fastly/models/invitation_data.rb +4 -13
- data/lib/fastly/models/invitation_response_data.rb +13 -13
- data/lib/fastly/models/{log_timeseries_get_response.rb → list_attack_report.rb} +5 -5
- data/lib/fastly/models/list_attack_report_meta.rb +218 -0
- data/lib/fastly/models/{log_timeseries_result_dimensions.rb → list_signal_report.rb} +12 -10
- data/lib/fastly/models/logging_azureblob_response.rb +26 -2
- data/lib/fastly/models/logging_bigquery_additional.rb +1 -1
- data/lib/fastly/models/logging_bigquery_response.rb +26 -2
- data/lib/fastly/models/logging_cloudfiles_response.rb +26 -2
- data/lib/fastly/models/logging_common.rb +29 -5
- data/lib/fastly/models/logging_common_response.rb +26 -2
- data/lib/fastly/models/logging_common_response_all_of.rb +29 -5
- data/lib/fastly/models/logging_datadog_additional.rb +1 -1
- data/lib/fastly/models/logging_datadog_response.rb +26 -2
- data/lib/fastly/models/logging_digitalocean_response.rb +26 -2
- data/lib/fastly/models/logging_elasticsearch_additional.rb +1 -1
- data/lib/fastly/models/logging_elasticsearch_response.rb +26 -2
- data/lib/fastly/models/logging_ftp_response.rb +26 -2
- data/lib/fastly/models/logging_gcs_response.rb +26 -2
- data/lib/fastly/models/logging_google_pubsub_additional.rb +1 -1
- data/lib/fastly/models/logging_google_pubsub_response.rb +26 -2
- data/lib/fastly/models/logging_grafanacloudlogs_additional.rb +1 -1
- data/lib/fastly/models/logging_grafanacloudlogs_response.rb +26 -2
- data/lib/fastly/models/logging_heroku_response.rb +26 -2
- data/lib/fastly/models/logging_honeycomb_additional.rb +1 -1
- data/lib/fastly/models/logging_honeycomb_response.rb +26 -2
- data/lib/fastly/models/logging_https_additional.rb +1 -1
- data/lib/fastly/models/logging_https_response.rb +26 -2
- data/lib/fastly/models/logging_kafka_response.rb +26 -2
- data/lib/fastly/models/logging_kafka_response_post.rb +26 -2
- data/lib/fastly/models/logging_kinesis_additional.rb +1 -1
- data/lib/fastly/models/logging_kinesis_response.rb +1 -1
- data/lib/fastly/models/logging_logentries_response.rb +26 -2
- data/lib/fastly/models/logging_loggly_response.rb +26 -2
- data/lib/fastly/models/logging_logshuttle_response.rb +26 -2
- data/lib/fastly/models/logging_newrelic_additional.rb +1 -1
- data/lib/fastly/models/logging_newrelic_response.rb +26 -2
- data/lib/fastly/models/logging_newrelicotlp_additional.rb +1 -1
- data/lib/fastly/models/logging_newrelicotlp_response.rb +26 -2
- data/lib/fastly/models/logging_openstack_response.rb +26 -2
- data/lib/fastly/models/logging_papertrail_response.rb +26 -2
- data/lib/fastly/models/logging_s3_response.rb +26 -2
- data/lib/fastly/models/logging_scalyr_response.rb +26 -2
- data/lib/fastly/models/logging_sftp_response.rb +26 -2
- data/lib/fastly/models/logging_splunk_response.rb +26 -2
- data/lib/fastly/models/logging_sumologic_response.rb +26 -2
- data/lib/fastly/models/logging_syslog_response.rb +26 -2
- data/lib/fastly/models/pool_additional.rb +1 -1
- data/lib/fastly/models/pool_response.rb +2 -2
- data/lib/fastly/models/pool_response_common.rb +1 -1
- data/lib/fastly/models/pool_response_post.rb +2 -2
- data/lib/fastly/models/relationship_service_invitations.rb +1 -0
- data/lib/fastly/models/relationship_service_invitations_service_invitations.rb +1 -0
- data/lib/fastly/models/relationships_for_invitation.rb +1 -0
- data/lib/fastly/models/signal_report.rb +249 -0
- data/lib/fastly/models/timeseries_get_response.rb +227 -0
- data/lib/fastly/models/{log_timeseries_get_response_meta.rb → timeseries_meta.rb} +23 -32
- data/lib/fastly/models/{log_timeseries_result.rb → timeseries_result.rb} +9 -5
- data/lib/fastly/models/tls_certificate_data_attributes.rb +14 -4
- data/lib/fastly/models/tls_csr_data.rb +4 -13
- data/lib/fastly/models/tls_csr_data_attributes.rb +14 -4
- data/lib/fastly/models/top_workspace.rb +238 -0
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +20 -12
- data/sig.json +1 -1
- metadata +42 -26
- data/docs/LogTimeseriesFilterFieldItem.md +0 -12
- data/docs/LogTimeseriesGetResponse.md +0 -11
- data/docs/LogTimeseriesGetResponseMeta.md +0 -14
- data/docs/LogTimeseriesGetResponseMetaFilters.md +0 -10
- data/docs/LogTimeseriesResult.md +0 -11
- data/docs/LogTimeseriesResultDimensions.md +0 -10
- data/docs/LogTimeseriesValueField.md +0 -59
- data/docs/ObservabilityTimeseriesForLogsApi.md +0 -67
- data/lib/fastly/models/ddos_protection_action.rb +0 -37
- data/lib/fastly/models/ddos_protection_traffic_attribute.rb +0 -40
- data/lib/fastly/models/log_timeseries_value_field.rb +0 -108
data/docs/LoggingS3Api.md
CHANGED
@@ -38,7 +38,8 @@ opts = {
|
|
38
38
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
39
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
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://
|
41
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
42
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
42
43
|
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
44
|
message_type: 'classic', # String | How the message should be formatted.
|
44
45
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
@@ -77,7 +78,8 @@ end
|
|
77
78
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
78
79
|
| **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] |
|
79
80
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
80
|
-
| **format** | **String** | A Fastly [log format string](https://
|
81
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
82
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
81
83
|
| **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] |
|
82
84
|
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'classic'] |
|
83
85
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
@@ -243,7 +245,8 @@ opts = {
|
|
243
245
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
244
246
|
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`.
|
245
247
|
response_condition: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
|
246
|
-
format: 'format_example', # String | A Fastly [log format string](https://
|
248
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
249
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
247
250
|
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`.
|
248
251
|
message_type: 'classic', # String | How the message should be formatted.
|
249
252
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
@@ -283,7 +286,8 @@ end
|
|
283
286
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
284
287
|
| **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] |
|
285
288
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
286
|
-
| **format** | **String** | A Fastly [log format string](https://
|
289
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
290
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
287
291
|
| **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] |
|
288
292
|
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'classic'] |
|
289
293
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
data/docs/LoggingS3Response.md
CHANGED
@@ -7,7 +7,8 @@
|
|
7
7
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
8
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
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://
|
10
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
11
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
11
12
|
| **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 '2'] |
|
12
13
|
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'classic'] |
|
13
14
|
| **timestamp_format** | **String** | A timestamp format | [optional][readonly] |
|
data/docs/LoggingScalyrApi.md
CHANGED
@@ -38,7 +38,8 @@ opts = {
|
|
38
38
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
39
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
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://
|
41
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
42
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
42
43
|
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
44
|
region: 'US', # String | The region that log data will be sent to.
|
44
45
|
token: 'token_example', # String | The token to use for authentication.
|
@@ -63,7 +64,8 @@ end
|
|
63
64
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
64
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] |
|
65
66
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
66
|
-
| **format** | **String** | A Fastly [log format string](https://
|
67
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
68
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
67
69
|
| **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] |
|
68
70
|
| **region** | **String** | The region that log data will be sent to. | [optional][default to 'US'] |
|
69
71
|
| **token** | **String** | The token to use for authentication. | [optional] |
|
@@ -215,7 +217,8 @@ opts = {
|
|
215
217
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
216
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`.
|
217
219
|
response_condition: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
|
218
|
-
format: 'format_example', # String | A Fastly [log format string](https://
|
220
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
221
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
219
222
|
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`.
|
220
223
|
region: 'US', # String | The region that log data will be sent to.
|
221
224
|
token: 'token_example', # String | The token to use for authentication.
|
@@ -241,7 +244,8 @@ end
|
|
241
244
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
242
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] |
|
243
246
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
244
|
-
| **format** | **String** | A Fastly [log format string](https://
|
247
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
248
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
245
249
|
| **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] |
|
246
250
|
| **region** | **String** | The region that log data will be sent to. | [optional][default to 'US'] |
|
247
251
|
| **token** | **String** | The token to use for authentication. | [optional] |
|
@@ -7,7 +7,8 @@
|
|
7
7
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
8
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
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://
|
10
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
11
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
11
12
|
| **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 '2'] |
|
12
13
|
| **region** | **String** | The region that log data will be sent to. | [optional][default to 'US'] |
|
13
14
|
| **token** | **String** | The token to use for authentication. | [optional] |
|
data/docs/LoggingSftpApi.md
CHANGED
@@ -38,7 +38,8 @@ opts = {
|
|
38
38
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
39
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
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://
|
41
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
42
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
42
43
|
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
44
|
message_type: 'classic', # String | How the message should be formatted.
|
44
45
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
@@ -73,7 +74,8 @@ end
|
|
73
74
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
74
75
|
| **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] |
|
75
76
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
76
|
-
| **format** | **String** | A Fastly [log format string](https://
|
77
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
78
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
77
79
|
| **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] |
|
78
80
|
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'classic'] |
|
79
81
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
@@ -235,7 +237,8 @@ opts = {
|
|
235
237
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
236
238
|
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`.
|
237
239
|
response_condition: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
|
238
|
-
format: 'format_example', # String | A Fastly [log format string](https://
|
240
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
241
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
239
242
|
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`.
|
240
243
|
message_type: 'classic', # String | How the message should be formatted.
|
241
244
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
@@ -271,7 +274,8 @@ end
|
|
271
274
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
272
275
|
| **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] |
|
273
276
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
274
|
-
| **format** | **String** | A Fastly [log format string](https://
|
277
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
278
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
275
279
|
| **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] |
|
276
280
|
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'classic'] |
|
277
281
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
data/docs/LoggingSftpResponse.md
CHANGED
@@ -7,7 +7,8 @@
|
|
7
7
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
8
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
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://
|
10
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
11
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
11
12
|
| **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 '2'] |
|
12
13
|
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'classic'] |
|
13
14
|
| **timestamp_format** | **String** | A timestamp format | [optional][readonly] |
|
data/docs/LoggingSplunkApi.md
CHANGED
@@ -38,7 +38,8 @@ opts = {
|
|
38
38
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
39
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
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://
|
41
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
42
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
42
43
|
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
44
|
tls_ca_cert: 'tls_ca_cert_example', # String | A secure certificate to authenticate a server with. Must be in PEM format.
|
44
45
|
tls_client_cert: 'tls_client_cert_example', # String | The client certificate used to make authenticated requests. Must be in PEM format.
|
@@ -69,7 +70,8 @@ end
|
|
69
70
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
70
71
|
| **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] |
|
71
72
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
72
|
-
| **format** | **String** | A Fastly [log format string](https://
|
73
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
74
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
73
75
|
| **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] |
|
74
76
|
| **tls_ca_cert** | **String** | A secure certificate to authenticate a server with. Must be in PEM format. | [optional][default to 'null'] |
|
75
77
|
| **tls_client_cert** | **String** | The client certificate used to make authenticated requests. Must be in PEM format. | [optional][default to 'null'] |
|
@@ -227,7 +229,8 @@ opts = {
|
|
227
229
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
228
230
|
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`.
|
229
231
|
response_condition: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
|
230
|
-
format: 'format_example', # String | A Fastly [log format string](https://
|
232
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
233
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
231
234
|
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`.
|
232
235
|
tls_ca_cert: 'tls_ca_cert_example', # String | A secure certificate to authenticate a server with. Must be in PEM format.
|
233
236
|
tls_client_cert: 'tls_client_cert_example', # String | The client certificate used to make authenticated requests. Must be in PEM format.
|
@@ -259,7 +262,8 @@ end
|
|
259
262
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
260
263
|
| **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] |
|
261
264
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
262
|
-
| **format** | **String** | A Fastly [log format string](https://
|
265
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
266
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
263
267
|
| **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] |
|
264
268
|
| **tls_ca_cert** | **String** | A secure certificate to authenticate a server with. Must be in PEM format. | [optional][default to 'null'] |
|
265
269
|
| **tls_client_cert** | **String** | The client certificate used to make authenticated requests. Must be in PEM format. | [optional][default to 'null'] |
|
@@ -7,7 +7,8 @@
|
|
7
7
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
8
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
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://
|
10
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
11
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
11
12
|
| **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 '2'] |
|
12
13
|
| **tls_ca_cert** | **String** | A secure certificate to authenticate a server with. Must be in PEM format. | [optional][default to 'null'] |
|
13
14
|
| **tls_client_cert** | **String** | The client certificate used to make authenticated requests. Must be in PEM format. | [optional][default to 'null'] |
|
data/docs/LoggingSumologicApi.md
CHANGED
@@ -38,7 +38,8 @@ opts = {
|
|
38
38
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
39
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
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://
|
41
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
42
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
42
43
|
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
44
|
message_type: Fastly::LoggingMessageType::CLASSIC, # LoggingMessageType |
|
44
45
|
url: 'url_example', # String | The URL to post logs to.
|
@@ -62,7 +63,8 @@ end
|
|
62
63
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
63
64
|
| **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] |
|
64
65
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
65
|
-
| **format** | **String** | A Fastly [log format string](https://
|
66
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
67
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
66
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] |
|
67
69
|
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'classic'] |
|
68
70
|
| **url** | **String** | The URL to post logs to. | [optional] |
|
@@ -213,7 +215,8 @@ opts = {
|
|
213
215
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
214
216
|
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`.
|
215
217
|
response_condition: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
|
216
|
-
format: 'format_example', # String | A Fastly [log format string](https://
|
218
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
219
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
217
220
|
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`.
|
218
221
|
message_type: Fastly::LoggingMessageType::CLASSIC, # LoggingMessageType |
|
219
222
|
url: 'url_example', # String | The URL to post logs to.
|
@@ -238,7 +241,8 @@ end
|
|
238
241
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
239
242
|
| **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] |
|
240
243
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
241
|
-
| **format** | **String** | A Fastly [log format string](https://
|
244
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
245
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
242
246
|
| **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] |
|
243
247
|
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'classic'] |
|
244
248
|
| **url** | **String** | The URL to post logs to. | [optional] |
|
@@ -7,7 +7,8 @@
|
|
7
7
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
8
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
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://
|
10
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
11
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
11
12
|
| **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 '2'] |
|
12
13
|
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'classic'] |
|
13
14
|
| **url** | **String** | The URL to post logs to. | [optional] |
|
data/docs/LoggingSyslogApi.md
CHANGED
@@ -38,7 +38,8 @@ opts = {
|
|
38
38
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
39
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
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://
|
41
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
42
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
42
43
|
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
44
|
tls_ca_cert: 'tls_ca_cert_example', # String | A secure certificate to authenticate a server with. Must be in PEM format.
|
44
45
|
tls_client_cert: 'tls_client_cert_example', # String | The client certificate used to make authenticated requests. Must be in PEM format.
|
@@ -71,7 +72,8 @@ end
|
|
71
72
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
72
73
|
| **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] |
|
73
74
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
74
|
-
| **format** | **String** | A Fastly [log format string](https://
|
75
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
76
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
75
77
|
| **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] |
|
76
78
|
| **tls_ca_cert** | **String** | A secure certificate to authenticate a server with. Must be in PEM format. | [optional][default to 'null'] |
|
77
79
|
| **tls_client_cert** | **String** | The client certificate used to make authenticated requests. Must be in PEM format. | [optional][default to 'null'] |
|
@@ -231,7 +233,8 @@ opts = {
|
|
231
233
|
name: 'name_example', # String | The name for the real-time logging configuration.
|
232
234
|
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`.
|
233
235
|
response_condition: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
|
234
|
-
format: 'format_example', # String | A Fastly [log format string](https://
|
236
|
+
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
237
|
+
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
235
238
|
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`.
|
236
239
|
tls_ca_cert: 'tls_ca_cert_example', # String | A secure certificate to authenticate a server with. Must be in PEM format.
|
237
240
|
tls_client_cert: 'tls_client_cert_example', # String | The client certificate used to make authenticated requests. Must be in PEM format.
|
@@ -265,7 +268,8 @@ end
|
|
265
268
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
266
269
|
| **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] |
|
267
270
|
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
268
|
-
| **format** | **String** | A Fastly [log format string](https://
|
271
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
272
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
269
273
|
| **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] |
|
270
274
|
| **tls_ca_cert** | **String** | A secure certificate to authenticate a server with. Must be in PEM format. | [optional][default to 'null'] |
|
271
275
|
| **tls_client_cert** | **String** | The client certificate used to make authenticated requests. Must be in PEM format. | [optional][default to 'null'] |
|
@@ -7,7 +7,8 @@
|
|
7
7
|
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
8
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
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://
|
10
|
+
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
11
|
+
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
11
12
|
| **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 '2'] |
|
12
13
|
| **tls_ca_cert** | **String** | A secure certificate to authenticate a server with. Must be in PEM format. | [optional][default to 'null'] |
|
13
14
|
| **tls_client_cert** | **String** | The client certificate used to make authenticated requests. Must be in PEM format. | [optional][default to 'null'] |
|
@@ -0,0 +1,99 @@
|
|
1
|
+
# Fastly::NgwafReportsApi
|
2
|
+
|
3
|
+
|
4
|
+
```ruby
|
5
|
+
require 'fastly'
|
6
|
+
api_instance = Fastly::NgwafReportsApi.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_attacks_report**](NgwafReportsApi.md#get_attacks_report) | **GET** /ngwaf/v1/reports/attacks | Get attacks report
|
17
|
+
[**get_signals_report**](NgwafReportsApi.md#get_signals_report) | **GET** /ngwaf/v1/reports/signals | Get signals report
|
18
|
+
|
19
|
+
|
20
|
+
## `get_attacks_report()`
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
get_attacks_report(opts): <ListAttackReport> # Get attacks report
|
24
|
+
```
|
25
|
+
|
26
|
+
Get attacks report
|
27
|
+
|
28
|
+
### Examples
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
api_instance = Fastly::NgwafReportsApi.new
|
32
|
+
opts = {
|
33
|
+
from: Time.parse('2019-08-20T18:07:33Z'), # Time | The start of a time range in RFC 3339 format.
|
34
|
+
to: Time.parse('2019-08-21T18:07:33Z'), # Time | The end of a time range in RFC 3339 format. Defaults to the current time.
|
35
|
+
}
|
36
|
+
|
37
|
+
begin
|
38
|
+
# Get attacks report
|
39
|
+
result = api_instance.get_attacks_report(opts)
|
40
|
+
p result
|
41
|
+
rescue Fastly::ApiError => e
|
42
|
+
puts "Error when calling NgwafReportsApi->get_attacks_report: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
### Options
|
47
|
+
|
48
|
+
| Name | Type | Description | Notes |
|
49
|
+
| ---- | ---- | ----------- | ----- |
|
50
|
+
| **from** | **Time** | The start of a time range in RFC 3339 format. | |
|
51
|
+
| **to** | **Time** | The end of a time range in RFC 3339 format. Defaults to the current time. | [optional] |
|
52
|
+
|
53
|
+
### Return type
|
54
|
+
|
55
|
+
[**ListAttackReport**](ListAttackReport.md)
|
56
|
+
|
57
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
58
|
+
[[Back to README]](../../README.md)
|
59
|
+
## `get_signals_report()`
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
get_signals_report(opts): <ListSignalReport> # Get signals report
|
63
|
+
```
|
64
|
+
|
65
|
+
Get signals report
|
66
|
+
|
67
|
+
### Examples
|
68
|
+
|
69
|
+
```ruby
|
70
|
+
api_instance = Fastly::NgwafReportsApi.new
|
71
|
+
opts = {
|
72
|
+
from: Time.parse('2019-08-20T18:07:33Z'), # Time | The start of a time range in RFC 3339 format.
|
73
|
+
to: Time.parse('2019-08-21T18:07:33Z'), # Time | The end of a time range in RFC 3339 format. Defaults to the current time.
|
74
|
+
signal_type: 'account', # String | The type of signal
|
75
|
+
}
|
76
|
+
|
77
|
+
begin
|
78
|
+
# Get signals report
|
79
|
+
result = api_instance.get_signals_report(opts)
|
80
|
+
p result
|
81
|
+
rescue Fastly::ApiError => e
|
82
|
+
puts "Error when calling NgwafReportsApi->get_signals_report: #{e}"
|
83
|
+
end
|
84
|
+
```
|
85
|
+
|
86
|
+
### Options
|
87
|
+
|
88
|
+
| Name | Type | Description | Notes |
|
89
|
+
| ---- | ---- | ----------- | ----- |
|
90
|
+
| **from** | **Time** | The start of a time range in RFC 3339 format. | |
|
91
|
+
| **to** | **Time** | The end of a time range in RFC 3339 format. Defaults to the current time. | [optional] |
|
92
|
+
| **signal_type** | **String** | The type of signal | [optional] |
|
93
|
+
|
94
|
+
### Return type
|
95
|
+
|
96
|
+
[**ListSignalReport**](ListSignalReport.md)
|
97
|
+
|
98
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
99
|
+
[[Back to README]](../../README.md)
|
@@ -0,0 +1,67 @@
|
|
1
|
+
# Fastly::ObservabilityTimeseriesApi
|
2
|
+
|
3
|
+
|
4
|
+
```ruby
|
5
|
+
require 'fastly'
|
6
|
+
api_instance = Fastly::ObservabilityTimeseriesApi.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
|
+
[**timeseries_get**](ObservabilityTimeseriesApi.md#timeseries_get) | **GET** /observability/timeseries | Retrieve observability data as a time series
|
17
|
+
|
18
|
+
|
19
|
+
## `timeseries_get()`
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
timeseries_get(opts): <TimeseriesGetResponse> # Retrieve observability data as a time series
|
23
|
+
```
|
24
|
+
|
25
|
+
Retrieves observability data as a time series.
|
26
|
+
|
27
|
+
### Examples
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
api_instance = Fastly::ObservabilityTimeseriesApi.new
|
31
|
+
opts = {
|
32
|
+
source: 'logs', # String |
|
33
|
+
from: '2024-01-03T16:00:00Z', # String |
|
34
|
+
to: '2024-01-03T18:00:00Z', # String |
|
35
|
+
granularity: 'hour', # String |
|
36
|
+
series: 'avg[response_time],p99[response_time]', # String |
|
37
|
+
dimensions: 'dimensions_example', # String |
|
38
|
+
filter: 'filter[response_status]=200', # String |
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
# Retrieve observability data as a time series
|
43
|
+
result = api_instance.timeseries_get(opts)
|
44
|
+
p result
|
45
|
+
rescue Fastly::ApiError => e
|
46
|
+
puts "Error when calling ObservabilityTimeseriesApi->timeseries_get: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
### Options
|
51
|
+
|
52
|
+
| Name | Type | Description | Notes |
|
53
|
+
| ---- | ---- | ----------- | ----- |
|
54
|
+
| **source** | **String** | | |
|
55
|
+
| **from** | **String** | | |
|
56
|
+
| **to** | **String** | | |
|
57
|
+
| **granularity** | **String** | | |
|
58
|
+
| **dimensions** | **String** | | [optional] |
|
59
|
+
| **filter** | **String** | | [optional] |
|
60
|
+
| **series** | **String** | | |
|
61
|
+
|
62
|
+
### Return type
|
63
|
+
|
64
|
+
[**TimeseriesGetResponse**](TimeseriesGetResponse.md)
|
65
|
+
|
66
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
67
|
+
[[Back to README]](../../README.md)
|
data/docs/PoolAdditional.md
CHANGED
@@ -14,7 +14,7 @@
|
|
14
14
|
| **healthcheck** | **String** | Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools. | [optional] |
|
15
15
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
16
16
|
| **type** | **String** | What type of load balance group to use. | [optional] |
|
17
|
-
| **override_host** | **String** | The hostname to [override the Host header](https://
|
17
|
+
| **override_host** | **String** | The hostname to [override the Host header](https://www.fastly.com/documentation/guides/full-site-delivery/domains-and-origins/specifying-an-override-host/). Defaults to `null` meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting. | [optional][default to 'null'] |
|
18
18
|
|
19
19
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
20
20
|
|
data/docs/PoolApi.md
CHANGED
@@ -55,8 +55,8 @@ opts = {
|
|
55
55
|
healthcheck: 'healthcheck_example', # String | Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools.
|
56
56
|
comment: 'comment_example', # String | A freeform descriptive note.
|
57
57
|
type: 'random', # String | What type of load balance group to use.
|
58
|
-
override_host: 'override_host_example', # String | The hostname to [override the Host header](https://
|
59
|
-
between_bytes_timeout: 56, # Integer | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.
|
58
|
+
override_host: 'override_host_example', # String | The hostname to [override the Host header](https://www.fastly.com/documentation/guides/full-site-delivery/domains-and-origins/specifying-an-override-host/). Defaults to `null` meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting.
|
59
|
+
between_bytes_timeout: 56, # Integer | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`.
|
60
60
|
connect_timeout: 56, # Integer | How long to wait for a timeout in milliseconds. Optional.
|
61
61
|
first_byte_timeout: 56, # Integer | How long to wait for the first byte in milliseconds. Optional.
|
62
62
|
max_conn_default: 56, # Integer | Maximum number of connections. Optional.
|
@@ -99,8 +99,8 @@ end
|
|
99
99
|
| **healthcheck** | **String** | Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools. | [optional] |
|
100
100
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
101
101
|
| **type** | **String** | What type of load balance group to use. | [optional] |
|
102
|
-
| **override_host** | **String** | The hostname to [override the Host header](https://
|
103
|
-
| **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional][default to 10000] |
|
102
|
+
| **override_host** | **String** | The hostname to [override the Host header](https://www.fastly.com/documentation/guides/full-site-delivery/domains-and-origins/specifying-an-override-host/). Defaults to `null` meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting. | [optional][default to 'null'] |
|
103
|
+
| **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`. | [optional][default to 10000] |
|
104
104
|
| **connect_timeout** | **Integer** | How long to wait for a timeout in milliseconds. Optional. | [optional] |
|
105
105
|
| **first_byte_timeout** | **Integer** | How long to wait for the first byte in milliseconds. Optional. | [optional] |
|
106
106
|
| **max_conn_default** | **Integer** | Maximum number of connections. Optional. | [optional][default to 200] |
|
@@ -270,8 +270,8 @@ opts = {
|
|
270
270
|
healthcheck: 'healthcheck_example', # String | Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools.
|
271
271
|
comment: 'comment_example', # String | A freeform descriptive note.
|
272
272
|
type: 'random', # String | What type of load balance group to use.
|
273
|
-
override_host: 'override_host_example', # String | The hostname to [override the Host header](https://
|
274
|
-
between_bytes_timeout: 56, # Integer | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.
|
273
|
+
override_host: 'override_host_example', # String | The hostname to [override the Host header](https://www.fastly.com/documentation/guides/full-site-delivery/domains-and-origins/specifying-an-override-host/). Defaults to `null` meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting.
|
274
|
+
between_bytes_timeout: 56, # Integer | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`.
|
275
275
|
connect_timeout: 56, # Integer | How long to wait for a timeout in milliseconds. Optional.
|
276
276
|
first_byte_timeout: 56, # Integer | How long to wait for the first byte in milliseconds. Optional.
|
277
277
|
max_conn_default: 56, # Integer | Maximum number of connections. Optional.
|
@@ -315,8 +315,8 @@ end
|
|
315
315
|
| **healthcheck** | **String** | Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools. | [optional] |
|
316
316
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
317
317
|
| **type** | **String** | What type of load balance group to use. | [optional] |
|
318
|
-
| **override_host** | **String** | The hostname to [override the Host header](https://
|
319
|
-
| **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional][default to 10000] |
|
318
|
+
| **override_host** | **String** | The hostname to [override the Host header](https://www.fastly.com/documentation/guides/full-site-delivery/domains-and-origins/specifying-an-override-host/). Defaults to `null` meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting. | [optional][default to 'null'] |
|
319
|
+
| **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`. | [optional][default to 10000] |
|
320
320
|
| **connect_timeout** | **Integer** | How long to wait for a timeout in milliseconds. Optional. | [optional] |
|
321
321
|
| **first_byte_timeout** | **Integer** | How long to wait for the first byte in milliseconds. Optional. | [optional] |
|
322
322
|
| **max_conn_default** | **Integer** | Maximum number of connections. Optional. | [optional][default to 200] |
|
data/docs/PoolResponse.md
CHANGED
@@ -24,8 +24,8 @@
|
|
24
24
|
| **healthcheck** | **String** | Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools. | [optional] |
|
25
25
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
26
26
|
| **type** | **String** | What type of load balance group to use. | [optional] |
|
27
|
-
| **override_host** | **String** | The hostname to [override the Host header](https://
|
28
|
-
| **between_bytes_timeout** | **String** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] |
|
27
|
+
| **override_host** | **String** | The hostname to [override the Host header](https://www.fastly.com/documentation/guides/full-site-delivery/domains-and-origins/specifying-an-override-host/). Defaults to `null` meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting. | [optional][default to 'null'] |
|
28
|
+
| **between_bytes_timeout** | **String** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] |
|
29
29
|
| **connect_timeout** | **String** | How long to wait for a timeout in milliseconds. | [optional] |
|
30
30
|
| **first_byte_timeout** | **String** | How long to wait for the first byte in milliseconds. | [optional] |
|
31
31
|
| **max_conn_default** | **String** | Maximum number of connections. | [optional][default to '200'] |
|