WebService-Fastly/lib/WebService/Fastly/LoggingLogentriesApi.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::LoggingLogentriesApi;
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_logentries
#
# Create a Logentries 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 int $port The port number. (optional, default to 20000)
# @param string $token Use token based authentication. (optional)
# @param LoggingUseTlsString $use_tls (optional)
# @param string $region The region to which to stream logs. (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',
},
'port' => {
data_type => 'int',
description => 'The port number.',
required => '0',
},
'token' => {
data_type => 'string',
description => 'Use token based authentication.',
required => '0',
},
'use_tls' => {
data_type => 'LoggingUseTlsString',
description => '',
required => '0',
},
'region' => {
data_type => 'string',
description => 'The region to which to stream logs.',
required => '0',
},
};
__PACKAGE__->method_documentation->{ 'create_log_logentries' } = {
summary => 'Create a Logentries log endpoint',
params => $params,
returns => 'LoggingLogentriesResponse',
};
}
# @return LoggingLogentriesResponse
#
sub create_log_logentries {
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_logentries");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling create_log_logentries");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/logentries';
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{'port'} ) {
$form_params->{'port'} = $self->{api_client}->to_form_value($args{'port'});
}
# form params
if ( exists $args{'token'} ) {
$form_params->{'token'} = $self->{api_client}->to_form_value($args{'token'});
}
# form params
if ( exists $args{'use_tls'} ) {
$form_params->{'use_tls'} = $self->{api_client}->to_form_value($args{'use_tls'});
}
# form params
if ( exists $args{'region'} ) {
$form_params->{'region'} = $self->{api_client}->to_form_value($args{'region'});
}
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('LoggingLogentriesResponse', $response);
return $_response_object;
}
#
# delete_log_logentries
#
# Delete a Logentries 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_logentries_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_logentries_name' => {
data_type => 'string',
description => 'The name for the real-time logging configuration.',
required => '1',
},
};
__PACKAGE__->method_documentation->{ 'delete_log_logentries' } = {
summary => 'Delete a Logentries log endpoint',
params => $params,
returns => 'InlineResponse200',
};
}
# @return InlineResponse200
#
sub delete_log_logentries {
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_logentries");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling delete_log_logentries");
}
# verify the required parameter 'logging_logentries_name' is set
unless (exists $args{'logging_logentries_name'}) {
croak("Missing the required parameter 'logging_logentries_name' when calling delete_log_logentries");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/logentries/{logging_logentries_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_logentries_name'}) {
my $_base_variable = "{" . "logging_logentries_name" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'logging_logentries_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_logentries
#
# Get a Logentries 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_logentries_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_logentries_name' => {
data_type => 'string',
description => 'The name for the real-time logging configuration.',
required => '1',
},
};
__PACKAGE__->method_documentation->{ 'get_log_logentries' } = {
summary => 'Get a Logentries log endpoint',
params => $params,
returns => 'LoggingLogentriesResponse',
};
}
# @return LoggingLogentriesResponse
#
sub get_log_logentries {
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_logentries");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling get_log_logentries");
}
# verify the required parameter 'logging_logentries_name' is set
unless (exists $args{'logging_logentries_name'}) {
croak("Missing the required parameter 'logging_logentries_name' when calling get_log_logentries");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/logentries/{logging_logentries_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_logentries_name'}) {
my $_base_variable = "{" . "logging_logentries_name" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'logging_logentries_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('LoggingLogentriesResponse', $response);
return $_response_object;
}
#
# list_log_logentries
#
# List Logentries 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_logentries' } = {
summary => 'List Logentries log endpoints',
params => $params,
returns => 'ARRAY[LoggingLogentriesResponse]',
};
}
# @return ARRAY[LoggingLogentriesResponse]
#
sub list_log_logentries {
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_logentries");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling list_log_logentries");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/logentries';
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[LoggingLogentriesResponse]', $response);
return $_response_object;
}
#
# update_log_logentries
#
# Update a Logentries 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_logentries_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 int $port The port number. (optional, default to 20000)
# @param string $token Use token based authentication. (optional)
# @param LoggingUseTlsString $use_tls (optional)
# @param string $region The region to which to stream logs. (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_logentries_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',
},
'port' => {
data_type => 'int',
description => 'The port number.',
required => '0',
},
'token' => {
data_type => 'string',
description => 'Use token based authentication.',
required => '0',
},
'use_tls' => {
data_type => 'LoggingUseTlsString',
description => '',
required => '0',
},
'region' => {
data_type => 'string',
description => 'The region to which to stream logs.',
required => '0',
},
};
__PACKAGE__->method_documentation->{ 'update_log_logentries' } = {
summary => 'Update a Logentries log endpoint',
params => $params,
returns => 'LoggingLogentriesResponse',
};
}
# @return LoggingLogentriesResponse
#
sub update_log_logentries {
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_logentries");
}
# verify the required parameter 'version_id' is set
unless (exists $args{'version_id'}) {
croak("Missing the required parameter 'version_id' when calling update_log_logentries");
}
# verify the required parameter 'logging_logentries_name' is set
unless (exists $args{'logging_logentries_name'}) {
croak("Missing the required parameter 'logging_logentries_name' when calling update_log_logentries");
}
# parse inputs
my $_resource_path = '/service/{service_id}/version/{version_id}/logging/logentries/{logging_logentries_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_logentries_name'}) {
my $_base_variable = "{" . "logging_logentries_name" . "}";
my $_base_value = $self->{api_client}->to_path_value($args{'logging_logentries_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{'port'} ) {
$form_params->{'port'} = $self->{api_client}->to_form_value($args{'port'});
}
# form params
if ( exists $args{'token'} ) {
$form_params->{'token'} = $self->{api_client}->to_form_value($args{'token'});
}
# form params
if ( exists $args{'use_tls'} ) {
$form_params->{'use_tls'} = $self->{api_client}->to_form_value($args{'use_tls'});
}
# form params
if ( exists $args{'region'} ) {
$form_params->{'region'} = $self->{api_client}->to_form_value($args{'region'});
}
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('LoggingLogentriesResponse', $response);
return $_response_object;
}
1;