Skip to content

Latest commit

 

History

History
484 lines (358 loc) · 23.8 KB

LoggingPubsubApi.md

File metadata and controls

484 lines (358 loc) · 23.8 KB

fastly.LoggingPubsubApi

Note

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

Method HTTP request Description
create_log_gcp_pubsub POST /service/{service_id}/version/{version_id}/logging/pubsub Create a GCP Cloud Pub/Sub log endpoint
delete_log_gcp_pubsub DELETE /service/{service_id}/version/{version_id}/logging/pubsub/{logging_google_pubsub_name} Delete a GCP Cloud Pub/Sub log endpoint
get_log_gcp_pubsub GET /service/{service_id}/version/{version_id}/logging/pubsub/{logging_google_pubsub_name} Get a GCP Cloud Pub/Sub log endpoint
list_log_gcp_pubsub GET /service/{service_id}/version/{version_id}/logging/pubsub List GCP Cloud Pub/Sub log endpoints
update_log_gcp_pubsub PUT /service/{service_id}/version/{version_id}/logging/pubsub/{logging_google_pubsub_name} Update a GCP Cloud Pub/Sub log endpoint

create_log_gcp_pubsub

LoggingGooglePubsubResponse create_log_gcp_pubsub(service_id, version_id)

Create a GCP Cloud Pub/Sub log endpoint

