Reference documentation and code samples for the Chronicle V1 API class Google::Backstory::Network.
A network event.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#application_protocol
def application_protocol() -> ::Google::Backstory::Network::ApplicationProtocol
Returns
- (::Google::Backstory::Network::ApplicationProtocol) — The application protocol.
#application_protocol=
def application_protocol=(value) -> ::Google::Backstory::Network::ApplicationProtocol
Parameter
- value (::Google::Backstory::Network::ApplicationProtocol) — The application protocol.
Returns
- (::Google::Backstory::Network::ApplicationProtocol) — The application protocol.
#application_protocol_version
def application_protocol_version() -> ::String
Returns
- (::String) — The version of the application protocol. e.g. "1.1, 2.0"
#application_protocol_version=
def application_protocol_version=(value) -> ::String
Parameter
- value (::String) — The version of the application protocol. e.g. "1.1, 2.0"
Returns
- (::String) — The version of the application protocol. e.g. "1.1, 2.0"
#asn
def asn() -> ::String
Returns
- (::String) — Autonomous system number.
#asn=
def asn=(value) -> ::String
Parameter
- value (::String) — Autonomous system number.
Returns
- (::String) — Autonomous system number.
#carrier_name
def carrier_name() -> ::String
Returns
- (::String) — Carrier identification.
#carrier_name=
def carrier_name=(value) -> ::String
Parameter
- value (::String) — Carrier identification.
Returns
- (::String) — Carrier identification.
#community_id
def community_id() -> ::String
Returns
- (::String) — Community ID network flow value.
#community_id=
def community_id=(value) -> ::String
Parameter
- value (::String) — Community ID network flow value.
Returns
- (::String) — Community ID network flow value.
#connection_state
def connection_state() -> ::Google::Backstory::Network::ConnectionState
Returns
- (::Google::Backstory::Network::ConnectionState) — The state of the network connection.
#connection_state=
def connection_state=(value) -> ::Google::Backstory::Network::ConnectionState
Parameter
- value (::Google::Backstory::Network::ConnectionState) — The state of the network connection.
Returns
- (::Google::Backstory::Network::ConnectionState) — The state of the network connection.
#dhcp
def dhcp() -> ::Google::Backstory::Dhcp
Returns
- (::Google::Backstory::Dhcp) — DHCP info.
#dhcp=
def dhcp=(value) -> ::Google::Backstory::Dhcp
Parameter
- value (::Google::Backstory::Dhcp) — DHCP info.
Returns
- (::Google::Backstory::Dhcp) — DHCP info.
#direction
def direction() -> ::Google::Backstory::Network::Direction
Returns
- (::Google::Backstory::Network::Direction) — The direction of network traffic.
#direction=
def direction=(value) -> ::Google::Backstory::Network::Direction
Parameter
- value (::Google::Backstory::Network::Direction) — The direction of network traffic.
Returns
- (::Google::Backstory::Network::Direction) — The direction of network traffic.
#dns
def dns() -> ::Google::Backstory::Dns
Returns
- (::Google::Backstory::Dns) — DNS info.
#dns=
def dns=(value) -> ::Google::Backstory::Dns
Parameter
- value (::Google::Backstory::Dns) — DNS info.
Returns
- (::Google::Backstory::Dns) — DNS info.
#dns_domain
def dns_domain() -> ::String
Returns
- (::String) — DNS domain name.
#dns_domain=
def dns_domain=(value) -> ::String
Parameter
- value (::String) — DNS domain name.
Returns
- (::String) — DNS domain name.
def email() -> ::Google::Backstory::Email
Returns
- (::Google::Backstory::Email) — Email info for the sender/recipient.
#email=
def email=(value) -> ::Google::Backstory::Email
Parameter
- value (::Google::Backstory::Email) — Email info for the sender/recipient.
Returns
- (::Google::Backstory::Email) — Email info for the sender/recipient.
#ftp
def ftp() -> ::Google::Backstory::Ftp
Returns
- (::Google::Backstory::Ftp) — FTP info.
#ftp=
def ftp=(value) -> ::Google::Backstory::Ftp
Parameter
- value (::Google::Backstory::Ftp) — FTP info.
Returns
- (::Google::Backstory::Ftp) — FTP info.
#http
def http() -> ::Google::Backstory::Http
Returns
- (::Google::Backstory::Http) — HTTP info.
#http=
def http=(value) -> ::Google::Backstory::Http
Parameter
- value (::Google::Backstory::Http) — HTTP info.
Returns
- (::Google::Backstory::Http) — HTTP info.
#ip_protocol
def ip_protocol() -> ::Google::Backstory::Network::IpProtocol
Returns
- (::Google::Backstory::Network::IpProtocol) — The IP protocol.
#ip_protocol=
def ip_protocol=(value) -> ::Google::Backstory::Network::IpProtocol
Parameter
- value (::Google::Backstory::Network::IpProtocol) — The IP protocol.
Returns
- (::Google::Backstory::Network::IpProtocol) — The IP protocol.
#ip_subnet_range
def ip_subnet_range() -> ::String
Returns
- (::String) — Associated human-readable IP subnet range (e.g. 10.1.2.0/24).
#ip_subnet_range=
def ip_subnet_range=(value) -> ::String
Parameter
- value (::String) — Associated human-readable IP subnet range (e.g. 10.1.2.0/24).
Returns
- (::String) — Associated human-readable IP subnet range (e.g. 10.1.2.0/24).
#ipv6
def ipv6() -> ::Boolean
Returns
- (::Boolean) — True if IPv6 is used.
#ipv6=
def ipv6=(value) -> ::Boolean
Parameter
- value (::Boolean) — True if IPv6 is used.
Returns
- (::Boolean) — True if IPv6 is used.
#is_proxy
def is_proxy() -> ::Boolean
Returns
- (::Boolean) — Whether the IP address is a known proxy.
#is_proxy=
def is_proxy=(value) -> ::Boolean
Parameter
- value (::Boolean) — Whether the IP address is a known proxy.
Returns
- (::Boolean) — Whether the IP address is a known proxy.
#organization_name
def organization_name() -> ::String
Returns
- (::String) — Organization name (e.g Google).
#organization_name=
def organization_name=(value) -> ::String
Parameter
- value (::String) — Organization name (e.g Google).
Returns
- (::String) — Organization name (e.g Google).
#parent_session_id
def parent_session_id() -> ::String
Returns
- (::String) — The ID of the parent network session.
#parent_session_id=
def parent_session_id=(value) -> ::String
Parameter
- value (::String) — The ID of the parent network session.
Returns
- (::String) — The ID of the parent network session.
#proxy_info
def proxy_info() -> ::Google::Backstory::ProxyInfo
Returns
- (::Google::Backstory::ProxyInfo) — Proxy information. Only set if is_proxy is true.
#proxy_info=
def proxy_info=(value) -> ::Google::Backstory::ProxyInfo
Parameter
- value (::Google::Backstory::ProxyInfo) — Proxy information. Only set if is_proxy is true.
Returns
- (::Google::Backstory::ProxyInfo) — Proxy information. Only set if is_proxy is true.
#received_bytes
def received_bytes() -> ::Integer
Returns
- (::Integer) — The number of bytes received.
#received_bytes=
def received_bytes=(value) -> ::Integer
Parameter
- value (::Integer) — The number of bytes received.
Returns
- (::Integer) — The number of bytes received.
#received_packets
def received_packets() -> ::Integer
Returns
- (::Integer) — The number of packets received.
#received_packets=
def received_packets=(value) -> ::Integer
Parameter
- value (::Integer) — The number of packets received.
Returns
- (::Integer) — The number of packets received.
#sent_bytes
def sent_bytes() -> ::Integer
Returns
- (::Integer) — The number of bytes sent.
#sent_bytes=
def sent_bytes=(value) -> ::Integer
Parameter
- value (::Integer) — The number of bytes sent.
Returns
- (::Integer) — The number of bytes sent.
#sent_packets
def sent_packets() -> ::Integer
Returns
- (::Integer) — The number of packets sent.
#sent_packets=
def sent_packets=(value) -> ::Integer
Parameter
- value (::Integer) — The number of packets sent.
Returns
- (::Integer) — The number of packets sent.
#session_duration
def session_duration() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — The duration of the session as the number of seconds and nanoseconds. For seconds, network.session_duration.seconds, the type is a 64-bit integer. For nanoseconds, network.session_duration.nanos, the type is a 32-bit integer.
#session_duration=
def session_duration=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — The duration of the session as the number of seconds and nanoseconds. For seconds, network.session_duration.seconds, the type is a 64-bit integer. For nanoseconds, network.session_duration.nanos, the type is a 32-bit integer.
Returns
- (::Google::Protobuf::Duration) — The duration of the session as the number of seconds and nanoseconds. For seconds, network.session_duration.seconds, the type is a 64-bit integer. For nanoseconds, network.session_duration.nanos, the type is a 32-bit integer.
#session_id
def session_id() -> ::String
Returns
- (::String) — The ID of the network session.
#session_id=
def session_id=(value) -> ::String
Parameter
- value (::String) — The ID of the network session.
Returns
- (::String) — The ID of the network session.
#smtp
def smtp() -> ::Google::Backstory::Smtp
Returns
- (::Google::Backstory::Smtp) — SMTP info. Store fields specific to SMTP not covered by Email.
#smtp=
def smtp=(value) -> ::Google::Backstory::Smtp
Parameter
- value (::Google::Backstory::Smtp) — SMTP info. Store fields specific to SMTP not covered by Email.
Returns
- (::Google::Backstory::Smtp) — SMTP info. Store fields specific to SMTP not covered by Email.
#tls
def tls() -> ::Google::Backstory::Tls
Returns
- (::Google::Backstory::Tls) — TLS info.
#tls=
def tls=(value) -> ::Google::Backstory::Tls
Parameter
- value (::Google::Backstory::Tls) — TLS info.
Returns
- (::Google::Backstory::Tls) — TLS info.
#total_bytes
def total_bytes() -> ::Integer
Returns
- (::Integer) — The number of total bytes.
#total_bytes=
def total_bytes=(value) -> ::Integer
Parameter
- value (::Integer) — The number of total bytes.
Returns
- (::Integer) — The number of total bytes.