WebService-Fastly
view release on metacpan or search on metacpan
docs/LoggingDatadogAdditional.md view on Meta::CPAN
## Load the model package
```perl
use WebService::Fastly::Object::LoggingDatadogAdditional;
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**region** | **string** | The region that log data will be sent to. | [optional] [default to 'US']
**format** | **string** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Datadog can ingest. | [optional] [default to '{"ddsource":"fastly","service"...
**token** | **string** | The API key from your Datadog account. Required. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/LoggingDatadogApi.md view on Meta::CPAN
api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $name = "name_example"; # string | The name for the real-time logging configuration.
my $placement = "placement_example"; # 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`.
my $response_condition = "response_condition_example"; # string | The name of an existing condition in the configured endpoint, or leave blank to always execute.
my $format = '{"ddsource":"fastly","service":"%{req.service_id}V","date":"%{begin:%Y-%m-%dT%H:%M:%S%Z}t","time_start":"%{begin:%Y-%m-%dT%H:%M:%S%Z}t","time_end":"%{end:%Y-%m-%dT%H:%M:%S%Z}t","http":{"request_time_ms":"%D","method":"%m","url":"%{json....
my $format_version = 2; # int | 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`.
my $region = 'US'; # string | The region that log data will be sent to.
my $token = "token_example"; # string | The API key from your Datadog account. Required.
eval {
my $result = $api_instance->create_log_datadog(service_id => $service_id, version_id => $version_id, name => $name, placement => $placement, response_condition => $response_condition, format => $format, format_version => $format_version, region =...
print Dumper($result);
};
if ($@) {
warn "Exception when calling LoggingDatadogApi->create_log_datadog: $@\n";
docs/LoggingDatadogApi.md view on Meta::CPAN
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_id** | **string**| Alphanumeric string identifying the service. |
**version_id** | **int**| Integer identifying a service version. |
**name** | **string**| The name for the real-time logging configuration. | [optional]
**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]
**response_condition** | **string**| The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional]
**format** | **string**| A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Datadog can ingest. | [optional] [default to '{"ddsource":"fastly","service"...
**format_version** | **int**| 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`. ...
**region** | **string**| The region that log data will be sent to. | [optional] [default to 'US']
**token** | **string**| The API key from your Datadog account. Required. | [optional]
### Return type
[**LoggingDatadogResponse**](LoggingDatadogResponse.md)
### Authorization
docs/LoggingDatadogApi.md view on Meta::CPAN
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $logging_datadog_name = "logging_datadog_name_example"; # string | The name for the real-time logging configuration.
my $name = "name_example"; # string | The name for the real-time logging configuration.
my $placement = "placement_example"; # 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`.
my $response_condition = "response_condition_example"; # string | The name of an existing condition in the configured endpoint, or leave blank to always execute.
my $format = '{"ddsource":"fastly","service":"%{req.service_id}V","date":"%{begin:%Y-%m-%dT%H:%M:%S%Z}t","time_start":"%{begin:%Y-%m-%dT%H:%M:%S%Z}t","time_end":"%{end:%Y-%m-%dT%H:%M:%S%Z}t","http":{"request_time_ms":"%D","method":"%m","url":"%{json....
my $format_version = 2; # int | 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`.
my $region = 'US'; # string | The region that log data will be sent to.
my $token = "token_example"; # string | The API key from your Datadog account. Required.
eval {
my $result = $api_instance->update_log_datadog(service_id => $service_id, version_id => $version_id, logging_datadog_name => $logging_datadog_name, name => $name, placement => $placement, response_condition => $response_condition, format => $form...
print Dumper($result);
};
if ($@) {
warn "Exception when calling LoggingDatadogApi->update_log_datadog: $@\n";
docs/LoggingDatadogApi.md view on Meta::CPAN
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_id** | **string**| Alphanumeric string identifying the service. |
**version_id** | **int**| Integer identifying a service version. |
**logging_datadog_name** | **string**| The name for the real-time logging configuration. |
**name** | **string**| The name for the real-time logging configuration. | [optional]
**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]
**response_condition** | **string**| The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional]
**format** | **string**| A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Datadog can ingest. | [optional] [default to '{"ddsource":"fastly","service"...
**format_version** | **int**| 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`. ...
**region** | **string**| The region that log data will be sent to. | [optional] [default to 'US']
**token** | **string**| The API key from your Datadog account. Required. | [optional]
### Return type
[**LoggingDatadogResponse**](LoggingDatadogResponse.md)
### Authorization
docs/LoggingDatadogResponse.md view on Meta::CPAN
```perl
use WebService::Fastly::Object::LoggingDatadogResponse;
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | The name for the real-time logging configuration. | [optional]
**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]
**response_condition** | **string** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional]
**format** | **string** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Datadog can ingest. | [optional] [default to '{"ddsource":"fastly","service"...
**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`...
**region** | **string** | The region that log data will be sent to. | [optional] [default to 'US']
**token** | **string** | The API key from your Datadog account. Required. | [optional]
**created_at** | **DateTime** | Date and time in ISO 8601 format. | [optional] [readonly]
**deleted_at** | **DateTime** | Date and time in ISO 8601 format. | [optional] [readonly]
**updated_at** | **DateTime** | Date and time in ISO 8601 format. | [optional] [readonly]
**service_id** | **string** | | [optional] [readonly]
**version** | **string** | | [optional] [readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/RequestSettingsAdditional.md view on Meta::CPAN
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**action** | **string** | Allows you to terminate request handling and immediately perform an action. | [optional]
**default_host** | **string** | Sets the host header. | [optional]
**hash_keys** | **string** | Comma separated list of varnish request object fields that should be in the hash key. | [optional]
**name** | **string** | Name for the request settings. | [optional]
**request_condition** | **string** | Condition which, if met, will select this configuration during a request. Optional. | [optional]
**xff** | **string** | Short for X-Forwarded-For. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/RequestSettingsApi.md view on Meta::CPAN
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $request_settings_name = "request_settings_name_example"; # string | Name for the request settings.
my $action = "action_example"; # string | Allows you to terminate request handling and immediately perform an action.
my $default_host = "default_host_example"; # string | Sets the host header.
my $hash_keys = "hash_keys_example"; # string | Comma separated list of varnish request object fields that should be in the hash key.
my $name = "name_example"; # string | Name for the request settings.
my $request_condition = "request_condition_example"; # string | Condition which, if met, will select this configuration during a request. Optional.
my $xff = "xff_example"; # string | Short for X-Forwarded-For.
my $bypass_busy_wait = 56; # int | Disable collapsed forwarding, so you don't wait for other objects to origin.
my $force_miss = 56; # int | Allows you to force a cache miss for the request. Replaces the item in the cache if the content is cacheable.
my $force_ssl = 56; # int | Forces the request use SSL (redirects a non-SSL to SSL).
my $geo_headers = 56; # int | Injects Fastly-Geo-Country, Fastly-Geo-City, and Fastly-Geo-Region into the request headers.
my $max_stale_age = 56; # int | How old an object is allowed to be to serve stale-if-error or stale-while-revalidate.
my $timer_support = 56; # int | Injects the X-Timer info into the request for viewing origin fetch durations.
eval {
my $result = $api_instance->update_request_settings(service_id => $service_id, version_id => $version_id, request_settings_name => $request_settings_name, action => $action, default_host => $default_host, hash_keys => $hash_keys, name => $name, r...
print Dumper($result);
docs/RequestSettingsApi.md view on Meta::CPAN
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_id** | **string**| Alphanumeric string identifying the service. |
**version_id** | **int**| Integer identifying a service version. |
**request_settings_name** | **string**| Name for the request settings. |
**action** | **string**| Allows you to terminate request handling and immediately perform an action. | [optional]
**default_host** | **string**| Sets the host header. | [optional]
**hash_keys** | **string**| Comma separated list of varnish request object fields that should be in the hash key. | [optional]
**name** | **string**| Name for the request settings. | [optional]
**request_condition** | **string**| Condition which, if met, will select this configuration during a request. Optional. | [optional]
**xff** | **string**| Short for X-Forwarded-For. | [optional]
**bypass_busy_wait** | **int**| Disable collapsed forwarding, so you don't wait for other objects to origin. | [optional]
**force_miss** | **int**| Allows you to force a cache miss for the request. Replaces the item in the cache if the content is cacheable. | [optional]
**force_ssl** | **int**| Forces the request use SSL (redirects a non-SSL to SSL). | [optional]
**geo_headers** | **int**| Injects Fastly-Geo-Country, Fastly-Geo-City, and Fastly-Geo-Region into the request headers. | [optional]
**max_stale_age** | **int**| How old an object is allowed to be to serve stale-if-error or stale-while-revalidate. | [optional]
**timer_support** | **int**| Injects the X-Timer info into the request for viewing origin fetch durations. | [optional]
### Return type
[**RequestSettingsResponse**](RequestSettingsResponse.md)
docs/RequestSettingsResponse.md view on Meta::CPAN
**created_at** | **DateTime** | Date and time in ISO 8601 format. | [optional] [readonly]
**deleted_at** | **DateTime** | Date and time in ISO 8601 format. | [optional] [readonly]
**updated_at** | **DateTime** | Date and time in ISO 8601 format. | [optional] [readonly]
**service_id** | **string** | | [optional] [readonly]
**version** | **string** | | [optional] [readonly]
**action** | **string** | Allows you to terminate request handling and immediately perform an action. | [optional]
**default_host** | **string** | Sets the host header. | [optional]
**hash_keys** | **string** | Comma separated list of varnish request object fields that should be in the hash key. | [optional]
**name** | **string** | Name for the request settings. | [optional]
**request_condition** | **string** | Condition which, if met, will select this configuration during a request. Optional. | [optional]
**xff** | **string** | Short for X-Forwarded-For. | [optional]
**bypass_busy_wait** | **string** | Disable collapsed forwarding, so you don't wait for other objects to origin. | [optional]
**force_miss** | **string** | Allows you to force a cache miss for the request. Replaces the item in the cache if the content is cacheable. | [optional]
**force_ssl** | **string** | Forces the request use SSL (redirects a non-SSL to SSL). | [optional]
**geo_headers** | **string** | Injects Fastly-Geo-Country, Fastly-Geo-City, and Fastly-Geo-Region into the request headers. | [optional]
**max_stale_age** | **string** | How old an object is allowed to be to serve stale-if-error or stale-while-revalidate. | [optional]
**timer_support** | **string** | Injects the X-Timer info into the request for viewing origin fetch durations. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
lib/WebService/Fastly/LoggingDatadogApi.pm view on Meta::CPAN
#
# create_log_datadog
#
# Create a Datadog log endpoint
#
# @param string $service_id Alphanumeric string identifying the service. (required)
# @param int $version_id Integer identifying a service version. (required)
# @param string $name The name for the real-time logging configuration. (optional)
# @param string $placement 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 `v...
# @param string $response_condition The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
# @param string $format A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Datadog can ingest. (optional, default to '{"ddsource":"fastly","service":"%{req.service_id}V","date":"%{begin:%...
# @param int $format_version 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`...
# @param string $region The region that log data will be sent to. (optional, default to 'US')
# @param string $token The API key from your Datadog account. Required. (optional)
{
my $params = {
'service_id' => {
data_type => 'string',
description => 'Alphanumeric string identifying the service.',
required => '1',
},
lib/WebService/Fastly/LoggingDatadogApi.pm view on Meta::CPAN
# update_log_datadog
#
# Update a Datadog log endpoint
#
# @param string $service_id Alphanumeric string identifying the service. (required)
# @param int $version_id Integer identifying a service version. (required)
# @param string $logging_datadog_name The name for the real-time logging configuration. (required)
# @param string $name The name for the real-time logging configuration. (optional)
# @param string $placement 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 `v...
# @param string $response_condition The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
# @param string $format A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Datadog can ingest. (optional, default to '{"ddsource":"fastly","service":"%{req.service_id}V","date":"%{begin:%...
# @param int $format_version 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`...
# @param string $region The region that log data will be sent to. (optional, default to 'US')
# @param string $token The API key from your Datadog account. Required. (optional)
{
my $params = {
'service_id' => {
data_type => 'string',
description => 'Alphanumeric string identifying the service.',
required => '1',
},
lib/WebService/Fastly/Object/RequestSettingsAdditional.pm view on Meta::CPAN
'request_condition' => {
datatype => 'string',
base_name => 'request_condition',
description => 'Condition which, if met, will select this configuration during a request. Optional.',
format => '',
read_only => 'false',
},
'xff' => {
datatype => 'string',
base_name => 'xff',
description => 'Short for X-Forwarded-For.',
format => '',
read_only => 'false',
},
});
__PACKAGE__->openapi_types( {
'action' => 'string',
'default_host' => 'string',
'hash_keys' => 'string',
'name' => 'string',
lib/WebService/Fastly/Object/RequestSettingsResponse.pm view on Meta::CPAN
'request_condition' => {
datatype => 'string',
base_name => 'request_condition',
description => 'Condition which, if met, will select this configuration during a request. Optional.',
format => '',
read_only => 'false',
},
'xff' => {
datatype => 'string',
base_name => 'xff',
description => 'Short for X-Forwarded-For.',
format => '',
read_only => 'false',
},
'bypass_busy_wait' => {
datatype => 'string',
base_name => 'bypass_busy_wait',
description => 'Disable collapsed forwarding, so you don't wait for other objects to origin.',
format => '',
read_only => 'false',
},
lib/WebService/Fastly/RequestSettingsApi.pm view on Meta::CPAN
# Update a Request Settings object
#
# @param string $service_id Alphanumeric string identifying the service. (required)
# @param int $version_id Integer identifying a service version. (required)
# @param string $request_settings_name Name for the request settings. (required)
# @param string $action Allows you to terminate request handling and immediately perform an action. (optional)
# @param string $default_host Sets the host header. (optional)
# @param string $hash_keys Comma separated list of varnish request object fields that should be in the hash key. (optional)
# @param string $name Name for the request settings. (optional)
# @param string $request_condition Condition which, if met, will select this configuration during a request. Optional. (optional)
# @param string $xff Short for X-Forwarded-For. (optional)
# @param int $bypass_busy_wait Disable collapsed forwarding, so you don't wait for other objects to origin. (optional)
# @param int $force_miss Allows you to force a cache miss for the request. Replaces the item in the cache if the content is cacheable. (optional)
# @param int $force_ssl Forces the request use SSL (redirects a non-SSL to SSL). (optional)
# @param int $geo_headers Injects Fastly-Geo-Country, Fastly-Geo-City, and Fastly-Geo-Region into the request headers. (optional)
# @param int $max_stale_age How old an object is allowed to be to serve stale-if-error or stale-while-revalidate. (optional)
# @param int $timer_support Injects the X-Timer info into the request for viewing origin fetch durations. (optional)
{
my $params = {
'service_id' => {
data_type => 'string',
lib/WebService/Fastly/RequestSettingsApi.pm view on Meta::CPAN
description => 'Name for the request settings.',
required => '0',
},
'request_condition' => {
data_type => 'string',
description => 'Condition which, if met, will select this configuration during a request. Optional.',
required => '0',
},
'xff' => {
data_type => 'string',
description => 'Short for X-Forwarded-For.',
required => '0',
},
'bypass_busy_wait' => {
data_type => 'int',
description => 'Disable collapsed forwarding, so you don't wait for other objects to origin.',
required => '0',
},
'force_miss' => {
data_type => 'int',
description => 'Allows you to force a cache miss for the request. Replaces the item in the cache if the content is cacheable.',
( run in 0.259 second using v1.01-cache-2.11-cpan-26ccb49234f )