WebService-Fastly/lib/WebService/Fastly/Object/Values.pm
=begin comment
Fastly API
Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://www.fastly.com/documentation/reference/api/)
The version of the API Spec document: 1.0.0
Contact: oss@fastly.com
=end comment
=cut
#
# NOTE: This class is auto generated.
# Do not edit the class manually.
#
package WebService::Fastly::Object::Values;
require 5.6.0;
use strict;
use warnings;
use utf8;
use JSON::MaybeXS qw(decode_json);
use Data::Dumper;
use Module::Runtime qw(use_module);
use Log::Any qw($log);
use Date::Parse;
use DateTime;
use base ("Class::Accessor", "Class::Data::Inheritable");
#
#The results of the query, optionally filtered and grouped over the requested timespan.
#
# NOTE: This class is auto generated. Do not edit the class manually.
#
=begin comment
Fastly API
Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://www.fastly.com/documentation/reference/api/)
The version of the API Spec document: 1.0.0
Contact: oss@fastly.com
=end comment
=cut
#
# NOTE: This class is auto generated.
# Do not edit the class manually.
#
__PACKAGE__->mk_classdata('attribute_map' => {});
__PACKAGE__->mk_classdata('openapi_types' => {});
__PACKAGE__->mk_classdata('method_documentation' => {});
__PACKAGE__->mk_classdata('class_documentation' => {});
__PACKAGE__->mk_classdata('openapi_nullable' => {});
# new plain object
sub new {
my ($class, %args) = @_;
my $self = bless {}, $class;
$self->init(%args);
return $self;
}
# initialize the object
sub init
{
my ($self, %args) = @_;
foreach my $attribute (keys %{$self->attribute_map}) {
my $args_key = $self->attribute_map->{$attribute};
$self->$attribute( $args{ $args_key } );
}
}
# return perl hash
sub to_hash {
my $self = shift;
my $_hash = decode_json(JSON()->new->allow_blessed->convert_blessed->encode($self));
return $_hash;
}
# used by JSON for serialization
sub TO_JSON {
my $self = shift;
my $_data = {};
foreach my $_key (keys %{$self->attribute_map}) {
$_data->{$self->attribute_map->{$_key}} = $self->{$_key};
}
return $_data;
}
# from Perl hashref
sub from_hash {
my ($self, $hash) = @_;
# loop through attributes and use openapi_types to deserialize the data
while ( my ($_key, $_type) = each %{$self->openapi_types} ) {
my $_json_attribute = $self->attribute_map->{$_key};
my $_is_nullable = ($self->openapi_nullable->{$_key} || 'false') eq 'true';
if ($_type =~ /^array\[(.+)\]$/i) { # array
my $_subclass = $1;
my @_array = ();
foreach my $_element (@{$hash->{$_json_attribute}}) {
push @_array, $self->_deserialize($_subclass, $_element, $_is_nullable);
}
$self->{$_key} = \@_array;
} elsif ($_type =~ /^hash\[string,(.+)\]$/i) { # hash
my $_subclass = $1;
my %_hash = ();
while (my($_key, $_element) = each %{$hash->{$_json_attribute}}) {
$_hash{$_key} = $self->_deserialize($_subclass, $_element, $_is_nullable);
}
$self->{$_key} = \%_hash;
} elsif (exists $hash->{$_json_attribute}) { #hash(model), primitive, datetime
$self->{$_key} = $self->_deserialize($_type, $hash->{$_json_attribute}, $_is_nullable);
} else {
$log->debugf("Warning: %s (%s) does not exist in input hash\n", $_key, $_json_attribute);
}
}
return $self;
}
# deserialize non-array data
sub _deserialize {
my ($self, $type, $data, $is_nullable) = @_;
$log->debugf("deserializing %s with %s",Dumper($data), $type);
if (!(defined $data) && $is_nullable) {
return undef;
}
if ($type eq 'DateTime') {
return DateTime->from_epoch(epoch => str2time($data));
} elsif ( grep( /^$type$/, ('int', 'double', 'string', 'boolean'))) {
return $data;
} else { # hash(model)
my $_instance = eval "WebService::Fastly::Object::$type->new()";
return $_instance->from_hash($data);
}
}
__PACKAGE__->class_documentation({description => 'The results of the query, optionally filtered and grouped over the requested timespan.',
class => 'Values',
required => [], # TODO
} );
__PACKAGE__->method_documentation({
'edge_requests' => {
datatype => 'int',
base_name => 'edge_requests',
description => 'Number of requests sent by end users to Fastly.',
format => 'int64',
read_only => 'false',
},
'edge_resp_header_bytes' => {
datatype => 'int',
base_name => 'edge_resp_header_bytes',
description => 'Total header bytes delivered from Fastly to the end user.',
format => 'int64',
read_only => 'false',
},
'edge_resp_body_bytes' => {
datatype => 'int',
base_name => 'edge_resp_body_bytes',
description => 'Total body bytes delivered from Fastly to the end user.',
format => 'int64',
read_only => 'false',
},
'status_1xx' => {
datatype => 'int',
base_name => 'status_1xx',
description => 'Number of 1xx \"Informational\" category status codes delivered.',
format => 'int64',
read_only => 'false',
},
'status_2xx' => {
datatype => 'int',
base_name => 'status_2xx',
description => 'Number of 2xx \"Success\" status codes delivered.',
format => 'int64',
read_only => 'false',
},
'status_3xx' => {
datatype => 'int',
base_name => 'status_3xx',
description => 'Number of 3xx \"Redirection\" codes delivered.',
format => 'int64',
read_only => 'false',
},
'status_4xx' => {
datatype => 'int',
base_name => 'status_4xx',
description => 'Number of 4xx \"Client Error\" codes delivered.',
format => 'int64',
read_only => 'false',
},
'status_5xx' => {
datatype => 'int',
base_name => 'status_5xx',
description => 'Number of 5xx \"Server Error\" codes delivered.',
format => 'int64',
read_only => 'false',
},
'status_200' => {
datatype => 'int',
base_name => 'status_200',
description => 'Number of responses delivered with status code 200 (Success).',
format => 'int64',
read_only => 'false',
},
'status_204' => {
datatype => 'int',
base_name => 'status_204',
description => 'Number of responses delivered with status code 204 (No Content).',
format => 'int64',
read_only => 'false',
},
'status_206' => {
datatype => 'int',
base_name => 'status_206',
description => 'Number of responses delivered with status code 206 (Partial Content).',
format => 'int64',
read_only => 'false',
},
'status_301' => {
datatype => 'int',
base_name => 'status_301',
description => 'Number of responses delivered with status code 301 (Moved Permanently).',
format => 'int64',
read_only => 'false',
},
'status_302' => {
datatype => 'int',
base_name => 'status_302',
description => 'Number of responses delivered with status code 302 (Found).',
format => 'int64',
read_only => 'false',
},
'status_304' => {
datatype => 'int',
base_name => 'status_304',
description => 'Number of responses delivered with status code 304 (Not Modified).',
format => 'int64',
read_only => 'false',
},
'status_400' => {
datatype => 'int',
base_name => 'status_400',
description => 'Number of responses delivered with status code 400 (Bad Request).',
format => 'int64',
read_only => 'false',
},
'status_401' => {
datatype => 'int',
base_name => 'status_401',
description => 'Number of responses delivered with status code 401 (Unauthorized).',
format => 'int64',
read_only => 'false',
},
'status_403' => {
datatype => 'int',
base_name => 'status_403',
description => 'Number of responses delivered with status code 403 (Forbidden).',
format => 'int64',
read_only => 'false',
},
'status_404' => {
datatype => 'int',
base_name => 'status_404',
description => 'Number of responses delivered with status code 404 (Not Found).',
format => 'int64',
read_only => 'false',
},
'status_416' => {
datatype => 'int',
base_name => 'status_416',
description => 'Number of responses delivered with status code 416 (Range Not Satisfiable).',
format => 'int64',
read_only => 'false',
},
'status_429' => {
datatype => 'int',
base_name => 'status_429',
description => 'Number of responses delivered with status code 429 (Too Many Requests).',
format => 'int64',
read_only => 'false',
},
'status_500' => {
datatype => 'int',
base_name => 'status_500',
description => 'Number of responses delivered with status code 500 (Internal Server Error).',
format => 'int64',
read_only => 'false',
},
'status_501' => {
datatype => 'int',
base_name => 'status_501',
description => 'Number of responses delivered with status code 501 (Not Implemented).',
format => 'int64',
read_only => 'false',
},
'status_502' => {
datatype => 'int',
base_name => 'status_502',
description => 'Number of responses delivered with status code 502 (Bad Gateway).',
format => 'int64',
read_only => 'false',
},
'status_503' => {
datatype => 'int',
base_name => 'status_503',
description => 'Number of responses delivered with status code 503 (Service Unavailable).',
format => 'int64',
read_only => 'false',
},
'status_504' => {
datatype => 'int',
base_name => 'status_504',
description => 'Number of responses delivered with status code 504 (Gateway Timeout).',
format => 'int64',
read_only => 'false',
},
'status_505' => {
datatype => 'int',
base_name => 'status_505',
description => 'Number of responses delivered with status code 505 (HTTP Version Not Supported).',
format => 'int64',
read_only => 'false',
},
'status_530' => {
datatype => 'int',
base_name => 'status_530',
description => 'Number of responses delivered with status code 530.',
format => 'int64',
read_only => 'false',
},
'requests' => {
datatype => 'int',
base_name => 'requests',
description => 'Number of requests processed.',
format => 'int64',
read_only => 'false',
},
'resp_header_bytes' => {
datatype => 'int',
base_name => 'resp_header_bytes',
description => 'Total header bytes delivered.',
format => 'int64',
read_only => 'false',
},
'resp_body_bytes' => {
datatype => 'int',
base_name => 'resp_body_bytes',
description => 'Total body bytes delivered.',
format => 'int64',
read_only => 'false',
},
'bereq_header_bytes' => {
datatype => 'int',
base_name => 'bereq_header_bytes',
description => 'Total header bytes sent to origin.',
format => 'int64',
read_only => 'false',
},
'bereq_body_bytes' => {
datatype => 'int',
base_name => 'bereq_body_bytes',
description => 'Total body bytes sent to origin.',
format => 'int64',
read_only => 'false',
},
'edge_hit_requests' => {
datatype => 'int',
base_name => 'edge_hit_requests',
description => 'Number of requests sent by end users to Fastly that resulted in a hit at the edge.',
format => 'int64',
read_only => 'false',
},
'edge_miss_requests' => {
datatype => 'int',
base_name => 'edge_miss_requests',
description => 'Number of requests sent by end users to Fastly that resulted in a miss at the edge.',
format => 'int64',
read_only => 'false',
},
'origin_fetches' => {
datatype => 'int',
base_name => 'origin_fetches',
description => 'Number of requests sent to origin.',
format => 'int64',
read_only => 'false',
},
'origin_fetch_resp_header_bytes' => {
datatype => 'int',
base_name => 'origin_fetch_resp_header_bytes',
description => 'Total header bytes received from origin.',
format => 'int64',
read_only => 'false',
},
'origin_fetch_resp_body_bytes' => {
datatype => 'int',
base_name => 'origin_fetch_resp_body_bytes',
description => 'Total body bytes received from origin.',
format => 'int64',
read_only => 'false',
},
'bandwidth' => {
datatype => 'int',
base_name => 'bandwidth',
description => 'Total bytes delivered (`resp_header_bytes` + `resp_body_bytes` + `bereq_header_bytes` + `bereq_body_bytes`).',
format => 'int64',
read_only => 'false',
},
'edge_hit_ratio' => {
datatype => 'double',
base_name => 'edge_hit_ratio',
description => 'Ratio of cache hits to cache misses at the edge, between 0 and 1 (`edge_hit_requests` / (`edge_hit_requests` + `edge_miss_requests`)).',
format => '',
read_only => 'false',
},
'origin_offload' => {
datatype => 'double',
base_name => 'origin_offload',
description => 'Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((`edge_resp_body_bytes` + `edge_resp_header_bytes`) - (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes`)) / (`edge_resp_body_bytes` + `edge_resp_header_bytes`). Previously, Origin Offload used a different formula. [Learn more](https://www.fastly.com/documentation/reference/changes/2024/06/add-origin_offload-metric).',
format => '',
read_only => 'false',
},
'origin_status_200' => {
datatype => 'int',
base_name => 'origin_status_200',
description => 'Number of responses received from origin with status code 200 (Success).',
format => 'int64',
read_only => 'false',
},
'origin_status_204' => {
datatype => 'int',
base_name => 'origin_status_204',
description => 'Number of responses received from origin with status code 204 (No Content).',
format => 'int64',
read_only => 'false',
},
'origin_status_206' => {
datatype => 'int',
base_name => 'origin_status_206',
description => 'Number of responses received from origin with status code 206 (Partial Content).',
format => 'int64',
read_only => 'false',
},
'origin_status_301' => {
datatype => 'int',
base_name => 'origin_status_301',
description => 'Number of responses received from origin with status code 301 (Moved Permanently).',
format => 'int64',
read_only => 'false',
},
'origin_status_302' => {
datatype => 'int',
base_name => 'origin_status_302',
description => 'Number of responses received from origin with status code 302 (Found).',
format => 'int64',
read_only => 'false',
},
'origin_status_304' => {
datatype => 'int',
base_name => 'origin_status_304',
description => 'Number of responses received from origin with status code 304 (Not Modified).',
format => 'int64',
read_only => 'false',
},
'origin_status_400' => {
datatype => 'int',
base_name => 'origin_status_400',
description => 'Number of responses received from origin with status code 400 (Bad Request).',
format => 'int64',
read_only => 'false',
},
'origin_status_401' => {
datatype => 'int',
base_name => 'origin_status_401',
description => 'Number of responses received from origin with status code 401 (Unauthorized).',
format => 'int64',
read_only => 'false',
},
'origin_status_403' => {
datatype => 'int',
base_name => 'origin_status_403',
description => 'Number of responses received from origin with status code 403 (Forbidden).',
format => 'int64',
read_only => 'false',
},
'origin_status_404' => {
datatype => 'int',
base_name => 'origin_status_404',
description => 'Number of responses received from origin with status code 404 (Not Found).',
format => 'int64',
read_only => 'false',
},
'origin_status_416' => {
datatype => 'int',
base_name => 'origin_status_416',
description => 'Number of responses received from origin with status code 416 (Range Not Satisfiable).',
format => 'int64',
read_only => 'false',
},
'origin_status_429' => {
datatype => 'int',
base_name => 'origin_status_429',
description => 'Number of responses received from origin with status code 429 (Too Many Requests).',
format => 'int64',
read_only => 'false',
},
'origin_status_500' => {
datatype => 'int',
base_name => 'origin_status_500',
description => 'Number of responses received from origin with status code 500 (Internal Server Error).',
format => 'int64',
read_only => 'false',
},
'origin_status_501' => {
datatype => 'int',
base_name => 'origin_status_501',
description => 'Number of responses received from origin with status code 501 (Not Implemented).',
format => 'int64',
read_only => 'false',
},
'origin_status_502' => {
datatype => 'int',
base_name => 'origin_status_502',
description => 'Number of responses received from origin with status code 502 (Bad Gateway).',
format => 'int64',
read_only => 'false',
},
'origin_status_503' => {
datatype => 'int',
base_name => 'origin_status_503',
description => 'Number of responses received from origin with status code 503 (Service Unavailable).',
format => 'int64',
read_only => 'false',
},
'origin_status_504' => {
datatype => 'int',
base_name => 'origin_status_504',
description => 'Number of responses received from origin with status code 504 (Gateway Timeout).',
format => 'int64',
read_only => 'false',
},
'origin_status_505' => {
datatype => 'int',
base_name => 'origin_status_505',
description => 'Number of responses received from origin with status code 505 (HTTP Version Not Supported).',
format => 'int64',
read_only => 'false',
},
'origin_status_530' => {
datatype => 'int',
base_name => 'origin_status_530',
description => 'Number of responses received from origin with status code 530.',
format => 'int64',
read_only => 'false',
},
'origin_status_1xx' => {
datatype => 'int',
base_name => 'origin_status_1xx',
description => 'Number of \"Informational\" category status codes received from origin.',
format => 'int64',
read_only => 'false',
},
'origin_status_2xx' => {
datatype => 'int',
base_name => 'origin_status_2xx',
description => 'Number of \"Success\" status codes received from origin.',
format => 'int64',
read_only => 'false',
},
'origin_status_3xx' => {
datatype => 'int',
base_name => 'origin_status_3xx',
description => 'Number of \"Redirection\" codes received from origin.',
format => 'int64',
read_only => 'false',
},
'origin_status_4xx' => {
datatype => 'int',
base_name => 'origin_status_4xx',
description => 'Number of \"Client Error\" codes received from origin.',
format => 'int64',
read_only => 'false',
},
'origin_status_5xx' => {
datatype => 'int',
base_name => 'origin_status_5xx',
description => 'Number of \"Server Error\" codes received from origin.',
format => 'int64',
read_only => 'false',
},
});
__PACKAGE__->openapi_types( {
'edge_requests' => 'int',
'edge_resp_header_bytes' => 'int',
'edge_resp_body_bytes' => 'int',
'status_1xx' => 'int',
'status_2xx' => 'int',
'status_3xx' => 'int',
'status_4xx' => 'int',
'status_5xx' => 'int',
'status_200' => 'int',
'status_204' => 'int',
'status_206' => 'int',
'status_301' => 'int',
'status_302' => 'int',
'status_304' => 'int',
'status_400' => 'int',
'status_401' => 'int',
'status_403' => 'int',
'status_404' => 'int',
'status_416' => 'int',
'status_429' => 'int',
'status_500' => 'int',
'status_501' => 'int',
'status_502' => 'int',
'status_503' => 'int',
'status_504' => 'int',
'status_505' => 'int',
'status_530' => 'int',
'requests' => 'int',
'resp_header_bytes' => 'int',
'resp_body_bytes' => 'int',
'bereq_header_bytes' => 'int',
'bereq_body_bytes' => 'int',
'edge_hit_requests' => 'int',
'edge_miss_requests' => 'int',
'origin_fetches' => 'int',
'origin_fetch_resp_header_bytes' => 'int',
'origin_fetch_resp_body_bytes' => 'int',
'bandwidth' => 'int',
'edge_hit_ratio' => 'double',
'origin_offload' => 'double',
'origin_status_200' => 'int',
'origin_status_204' => 'int',
'origin_status_206' => 'int',
'origin_status_301' => 'int',
'origin_status_302' => 'int',
'origin_status_304' => 'int',
'origin_status_400' => 'int',
'origin_status_401' => 'int',
'origin_status_403' => 'int',
'origin_status_404' => 'int',
'origin_status_416' => 'int',
'origin_status_429' => 'int',
'origin_status_500' => 'int',
'origin_status_501' => 'int',
'origin_status_502' => 'int',
'origin_status_503' => 'int',
'origin_status_504' => 'int',
'origin_status_505' => 'int',
'origin_status_530' => 'int',
'origin_status_1xx' => 'int',
'origin_status_2xx' => 'int',
'origin_status_3xx' => 'int',
'origin_status_4xx' => 'int',
'origin_status_5xx' => 'int'
} );
__PACKAGE__->attribute_map( {
'edge_requests' => 'edge_requests',
'edge_resp_header_bytes' => 'edge_resp_header_bytes',
'edge_resp_body_bytes' => 'edge_resp_body_bytes',
'status_1xx' => 'status_1xx',
'status_2xx' => 'status_2xx',
'status_3xx' => 'status_3xx',
'status_4xx' => 'status_4xx',
'status_5xx' => 'status_5xx',
'status_200' => 'status_200',
'status_204' => 'status_204',
'status_206' => 'status_206',
'status_301' => 'status_301',
'status_302' => 'status_302',
'status_304' => 'status_304',
'status_400' => 'status_400',
'status_401' => 'status_401',
'status_403' => 'status_403',
'status_404' => 'status_404',
'status_416' => 'status_416',
'status_429' => 'status_429',
'status_500' => 'status_500',
'status_501' => 'status_501',
'status_502' => 'status_502',
'status_503' => 'status_503',
'status_504' => 'status_504',
'status_505' => 'status_505',
'status_530' => 'status_530',
'requests' => 'requests',
'resp_header_bytes' => 'resp_header_bytes',
'resp_body_bytes' => 'resp_body_bytes',
'bereq_header_bytes' => 'bereq_header_bytes',
'bereq_body_bytes' => 'bereq_body_bytes',
'edge_hit_requests' => 'edge_hit_requests',
'edge_miss_requests' => 'edge_miss_requests',
'origin_fetches' => 'origin_fetches',
'origin_fetch_resp_header_bytes' => 'origin_fetch_resp_header_bytes',
'origin_fetch_resp_body_bytes' => 'origin_fetch_resp_body_bytes',
'bandwidth' => 'bandwidth',
'edge_hit_ratio' => 'edge_hit_ratio',
'origin_offload' => 'origin_offload',
'origin_status_200' => 'origin_status_200',
'origin_status_204' => 'origin_status_204',
'origin_status_206' => 'origin_status_206',
'origin_status_301' => 'origin_status_301',
'origin_status_302' => 'origin_status_302',
'origin_status_304' => 'origin_status_304',
'origin_status_400' => 'origin_status_400',
'origin_status_401' => 'origin_status_401',
'origin_status_403' => 'origin_status_403',
'origin_status_404' => 'origin_status_404',
'origin_status_416' => 'origin_status_416',
'origin_status_429' => 'origin_status_429',
'origin_status_500' => 'origin_status_500',
'origin_status_501' => 'origin_status_501',
'origin_status_502' => 'origin_status_502',
'origin_status_503' => 'origin_status_503',
'origin_status_504' => 'origin_status_504',
'origin_status_505' => 'origin_status_505',
'origin_status_530' => 'origin_status_530',
'origin_status_1xx' => 'origin_status_1xx',
'origin_status_2xx' => 'origin_status_2xx',
'origin_status_3xx' => 'origin_status_3xx',
'origin_status_4xx' => 'origin_status_4xx',
'origin_status_5xx' => 'origin_status_5xx'
} );
__PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});
__PACKAGE__->openapi_nullable( {
} );
1;