Skip to content

Latest commit

 

History

History
239 lines (178 loc) · 12 KB

LoggingSumologicApi.md

File metadata and controls

239 lines (178 loc) · 12 KB
Raw

Fastly\Api\LoggingSumologicApi

$apiInstance = new Fastly\Api\LoggingSumologicApi(
    // 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

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
createLogSumologic() POST /service/{service_id}/version/{version_id}/logging/sumologic Create a Sumologic log endpoint
deleteLogSumologic() DELETE /service/{service_id}/version/{version_id}/logging/sumologic/{logging_sumologic_name} Delete a Sumologic log endpoint
getLogSumologic() GET /service/{service_id}/version/{version_id}/logging/sumologic/{logging_sumologic_name} Get a Sumologic log endpoint
listLogSumologic() GET /service/{service_id}/version/{version_id}/logging/sumologic List Sumologic log endpoints
updateLogSumologic() PUT /service/{service_id}/version/{version_id}/logging/sumologic/{logging_sumologic_name} Update a Sumologic log endpoint

createLogSumologic()

createLogSumologic($options): \Fastly\Model\LoggingSumologicResponse // Create a Sumologic log endpoint

Create a Sumologic 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'] = new \Fastly\Model\LoggingMessageType(); // \Fastly\Model\LoggingMessageType
$options['url'] = 'url_example'; // string | The URL to post logs to.

try {
    $result = $apiInstance->createLogSumologic($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingSumologicApi->createLogSumologic: ', $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 \Fastly\Model\LoggingMessageType [optional]
url string The URL to post logs to. [optional]

Return type

\Fastly\Model\LoggingSumologicResponse

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

deleteLogSumologic()

deleteLogSumologic($options): \Fastly\Model\InlineResponse200 // Delete a Sumologic log endpoint

Delete the Sumologic 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_sumologic_name'] = 'logging_sumologic_name_example'; // string | The name for the real-time logging configuration.

try {
    $result = $apiInstance->deleteLogSumologic($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingSumologicApi->deleteLogSumologic: ', $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_sumologic_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]

getLogSumologic()

getLogSumologic($options): \Fastly\Model\LoggingSumologicResponse // Get a Sumologic log endpoint

Get the Sumologic 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_sumologic_name'] = 'logging_sumologic_name_example'; // string | The name for the real-time logging configuration.

try {
    $result = $apiInstance->getLogSumologic($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingSumologicApi->getLogSumologic: ', $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_sumologic_name string The name for the real-time logging configuration.

Return type

\Fastly\Model\LoggingSumologicResponse

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

listLogSumologic()

listLogSumologic($options): \Fastly\Model\LoggingSumologicResponse[] // List Sumologic log endpoints

List all of the Sumologics 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->listLogSumologic($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingSumologicApi->listLogSumologic: ', $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\LoggingSumologicResponse[]

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

updateLogSumologic()

updateLogSumologic($options): \Fastly\Model\LoggingSumologicResponse // Update a Sumologic log endpoint

Update the Sumologic 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_sumologic_name'] = 'logging_sumologic_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'] = new \Fastly\Model\LoggingMessageType(); // \Fastly\Model\LoggingMessageType
$options['url'] = 'url_example'; // string | The URL to post logs to.

try {
    $result = $apiInstance->updateLogSumologic($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingSumologicApi->updateLogSumologic: ', $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_sumologic_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 \Fastly\Model\LoggingMessageType [optional]
url string The URL to post logs to. [optional]

Return type

\Fastly\Model\LoggingSumologicResponse

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