WebService-Fastly/lib/WebService/Fastly/LoggingKinesisApi.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::LoggingKinesisApi;
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_kinesis
#
# Create an Amazon Kinesis 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 LoggingPlacement $placement (optional)
# @param string $format A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). (optional, default to '{"timestamp":"%{begin:%Y-%m-%dT%H:%M:%S}t","time_elapsed":"%{time.elapsed.usec}V","is_tls":"%{if(req.is_ssl, \"true\", \"false\")}V","client_ip":"%{req.http.Fastly-Client-IP}V","geo_city":"%{client.geo.city}V","geo_country_code":"%{client.geo.country_code}V","request":"%{req.request}V","host":"%{req.http.Fastly-Orig-Host}V","url":"%{json.escape(req.url)}V","request_referer":"%{json.escape(req.http.Referer)}V","request_user_agent":"%{json.escape(req.http.User-Agent)}V","request_accept_language":"%{json.escape(req.http.Accept-Language)}V","request_accept_charset":"%{json.escape(req.http.Accept-Charset)}V","cache_status":"%{regsub(fastly_info.state, \"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}')
# @param string $topic The Amazon Kinesis stream to send logs to. Required. (optional)
# @param AwsRegion $region (optional)
# @param string $secret_key The secret key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified. (optional)
# @param string $access_key The access key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified. (optional)
# @param string $iam_role The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if `access_key` and `secret_key` are provided. (optional)
# @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)
{
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 => 'LoggingPlacement',
description => '',
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',
},
'topic' => {
data_type => 'string',
description => 'The Amazon Kinesis stream to send logs to. Required.',
required => '0',
},
'region' => {
data_type => 'AwsRegion',
description => '',
required => '0',
},
'secret_key' => {
data_type => 'string',
description => 'The secret key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified.',
required => '0',
},
'access_key' => {
data_type => 'string',
description => 'The access key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified.',
required => '0',
},
'iam_role' => {
data_type => 'string',
description => 'The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if `access_key` and `secret_key` are provided.',
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',
},
};
__PACKAGE__->method_documentation->{ 'create_log_kinesis' } = {
summary => 'Create an Amazon Kinesis log endpoint',
params => $params,
returns => 'LoggingKinesisResponse',
};
}
# @return LoggingKinesisResponse
#
sub create_log_kinesis {
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_kinesis");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling create_log_kinesis");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/kinesis';
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{'format'} ) {
$form_params->{'format'} = $self->{api_client}->to_form_value($args{'format'});
}
# form params
if ( exists $args{'topic'} ) {
$form_params->{'topic'} = $self->{api_client}->to_form_value($args{'topic'});
}
# form params
if ( exists $args{'region'} ) {
$form_params->{'region'} = $self->{api_client}->to_form_value($args{'region'});
}
# form params
if ( exists $args{'secret_key'} ) {
$form_params->{'secret_key'} = $self->{api_client}->to_form_value($args{'secret_key'});
}
# form params
if ( exists $args{'access_key'} ) {
$form_params->{'access_key'} = $self->{api_client}->to_form_value($args{'access_key'});
}
# form params
if ( exists $args{'iam_role'} ) {
$form_params->{'iam_role'} = $self->{api_client}->to_form_value($args{'iam_role'});
}
# form params
if ( exists $args{'format_version'} ) {
$form_params->{'format_version'} = $self->{api_client}->to_form_value($args{'format_version'});
}
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('LoggingKinesisResponse', $response);
return $_response_object;
}
#
# delete_log_kinesis
#
# Delete the Amazon Kinesis 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_kinesis_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_kinesis_name' => {
data_type => 'string',
description => 'The name for the real-time logging configuration.',
required => '1',
},
};
__PACKAGE__->method_documentation->{ 'delete_log_kinesis' } = {
summary => 'Delete the Amazon Kinesis log endpoint',
params => $params,
returns => 'InlineResponse200',
};
}
# @return InlineResponse200
#
sub delete_log_kinesis {
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_kinesis");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling delete_log_kinesis");
}
# verify the required parameter 'logging_kinesis_name' is set
unless (exists $args{'logging_kinesis_name'}) {
croak("Missing the required parameter 'logging_kinesis_name' when calling delete_log_kinesis");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_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_kinesis_name'}) {
my $_base_variable = "{" . "logging_kinesis_name" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'logging_kinesis_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_kinesis
#
# Get an Amazon Kinesis 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_kinesis_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_kinesis_name' => {
data_type => 'string',
description => 'The name for the real-time logging configuration.',
required => '1',
},
};
__PACKAGE__->method_documentation->{ 'get_log_kinesis' } = {
summary => 'Get an Amazon Kinesis log endpoint',
params => $params,
returns => 'LoggingKinesisResponse',
};
}
# @return LoggingKinesisResponse
#
sub get_log_kinesis {
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_kinesis");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling get_log_kinesis");
}
# verify the required parameter 'logging_kinesis_name' is set
unless (exists $args{'logging_kinesis_name'}) {
croak("Missing the required parameter 'logging_kinesis_name' when calling get_log_kinesis");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_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_kinesis_name'}) {
my $_base_variable = "{" . "logging_kinesis_name" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'logging_kinesis_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('LoggingKinesisResponse', $response);
return $_response_object;
}
#
# list_log_kinesis
#
# List Amazon Kinesis 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_kinesis' } = {
summary => 'List Amazon Kinesis log endpoints',
params => $params,
returns => 'ARRAY[LoggingKinesisResponse]',
};
}
# @return ARRAY[LoggingKinesisResponse]
#
sub list_log_kinesis {
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_kinesis");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling list_log_kinesis");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/kinesis';
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[LoggingKinesisResponse]', $response);
return $_response_object;
}
#
# update_log_kinesis
#
# Update the Amazon Kinesis 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_kinesis_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_kinesis_name' => {
data_type => 'string',
description => 'The name for the real-time logging configuration.',
required => '1',
},
};
__PACKAGE__->method_documentation->{ 'update_log_kinesis' } = {
summary => 'Update the Amazon Kinesis log endpoint',
params => $params,
returns => 'LoggingKinesisResponse',
};
}
# @return LoggingKinesisResponse
#
sub update_log_kinesis {
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_kinesis");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling update_log_kinesis");
}
# verify the required parameter 'logging_kinesis_name' is set
unless (exists $args{'logging_kinesis_name'}) {
croak("Missing the required parameter 'logging_kinesis_name' when calling update_log_kinesis");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_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_kinesis_name'}) {
my $_base_variable = "{" . "logging_kinesis_name" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'logging_kinesis_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('LoggingKinesisResponse', $response);
return $_response_object;
}
1;