WebService-Fastly/lib/WebService/Fastly/LoggingAzureblobApi.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::LoggingAzureblobApi;
require 5.6.0;
use strict;
use warnings;
use utf8;
use Exporter;
use Carp qw( croak );
use Log::Any qw($log);
use WebService::Fastly::ApiClient;
use base "Class::Data::Inheritable";
__PACKAGE__->mk_classdata('method_documentation' => {});
sub new {
my $class = shift;
my $api_client;
if ($_[0] && ref $_[0] && ref $_[0] eq 'WebService::Fastly::ApiClient' ) {
$api_client = $_[0];
} else {
$api_client = WebService::Fastly::ApiClient->new(@_);
}
bless { api_client => $api_client }, $class;
}
#
# create_log_azure
#
# Create an Azure Blob Storage 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 `vcl_deliver`. (optional)
# @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://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). (optional, default to '%h %l %u %t "%r" %>s %b')
# @param string $log_processing_region The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. (optional, default to 'none')
# @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` if `format_version` is set to `1`. (optional, default to 2)
# @param string $message_type How the message should be formatted. (optional, default to 'classic')
# @param string $timestamp_format A timestamp format (optional)
# @param string $compression_codec 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. (optional)
# @param int $period How frequently log files are finalized so they can be available for reading (in seconds). (optional, default to 3600)
# @param int $gzip_level 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. (optional, default to 0)
# @param string $path The path to upload logs to. (optional, default to 'null')
# @param string $account_name The unique Azure Blob Storage namespace in which your data objects are stored. Required. (optional)
# @param string $container The name of the Azure Blob Storage container in which to store logs. Required. (optional)
# @param string $sas_token The Azure shared access signature providing write access to the blob service objects. Be sure to update your token before it expires or the logging functionality will not work. Required. (optional)
# @param string $public_key A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (optional, default to 'null')
# @param int $file_max_bytes The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB). Note that Microsoft Azure Storage has [block size limits](https://learn.microsoft.com/en-us/rest/api/storageservices/put-block?tabs=microsoft-entra-id#remarks). (optional)
{
my $params = {
'service_id' => {
data_type => 'string',
description => 'Alphanumeric string identifying the service.',
required => '1',
},
'version_id' => {
data_type => 'int',
description => 'Integer identifying a service version.',
required => '1',
},
'name' => {
data_type => 'string',
description => 'The name for the real-time logging configuration.',
required => '0',
},
'placement' => {
data_type => 'string',
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`. ',
required => '0',
},
'response_condition' => {
data_type => 'string',
description => 'The name of an existing condition in the configured endpoint, or leave blank to always execute.',
required => '0',
},
'format' => {
data_type => 'string',
description => 'A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).',
required => '0',
},
'log_processing_region' => {
data_type => 'string',
description => 'The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.',
required => '0',
},
'format_version' => {
data_type => 'int',
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`. ',
required => '0',
},
'message_type' => {
data_type => 'string',
description => 'How the message should be formatted.',
required => '0',
},
'timestamp_format' => {
data_type => 'string',
description => 'A timestamp format',
required => '0',
},
'compression_codec' => {
data_type => 'string',
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.',
required => '0',
},
'period' => {
data_type => 'int',
description => 'How frequently log files are finalized so they can be available for reading (in seconds).',
required => '0',
},
'gzip_level' => {
data_type => 'int',
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.',
required => '0',
},
'path' => {
data_type => 'string',
description => 'The path to upload logs to.',
required => '0',
},
'account_name' => {
data_type => 'string',
description => 'The unique Azure Blob Storage namespace in which your data objects are stored. Required.',
required => '0',
},
'container' => {
data_type => 'string',
description => 'The name of the Azure Blob Storage container in which to store logs. Required.',
required => '0',
},
'sas_token' => {
data_type => 'string',
description => 'The Azure shared access signature providing write access to the blob service objects. Be sure to update your token before it expires or the logging functionality will not work. Required.',
required => '0',
},
'public_key' => {
data_type => 'string',
description => 'A PGP public key that Fastly will use to encrypt your log files before writing them to disk.',
required => '0',
},
'file_max_bytes' => {
data_type => 'int',
description => 'The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB). Note that Microsoft Azure Storage has [block size limits](https://learn.microsoft.com/en-us/rest/api/storageservices/put-block?tabs=microsoft-entra-id#remarks).',
required => '0',
},
};
__PACKAGE__->method_documentation->{ 'create_log_azure' } = {
summary => 'Create an Azure Blob Storage log endpoint',
params => $params,
returns => 'LoggingAzureblobResponse',
};
}
# @return LoggingAzureblobResponse
#
sub create_log_azure {
my ($self, %args) = @_;
# verify the required parameter 'service_id' is set
unless (exists $args{'service_id'}) {
croak("Missing the required parameter 'service_id' when calling create_log_azure");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling create_log_azure");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/azureblob';
my $_method = 'POST';
my $query_params = {};
my $header_params = {};
my $form_params = {};
# 'Accept' and 'Content-Type' header
my $_header_accept = $self->{api_client}->select_header_accept('application/json');
if ($_header_accept) {
$header_params->{'Accept'} = $_header_accept;
}
$header_params->{'Content-Type'} = $self->{api_client}->select_header_content_type('application/x-www-form-urlencoded');
# path params
if ( exists $args{'service_id'}) {
my $_base_variable = "{" . "service_id" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'service_id'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
# path params
if ( exists $args{'version_id'}) {
my $_base_variable = "{" . "version_id" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'version_id'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
# form params
if ( exists $args{'name'} ) {
$form_params->{'name'} = $self->{api_client}->to_form_value($args{'name'});
}
# form params
if ( exists $args{'placement'} ) {
$form_params->{'placement'} = $self->{api_client}->to_form_value($args{'placement'});
}
# form params
if ( exists $args{'response_condition'} ) {
$form_params->{'response_condition'} = $self->{api_client}->to_form_value($args{'response_condition'});
}
# form params
if ( exists $args{'format'} ) {
$form_params->{'format'} = $self->{api_client}->to_form_value($args{'format'});
}
# form params
if ( exists $args{'log_processing_region'} ) {
$form_params->{'log_processing_region'} = $self->{api_client}->to_form_value($args{'log_processing_region'});
}
# form params
if ( exists $args{'format_version'} ) {
$form_params->{'format_version'} = $self->{api_client}->to_form_value($args{'format_version'});
}
# form params
if ( exists $args{'message_type'} ) {
$form_params->{'message_type'} = $self->{api_client}->to_form_value($args{'message_type'});
}
# form params
if ( exists $args{'timestamp_format'} ) {
$form_params->{'timestamp_format'} = $self->{api_client}->to_form_value($args{'timestamp_format'});
}
# form params
if ( exists $args{'compression_codec'} ) {
$form_params->{'compression_codec'} = $self->{api_client}->to_form_value($args{'compression_codec'});
}
# form params
if ( exists $args{'period'} ) {
$form_params->{'period'} = $self->{api_client}->to_form_value($args{'period'});
}
# form params
if ( exists $args{'gzip_level'} ) {
$form_params->{'gzip_level'} = $self->{api_client}->to_form_value($args{'gzip_level'});
}
# form params
if ( exists $args{'path'} ) {
$form_params->{'path'} = $self->{api_client}->to_form_value($args{'path'});
}
# form params
if ( exists $args{'account_name'} ) {
$form_params->{'account_name'} = $self->{api_client}->to_form_value($args{'account_name'});
}
# form params
if ( exists $args{'container'} ) {
$form_params->{'container'} = $self->{api_client}->to_form_value($args{'container'});
}
# form params
if ( exists $args{'sas_token'} ) {
$form_params->{'sas_token'} = $self->{api_client}->to_form_value($args{'sas_token'});
}
# form params
if ( exists $args{'public_key'} ) {
$form_params->{'public_key'} = $self->{api_client}->to_form_value($args{'public_key'});
}
# form params
if ( exists $args{'file_max_bytes'} ) {
$form_params->{'file_max_bytes'} = $self->{api_client}->to_form_value($args{'file_max_bytes'});
}
my $_body_data;
# authentication setting, if any
my $auth_settings = [qw(token )];
# make the API Call
my $response = $self->{api_client}->call_api($_resource_path, $_method,
$query_params, $form_params,
$header_params, $_body_data, $auth_settings);
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('LoggingAzureblobResponse', $response);
return $_response_object;
}
#
# delete_log_azure
#
# Delete the Azure Blob Storage 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_azureblob_name The name for the real-time logging configuration. (required)
{
my $params = {
'service_id' => {
data_type => 'string',
description => 'Alphanumeric string identifying the service.',
required => '1',
},
'version_id' => {
data_type => 'int',
description => 'Integer identifying a service version.',
required => '1',
},
'logging_azureblob_name' => {
data_type => 'string',
description => 'The name for the real-time logging configuration.',
required => '1',
},
};
__PACKAGE__->method_documentation->{ 'delete_log_azure' } = {
summary => 'Delete the Azure Blob Storage log endpoint',
params => $params,
returns => 'InlineResponse200',
};
}
# @return InlineResponse200
#
sub delete_log_azure {
my ($self, %args) = @_;
# verify the required parameter 'service_id' is set
unless (exists $args{'service_id'}) {
croak("Missing the required parameter 'service_id' when calling delete_log_azure");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling delete_log_azure");
}
# verify the required parameter 'logging_azureblob_name' is set
unless (exists $args{'logging_azureblob_name'}) {
croak("Missing the required parameter 'logging_azureblob_name' when calling delete_log_azure");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/azureblob/{logging_azureblob_name}';
my $_method = 'DELETE';
my $query_params = {};
my $header_params = {};
my $form_params = {};
# 'Accept' and 'Content-Type' header
my $_header_accept = $self->{api_client}->select_header_accept('application/json');
if ($_header_accept) {
$header_params->{'Accept'} = $_header_accept;
}
$header_params->{'Content-Type'} = $self->{api_client}->select_header_content_type();
# path params
if ( exists $args{'service_id'}) {
my $_base_variable = "{" . "service_id" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'service_id'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
# path params
if ( exists $args{'version_id'}) {
my $_base_variable = "{" . "version_id" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'version_id'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
# path params
if ( exists $args{'logging_azureblob_name'}) {
my $_base_variable = "{" . "logging_azureblob_name" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'logging_azureblob_name'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
my $_body_data;
# authentication setting, if any
my $auth_settings = [qw(token )];
# make the API Call
my $response = $self->{api_client}->call_api($_resource_path, $_method,
$query_params, $form_params,
$header_params, $_body_data, $auth_settings);
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('InlineResponse200', $response);
return $_response_object;
}
#
# get_log_azure
#
# Get an Azure Blob Storage 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_azureblob_name The name for the real-time logging configuration. (required)
{
my $params = {
'service_id' => {
data_type => 'string',
description => 'Alphanumeric string identifying the service.',
required => '1',
},
'version_id' => {
data_type => 'int',
description => 'Integer identifying a service version.',
required => '1',
},
'logging_azureblob_name' => {
data_type => 'string',
description => 'The name for the real-time logging configuration.',
required => '1',
},
};
__PACKAGE__->method_documentation->{ 'get_log_azure' } = {
summary => 'Get an Azure Blob Storage log endpoint',
params => $params,
returns => 'LoggingAzureblobResponse',
};
}
# @return LoggingAzureblobResponse
#
sub get_log_azure {
my ($self, %args) = @_;
# verify the required parameter 'service_id' is set
unless (exists $args{'service_id'}) {
croak("Missing the required parameter 'service_id' when calling get_log_azure");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling get_log_azure");
}
# verify the required parameter 'logging_azureblob_name' is set
unless (exists $args{'logging_azureblob_name'}) {
croak("Missing the required parameter 'logging_azureblob_name' when calling get_log_azure");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/azureblob/{logging_azureblob_name}';
my $_method = 'GET';
my $query_params = {};
my $header_params = {};
my $form_params = {};
# 'Accept' and 'Content-Type' header
my $_header_accept = $self->{api_client}->select_header_accept('application/json');
if ($_header_accept) {
$header_params->{'Accept'} = $_header_accept;
}
$header_params->{'Content-Type'} = $self->{api_client}->select_header_content_type();
# path params
if ( exists $args{'service_id'}) {
my $_base_variable = "{" . "service_id" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'service_id'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
# path params
if ( exists $args{'version_id'}) {
my $_base_variable = "{" . "version_id" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'version_id'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
# path params
if ( exists $args{'logging_azureblob_name'}) {
my $_base_variable = "{" . "logging_azureblob_name" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'logging_azureblob_name'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
my $_body_data;
# authentication setting, if any
my $auth_settings = [qw(token )];
# make the API Call
my $response = $self->{api_client}->call_api($_resource_path, $_method,
$query_params, $form_params,
$header_params, $_body_data, $auth_settings);
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('LoggingAzureblobResponse', $response);
return $_response_object;
}
#
# list_log_azure
#
# List Azure Blob Storage log endpoints
#
# @param string $service_id Alphanumeric string identifying the service. (required)
# @param int $version_id Integer identifying a service version. (required)
{
my $params = {
'service_id' => {
data_type => 'string',
description => 'Alphanumeric string identifying the service.',
required => '1',
},
'version_id' => {
data_type => 'int',
description => 'Integer identifying a service version.',
required => '1',
},
};
__PACKAGE__->method_documentation->{ 'list_log_azure' } = {
summary => 'List Azure Blob Storage log endpoints',
params => $params,
returns => 'ARRAY[LoggingAzureblobResponse]',
};
}
# @return ARRAY[LoggingAzureblobResponse]
#
sub list_log_azure {
my ($self, %args) = @_;
# verify the required parameter 'service_id' is set
unless (exists $args{'service_id'}) {
croak("Missing the required parameter 'service_id' when calling list_log_azure");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling list_log_azure");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/azureblob';
my $_method = 'GET';
my $query_params = {};
my $header_params = {};
my $form_params = {};
# 'Accept' and 'Content-Type' header
my $_header_accept = $self->{api_client}->select_header_accept('application/json');
if ($_header_accept) {
$header_params->{'Accept'} = $_header_accept;
}
$header_params->{'Content-Type'} = $self->{api_client}->select_header_content_type();
# path params
if ( exists $args{'service_id'}) {
my $_base_variable = "{" . "service_id" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'service_id'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
# path params
if ( exists $args{'version_id'}) {
my $_base_variable = "{" . "version_id" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'version_id'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
my $_body_data;
# authentication setting, if any
my $auth_settings = [qw(token )];
# make the API Call
my $response = $self->{api_client}->call_api($_resource_path, $_method,
$query_params, $form_params,
$header_params, $_body_data, $auth_settings);
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('ARRAY[LoggingAzureblobResponse]', $response);
return $_response_object;
}
#
# update_log_azure
#
# Update an Azure Blob Storage 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_azureblob_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 `vcl_deliver`. (optional)
# @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://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). (optional, default to '%h %l %u %t "%r" %>s %b')
# @param string $log_processing_region The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. (optional, default to 'none')
# @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` if `format_version` is set to `1`. (optional, default to 2)
# @param string $message_type How the message should be formatted. (optional, default to 'classic')
# @param string $timestamp_format A timestamp format (optional)
# @param string $compression_codec 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. (optional)
# @param int $period How frequently log files are finalized so they can be available for reading (in seconds). (optional, default to 3600)
# @param int $gzip_level 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. (optional, default to 0)
# @param string $path The path to upload logs to. (optional, default to 'null')
# @param string $account_name The unique Azure Blob Storage namespace in which your data objects are stored. Required. (optional)
# @param string $container The name of the Azure Blob Storage container in which to store logs. Required. (optional)
# @param string $sas_token The Azure shared access signature providing write access to the blob service objects. Be sure to update your token before it expires or the logging functionality will not work. Required. (optional)
# @param string $public_key A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (optional, default to 'null')
# @param int $file_max_bytes The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB). Note that Microsoft Azure Storage has [block size limits](https://learn.microsoft.com/en-us/rest/api/storageservices/put-block?tabs=microsoft-entra-id#remarks). (optional)
{
my $params = {
'service_id' => {
data_type => 'string',
description => 'Alphanumeric string identifying the service.',
required => '1',
},
'version_id' => {
data_type => 'int',
description => 'Integer identifying a service version.',
required => '1',
},
'logging_azureblob_name' => {
data_type => 'string',
description => 'The name for the real-time logging configuration.',
required => '1',
},
'name' => {
data_type => 'string',
description => 'The name for the real-time logging configuration.',
required => '0',
},
'placement' => {
data_type => 'string',
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`. ',
required => '0',
},
'response_condition' => {
data_type => 'string',
description => 'The name of an existing condition in the configured endpoint, or leave blank to always execute.',
required => '0',
},
'format' => {
data_type => 'string',
description => 'A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).',
required => '0',
},
'log_processing_region' => {
data_type => 'string',
description => 'The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.',
required => '0',
},
'format_version' => {
data_type => 'int',
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`. ',
required => '0',
},
'message_type' => {
data_type => 'string',
description => 'How the message should be formatted.',
required => '0',
},
'timestamp_format' => {
data_type => 'string',
description => 'A timestamp format',
required => '0',
},
'compression_codec' => {
data_type => 'string',
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.',
required => '0',
},
'period' => {
data_type => 'int',
description => 'How frequently log files are finalized so they can be available for reading (in seconds).',
required => '0',
},
'gzip_level' => {
data_type => 'int',
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.',
required => '0',
},
'path' => {
data_type => 'string',
description => 'The path to upload logs to.',
required => '0',
},
'account_name' => {
data_type => 'string',
description => 'The unique Azure Blob Storage namespace in which your data objects are stored. Required.',
required => '0',
},
'container' => {
data_type => 'string',
description => 'The name of the Azure Blob Storage container in which to store logs. Required.',
required => '0',
},
'sas_token' => {
data_type => 'string',
description => 'The Azure shared access signature providing write access to the blob service objects. Be sure to update your token before it expires or the logging functionality will not work. Required.',
required => '0',
},
'public_key' => {
data_type => 'string',
description => 'A PGP public key that Fastly will use to encrypt your log files before writing them to disk.',
required => '0',
},
'file_max_bytes' => {
data_type => 'int',
description => 'The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB). Note that Microsoft Azure Storage has [block size limits](https://learn.microsoft.com/en-us/rest/api/storageservices/put-block?tabs=microsoft-entra-id#remarks).',
required => '0',
},
};
__PACKAGE__->method_documentation->{ 'update_log_azure' } = {
summary => 'Update an Azure Blob Storage log endpoint',
params => $params,
returns => 'LoggingAzureblobResponse',
};
}
# @return LoggingAzureblobResponse
#
sub update_log_azure {
my ($self, %args) = @_;
# verify the required parameter 'service_id' is set
unless (exists $args{'service_id'}) {
croak("Missing the required parameter 'service_id' when calling update_log_azure");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling update_log_azure");
}
# verify the required parameter 'logging_azureblob_name' is set
unless (exists $args{'logging_azureblob_name'}) {
croak("Missing the required parameter 'logging_azureblob_name' when calling update_log_azure");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/azureblob/{logging_azureblob_name}';
my $_method = 'PUT';
my $query_params = {};
my $header_params = {};
my $form_params = {};
# 'Accept' and 'Content-Type' header
my $_header_accept = $self->{api_client}->select_header_accept('application/json');
if ($_header_accept) {
$header_params->{'Accept'} = $_header_accept;
}
$header_params->{'Content-Type'} = $self->{api_client}->select_header_content_type('application/x-www-form-urlencoded');
# path params
if ( exists $args{'service_id'}) {
my $_base_variable = "{" . "service_id" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'service_id'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
# path params
if ( exists $args{'version_id'}) {
my $_base_variable = "{" . "version_id" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'version_id'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
# path params
if ( exists $args{'logging_azureblob_name'}) {
my $_base_variable = "{" . "logging_azureblob_name" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'logging_azureblob_name'});
$_resource_path =~ s/$_base_variable/$_base_value/g;
}
# form params
if ( exists $args{'name'} ) {
$form_params->{'name'} = $self->{api_client}->to_form_value($args{'name'});
}
# form params
if ( exists $args{'placement'} ) {
$form_params->{'placement'} = $self->{api_client}->to_form_value($args{'placement'});
}
# form params
if ( exists $args{'response_condition'} ) {
$form_params->{'response_condition'} = $self->{api_client}->to_form_value($args{'response_condition'});
}
# form params
if ( exists $args{'format'} ) {
$form_params->{'format'} = $self->{api_client}->to_form_value($args{'format'});
}
# form params
if ( exists $args{'log_processing_region'} ) {
$form_params->{'log_processing_region'} = $self->{api_client}->to_form_value($args{'log_processing_region'});
}
# form params
if ( exists $args{'format_version'} ) {
$form_params->{'format_version'} = $self->{api_client}->to_form_value($args{'format_version'});
}
# form params
if ( exists $args{'message_type'} ) {
$form_params->{'message_type'} = $self->{api_client}->to_form_value($args{'message_type'});
}
# form params
if ( exists $args{'timestamp_format'} ) {
$form_params->{'timestamp_format'} = $self->{api_client}->to_form_value($args{'timestamp_format'});
}
# form params
if ( exists $args{'compression_codec'} ) {
$form_params->{'compression_codec'} = $self->{api_client}->to_form_value($args{'compression_codec'});
}
# form params
if ( exists $args{'period'} ) {
$form_params->{'period'} = $self->{api_client}->to_form_value($args{'period'});
}
# form params
if ( exists $args{'gzip_level'} ) {
$form_params->{'gzip_level'} = $self->{api_client}->to_form_value($args{'gzip_level'});
}
# form params
if ( exists $args{'path'} ) {
$form_params->{'path'} = $self->{api_client}->to_form_value($args{'path'});
}
# form params
if ( exists $args{'account_name'} ) {
$form_params->{'account_name'} = $self->{api_client}->to_form_value($args{'account_name'});
}
# form params
if ( exists $args{'container'} ) {
$form_params->{'container'} = $self->{api_client}->to_form_value($args{'container'});
}
# form params
if ( exists $args{'sas_token'} ) {
$form_params->{'sas_token'} = $self->{api_client}->to_form_value($args{'sas_token'});
}
# form params
if ( exists $args{'public_key'} ) {
$form_params->{'public_key'} = $self->{api_client}->to_form_value($args{'public_key'});
}
# form params
if ( exists $args{'file_max_bytes'} ) {
$form_params->{'file_max_bytes'} = $self->{api_client}->to_form_value($args{'file_max_bytes'});
}
my $_body_data;
# authentication setting, if any
my $auth_settings = [qw(token )];
# make the API Call
my $response = $self->{api_client}->call_api($_resource_path, $_method,
$query_params, $form_params,
$header_params, $_body_data, $auth_settings);
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('LoggingAzureblobResponse', $response);
return $_response_object;
}
1;