class Fastly
  # An endpoint to stream syslogs to
  class Syslog < BelongsToServiceAndVersion
    attr_accessor :service_id, :name, :comment, :ipv4, :ipv6, :hostname, :port, :placement, :token, :format, :format_version, :message_type, :response_condition, :use_tls, :tls_hostname, :tls_ca_cert

    ##
    # :attr: service_id
    #
    # The id of the service this belongs to.
    #

    ##
    # :attr: version
    #
    # The number of the version this belongs to.
    #

    ##
    # :attr: name
    #
    # The domain name of this domain
    #

    ##
    # :attr: comment
    #
    # a free form comment field

    ##
    # :attr: address
    #
    # A magic field - will automagically be set to whichever of ipv4, ipv6 or hostname is currently set.
    #
    # Conversely if you set the address field then the correct field from ipv4, ipv6 or hostname will be set.

    ##
    # :attr: ipv4
    #
    # the ipv4 address of the host to stream logs to (this, hostname or ipv6 must be set)

    ##
    # :attr: ipv6
    #
    # the ipv6 address of the host to stream logs to  (this, hostname or ipv4 must be set)

    ##
    # :attr: hostname
    #
    # the hostname to to stream logs to  (this, ipv4 or ipv6 must be set)

    ##
    # :attr: port
    #
    # the port to stream logs to (defaults to 514)
    
    ##
    # :attr: placement
    #
    # Where in the generated VCL the logging call should be placed

    ##
    # :attr: token
    #
    # Whether to prepend each message with a specific token.

    ##
    # :attr: format
    #
    # Format to log like in apache format

    ##
    # :attr: format_version
    #
    # The version of the custom logging format used for the configured endpoint.
    # Can be either 1 (the default, version 1 log format) or 2 (the version 2
    # log format).

    ##
    # :attr: message_type
    #
    # How the message should be formatted. Can be either classic (RFC 3164
    # syslog prefix), loggly (RFC 5424 structured syslog), logplex (Heroku-style
    # length prefixed syslog), or blank (No prefix. Useful for writing JSON and
    # CSV).

    ##
    # :attr: response_condition
    #
    # name of a response_condition to filter the log on, if empty it always logs

    ##
    # :attr: use_tls
    #
    # Establish a TLS connection when connecting

    ##
    # :attr: tls_hostname
    #
    # Hostname used to verify the certificate. It can either be the CN or be in
    # subAltNames. Not required.

    ##
    # :attr: tls_ca_cert
    #
    # Use this pem formatted certificate as the CA cert to verify the syslog
    # server's certificate
    def self.path
      'logging/syslog'
    end
  end
end