=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://developer.fastly.com/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.
#
require 5.6.0;
use strict;
use utf8;
use JSON::MaybeXS qw(decode_json);
use Module::Runtime qw(use_module);
use Log::Any qw($log);
use base ("Class::Accessor", "Class::Data::Inheritable");
#
#
#
# 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://developer.fastly.com/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 => '',
class => 'LoggingS3',
required => [], # TODO
} );
__PACKAGE__->method_documentation({
'name' => {
datatype => 'string',
base_name => 'name',
description => 'The name for the real-time logging configuration.',
format => '',
read_only => 'false',
},
'placement' => {
datatype => 'string',
base_name => 'placement',
description => '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`. ',
format => '',
read_only => 'false',
},
'format_version' => {
datatype => 'int',
base_name => 'format_version',
description => '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`. ',
format => '',
read_only => 'false',
},
'response_condition' => {
datatype => 'string',
base_name => 'response_condition',
description => 'The name of an existing condition in the configured endpoint, or leave blank to always execute.',
format => '',
read_only => 'false',
},
'format' => {
datatype => 'string',
base_name => 'format',
description => 'A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).',
format => '',
read_only => 'false',
},
'message_type' => {
datatype => 'string',
base_name => 'message_type',
description => 'How the message should be formatted.',
format => '',
read_only => 'false',
},
'timestamp_format' => {
datatype => 'string',
base_name => 'timestamp_format',
description => 'A timestamp format',
format => '',
read_only => 'true',
},
'period' => {
datatype => 'int',
base_name => 'period',
description => 'How frequently log files are finalized so they can be available for reading (in seconds).',
format => '',
read_only => 'false',
},
'gzip_level' => {
datatype => 'int',
base_name => 'gzip_level',
description => 'The level of gzip encoding when sending logs (default `0`, no compression). Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.',
format => '',
read_only => 'false',
},
'compression_codec' => {
datatype => 'string',
base_name => 'compression_codec',
description => 'The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.',
format => '',
read_only => 'false',
},
'access_key' => {
datatype => 'string',
base_name => 'access_key',
description => 'The access key for your S3 account. Not required if `iam_role` is provided.',
format => '',
read_only => 'false',
},
'acl' => {
datatype => 'string',
base_name => 'acl',
description => 'The access control list (ACL) specific request header. See the AWS documentation for [Access Control List (ACL) Specific Request Headers](https://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadInitiate.html#initiate-mpu-acl-specific-request-headers) for more information.',
format => '',
read_only => 'false',
},
'bucket_name' => {
datatype => 'string',
base_name => 'bucket_name',
description => 'The bucket name for S3 account.',
format => '',
read_only => 'false',
},
'domain' => {
datatype => 'string',
base_name => 'domain',
description => 'The domain of the Amazon S3 endpoint.',
format => '',
read_only => 'false',
},
'iam_role' => {
datatype => 'string',
base_name => 'iam_role',
description => 'The Amazon Resource Name (ARN) for the IAM role granting Fastly access to S3. Not required if `access_key` and `secret_key` are provided.',
format => '',
read_only => 'false',
},
'path' => {
datatype => 'string',
base_name => 'path',
description => 'The path to upload logs to.',
format => '',
read_only => 'false',
},
'public_key' => {
datatype => 'string',
base_name => 'public_key',
description => 'A PGP public key that Fastly will use to encrypt your log files before writing them to disk.',
format => '',
read_only => 'false',
},
'redundancy' => {
datatype => 'string',
base_name => 'redundancy',
description => 'The S3 redundancy level.',
format => '',
read_only => 'false',
},
'secret_key' => {
datatype => 'string',
base_name => 'secret_key',
description => 'The secret key for your S3 account. Not required if `iam_role` is provided.',
format => '',
read_only => 'false',
},
'server_side_encryption_kms_key_id' => {
datatype => 'string',
base_name => 'server_side_encryption_kms_key_id',
description => 'Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`.',
format => '',
read_only => 'false',
},
'server_side_encryption' => {
datatype => 'string',
base_name => 'server_side_encryption',
description => 'Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption.',
format => '',
read_only => 'false',
},
});
__PACKAGE__->openapi_types( {
'name' => 'string',
'placement' => 'string',
'format_version' => 'int',
'response_condition' => 'string',
'format' => 'string',
'message_type' => 'string',
'timestamp_format' => 'string',
'period' => 'int',
'gzip_level' => 'int',
'compression_codec' => 'string',
'access_key' => 'string',
'acl' => 'string',
'bucket_name' => 'string',
'domain' => 'string',
'iam_role' => 'string',
'path' => 'string',
'public_key' => 'string',
'redundancy' => 'string',
'secret_key' => 'string',
'server_side_encryption_kms_key_id' => 'string',
'server_side_encryption' => 'string'
} );
__PACKAGE__->attribute_map( {
'name' => 'name',
'placement' => 'placement',
'format_version' => 'format_version',
'response_condition' => 'response_condition',
'format' => 'format',
'message_type' => 'message_type',
'timestamp_format' => 'timestamp_format',
'period' => 'period',
'gzip_level' => 'gzip_level',
'compression_codec' => 'compression_codec',
'access_key' => 'access_key',
'acl' => 'acl',
'bucket_name' => 'bucket_name',
'domain' => 'domain',
'iam_role' => 'iam_role',
'path' => 'path',
'public_key' => 'public_key',
'redundancy' => 'redundancy',
'secret_key' => 'secret_key',
'server_side_encryption_kms_key_id' => 'server_side_encryption_kms_key_id',
'server_side_encryption' => 'server_side_encryption'
} );
__PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});
__PACKAGE__->openapi_nullable( {
'placement' => 'true',
'response_condition' => 'true',
'timestamp_format' => 'true',
'access_key' => 'true',
'iam_role' => 'true',
'path' => 'true',
'public_key' => 'true',
'redundancy' => 'true',
'secret_key' => 'true',
'server_side_encryption_kms_key_id' => 'true',
'server_side_encryption' => 'true',
} );
1;