Skip to content

Latest commit

 

History

History
231 lines (157 loc) · 10.8 KB

LoggingGcsApi.md

File metadata and controls

231 lines (157 loc) · 10.8 KB
Raw

LoggingGcsApi

Note

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

Method HTTP request Description
create_log_gcs POST /service/{service_id}/version/{version_id}/logging/gcs Create a GCS log endpoint
delete_log_gcs DELETE /service/{service_id}/version/{version_id}/logging/gcs/{logging_gcs_name} Delete a GCS log endpoint
get_log_gcs GET /service/{service_id}/version/{version_id}/logging/gcs/{logging_gcs_name} Get a GCS log endpoint
list_log_gcs GET /service/{service_id}/version/{version_id}/logging/gcs List GCS log endpoints
update_log_gcs PUT /service/{service_id}/version/{version_id}/logging/gcs/{logging_gcs_name} Update a GCS log endpoint

create_log_gcs

Create GCS logging for a particular service and version.

let cfg = &Configuration::default();
let params = CreateLogGcsParams {
    // parameters
};
create_log_gcs(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
name Option<String> The name for the real-time logging configuration.
placement Option<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.
response_condition Option<String> The name of an existing condition in the configured endpoint, or leave blank to always execute.
format Option<String> A Fastly log format string. [default to %h %l %u %t "%r" %>s %b]
format_version Option<i32> 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. [default to FormatVersion_v2]
message_type Option<String> How the message should be formatted. [default to MessageType_Classic]
timestamp_format Option<String> A timestamp format
compression_codec Option<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.
period Option<i32> How frequently log files are finalized so they can be available for reading (in seconds). [default to 3600]
gzip_level Option<i32> 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. [default to 0]
user Option<String> Your Google Cloud Platform service account email address. The client_email field in your service account authentication JSON. Not required if account_name is specified.
secret_key Option<String> Your Google Cloud Platform account secret key. The private_key field in your service account authentication JSON. Not required if account_name is specified.
account_name Option<String> The name of the Google Cloud Platform service account associated with the target log collection service. Not required if user and secret_key are provided.
bucket_name Option<String> The name of the GCS bucket.
path Option<String> [default to /]
public_key Option<String> A PGP public key that Fastly will use to encrypt your log files before writing them to disk. [default to null]
project_id Option<String> Your Google Cloud Platform project ID. Required

Return type

crate::models::LoggingGcsResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

delete_log_gcs

Delete the GCS Logging for a particular service and version.

let cfg = &Configuration::default();
let params = DeleteLogGcsParams {
    // parameters
};
delete_log_gcs(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
logging_gcs_name String The name for the real-time logging configuration. [required]

Return type

crate::models::InlineResponse200

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_log_gcs

Get the GCS Logging for a particular service and version.

let cfg = &Configuration::default();
let params = GetLogGcsParams {
    // parameters
};
get_log_gcs(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
logging_gcs_name String The name for the real-time logging configuration. [required]

Return type

crate::models::LoggingGcsResponse

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

list_log_gcs

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

let cfg = &Configuration::default();
let params = ListLogGcsParams {
    // parameters
};
list_log_gcs(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]

Return type

Vec<crate::models::LoggingGcsResponse>

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

update_log_gcs

Update the GCS for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateLogGcsParams {
    // parameters
};
update_log_gcs(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
logging_gcs_name String The name for the real-time logging configuration. [required]
name Option<String> The name for the real-time logging configuration.
placement Option<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.
response_condition Option<String> The name of an existing condition in the configured endpoint, or leave blank to always execute.
format Option<String> A Fastly log format string. [default to %h %l %u %t "%r" %>s %b]
format_version Option<i32> 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. [default to FormatVersion_v2]
message_type Option<String> How the message should be formatted. [default to MessageType_Classic]
timestamp_format Option<String> A timestamp format
compression_codec Option<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.
period Option<i32> How frequently log files are finalized so they can be available for reading (in seconds). [default to 3600]
gzip_level Option<i32> 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. [default to 0]
user Option<String> Your Google Cloud Platform service account email address. The client_email field in your service account authentication JSON. Not required if account_name is specified.
secret_key Option<String> Your Google Cloud Platform account secret key. The private_key field in your service account authentication JSON. Not required if account_name is specified.
account_name Option<String> The name of the Google Cloud Platform service account associated with the target log collection service. Not required if user and secret_key are provided.
bucket_name Option<String> The name of the GCS bucket.
path Option<String> [default to /]
public_key Option<String> A PGP public key that Fastly will use to encrypt your log files before writing them to disk. [default to null]
project_id Option<String> Your Google Cloud Platform project ID. Required

Return type

crate::models::LoggingGcsResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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