Skip to content

Latest commit

 

History

History
272 lines (212 loc) · 17 KB

LoggingCloudfilesApi.md

File metadata and controls

272 lines (212 loc) · 17 KB
Raw

Fastly\Api\LoggingCloudfilesApi

$apiInstance = new Fastly\Api\LoggingCloudfilesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

Methods

Method Fastly API endpoint Description
createLogCloudfiles() POST /service/{service_id}/version/{version_id}/logging/cloudfiles Create a Cloud Files log endpoint
deleteLogCloudfiles() DELETE /service/{service_id}/version/{version_id}/logging/cloudfiles/{logging_cloudfiles_name} Delete the Cloud Files log endpoint
getLogCloudfiles() GET /service/{service_id}/version/{version_id}/logging/cloudfiles/{logging_cloudfiles_name} Get a Cloud Files log endpoint
listLogCloudfiles() GET /service/{service_id}/version/{version_id}/logging/cloudfiles List Cloud Files log endpoints
updateLogCloudfiles() PUT /service/{service_id}/version/{version_id}/logging/cloudfiles/{logging_cloudfiles_name} Update the Cloud Files log endpoint

createLogCloudfiles()

createLogCloudfiles($options): \Fastly\Model\LoggingCloudfilesResponse // Create a Cloud Files log endpoint

Create a Cloud Files log endpoint for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['name'] = 'name_example'; // string | The name for the real-time logging configuration.
$options['placement'] = 'placement_example'; // string | 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`.
$options['response_condition'] = 'response_condition_example'; // string | The name of an existing condition in the configured endpoint, or leave blank to always execute.
$options['format'] = '%h %l %u %t \"%r\" %>s %b'; // string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
$options['format_version'] = self::FORMAT_VERSION_v2; // int | 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`.
$options['message_type'] = 'classic'; // string | How the message should be formatted.
$options['timestamp_format'] = 'timestamp_format_example'; // string | A timestamp format
$options['compression_codec'] = 'compression_codec_example'; // string | 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.
$options['period'] = 3600; // int | How frequently log files are finalized so they can be available for reading (in seconds).
$options['gzip_level'] = 0; // int | 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.
$options['access_key'] = 'access_key_example'; // string | Your Cloud Files account access key.
$options['bucket_name'] = 'bucket_name_example'; // string | The name of your Cloud Files container.
$options['path'] = 'null'; // string | The path to upload logs to.
$options['region'] = 'region_example'; // string | The region to stream logs to.
$options['public_key'] = 'null'; // string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk.
$options['user'] = 'user_example'; // string | The username for your Cloud Files account.

try {
    $result = $apiInstance->createLogCloudfiles($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingCloudfilesApi->createLogCloudfiles: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
name string The name for the real-time logging configuration. [optional]
placement string 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] [one of: 'none', 'waf_debug', 'null']
response_condition string The name of an existing condition in the configured endpoint, or leave blank to always execute. [optional]
format string A Fastly log format string. [optional] [defaults to '%h %l %u %t "%r" %>s %b']
format_version int 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] [one of: 1, 2]
message_type string How the message should be formatted. [optional] [one of: 'classic', 'loggly', 'logplex', 'blank'] [defaults to 'classic']
timestamp_format string A timestamp format [optional]
compression_codec string 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] [one of: 'zstd', 'snappy', 'gzip']
period int How frequently log files are finalized so they can be available for reading (in seconds). [optional] [defaults to 3600]
gzip_level int 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] [defaults to 0]
access_key string Your Cloud Files account access key. [optional]
bucket_name string The name of your Cloud Files container. [optional]
path string The path to upload logs to. [optional] [defaults to 'null']
region string The region to stream logs to. [optional] [one of: 'DFW', 'ORD', 'IAD', 'LON', 'SYD', 'HKG', 'null']
public_key string A PGP public key that Fastly will use to encrypt your log files before writing them to disk. [optional] [defaults to 'null']
user string The username for your Cloud Files account. [optional]

Return type

\Fastly\Model\LoggingCloudfilesResponse

[Back to top] [Back to API list] [Back to README]

deleteLogCloudfiles()

deleteLogCloudfiles($options): \Fastly\Model\InlineResponse200 // Delete the Cloud Files log endpoint

Delete the Cloud Files log endpoint for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['logging_cloudfiles_name'] = 'logging_cloudfiles_name_example'; // string | The name for the real-time logging configuration.