Create a Pub/Sub logging object for a particular service and version.

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_pubsub_api
from fastly.model.logging_google_pubsub_response import LoggingGooglePubsubResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_pubsub_api.LoggingPubsubApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    name = "test-log-endpoint" # str | The name for the real-time logging configuration. (optional)
    placement = "none" # str, none_type | 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)
    response_condition = "response_condition_example" # str, none_type | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format = "%h %l %u %t "%r" %>s %b" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b"
    format_version = 2 # 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) if omitted the server will use the default value of 2
    user = "[email protected]" # str | 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. (optional)
    secret_key = '''-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----
''' # str | Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Not required if `account_name` is specified. (optional)
    account_name = "[email protected]" # str | 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. (optional)
    topic = "topic_example" # str | The Google Cloud Pub/Sub topic to which logs will be published. Required. (optional)
    project_id = "test-project-id" # str | Your Google Cloud Platform project ID. Required (optional)

    # example passing only required values which don't have defaults set
    try:
        # Create a GCP Cloud Pub/Sub log endpoint
        api_response = api_instance.create_log_gcp_pubsub(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingPubsubApi->create_log_gcp_pubsub: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a GCP Cloud Pub/Sub log endpoint
        api_response = api_instance.create_log_gcp_pubsub(service_id, version_id, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, user=user, secret_key=secret_key, account_name=account_name, topic=topic, project_id=project_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingPubsubApi->create_log_gcp_pubsub: %s\n" % e)

Parameters

Name Type Description Notes
service_id str Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
name str The name for the real-time logging configuration. [optional]
placement str, none_type 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]
response_condition str, none_type The name of an existing condition in the configured endpoint, or leave blank to always execute. [optional]
format str A Fastly log format string. [optional] if omitted the server will use the default value of "%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] if omitted the server will use the default value of 2
user str 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. [optional]
secret_key str Your Google Cloud Platform account secret key. The private_key field in your service account authentication JSON. Not required if account_name is specified. [optional]
account_name str 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. [optional]
topic str The Google Cloud Pub/Sub topic to which logs will be published. Required. [optional]
project_id str Your Google Cloud Platform project ID. Required [optional]

Return type

LoggingGooglePubsubResponse

Authorization

token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

delete_log_gcp_pubsub

InlineResponse200 delete_log_gcp_pubsub(service_id, version_id, logging_google_pubsub_name)

Delete a GCP Cloud Pub/Sub log endpoint

Delete a Pub/Sub logging object for a particular service and version.

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_pubsub_api
from fastly.model.inline_response200 import InlineResponse200
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_pubsub_api.LoggingPubsubApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_google_pubsub_name = "test-log-endpoint" # str | The name for the real-time logging configuration.

    # example passing only required values which don't have defaults set
    try:
        # Delete a GCP Cloud Pub/Sub log endpoint
        api_response = api_instance.delete_log_gcp_pubsub(service_id, version_id, logging_google_pubsub_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingPubsubApi->delete_log_gcp_pubsub: %s\n" % e)

Parameters

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

Return type

InlineResponse200

Authorization

token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

get_log_gcp_pubsub

LoggingGooglePubsubResponse get_log_gcp_pubsub(service_id, version_id, logging_google_pubsub_name)

Get a GCP Cloud Pub/Sub log endpoint

Get the details for a Pub/Sub logging object for a particular service and version.

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_pubsub_api
from fastly.model.logging_google_pubsub_response import LoggingGooglePubsubResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_pubsub_api.LoggingPubsubApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_google_pubsub_name = "test-log-endpoint" # str | The name for the real-time logging configuration.

    # example passing only required values which don't have defaults set
    try:
        # Get a GCP Cloud Pub/Sub log endpoint
        api_response = api_instance.get_log_gcp_pubsub(service_id, version_id, logging_google_pubsub_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingPubsubApi->get_log_gcp_pubsub: %s\n" % e)

Parameters

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

Return type

LoggingGooglePubsubResponse

Authorization

token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

list_log_gcp_pubsub

[LoggingGooglePubsubResponse] list_log_gcp_pubsub(service_id, version_id)

List GCP Cloud Pub/Sub log endpoints

List all of the Pub/Sub logging objects for a particular service and version.

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_pubsub_api
from fastly.model.logging_google_pubsub_response import LoggingGooglePubsubResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_pubsub_api.LoggingPubsubApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.

    # example passing only required values which don't have defaults set
    try:
        # List GCP Cloud Pub/Sub log endpoints
        api_response = api_instance.list_log_gcp_pubsub(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingPubsubApi->list_log_gcp_pubsub: %s\n" % e)

Parameters

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

Return type

[LoggingGooglePubsubResponse]

Authorization

token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

update_log_gcp_pubsub

LoggingGooglePubsubResponse update_log_gcp_pubsub(service_id, version_id, logging_google_pubsub_name)

Update a GCP Cloud Pub/Sub log endpoint

Update a Pub/Sub logging object for a particular service and version.

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_pubsub_api
from fastly.model.logging_google_pubsub_response import LoggingGooglePubsubResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_pubsub_api.LoggingPubsubApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_google_pubsub_name = "test-log-endpoint" # str | The name for the real-time logging configuration.
    name = "test-log-endpoint" # str | The name for the real-time logging configuration. (optional)
    placement = "none" # str, none_type | 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)
    response_condition = "response_condition_example" # str, none_type | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format = "%h %l %u %t "%r" %>s %b" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b"
    format_version = 2 # 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) if omitted the server will use the default value of 2
    user = "[email protected]" # str | 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. (optional)
    secret_key = '''-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----
''' # str | Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Not required if `account_name` is specified. (optional)
    account_name = "[email protected]" # str | 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. (optional)
    topic = "topic_example" # str | The Google Cloud Pub/Sub topic to which logs will be published. Required. (optional)
    project_id = "test-project-id" # str | Your Google Cloud Platform project ID. Required (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update a GCP Cloud Pub/Sub log endpoint
        api_response = api_instance.update_log_gcp_pubsub(service_id, version_id, logging_google_pubsub_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingPubsubApi->update_log_gcp_pubsub: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update a GCP Cloud Pub/Sub log endpoint
        api_response = api_instance.update_log_gcp_pubsub(service_id, version_id, logging_google_pubsub_name, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, user=user, secret_key=secret_key, account_name=account_name, topic=topic, project_id=project_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingPubsubApi->update_log_gcp_pubsub: %s\n" % e)

Parameters

Name Type Description Notes
service_id str Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
logging_google_pubsub_name str The name for the real-time logging configuration.
name str The name for the real-time logging configuration. [optional]
placement str, none_type 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]
response_condition str, none_type The name of an existing condition in the configured endpoint, or leave blank to always execute. [optional]
format str A Fastly log format string. [optional] if omitted the server will use the default value of "%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] if omitted the server will use the default value of 2
user str 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. [optional]
secret_key str Your Google Cloud Platform account secret key. The private_key field in your service account authentication JSON. Not required if account_name is specified. [optional]
account_name str 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. [optional]
topic str The Google Cloud Pub/Sub topic to which logs will be published. Required. [optional]
project_id str Your Google Cloud Platform project ID. Required [optional]

Return type

LoggingGooglePubsubResponse

Authorization

token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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