try {
    $result = $apiInstance->deleteLogCloudfiles($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingCloudfilesApi->deleteLogCloudfiles: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
logging_cloudfiles_name string The name for the real-time logging configuration.

Return type

\Fastly\Model\InlineResponse200

[Back to top] [Back to API list] [Back to README]

getLogCloudfiles()

getLogCloudfiles($options): \Fastly\Model\LoggingCloudfilesResponse // Get a Cloud Files log endpoint

Get the Cloud Files log endpoint for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['logging_cloudfiles_name'] = 'logging_cloudfiles_name_example'; // string | The name for the real-time logging configuration.

try {
    $result = $apiInstance->getLogCloudfiles($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingCloudfilesApi->getLogCloudfiles: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
logging_cloudfiles_name string The name for the real-time logging configuration.

Return type

\Fastly\Model\LoggingCloudfilesResponse

[Back to top] [Back to API list] [Back to README]

listLogCloudfiles()

listLogCloudfiles($options): \Fastly\Model\LoggingCloudfilesResponse[] // List Cloud Files log endpoints

List all of the Cloud Files log endpoints for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.

try {
    $result = $apiInstance->listLogCloudfiles($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingCloudfilesApi->listLogCloudfiles: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.

Return type

\Fastly\Model\LoggingCloudfilesResponse[]

[Back to top] [Back to API list] [Back to README]

updateLogCloudfiles()

updateLogCloudfiles($options): \Fastly\Model\LoggingCloudfilesResponse // Update the Cloud Files log endpoint

Update the Cloud Files log endpoint for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['logging_cloudfiles_name'] = 'logging_cloudfiles_name_example'; // string | The name for the real-time logging configuration.
$options['name'] = 'name_example'; // string | The name for the real-time logging configuration.
$options['placement'] = 'placement_example'; // string | 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`.
$options['response_condition'] = 'response_condition_example'; // string | The name of an existing condition in the configured endpoint, or leave blank to always execute.
$options['format'] = '%h %l %u %t \"%r\" %>s %b'; // string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
$options['format_version'] = self::FORMAT_VERSION_v2; // int | 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`.
$options['message_type'] = 'classic'; // string | How the message should be formatted.
$options['timestamp_format'] = 'timestamp_format_example'; // string | A timestamp format
$options['compression_codec'] = 'compression_codec_example'; // string | 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.
$options['period'] = 3600; // int | How frequently log files are finalized so they can be available for reading (in seconds).
$options['gzip_level'] = 0; // int | 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.
$options['access_key'] = 'access_key_example'; // string | Your Cloud Files account access key.
$options['bucket_name'] = 'bucket_name_example'; // string | The name of your Cloud Files container.
$options['path'] = 'null'; // string | The path to upload logs to.
$options['region'] = 'region_example'; // string | The region to stream logs to.
$options['public_key'] = 'null'; // string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk.
$options['user'] = 'user_example'; // string | The username for your Cloud Files account.

try {
    $result = $apiInstance->updateLogCloudfiles($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingCloudfilesApi->updateLogCloudfiles: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
logging_cloudfiles_name string The name for the real-time logging configuration.
name string The name for the real-time logging configuration. [optional]
placement string 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] [one of: 'none', 'waf_debug', 'null']
response_condition string The name of an existing condition in the configured endpoint, or leave blank to always execute. [optional]
format string A Fastly log format string. [optional] [defaults to '%h %l %u %t "%r" %>s %b']
format_version int 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] [one of: 1, 2]
message_type string How the message should be formatted. [optional] [one of: 'classic', 'loggly', 'logplex', 'blank'] [defaults to 'classic']
timestamp_format string A timestamp format [optional]
compression_codec string 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] [one of: 'zstd', 'snappy', 'gzip']
period int How frequently log files are finalized so they can be available for reading (in seconds). [optional] [defaults to 3600]
gzip_level int 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] [defaults to 0]
access_key string Your Cloud Files account access key. [optional]
bucket_name string The name of your Cloud Files container. [optional]
path string The path to upload logs to. [optional] [defaults to 'null']
region string The region to stream logs to. [optional] [one of: 'DFW', 'ORD', 'IAD', 'LON', 'SYD', 'HKG', 'null']
public_key string A PGP public key that Fastly will use to encrypt your log files before writing them to disk. [optional] [defaults to 'null']
user string The username for your Cloud Files account. [optional]

Return type

\Fastly\Model\LoggingCloudfilesResponse

[Back to top] [Back to API list] [Back to README]