IBM Streams 4.2

Functions: SPL standard and specialized toolkits

SPL standard and specialized toolkits > Functions

Functions

BigInsightsChineseNER(): This function returns a value that can be passed to the modulePath parameter of the TextExtract operator.
BigInsightsJapaneseNER(): This function returns a value that can be passed to the modulePath parameter of the TextExtract operator.
BigInsightsWesternNERMultilingual(): This function returns a value that can be passed to the modulePath parameter of the TextExtract operator.
BigInsightsWesternNERStandard(): This function returns a value that can be passed to the modulePath parameter of the TextExtract operator.
CAPTURE_MICROSECONDS(): This function returns the number of microseconds since the value of the CAPTURE_SECONDS() function until the current packet was captured, according to the system clock on the machine that captured it.
CAPTURE_SECONDS(): This function returns the number of seconds since the beginning of the Unix epoch (midnight on January 1st, 1970 in Greenwich, England) until the current packet was captured, according to the system clock on the machine that captured it.
CAPTURE_TSC_MICROSECONDS(): This function returns the value of the machine's timestamp counter when the packet was captured, that is, the number of microseconds since the machine was booted.
DHCP_ADDRESS_LEASE_TIME(): This parser result function returns the duration of the address lease, in seconds, if DHCP option 51 is included in the message, or zero if not.
DHCP_ALL_SUBNETS_LOCAL(): This parser result function returns true if all subnets use the same MTU size, if DHCP option 27 is included in the message, or false if not.
DHCP_ARP_CACHE_TIMEOUT(): This parser result function returns the timeout for ARP cache entries, in seconds, if DHCP option 35 is included in the message, or zero if not.
DHCP_BOOTFILE_NAME(): This parser result function returns the pathname of a boot file the client can use, if there is one, or an empty string otherwise.
DHCP_BOOT_FILE_SIZE(): This parser result function returns the size of boot file in 512 byte blocks, if DHCP option 13 is included in the message, or zero if not.
DHCP_BROADCAST_ADDRESS(): This parser result function returns the IP version 4 address to use when broadcasting on subnet, if DHCP option 28 is included in the message, or zero if not.
DHCP_CLIENT_ADDRESS(): This parser result function returns the DHCP client's IP version 4 address when it requests renewal of its lease.
DHCP_CLIENT_HARDWARE_ADDRESS(): This parser result function returns the DHCP client's network hardware address, for example, the MAC address of its ethernet adapter.
DHCP_CLIENT_HARDWARE_TYPE(): This parser result function returns the client's hardware address type, for example, '1' for ethernet.
DHCP_CLIENT_IDENTIFIER(): This parser result function returns client-specific information, if DHCP option 61 is included in the message, or an empty list if not.
DHCP_COOKIE_SERVERS(): This parser result function returns a list of cookie servers, represented as IP version 4 addresses, if DHCP option 8 is included in the message, or an empty list if not.
DHCP_DNS_SERVERS(): This parser result function returns a list of DNS servers, represented as IP version 4 addresses, if DHCP option 6 is included in the message, or an empty list if not.
DHCP_DOMAIN_NAME(): This parser result function returns the domain name the client should use with DNS, if DHCP option 15 is included in the message, or an empty string if not.
DHCP_ERROR_MESSAGE(): This parser result function returns an error message from server, if request failed, if DHCP option 56 is included in the message.
DHCP_ETHERNET_ENCAPSULATION(): This parser result function returns true when the client should use ethernet encapsulation, if DHCP option 36 is included in the message, or false if not.
DHCP_EXTENSIONS_PATH(): This parser result function returns BOOTP extensions, if DHCP option 18 is included in the message, or an empty string if not.
DHCP_FINGER_SERVERS(): This parser result function returns a list of Finger servers, represented as IP version 4 addresses, if DHCP option 73 is included in the message, or an empty list if not.
DHCP_FLAGS(): This parser result function returns the DHCP broadcast flag.
DHCP_HOP_COUNT(): This parser result function returns the number of relay agents separating the DHCP client and server.
DHCP_HOST_NAME(): This parser result function returns the hostname of the client, if DHCP option 12 is included in the message, or an empty string if not.
DHCP_IMPRESS_SERVERS(): This parser result function returns a list of Impress servers, represented as IP version 4 addresses, if DHCP option 10 is included in the message, or an empty list if not.
DHCP_INTERFACE_MTU(): This parser result function returns the MTU size to use on this interface, if DHCP option 26 is included in the message, or zero if not.
DHCP_IP_DEFAULT_TTL(): This parser result function returns the default IP time-to-live for outgoing packets, if DHCP option 23 is included in the message, or zero if not.
DHCP_IP_FORWARDING(): This parser result function returns true if the client should forward IP packets, if DHCP option 19 is included in the message, or false if not.
DHCP_IRC_SERVERS(): This parser result function returns a list of IRC servers, represented as IP version 4 addresses, if DHCP option 74 is included in the message, or an empty list if not.
DHCP_LOG_SERVERS(): This parser result function returns a list of log servers, represented as IP version 4 addresses, if DHCP option 7 is included in the message, or an empty list if not.
DHCP_LPR_SERVERS(): This parser result function returns a list of print servers, represented as IP version 4 addresses, if DHCP option 9 is included in the message, or an empty list if not.
DHCP_MASK_SUPPLIER(): This parser result function returns true when client should respond to subnet mask discovery, if DHCP option 30 is included in the message, or false if not.
DHCP_MAXIMUM_MESSAGE_SIZE(): This parser result function returns the maximum size of DHCP message, if DHCP option 57 is included in the message, or zero if not.
DHCP_MAXIMUM_REASSEMBLY_SIZE(): This parser result function returns the maximum size of reassembled packets, if DHCP option 22 is included in the message, or zero if not.
DHCP_MERIT_DUMP_FILE(): This parser result function returns the pathname of a file for client's core dump image, if DHCP option 14 is included in the message, or an empty string if not.
DHCP_MESSAGE_TYPE(): This parser result function returns the type of this DHCP message, if DHCP option 53 is included in the message, or zero if not, for example:
DHCP_MOBILE_IP_HOME_AGENTS(): This parser result function returns a list of mobile IP home agents, represented as IP version 4 addresses, if DHCP option 68 is included in the message, or an empty list if not.
DHCP_MTU_AGING_TIMEOUT(): This parser result function returns the time to use when aging path MTU values, in seconds, if DHCP option 24 is included in the message, or zero if not.
DHCP_MTU_PLATEAU_TABLE(): This parser result function returns a list of MTU sizes for path discovery, if DHCP option 25 is included in the message, or an empty list if not.
DHCP_NAME_SERVERS(): This parser result function returns a list of name servers (not DNS servers, see next option), represented as IP version 4 addresses, if DHCP option 5 is included in the message, or an empty list if not.
DHCP_NETBIOS_NAME_SERVERS(): This parser result function returns a list of NetBIOS-over-TCP name servers, represented as IP version 4 addresses, if DHCP option 44 is included in the message, or an empty list if not.
DHCP_NETBIOS_NBDD_SERVERS(): This parser result function returns a list of NetBIOS-over-TCP NBDD servers, represented as IP version 4 addresses, if DHCP option 45 is included in the message, or an empty list if not.
DHCP_NETBIOS_NODE_TYPE(): This parser result function returns the type of NetBIOS-over-TCP node, if DHCP option 46 is included in the message, or zero if not.
DHCP_NETBIOS_SCOPE(): This parser result function returns the client's NetBIOS-over-TCP scope parameter, if DHCP option 47 is included in the message, or an empty string if not.
DHCP_NISPLUS_DOMAIN(): This parser result function returns the name of the client's NIS+ domain, if DHCP option 64 is included in the message.
DHCP_NISPLUS_SERVERS(): This parser result function returns a list of NIS+ servers, represented as IP version 4 addresses, if DHCP option 65 is included in the message, or an empty list if not.
DHCP_NIS_DOMAIN(): This parser result function returns the name of the client's NIS domain, if DHCP option 40 is included in the message, or an empty string if not.
DHCP_NIS_SERVERS(): This parser result function returns a list of NIS servers, represented as IP version 4 addresses, if DHCP option 41 is included in the message, or an empty list if not.
DHCP_NNTP_SERVERS(): This parser result function returns a list of NNTP servers, represented as IP version 4 addresses, if DHCP option 71 is included in the message, or an empty list if not.
DHCP_NONLOCAL_SOURCE_FILTERS(): This parser result function returns a list of IP version 4 address/mask pairs for filtering source packets, if DHCP option 21 is included in the message, or an empty list if not.
DHCP_NONLOCAL_SOURCE_ROUTING(): This parser result function returns true if the client should forward IP packets with non-local source routing, if DHCP option 20 is included in the message, or false if not.
DHCP_NTP_SERVERS(): This parser result function returns a list of NTP servers, represented as IP version 4 addresses, if DHCP option 42 is included in the message, or an empty list if not.
DHCP_OPCODE(): This parser result function returns the DHCP message type ('1' for request, '2' for reply).
DHCP_OPTION_OVERLOAD_FLAGS(): This parser result function returns flags indicating whether the sname and file fields in the DHCP message header contain the server's host name and client's boot file name, or additional DHCP options, if DHCP option 52 is included in the message, or zero if not.
DHCP_PARAMETER_REQUESTS(): This parser result function returns a list of requested DHCP parameters, expressed as option codes, if DHCP option 55 is included in the message, or an empty list if not.
DHCP_PERFORM_MASK_DISCOVERY(): This parser result function returns true when client should perform subnet mask discovery, if DHCP option 29 is included in the message, or false if not.
DHCP_PERFORM_ROUTER_DISCOVERY(): This parser result function returns true when the client should solicit routers, if DHCP option 31 is included in the message, or false if not.
DHCP_POP3_SERVERS(): This parser result function returns a list of POP3 servers, represented as IP version 4 addresses, if DHCP option 70 is included in the message, or an empty list if not.
DHCP_REBINDING_TIME(): This parser result function returns the time from address lease to rebinding, in seconds, if DHCP option 59 is included in the message, or zero if not.
DHCP_RELAY_AGENT(): This parser result function returns the IP version 4 address of the relay agent between the DHCP client and server, if there is one, or zero otherwise.
DHCP_RENEWAL_TIME(): This parser result function returns then time from address lease to renewal, in seconds, if DHCP option 58 is included in the message, or zero if not.
DHCP_REQUESTED_ADDRESS(): This parser result function returns the client's requested address, as an IP version 4 address, if DHCP option 50 is included in the message, or zero if not.
DHCP_RESOURCE_SERVERS(): This parser result function returns a list of resource location servers, represented as IP version 4 addresses, if DHCP option 11 is included in the message, or an empty list if not.
DHCP_ROOT_PATH(): This parser result function returns the pathname of the client's root disk (for diskless workstations), if DHCP option 17 is included in the message, or an empty string if not.
DHCP_ROUTERS(): This parser result function returns a list of routers on client's subnet, represented as IP version 4 addresses, if DHCP option 3 is included in the message, or an empty list if not.
DHCP_ROUTER_SOLICITATION_ADDRESS(): This parser result function returns the IP version 4 address to which router solicitations should be sent, if DHCP option 32 is included in the message, or zero if not.
DHCP_SECONDS(): This parser result function returns the elased time, in seconds, between the request and the response.
DHCP_SERVER_ADDRESS(): This parser result function returns the IP version 4 address of DHCP server, if DHCP option 54 is included in the message, or zero if not.
DHCP_SERVER_HOSTNAME(): This parser result function returns the name of the DHCP server, if it has one, or an empty string otherwise.
DHCP_SERVER_NEXT(): This parser result function returns the IP version 4 address of the next DHCP server to use.
DHCP_SMTP_SERVERS(): This parser result function returns a list of SMTP servers, represented as IP version 4 addresses, if DHCP option 69 is included in the message, or an empty list if not.
DHCP_STATIC_ROUTES(): This parser result function returns a list of IP version 4 address pairs for the client's static routing table, if DHCP option 33 is included in the message, or an empty list if not.
DHCP_STDA_SERVERS(): This parser result function returns a list of StreetTalk Directory Assistance servers, represented as IP version 4 addresses, if DHCP option 76 is included in the message, or an empty list if not.
DHCP_STREETTALK_SERVERS(): This parser result function returns a list of StreetTalk servers, represented as IP version 4 addresses, if DHCP option 75 is included in the message, or an empty list if not.
DHCP_SUBNET_MASK(): This parser result function returns the mask of the client's subnet, represented as an IP version 4 address, if DHCP option 1 is included in the message, or zero if not.
DHCP_SWAP_SERVER(): This parser result function returns the IP version 4 address of the client's swap server, if DHCP option 16 is included in the message.
DHCP_TCP_DEFUALT_TTL(): This parser result function returns the default TCP time-to-live for outgoing segments, if DHCP option 37 is included in the message, or zero if not.
DHCP_TCP_KEEPALIVE_GARBAGE(): This parser result function returns true when the client should send a byte of garbage with TCP keepalive messages, if DHCP option 39 is included in the message, or false if not.
DHCP_TCP_KEEPALIVE_INTERVAL(): This parser result function returns the time the client should wait before sending TCP keepalive messages, in seconds, if DHCP option 38 is included in the message, or zero if not.
DHCP_TIME_OFFSET(): This parser result function returns the time offset of the client's subnet, relative to GMT/UTC, in seconds, if DHCP option 2 is included in the message, or zero if not.
DHCP_TIME_SERVERS(): This parser result function returns a list of time servers, represented as IP version 4 addresses, if DHCP option 4 is included in the message, or an empty list if not.
DHCP_TRAILER_ENCAPSULATION(): This parser result function returns true when the client should negotiate trailers, if DHCP option 34 is included in the message, or false if not.
DHCP_TRANSACTION_IDENTIFIER(): This parser result function returns the request correlator chosen by the DHCP client in its request and returned to it by server in its response.
DHCP_VENDOR_IDENTIFIER(): This parser result function returns vendor-specific information, if DHCP option 60 is included in the message, or an empty list if not.
DHCP_VENDOR_INFORMATION(): This parser result function returns vendor-specific information, if DHCP option 43 is included in the message, or an empty list if not.
DHCP_WWW_SERVERS(): This parser result function returns a list of WWW servers, represented as IP version 4 addresses, if DHCP option 72 is included in the message, or an empty list if not.
DHCP_XWINDOW_DISPLAY_MANAGERS(): This parser result function returns a list of X-Windows display managers, represented as IP version 4 addresses, if DHCP option 49 is included in the message, or an empty list if not.
DHCP_XWINDOW_FONT_SERVERS(): This parser result function returns a list of X-Windows font servers, represented as IP version 4 addresses, if DHCP option 48 is included in the message, or an empty list if not.
DHCP_YOUR_ADDRESS(): This parser result function returns the IP version 4 address leased to the client by the DHCP server, if the message is an acknowledgement granting a lease, or zero if not.
DNS_ADDITIONAL_CLASSES(): This parser result function returns a list of the 'class' fields in the 'name server' resource records in the current message.
DNS_ADDITIONAL_COUNT(): This parser result function returns the number of 'additional' resource records in the current message.
DNS_ADDITIONAL_DATA(): This parser result function returns a list of the 'data' fields in the 'name server' resource records in the current message.
DNS_ADDITIONAL_NAMES(): This parser result function returns a list of the 'name' fields in the 'additional' resource records in the current message.
DNS_ADDITIONAL_TTLS(): This parser result function returns a list of the 'time to live' fields in the 'name server' resource records in the current message.
DNS_ADDITIONAL_TYPES(): This parser result function returns a list of the 'type' fields in the 'name server' resource records in the current message.
DNS_ALL_FLAGS(): This parser result function returns a 16 bit mask containing all flags in the DNS header of the current message.
DNS_ANSWER_ADDRESS(): This parser result function returns the 'data' field of the first 'answer' resource record, if there is one with a 'type' value of '1' or '28' (meaning, the answer is an IP version 4 or version 6 address from a type 'A' or 'AAAA' record, respectively), as a string value, or an empty string if not.
DNS_ANSWER_ADDRESSES(): This parser result function returns a list of the 'data' fields in the 'answer' resource records that have a 'type' value of '1' or '28' (meaning, the answer is an IP version 4 or version 6 address from a type 'A' or 'AAAA' record, respectively), as string values.
DNS_ANSWER_CANONICAL(): This parser result function returns the 'data' field of the first 'answer' resource record, if there is one with a 'type' value of '5' (meaning, the answer is a canonical domain name from a type 'CNAME' record), or an empty string if not.
DNS_ANSWER_CLASSES(): This parser result function returns a list of the 'class' fields in the 'answer' resource records in the current message.
DNS_ANSWER_COUNT(): This parser result function returns the number of 'answer' resource records in the current message.
DNS_ANSWER_DATA(): This parser result function returns a list of the 'data' fields in the 'answer' resource records in the current message.
DNS_ANSWER_IPV4_ADDRESS(): This parser result function returns the 'data' field of the first 'answer' resource record, if there is one with a 'type' value of '1' (meaning, the answer is an IP version 4 address from a type 'A' record), as a binary value, or zero if not.
DNS_ANSWER_IPV4_ADDRESSES(): This parser result function returns the 'data' fields of the 'answer' resource records that have 'type' values of '1' (meaning, the answers are IP version 4 addresses from type 'A' records), as a list of binary values.
DNS_ANSWER_IPV6_ADDRESS(): This parser result function returns the 'data' field of the first 'answer' resource record, if there is one with a 'type' value of '28' (meaning, the answer is an IP version 6 address from a type 'AAAA' record), as a binary value, or zero if not.
DNS_ANSWER_IPV6_ADDRESSES(): This parser result function returns the 'data' fields of the 'answer' resource records that have 'type' values of '28' (meaning, the answers IP version 6 addresses from type 'AAAA' records), as a binary values.
DNS_ANSWER_NAMES(): This parser result function returns a list of the 'name' fields in the 'answer' resource records in the current message.
DNS_ANSWER_TTLS(): This parser result function returns a list of the 'time to live' fields in the 'answer' resource records in the current message.
DNS_ANSWER_TYPES(): This parser result function returns a list of the 'type' fields in the 'answer' resource records in the current message.
DNS_AUTHORITATIVE_FLAG(): This parser result function returns true if the 'authoritative' flag is set in the current message, or false if not.
DNS_IDENTIFIER(): This parser result function returns the DNS client's request correlator in the current message, and returned by the server in its response.
DNS_NAMESERVER_CLASSES(): This parser result function returns a list of the 'class' fields in the 'name server' resource records in the current message.
DNS_NAMESERVER_COUNT(): This parser result function returns the number of 'name server' resource records in the current message.
DNS_NAMESERVER_DATA(): This parser result function returns a list of the 'data' fields in the 'name server' resource records in the current message.
DNS_NAMESERVER_NAMES(): This parser result function returns a list of the 'name' fields in the 'name server' resource records in the current message.
DNS_NAMESERVER_TTLS(): This parser result function returns a list of the 'time to live' fields in the 'name server' resource records in the current message.
DNS_NAMESERVER_TYPES(): This parser result function returns a list of the 'type' fields in the 'name server' resource records in the current message.
DNS_OPCODE(): This parser result function returns the operation code requested by the DNS client in the current message, for example,
DNS_QUESTION_CLASS(): This parser result function returns the 'class' field of the first 'question' resource record in the current message, for example, '1' for Internet adddresses ('IN' records),
DNS_QUESTION_CLASSES(): This parser result function returns a list of the 'class' fields in the 'question' resource records in the current message.
DNS_QUESTION_COUNT(): This parser result function returns the number of 'question' resource records in the current message.
DNS_QUESTION_NAME(): This parser result function returns the 'name' field of the first 'question' resource record in the current message, if there is one, or an empty string if not.
DNS_QUESTION_NAMES(): This parser result function returns a list of the 'name' fields in the 'question' resource records in the current message.
DNS_QUESTION_TYPE(): This parser result function returns the 'type' field of the first 'question' resource record in the current message, for example:
DNS_QUESTION_TYPES(): This parser result function returns a list of the 'type' fields in the 'question' resource records in the current message.
DNS_RESPONSE_CODE(): This parser result function returns the response code from the DNS server in the current message, for example,
DNS_RESPONSE_FLAG(): This parser result function returns true if the current message is a response sent by a DNS server, or false if it is a request sent by a DNS client.
DNS_TRUNCATION_FLAG(): This parser result function returns true if the 'truncation' flag is set in the current message, or false if not.
ERSPAN_DST_ADDRESS(): This function returns the value of the GRE ERSPAN destination address in the current packet, if it has one, or zero if otherwise.
ERSPAN_SRC_ADDRESS(): This function returns the value of the GRE ERSPAN source address in the current packet, if it has one, or zero if otherwise.
ETHER_DST_ADDRESS(): This function returns the ethernet destination address of the current packet.
ETHER_PROTOCOL(): This function returns the ethernet protocol (that is, the EtherType) of the current packet, for example, '2048' for IP version 4, or '34,525' for IP version 6.
ETHER_SRC_ADDRESS(): This function returns the ethernet source address of the current packet.
EVENT(): This result function returns a string containing the name of the event that caused the output tuple to be produced.
EVENT_FILE_CHUNK(): This result function returns true if a chunk of a file within the current flow has been received, or false otherwise.
EVENT_FLOW_DATA(): This result function returns true if data for the current flow has been received, or false otherwise.
EVENT_FLOW_END(): This result function returns true if this is the last tuple of a flow, or false otherwise.
EVENT_FLOW_START(): This result function returns true if this is the first tuple of a new flow, or false otherwise.
EVENT_FLOW_TLS(): This result function returns true if this flow is encrypted using the TLS protocol, or false otherwise.
EVENT_REQUEST(): This result function returns true if request headers for a transaction within the current flow have been received, or false otherwise.
EVENT_RESPONSE(): This result function returns true if response headers for a transaction within the current flow flow have been received, or false otherwise.
FILE_CHUNK_BINARY(): This result function returns the current chunk of the current file as a binary object, for 'FileChunk' events only.
FILE_CHUNK_COUNTER(): This result function returns a sequence number for this chunk of the current file, starting at zero, for 'FileChunk' events only.
FILE_CHUNK_FINAL(): This result function returns true for the last chunk of the current file, for FileChunk events only, or false otherwise,
FILE_CHUNK_INITIAL(): This result function returns true for the first chunk of the curent file, for FileChunk events only, or false otherwise,
FILE_CHUNK_LENGTH(): This result function returns the length of the current chunk of the current file, for 'FileChunk' events only.
FILE_CHUNK_LENGTH_SUM(): This result function returns the sum of the lengths of this and all preceding chunks of the current file, for 'FileChunk' events only.
FILE_CHUNK_STRING(): This result function returns the current chunk of the current file as a string, for 'FileChunk' events only.
FILE_CONTENT_CHARSET(): This result function returns the character set portion of the 'ContentType' header for the current file, if there is one, or an empty string if not.
FILE_CONTENT_LENGTH(): This result function returns the value of the 'ContentLength' header for the current file, if there is one, or an empty string if not.
FILE_CONTENT_TYPE(): This result function returns the value of the 'ContentType' header for the current file, if there is one, or an empty string if not.
FILE_FORMAT(): This result function returns the format of the current file, if there is one and the operator can determine it, or an empty string if not.
FILE_ID(): This result function returns a unique numeric identifier for the current file.
FILE_ID_PARENT(): This result function returns the identifier of the file containing the current file, when the transaction contains a file containing other files, and the operator can decompose them, or zero if not.
FLOW_DATA_BINARY(): This result function returns the flow data received as a binary object, for the 'FlowData' event only.
FLOW_DATA_COUNTER(): This result function returns a sequence number for the FlowData events within a particular flow, starting at zero for each new flow, as identified by the FLOW_ID() function.
FLOW_DATA_LENGTH(): This result function returns the length of the flow data received, for the 'FlowData' event only.
FLOW_DATA_STRING(): This result function returns the flow data received as a string, for the 'FlowData' event only.
FLOW_DIRECTION(): This result function returns "SrcToDst" or "DstToSrc", where source and destination refer to the FLOW_xxxx_ADDRESS() functions, or "" if the operator cannot determine a direction.
FLOW_DISCONNECT_REASON(): This result function returns the reason a flow ended.
FLOW_DST_BYTES(): This result function returns the total number of bytes sent by the destination endpoint of the flow to the source endpoint, for the FlowEnd event only.
FLOW_DST_PACKETS(): This result function returns the total number of packets sent by the destination endpoint of the flow to the source endpoint, for the FlowEnd event only.
FLOW_DST_PORT(): This result function returns the UDP or TCP port number of the destination endpoint of this flow, if the flow's IP protocol is UDP or TCP, or zero otherwise.
FLOW_ELAPSED_TIME(): This result function returns the elapsed time of the flow in seconds, with a precision of microseconds, for the 'FlowEnd' event only.
FLOW_END_TIME(): This result function returns the time when the flow ended, in seconds, relative to the beginning of the Unix epoch (midnight on January 1st, 1970 in Greenwich, England), with a precision of microseconds, for the 'FlowEnd' event only.
FLOW_ETHER_DST_ADDRESS(): This result function returns the ethernet MAC address of the destination endpoint of this flow.
FLOW_ETHER_SRC_ADDRESS(): This result function returns the ethernet MAC address of the source endpoint of this flow.
FLOW_EVENT_TIME(): This result function returns the time of the current event, in seconds, relative to the beginning of the Unix epoch (midnight on January 1st, 1970 in Greenwich, England), with a precision of microseconds.
FLOW_ID(): This result function returns a unique numeric identifier for the current flow.
FLOW_IPV4_DST_ADDRESS(): This result function returns the IP version 4 address of the destination endpoint of this flow.
FLOW_IPV4_SRC_ADDRESS(): This result function returns the IP version 4 address of the source endpoint of this flow.
FLOW_IP_PROTOCOL(): This result function returns the value of the IP protocol field from the flow's IP headers, if it is an IP flow, or zero otherwise.
FLOW_PROTOCOL(): This result function returns the application protocol, if the operator can determine it, or an empty string if not.
FLOW_PROTOCOL_CONFIDENCE(): This result function returns an integer from 1 to 3 indicating the operator's confidence in its identification of the application protocol (see the FLOW_PROTOCOL() result function), from 'low' to 'high', respectively.
FLOW_PROTOCOL_DEPTH(): This result function returns a small value, usually between 0 and 7, indicating the nesting depth at which the application protocol (see the FLOW_PROTOCOL() result function) was identified.
FLOW_REQUEST_HEADERS(): This result function returns the request headers of the current transaction of the current flow, if it has any, or an empty string if not.
FLOW_REQUEST_URI_AUTHORITY(): This result function returns the 'authority' portion of a URI, when the current transaction of the current flow has one, or an empty string if not.
FLOW_REQUEST_URI_FRAGMENT(): This result function returns the 'fragment' portion of a URI, when the current transaction of the current flow has one, or an empty string if not.
FLOW_REQUEST_URI_METHOD(): This result function returns the 'method' portion of a URI, when the current transaction of the current flow has one, or an empty string if not.
FLOW_REQUEST_URI_NORMALIZED(): This result function returns URI, the 'normalized' portion of a URI, when the current transaction of the current flow has one, or an empty string if not.
FLOW_REQUEST_URI_PATH(): This result function returns the 'path' portion of a URI, when the current transaction of the current flow has one, or an empty string if not.
FLOW_REQUEST_URI_QUERY(): This result function returns the 'query' portion of a URI, when the current transaction of the current flow has one, or an empty string if not.
FLOW_REQUEST_URI_RAW(): This result function returns the 'raw' URI, when the current transaction of the current flow has one, or an empty string if not.
FLOW_REQUEST_URI_SCHEME(): This result function returns the 'scheme' portion of a URI, when the current transaction of the current flow has one, or an empty string if not.
FLOW_REQUEST_URI_USERNAME(): This result function returns the 'username' portion of a URI, when the current transaction of the current flow has one, or an empty string if not.
FLOW_RESPONSE_HEADERS(): This result function returns the response headers of the current transaction of the current flow, if it has any, or an empty string if not.
FLOW_RESPONSE_STATUS_CODE(): This result function returns the response status code of the current transaction of the current flow, if it has any, or an empty string if not.
FLOW_SRC_BYTES(): This result function returns the total number of bytes sent by the source endpoint of the flow to the destination endpoint, for the FlowEnd event only.
FLOW_SRC_PACKETS(): This result function returns the total number of packets sent by the source endpoint of the flow to the destination endpoint, for the FlowEnd event only.
FLOW_SRC_PORT(): This result function returns the UDP or TCP port number of the source endpoint of this flow, if the flow's IP protocol is UDP or TCP, or zero otherwise.
FLOW_START_TIME(): This result function returns the time when the flow started, in seconds, relative to the beginning of the Unix epoch (midnight on January 1st, 1970 in Greenwich, England), with a precision of microseconds.
FLOW_TRANSACTION_ID(): This result function returns a unique numeric identifier for the current request/response pair within the current flow, when there is one, or zero if not.
IPFIX_bgpDestinationAsNumber(): IPFIX field 17: The autonomous system (AS) number of the destination IP address.
IPFIX_bgpNextAdjacentAsNumber(): IPFIX field 128: The autonomous system (AS) number of the first AS in the AS path to the destination IP address.
IPFIX_bgpNextHopIPv4Address(): IPFIX field 18: The IPv4 address of the next (adjacent) BGP hop.
IPFIX_bgpNextHopIPv6Address(): IPFIX field 63: The IPv6 address of the next (adjacent) BGP hop.
IPFIX_bgpPrevAdjacentAsNumber(): IPFIX field 129: The autonomous system (AS) number of the last AS in the AS path from the source IP address.
IPFIX_bgpSourceAsNumber(): IPFIX field 16: The autonomous system (AS) number of the source IP address.
IPFIX_collectorIPv4Address(): IPFIX field 211: An IPv4 address to which the Exporting Process sends Flow information.
IPFIX_collectorIPv6Address(): IPFIX field 212: An IPv6 address to which the Exporting Process sends Flow information.
IPFIX_collectorTransportPort(): IPFIX field 216: The destination port identifier to which the Exporting Process sends Flow information.
IPFIX_commonPropertiesId(): IPFIX field 137: An identifier of a set of common properties that is unique per Observation Domain and Transport Session.
IPFIX_destinationIPv4Address(): IPFIX field 12: The IPv4 destination address in the IP packet header.
IPFIX_destinationIPv4Prefix(): IPFIX field 45: IPv4 destination address prefix.
IPFIX_destinationIPv4PrefixLength(): IPFIX field 13: The number of contiguous bits that are relevant in the destinationIPv4Prefix Information Element.
IPFIX_destinationIPv6Address(): IPFIX field 28: The IPv6 destination address in the IP packet header.
IPFIX_destinationIPv6Prefix(): IPFIX field 169: IPv6 destination address prefix.
IPFIX_destinationIPv6PrefixLength(): IPFIX field 30: The number of contiguous bits that are relevant in the destinationIPv6Prefix Information Element.
IPFIX_destinationMacAddress(): IPFIX field 80: The IEEE 802 destination MAC address field.
IPFIX_destinationTransportPort(): IPFIX field 11: The destination port identifier in the transport header.
IPFIX_droppedOctetDeltaCount(): IPFIX field 132: The number of octets since the previous report (if any) in packets of this Flow dropped by packet treatment.
IPFIX_droppedOctetTotalCount(): IPFIX field 134: The total number of octets in packets of this Flow dropped by packet treatment since the Metering Process (re-)initialization for this Observation Point.
IPFIX_droppedPacketDeltaCount(): IPFIX field 133: The number of packets since the previous report (if any) of this Flow dropped by packet treatment.
IPFIX_droppedPacketTotalCount(): IPFIX field 135: The number of packets of this Flow dropped by packet treatment since the Metering Process (re-)initialization for this Observation Point.
IPFIX_egressInterface(): IPFIX field 14: The index of the IP interface where packets of this Flow are being sent.
IPFIX_enterpriseBasicListFieldAsByteLists(int32): This function returns the value of the specified IPFIX 'enterprise' field as a list of byte lists, if it is present in the 'data flow' record and it was encoded as an IPFIX 'basic list', or an empty list if absent.
IPFIX_enterpriseBasicListFieldAsIntegers(int32): This function returns the value of the specified IPFIX 'enterprise' field as a list of integers, if it is present in the 'data flow' record and it was encoded as an IPFIX 'basic list', or an empty list if absent.
IPFIX_enterpriseBasicListFieldAsStrings(int32): This function returns the value of the specified IPFIX 'enterprise' field as a list of strings, if it is present in the 'data flow' record and it was encoded as an IPFIX 'basic list', or an empty list if absent.
IPFIX_enterpriseBasicListFieldElementIdentifier(int32): This function returns the value of the 'element identifier' corresponding to the specified IPFIX 'enterprise' 'field, if one is present in the 'data flow' record and it was encoded as an IPFIX 'basic list', or zero if absent.
IPFIX_enterpriseBasicListFieldEnterpriseIdentifier(int32): This function returns the value of the 'enterprise identifier' corresponding to the specified IPFIX 'enterprise' field, if one is present in the 'data flow' record and it was encoded as an IPFIX 'basic list', or zero if absent.
IPFIX_enterpriseBasicListFieldSemantic(int32): This function returns the value of the 'semantic code' corresponding to the specified IPFIX 'enterprise' field, if one is present in the 'data flow' record and it was encoded as an IPFIX 'basic list', or zero if absent.
IPFIX_enterpriseFieldAsByteList(int32): This function returns the value of the specified IPFIX 'enterprise' field as a list of bytes, if it is present in the 'data flow' record, or zero if absent.
IPFIX_enterpriseFieldAsInteger(int32): This function returns the value of the specified IPFIX 'enterprise' field as an integer, if it is present in the 'data flow' record, or zero if absent.
IPFIX_enterpriseFieldAsString(int32): This function returns the value of the specified IPFIX 'enterprise' field as a string, if it is present in the 'data flow' record, or zero if absent.
IPFIX_enterpriseIdentifier(int32): This function returns the value of the 'enterprise identifier' corresponding to the specified IPFIX 'field identifier', if one is present in the 'data flow' record, or zero if absent.
IPFIX_exportInterface(): IPFIX field 213: The index of the interface from which IPFIX Messages sent by the Exporting Process to a Collector leave the IPFIX Device.
IPFIX_exportProtocolVersion(): IPFIX field 214: The protocol version used by the Exporting Process for sending Flow information.
IPFIX_exportTransportProtocol(): IPFIX field 215: The value of the protocol number used by the Exporting Process for sending Flow information.
IPFIX_exportedFlowRecordTotalCount(): IPFIX field 42: The total number of Flow Records that the Exporting Process has sent as Data Records since the Exporting Process (re-)initialization to a particular Collecting Process.
IPFIX_exportedMessageTotalCount(): IPFIX field 41: The total number of IPFIX Messages that the Exporting Process has sent since the Exporting Process (re-)initialization to a particular Collecting Process.
IPFIX_exportedOctetTotalCount(): IPFIX field 40: The total number of octets that the Exporting Process has sent since the Exporting Process (re-)initialization to a particular Collecting Process.
IPFIX_exporterIPv4Address(): IPFIX field 130: The IPv4 address used by the Exporting Process.
IPFIX_exporterIPv6Address(): IPFIX field 131: The IPv6 address used by the Exporting Process.
IPFIX_exporterTransportPort(): IPFIX field 217: The source port identifier from which the Exporting Process sends Flow information.
IPFIX_exportingProcessId(): IPFIX field 144: An identifier of an Exporting Process that is unique per IPFIX Device.
IPFIX_flowActiveTimeout(): IPFIX field 36: The number of seconds after which an active Flow is timed out anyway, even if there is still a continuous flow of packets.
IPFIX_flowDirection(): IPFIX field 61: The direction of the Flow observed at the Observation Point.
IPFIX_flowDurationMicroseconds(): IPFIX field 162: The difference in time between the first observed packet of this Flow and the last observed packet of this Flow.
IPFIX_flowDurationMilliseconds(): IPFIX field 161: The difference in time between the first observed packet of this Flow and the last observed packet of this Flow.
IPFIX_flowEndDeltaMicroseconds(): IPFIX field 159: This is a relative timestamp only valid within the scope of a single IPFIX Message.
IPFIX_flowEndMicroseconds(): IPFIX field 155: The absolute timestamp of the last packet of this Flow.
IPFIX_flowEndMilliseconds(): IPFIX field 153: The absolute timestamp of the last packet of this Flow.
IPFIX_flowEndNanoseconds(): IPFIX field 157: The absolute timestamp of the last packet of this Flow.
IPFIX_flowEndReason(): IPFIX field 136: The reason for Flow termination.
IPFIX_flowEndSeconds(): IPFIX field 151: The absolute timestamp of the last packet of this Flow.
IPFIX_flowEndSysUpTime(): IPFIX field 21: The relative timestamp of the last packet of this Flow.
IPFIX_flowId(): IPFIX field 148: An identifier of a Flow that is unique within an Observation Domain.
IPFIX_flowIdleTimeout(): IPFIX field 37: A Flow is considered to be timed out if no packets belonging to the Flow have been observed for the number of seconds specified by this field.
IPFIX_flowKeyIndicator(): IPFIX field 173: This set of bit fields is used for marking the Information Elements of a Data Record that serve as Flow Key.
IPFIX_flowLabelIPv6(): IPFIX field 31: The value of the IPv6 Flow Label field in the IP packet header.
IPFIX_flowStartDeltaMicroseconds(): IPFIX field 158: This is a relative timestamp only valid within the scope of a single IPFIX Message.
IPFIX_flowStartMicroseconds(): IPFIX field 154: The absolute timestamp of the first packet of this Flow.
IPFIX_flowStartMilliseconds(): IPFIX field 152: The absolute timestamp of the first packet of this Flow.
IPFIX_flowStartNanoseconds(): IPFIX field 156: The absolute timestamp of the first packet of this Flow.
IPFIX_flowStartSeconds(): IPFIX field 150: The absolute timestamp of the first packet of this Flow.
IPFIX_flowStartSysUpTime(): IPFIX field 22: The relative timestamp of the first packet of this Flow.
IPFIX_fragmentFlags(): IPFIX field 197: Fragmentation properties indicated by flags in the IPv4 packet header or the IPv6 Fragment header, respectively.
IPFIX_fragmentIdentification(): IPFIX field 54: The value of the Identification field in the IPv4 packet header or in the IPv6 Fragment header, respectively.
IPFIX_fragmentOffset(): IPFIX field 88: The value of the IP fragment offset field in the IPv4 packet header or the IPv6 Fragment header, respectively.
IPFIX_icmpCodeIPv4(): IPFIX field 177: Code of the IPv4 ICMP message.
IPFIX_icmpCodeIPv6(): IPFIX field 179: Code of the IPv6 ICMP message.
IPFIX_icmpTypeCodeIPv4(): IPFIX field 32: Type and Code of the IPv4 ICMP message.
IPFIX_icmpTypeCodeIPv6(): IPFIX field 139: Type and Code of the IPv6 ICMP message.
IPFIX_icmpTypeIPv4(): IPFIX field 176: Type of the IPv4 ICMP message.
IPFIX_icmpTypeIPv6(): IPFIX field 178: Type of the IPv6 ICMP message.
IPFIX_igmpType(): IPFIX field 33: The type field of the IGMP message.
IPFIX_ignoredOctetTotalCount(): IPFIX field 165: The total number of octets in observed IP packets (including the IP header) that the Metering Process did not process since the (re-)initialization of the Metering Process.
IPFIX_ignoredPacketTotalCount(): IPFIX field 164: The total number of observed IP packets that the Metering Process did not process since the (re-)initialization of the Metering Process.
IPFIX_ingressInterface(): IPFIX field 10: The index of the IP interface where packets of this Flow are being received.
IPFIX_ipClassOfService(): IPFIX field 5: For IPv4 packets, this is the value of the TOS field in the IPv4 packet header.
IPFIX_ipDiffServCodePoint(): IPFIX field 195: The value of a Differentiated Services Code Point (DSCP) encoded in the Differentiated Services field.
IPFIX_ipHeaderLength(): IPFIX field 189: The length of the IP header.
IPFIX_ipNextHopIPv4Address(): IPFIX field 15: The IPv4 address of the next IPv4 hop.
IPFIX_ipNextHopIPv6Address(): IPFIX field 62: The IPv6 address of the next IPv6 hop.
IPFIX_ipPayloadLength(): IPFIX field 204: The effective length of the IP payload.
IPFIX_ipPrecedence(): IPFIX field 196: The value of the IP Precedence.
IPFIX_ipTTL(): IPFIX field 192: For IPv4, the value of the Information Element matches the value of the Time to Live (TTL) field in the IPv4 packet header.
IPFIX_ipTotalLength(): IPFIX field 224: The total length of the IP packet.
IPFIX_ipVersion(): IPFIX field 60: The IP version field in the IP packet header.
IPFIX_ipv4IHL(): IPFIX field 207: The value of the Internet Header Length (IHL) field in the IPv4 header.
IPFIX_ipv4Options(): IPFIX field 208: IPv4 options in packets of this Flow.
IPFIX_ipv6ExtensionHeaders(): IPFIX field 64: IPv6 extension headers observed in packets of this Flow.
IPFIX_isMulticast(): IPFIX field 206: If the IP destination address is not a reserved multicast address, then the value of all bits of the octet (including the reserved ones) is zero.
IPFIX_lineCardId(): IPFIX field 141: An identifier of a line card that is unique per IPFIX Device hosting an Observation Point.
IPFIX_maximumIpTotalLength(): IPFIX field 26: Length of the largest packet observed for this Flow.
IPFIX_maximumTTL(): IPFIX field 53: Maximum TTL value observed for any packet in this Flow.
IPFIX_meteringProcessId(): IPFIX field 143: An identifier of a Metering Process that is unique per IPFIX Device.
IPFIX_minimumIpTotalLength(): IPFIX field 25: Length of the smallest packet observed for this Flow.
IPFIX_minimumTTL(): IPFIX field 52: Minimum TTL value observed for any packet in this Flow.
IPFIX_mplsLabelStackDepth(): IPFIX field 202: The number of labels in the MPLS label stack.
IPFIX_mplsLabelStackLength(): IPFIX field 201: The length of the MPLS label stack in units of octets.
IPFIX_mplsLabelStackSection10(): IPFIX field 79: The Label, Exp, and S fields from the label stack entry that was pushed immediately before the label stack entry that would be reported by mplsLabelStackSection9.
IPFIX_mplsLabelStackSection2(): IPFIX field 71: The Label, Exp, and S fields from the label stack entry that was pushed immediately before the label stack entry that would be reported by mplsTopLabelStackSection.
IPFIX_mplsLabelStackSection3(): IPFIX field 72: The Label, Exp, and S fields from the label stack entry that was pushed immediately before the label stack entry that would be reported by mplsLabelStackSection2.
IPFIX_mplsLabelStackSection4(): IPFIX field 73: The Label, Exp, and S fields from the label stack entry that was pushed immediately before the label stack entry that would be reported by mplsLabelStackSection3.
IPFIX_mplsLabelStackSection5(): IPFIX field 74: The Label, Exp, and S fields from the label stack entry that was pushed immediately before the label stack entry that would be reported by mplsLabelStackSection4.
IPFIX_mplsLabelStackSection6(): IPFIX field 75: The Label, Exp, and S fields from the label stack entry that was pushed immediately before the label stack entry that would be reported by mplsLabelStackSection5.
IPFIX_mplsLabelStackSection7(): IPFIX field 76: The Label, Exp, and S fields from the label stack entry that was pushed immediately before the label stack entry that would be reported by mplsLabelStackSection6.
IPFIX_mplsLabelStackSection8(): IPFIX field 77: The Label, Exp, and S fields from the label stack entry that was pushed immediately before the label stack entry that would be reported by mplsLabelStackSection7.
IPFIX_mplsLabelStackSection9(): IPFIX field 78: The Label, Exp, and S fields from the label stack entry that was pushed immediately before the label stack entry that would be reported by mplsLabelStackSection8.
IPFIX_mplsPayloadLength(): IPFIX field 194: The size of the MPLS packet without the label stack.
IPFIX_mplsTopLabelExp(): IPFIX field 203: The Exp field from the top MPLS label stack entry, i.e., the last label that was pushed.
IPFIX_mplsTopLabelIPv4Address(): IPFIX field 47: The IPv4 address of the system that the MPLS top label will cause this Flow to be forwarded to.
IPFIX_mplsTopLabelIPv6Address(): IPFIX field 140: The IPv6 address of the system that the MPLS top label will cause this Flow to be forwarded to.
IPFIX_mplsTopLabelStackSection(): IPFIX field 70: The Label, Exp, and S fields from the top MPLS label stack entry, i.e., from the last label that was pushed.
IPFIX_mplsTopLabelTTL(): IPFIX field 200: The TTL field from the top MPLS label stack entry, i.e., the last label that was pushed.
IPFIX_mplsTopLabelType(): IPFIX field 46: This field identifies the control protocol that allocated the top-of-stack label.
IPFIX_mplsVpnRouteDistinguisher(): IPFIX field 90: The value of the VPN route distinguisher of a corresponding entry in a VPN routing and forwarding table.
IPFIX_nextHeaderIPv6(): IPFIX field 193: The value of the Next Header field of the IPv6 header.
IPFIX_notSentFlowTotalCount(): IPFIX field 166: The total number of Flow Records that were generated by the Metering Process and dropped by the Metering Process or by the Exporting Process instead of being sent to the Collecting Process.
IPFIX_notSentOctetTotalCount(): IPFIX field 168: The total number of octets in packets in Flow Records that were generated by the Metering Process and dropped by the Metering Process or by the Exporting Process instead of being sent to the Collecting Process.
IPFIX_notSentPacketTotalCount(): IPFIX field 167: The total number of packets in Flow Records that were generated by the Metering Process and dropped by the Metering Process or by the Exporting Process instead of being sent to the Collecting Process.
IPFIX_observationDomainId(): IPFIX field 149: An identifier of an Observation Domain that is locally unique to an Exporting Process.
IPFIX_observationPointId(): IPFIX field 138: An identifier of an Observation Point that is unique per Observation Domain.
IPFIX_observedFlowTotalCount(): IPFIX field 163: The total number of Flows observed in the Observation Domain since the Metering Process (re-)initialization for this Observation Point.
IPFIX_octetDeltaCount(): IPFIX field 1: The number of octets since the previous report (if any) in incoming packets for this Flow at the Observation Point.
IPFIX_octetDeltaSumOfSquares(): IPFIX field 198: The sum of the squared numbers of octets per incoming packet since the previous report (if any) for this Flow at the Observation Point.
IPFIX_octetTotalCount(): IPFIX field 85: The total number of octets in incoming packets for this Flow at the Observation Point since the Metering Process (re-)initialization for this Observation Point.
IPFIX_octetTotalSumOfSquares(): IPFIX field 199: The total sum of the squared numbers of octets in incoming packets for this Flow at the Observation Point since the Metering Process (re-)initialization for this Observation Point.
IPFIX_packetDeltaCount(): IPFIX field 2: The number of incoming packets since the previous report (if any) for this Flow at the Observation Point.
IPFIX_packetTotalCount(): IPFIX field 86: The total number of incoming packets for this Flow at the Observation Point since the Metering Process (re-)initialization for this Observation Point.
IPFIX_paddingOctets(): IPFIX field 210: The value of this Information Element is always a sequence of 0x00 values.
IPFIX_payloadLengthIPv6(): IPFIX field 191: This Information Element reports the value of the Payload Length field in the IPv6 header.
IPFIX_portId(): IPFIX field 142: An identifier of a line port that is unique per IPFIX Device hosting an Observation Point.
IPFIX_postDestinationMacAddress(): IPFIX field 57: The definition of this Information Element is identical to the definition of Information Element 'destinationMacAddress', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.
IPFIX_postIpClassOfService(): IPFIX field 55: The definition of this Information Element is identical to the definition of Information Element 'ipClassOfService', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.
IPFIX_postMCastOctetDeltaCount(): IPFIX field 20: The number of octets since the previous report (if any) in outgoing multicast packets sent for packets of this Flow by a multicast daemon within the Observation Domain.
IPFIX_postMCastOctetTotalCount(): IPFIX field 175: The total number of octets in outgoing multicast packets sent for packets of this Flow by a multicast daemon in the Observation Domain since the Metering Process (re-)initialization.
IPFIX_postMCastPacketDeltaCount(): IPFIX field 19: The number of outgoing multicast packets since the previous report (if any) sent for packets of this Flow by a multicast daemon within the Observation Domain.
IPFIX_postMCastPacketTotalCount(): IPFIX field 174: The total number of outgoing multicast packets sent for packets of this Flow by a multicast daemon within the Observation Domain since the Metering Process (re-)initialization.
IPFIX_postMplsTopLabelExp(): IPFIX field 237: The definition of this Information Element is identical to the definition of Information Element 'mplsTopLabelExp', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.
IPFIX_postOctetDeltaCount(): IPFIX field 23: The definition of this Information Element is identical to the definition of Information Element 'octetDeltaCount', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.
IPFIX_postOctetTotalCount(): IPFIX field 171: The definition of this Information Element is identical to the definition of Information Element 'octetTotalCount', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.
IPFIX_postPacketDeltaCount(): IPFIX field 24: The definition of this Information Element is identical to the definition of Information Element 'packetDeltaCount', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.
IPFIX_postPacketTotalCount(): IPFIX field 172: The definition of this Information Element is identical to the definition of Information Element 'packetTotalCount', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.
IPFIX_postSourceMacAddress(): IPFIX field 81: The definition of this Information Element is identical to the definition of Information Element 'sourceMacAddress', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.
IPFIX_postVlanId(): IPFIX field 59: The definition of this Information Element is identical to the definition of Information Element 'vlanId', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.
IPFIX_protocolIdentifier(): IPFIX field 4: The value of the protocol number in the IP packet header.
IPFIX_sourceIPv4Address(): IPFIX field 8: The IPv4 source address in the IP packet header.
IPFIX_sourceIPv4Prefix(): IPFIX field 44: IPv4 source address prefix.
IPFIX_sourceIPv4PrefixLength(): IPFIX field 9: The number of contiguous bits that are relevant in the sourceIPv4Prefix Information Element.
IPFIX_sourceIPv6Address(): IPFIX field 27: The IPv6 source address in the IP packet header.
IPFIX_sourceIPv6Prefix(): IPFIX field 170: IPv6 source address prefix.
IPFIX_sourceIPv6PrefixLength(): IPFIX field 29: The number of contiguous bits that are relevant in the sourceIPv6Prefix Information Element.
IPFIX_sourceMacAddress(): IPFIX field 56: The IEEE 802 source MAC address field.
IPFIX_sourceTransportPort(): IPFIX field 7: The source port identifier in the transport header.
IPFIX_standardFieldAsByteList(int32): This function returns the value of the specified IPFIX 'standard' field as a list of bytes, if it is present in the 'data flow' record, or zero if absent.
IPFIX_standardFieldAsInteger(int32): This function returns the value of the specified IPFIX 'standard' field as an integer, if it is present in the 'data flow' record, or zero if absent.
IPFIX_standardFieldAsString(int32): This function returns the value of the specified IPFIX 'standard' field as a string, if it is present in the 'data flow' record, or zero if absent.
IPFIX_systemInitTimeMilliseconds(): IPFIX field 160: The absolute timestamp of the last (re-)initialization of the IPFIX Device.
IPFIX_tcpAckTotalCount(): IPFIX field 222: The total number of packets of this Flow with TCP "Acknowledgment field significant" (ACK) flag set.
IPFIX_tcpAcknowledgementNumber(): IPFIX field 185: The acknowledgement number in the TCP header.
IPFIX_tcpControlBits(): IPFIX field 6: TCP control bits observed for packets of this Flow.
IPFIX_tcpDestinationPort(): IPFIX field 183: The destination port identifier in the TCP header.
IPFIX_tcpFinTotalCount(): IPFIX field 219: The total number of packets of this Flow with TCP "No more data from sender" (FIN) flag set.
IPFIX_tcpHeaderLength(): IPFIX field 188: The length of the TCP header.
IPFIX_tcpOptions(): IPFIX field 209: TCP options in packets of this Flow.
IPFIX_tcpPshTotalCount(): IPFIX field 221: The total number of packets of this Flow with TCP "Push Function" (PSH) flag set.
IPFIX_tcpRstTotalCount(): IPFIX field 220: The total number of packets of this Flow with TCP "Reset the connection" (RST) flag set.
IPFIX_tcpSequenceNumber(): IPFIX field 184: The sequence number in the TCP header.
IPFIX_tcpSourcePort(): IPFIX field 182: The source port identifier in the TCP header.
IPFIX_tcpSynTotalCount(): IPFIX field 218: The total number of packets of this Flow with TCP "Synchronize sequence numbers" (SYN) flag set.
IPFIX_tcpUrgTotalCount(): IPFIX field 223: The total number of packets of this Flow with TCP "Urgent Pointer field significant" (URG) flag set.
IPFIX_tcpUrgentPointer(): IPFIX field 187: The urgent pointer in the TCP header.
IPFIX_tcpWindowScale(): IPFIX field 238: The scale of the window field in the TCP header.
IPFIX_tcpWindowSize(): IPFIX field 186: The window field in the TCP header.
IPFIX_templateId(): IPFIX field 145: An identifier of a Template that is locally unique within a combination of a Transport session and an Observation Domain.
IPFIX_totalLengthIPv4(): IPFIX field 190: The total length of the IPv4 packet.
IPFIX_udpDestinationPort(): IPFIX field 181: The destination port identifier in the UDP header.
IPFIX_udpMessageLength(): IPFIX field 205: The value of the Length field in the UDP header.
IPFIX_udpSourcePort(): IPFIX field 180: The source port identifier in the UDP header.
IPFIX_vlanId(): IPFIX field 58: The IEEE 802.1Q VLAN identifier (VID) extracted from the Tag Control Information field that was attached to the IP packet.
IPFIX_wlanChannelId(): IPFIX field 146: The identifier of the 802.11 (Wi-Fi) channel used.
IPFIX_wlanSSID(): IPFIX field 147: The Service Set IDentifier (SSID) identifying an 802.11 (Wi-Fi) network used.
IPV4_DST_ADDRESS(): This function returns the IP version 4 destination address of the current packet, if it has one, or zero otherwise.
IPV4_SRC_ADDRESS(): This function returns the IP version 4 source address of the current packet, if it has one, or zero otherwise.
IPV6_DST_ADDRESS(): This function returns the IP version 6 destination address of the current packet, if it has one, or an empty list otherwise.
IPV6_SRC_ADDRESS(): This function returns the IP version 6 source address of the current packet, if it has one, or an empty list otherwise.
IP_DST_PORT(): This function returns the TCP or UDP destination port number of the current packet, if it has one, or zero otherwise.
IP_PROTOCOL(): This function returns the IP protocol of the current packet, for example, '6' for TCP, or '17' for UDP, or zero if the ethernet packet does not contain an IP packet.
IP_SRC_PORT(): This function returns the TCP or UDP source port number of the current packet, if it has one, or zero otherwise.
IP_VERSION(): This function returns the IP version of the current packet ('4' for IP version 4, or '6' for IP version 6), if the ethernet packet contains an IP packet, or zero otherwise.
JMIRROR_DST_ADDRESS(): This function returns the value of the 'jmirror' destination address in the current packet, if it has one, or zero if otherwise.
JMIRROR_DST_PORT(): This function returns the value of the 'jmirror' dstination port in the current packet, if it has one, or zero if otherwise.
JMIRROR_INTERCEPT_ID(): This function returns the value of the 'jmirror' intercept identifier in the current packet, if it has one, or zero if otherwise.
JMIRROR_SESSION_ID(): This function returns the value of the 'jmirror' session identifier in the current packet, if it has one, or zero if otherwise.
JMIRROR_SRC_ADDRESS(): This function returns the value of the 'jmirror' source address in the current packet, if it has one, or zero if otherwise.
JMIRROR_SRC_PORT(): This function returns the value of the 'jmirror' source port in the current packet, if it has one, or zero if otherwise.
NETFLOW_APPLICATION_DESCRIPTION(): This parser result function returns the application description.
NETFLOW_APPLICATION_NAME(): This parser result function returns the name associated with a classification.
NETFLOW_APPLICATION_TAG(): This parser result function returns 8 bits of engine ID, followed by n bits of classification.
NETFLOW_BGP_IPV4_NEXT_HOP(): This parser result function returns the IP version 4 address of the next router in the BGP domain.
NETFLOW_BPG_IPV6_NEXT_HOP(): This parser result function returns the next router in the BGP domain.
NETFLOW_COUNT(): This parser result function returns the number of Netflow records in the current message, including templates, options, and flows.
NETFLOW_DIRECTION(): This parser result function returns the direction of the flow, '0' for ingress, '1' for egress.
NETFLOW_DST_AS(): This parser result function returns the BGP autonomous system number of the destination endpoint of the current flow.
NETFLOW_DST_MASK(): This parser result function returns the number of significant bits in the IP version 4 address of the destination endpoint of the current flow record, if available, or zero if not.
NETFLOW_DST_PORT(): This parser result function returns the TCP or UDP port number of the destination endpoint of the current flow record, if available, or zero if not.
NETFLOW_DST_TOS(): This parser result function returns the 'type of service' byte setting for the flow when exiting the outgoing interface.
NETFLOW_DST_TRAFFIC_INDEX(): This parser result function returns BGP policy accounting destination traffic index.
NETFLOW_DST_VLAN(): This parser result function returns the virtual LAN identifier associated with the egress interface.
NETFLOW_ENGINE_ID(): This parser result function returns the identifier of the switching engine in the router.
NETFLOW_ENGINE_TYPE(): This parser result function returns the type code of the switching engine in the router.
NETFLOW_FIELD_AS_BYTE_LIST(int32): This parser result function returns the value of the specified Netflow version 9 field in the current flow record, if present, represented as list of unsigned bytes, or an empty list if not.
NETFLOW_FIELD_AS_INTEGER(int32): This parser result function returns the value of the specified Netflow version 9 field in the current flow record, if present, represented as an unsigned integer, or zero if not.
NETFLOW_FIELD_AS_STRING(int32): This parser result function returns the value of the specified Netflow version 9 field in the current flow record, if present, represented as a string, or an empty string if not.
NETFLOW_FIRST_SWITCHED(): This parser result function returns the value of NETFLOW_SYSTEM_UPTIME() for the first packet of the current flow, that is, the time that the first packet in this flow passed through the router, relative to when the router was booted, in milliseconds.
NETFLOW_FLOWS(): This parser result function returns the number of flows that were aggregated for the current flow record, if available, or zero if not.
NETFLOW_FLOW_ACTIVE_TIMEOUT(): This parser result function returns the timeout value, in seconds, for active flow entries in the Netflow cache.
NETFLOW_FLOW_INACTIVE_TIMEOUT(): This parser result function returns the timeout value, in seconds, for inactive flow entries in the Netflow cache.
NETFLOW_FLOW_SAMPLER_ID(): This parser result function returns the identifier shown in "show flow-sampler".
NETFLOW_FLOW_SAMPLER_MODE(): This parser result function returns the sampling mode, when Netflow is sampled, For Netflow version 9, this is field 49.
NETFLOW_FLOW_SAMPLER_RANDOM_INTERVAL(): This parser result function returns the packet sampling interval, when Netflow is sampled.
NETFLOW_FORWARDING_STATUS(): This parser result function returns the forwarding status, with the 2 left bits giving the status and the 6 remaining bits giving the reason code.
NETFLOW_FRAGMENT_OFFSET(): This parser result function returns the fragment offset value from fragmented IP packets.
NETFLOW_ICMP_TYPE(): This parser result function returns the ICMP packet type.
NETFLOW_IF_DESC(): This parser result function returns the router's interface description.
NETFLOW_IF_NAME(): This parser result function returns the router's interface name.
NETFLOW_INPUT_INTERFACE(): This parser result function returns the interface index where the current flow entered the router, if available, or zero if not.
NETFLOW_IN_BYTES(): This parser result function returns the number of bytes that entered the router for the current flow record, if available, or zero if not.
NETFLOW_IN_PERMANENT_BYTES(): This parser result function returns the running byte counter for a permanent flow.
NETFLOW_IN_PERMANENT_PKTS(): This parser result function returns the running packet counter for a permanent flow.
NETFLOW_IN_PKTS(): This parser result function returns the number of packets that entered the router for the current flow record, if available, or zero if not.
NETFLOW_IPV4_DST_ADDR(): This parser result function returns the IP version 4 address of the destination endpoint of the current flow record, if available, or zero if not.
NETFLOW_IPV4_DST_PREFIX(): This parser result function returns the IP version 4 destination address prefix (specific for Cisco Catalyst architecture).
NETFLOW_IPV4_IDENT(): This parser result function returns The IP version 4 identification field of the flow.
NETFLOW_IPV4_NEXT_HOP(): This parser result function returns the IP version 4 address of the next router towards the destination endpoint of the current flow.
NETFLOW_IPV4_SRC_ADDR(): This parser result function returns the IP version 4 address of the source endpoint of the current flow record, if available, or zero if not.
NETFLOW_IPV4_SRC_PREFIX(): This parser result function returns the IP version 4 source address prefix (specific for Cisco Catalyst architecture).
NETFLOW_IPV6_DST_ADDR(): This parser result function returns the IP version 6 address of the destination endpoint of the current flow record, if available, or an empty list if not.
NETFLOW_IPV6_DST_MASK(): This parser result function returns the number of significant bits in the IP version 6 address of the source endpoint of the current flow record, if available, or zero if not.
NETFLOW_IPV6_FLOW_LABEL(): This parser result function returns the IP version 6 flow label.
NETFLOW_IPV6_NEXT_HOP(): This parser result function returns the IP version 6 address of the next-hop router.
NETFLOW_IPV6_OPTION_HEADERS(): This parser result function returns the IP version 6 option headers found in the flow.
NETFLOW_IPV6_SRC_ADDR(): This parser result function returns the IP version 6 address of the source endpoint of the current flow record, if available, or an empty list if not.
NETFLOW_IPV6_SRC_MASK(): This parser result function returns the number of significant bits in the IP version 6 address of the source endpoint of the current flow record, if available, or zero if not.
NETFLOW_IP_PROTOCOL_VERSION(): This parser result function returns the IP version for the flow, either '4' or '6'.
NETFLOW_LAST_SWITCHED(): This parser result function returns the value of NETFLOW_SYSTEM_UPTIME() for the last packet of the current flow, that is, the time that the last packet in this flow passed through the router, relative to when the router was booted, in milliseconds.
NETFLOW_MAC_DST_ADDR_IN(): This parser result function returns the incoming destination MAC address.
NETFLOW_MAC_DST_ADDR_OUT(): This parser result function returns the incoming destination MAC address for the flow.
NETFLOW_MAC_SRC_ADDR_IN(): This parser result function returns the incoming source MAC address for the flow.
NETFLOW_MAC_SRC_ADDR_OUT(): This parser result function returns the outgoing source MAC address.
NETFLOW_MAX_PKT_LNGTH(): This parser result function returns the maximum packet length for the current flow.
NETFLOW_MAX_TTL(): This parser result function returns the maximum 'time to live' for incoming packets of the flow.
NETFLOW_MIN_PKT_LNGTH(): This parser result function returns the minimum packet length for the current flow.
NETFLOW_MIN_TTL(): This parser result function returns the minimum 'time to live' for incoming packets of the flow.
NETFLOW_MPLS_LABEL(int32): This parser result function returns the MPLS label at the specified position in the stack, where the position is specified with an argument between 1 and 10.
NETFLOW_MPLS_PAL_RD(): This parser result function returns the MPLS PAL Route Distinguisher.
NETFLOW_MPLS_PREFIX_LEN(): This parser result function returns the number of consecutive bits in the MPLS prefix length.
NETFLOW_MPLS_TOP_LABEL_IPV4_ADDR(): This parser result function returns the Forwarding Equivalent Class corresponding to the MPLS Top Label.
NETFLOW_MPLS_TOP_LABEL_TYPE(): This parser result function returns the MPLS top label type, '0' for UNKNOWN, '1' for TE-MIDPT, '2' for ATOM, '3' for VPN '4' for BGP, '5' for LDP.
NETFLOW_MUL_DST_BYTES(): This parser result function returns the number of outgoing multicast bytes in the current flow.
NETFLOW_MUL_DST_PKTS(): This parser result function returns the number of outgoing multicast packets in the current flow.
NETFLOW_MUL_IGMP_TYPE(): This parser result function returns the IGMP packet type.
NETFLOW_OUTPUT_INTERFACE(): This parser result function returns the interface index where the current flow left the router, if available, or zero if not.
NETFLOW_OUT_BYTES(): This parser result function returns the number of bytes that left the router for the current flow.
NETFLOW_OUT_PKTS(): This parser result function returns the number of packets that left the router for the current flow.
NETFLOW_POST_IP_DSCP(): This parser result function returns the value of a Differentiated Services Code Point (DSCP) encoded in the Differentiated Services Field, after modification.
NETFLOW_PROTOCOL(): This parser result function returns the IP protocol number for the current flow record, if available, for example, '17' for UDP, or '6' for TCP, or zero if not.
NETFLOW_REPLICATION_FACTOR(): This parser result function returns the multicast replication factor.
NETFLOW_SAMPLER_NAME(): This parser result function returns the name of the flow sampler, when Netflow is sampled.
NETFLOW_SAMPLING_ALGORITHM(): This parser result function returns the sampling algorithm, when Netflow is sampled, with '1' for deterministic sampling, and '2' for random sampling.
NETFLOW_SAMPLING_INTERVAL(): This parser result function returns the sampling rate, when Netflow is sampled, for example, a value of 100 indicates that one of every 100 packets is sampled.
NETFLOW_SEQUENCE_NUMBER(): This parser result function returns the sequence number assigned to the current message by the router.
NETFLOW_SOURCE_ID(): This parser result function returns the port identifier of the router.
NETFLOW_SRC_AS(): This parser result function returns the BGP autonomous system number of the source endpoint of the current flow.
NETFLOW_SRC_MASK(): This parser result function returns the number of significant bits in the IP version 4 address of the source endpoint of the current flow record, if available, or zero if not.
NETFLOW_SRC_PORT(): This parser result function returns the TCP or UDP port number of the source endpoint of the current flow record, if available, or zero if not.
NETFLOW_SRC_TOS(): This parser result function returns the IP 'type of service' byte for the current flow record on entering the router, if available, or zero if not.
NETFLOW_SRC_TRAFFIC_INDEX(): This parser result function returns BGP policy accounting source traffic index.
NETFLOW_SRC_VLAN(): This parser result function returns the virtual LAN identifier associated with the ingress interface.
NETFLOW_SYSTEM_UPTIME(): This parser result function returns the elapsed time from when the router started until the current message was sent, in milliseconds.
NETFLOW_TCP_FLAGS(): This parser result function returns the cumulative value of all TCP flags in the current flow record, that is, the logical 'or' of the TCP flags in all packets in the flow, if available, or zero if not.
NETFLOW_TOTAL_BYTES_EXP(): This parser result function returns the number of bytes exported by the Observation Domain.
NETFLOW_TOTAL_FLOWS_EXP(): This parser result function returns the number of flows exported by the Observation Domain.
NETFLOW_TOTAL_PKTS_EXP(): This parser result function returns the number of packets exported by the Observation Domain.
NETFLOW_UNIX_NANOSECONDS(): This parser result function returns the fractional part of NETFLOW_UNIX_SECONDS(), in nanoseconds, for Netflow version 5 messages only.
NETFLOW_UNIX_SECONDS(): This parser result function returns the time that the current message was sent, in seconds, according to the router's clock, relative to the beginning of the Unix epoch (at midnight on the first of January in Greenwich, England).
NETFLOW_VERSION(): This parser result function returns the Netflow version of the current message, either '5' or '9'.
OPEN_FILES(): This result function returns the number of files that are open at the time the tuple is produced.
OPEN_FILES_HIGH_WATER_MARK(): This result function returns the maximum number of files that were ever open simultaneously, since the operator started.
OPEN_FLOWS(): This result function returns the number of flows that are open at the time the tuple is produced.
OPEN_FLOWS_HIGH_WATER_MARK(): This result function returns the maximum number of flows that were ever open simultaneously, since the operator started.
PACKET_DATA(): This function returns the network data in the current packet, including all network headers.
PACKET_LENGTH(): This function returns the number of bytes of network data in the current packet, including all network headers.
PAYLOAD_DATA(): This function returns the payload data in the current packet, excluding all network headers.
PAYLOAD_LENGTH(): This function returns the number of bytes of payload data in the current packet, excluding all network headers.
PEID(): Return the PE ID for the current processing element that this operator is executing in.
PI(): Value of PI.
TCP_ACKNOWLEDGEMENT(): This function returns the value of the TCP acknowledgement number in the current packet, if it has one, or zero if otherwise.
TCP_DST_PORT(): This function returns the TCP destination port number of the current packet, if it has one, or zero otherwise.
TCP_FLAGS_ACK(): This function returns true if the current packet has a TCP 'ack' flag and its set, or false otherwise.
TCP_FLAGS_FIN(): This function returns true if the current packet has a TCP 'fin' flag and its set, or false otherwise.
TCP_FLAGS_PUSH(): This function returns true if the current packet has a TCP 'push' flag and its set, or false otherwise.
TCP_FLAGS_RESET(): This function returns true if the current packet has a TCP 'reset' flag and its set, or false otherwise.
TCP_FLAGS_SYN(): This function returns true if the current packet has a TCP 'syn' flag and its set, or false otherwise.
TCP_FLAGS_URGENT(): This function returns true if the current packet has a TCP 'urgent' flag and its set, or false otherwise.
TCP_PORT(uint16): This function returns true if the current packet has a TCP source or destination port, or false if not.
TCP_SEQUENCE(): This function returns the value of the TCP sequence number in the current packet, if it has one, or zero if otherwise.
TCP_SRC_PORT(): This function returns the TCP source port number of the current packet, if it has one, or zero otherwise.
TCP_WINDOW(): This function returns the value of the TCP window size in the current packet, if it has one, or zero if otherwise.
TLS_RECORD_DIRECTION(): This result function returns the direction this TLS message is going, if the flow is encrypted with the 'transport-layer security' protocol, or an empty string if not.
TLS_RECORD_LENGTH(): This result function returns the length of this TLS message, if the flow is encrypted with the 'transport-layer security' protocol, or '0' if not.
TLS_RECORD_MORE(): This result function indicates whether or not more TLS messages are coming, if the flow is encrypted with the 'transport-layer security' protocol, or false if not.
TLS_RECORD_OFFSET(): This result function returns the offset of this TLS message, if the flow is encrypted with the 'transport-layer security' protocol, or '0' if not.
TLS_RECORD_TYPE(): This result function returns the type of TLS message found, if the flow is encrypted with the 'transport-layer security' protocol, or an empty string if not.
TLS_VERSION(): This result function returns the version of the TLS protocol being used, if the flow is encrypted with the 'transport-layer security' protocol, or an empty string if not.
TUNNEL_IPV4_DST_ADDRESS(): This result function returns the IP version 4 address of the innermost destination endpoint within the tunnel.
TUNNEL_IPV4_SRC_ADDRESS(): This result function returns the IP version 4 address of the innermost source endpoint within the tunnel.
TUNNEL_IPV6_DST_ADDRESS(): This result function returns the IP version 6 address of the innermost destination endpoint within the tunnel.
TUNNEL_IPV6_SRC_ADDRESS(): This result function returns the IP version 6 address of the innermost source endpoint within the tunnel.
TUNNEL_TYPE(): This result function returns characteristics of protocols found within another protocol.
UDP_DST_PORT(): This function returns the UDP destination port number of the current packet, if it has one, or zero otherwise.
UDP_PORT(uint16): This function returns true if the current packet is a UDP packet and the argument matches its source or destination port, or false otherwise.
UDP_SRC_PORT(): This function returns the UDP source port number of the current packet, if it has one, or zero otherwise.
VLAN_TAGS(): This function returns a list of 0 to N VLAN tags found in the current packet.
abort(): Abort program execution.
abs(T): Compute the absolute value.
abs(T): Compute the absolute value.
abs(complex32): Compute the absolute value.
abs(complex64): Compute the absolute value.
abs(list<T>): Compute the absolute value of a list.
abs(list<T>[N]): Compute the absolute value of a list.
acos(T): Compute the arc-cosine.
add(timestamp, float64): Add a time difference in seconds (as float64) to a timestamp.
add(timestamp, int64): Add a time difference in nanoseconds (as int64) to a timestamp.
addUDPSubscription(rstring): Take a subscription and modify it to account for parallel regions in the publisher or subscriber.
andFilter(rstring, rstring): Return a string representation of cond1 && cond2.
appLog(enum{error, warn, info}, T): Log a message in the logging system.
appLog(enum{error, warn, info}, T, T): Log a message in the logging system.
appTrc(enum{error, warn, info, debug, trace}, T): Log a message in the tracing system.
appTrc(enum{error, warn, info, debug, trace}, T, T): Log a message in the tracing system.
appendM(blob, list<uint8>): Append a list of bytes to a blob.
appendM(blob, uint8): Append a byte to a blob.
appendM(list<T>, T): Append to a list (mutating version).
appendM(list<T>[N], T): Append to a bounded list (mutating version).
appendM(rstring[N], rstring): Append an rstring to a bounded rstring.
appendM(rstring[N], rstring[M]): Append a bounded rstring to a bounded rstring.
area(T): Computes the area of the provided geometry, is always 0.0 for 0-d and 1-d objects. Area is computed on the spherical earth model for 2-d geometries. In case of an exception, -1 will be returned and the exception logged.
asin(T): Compute the arcsine.
assert(boolean): Check assertion at runtime in non-optimized code.
assert(boolean, T): Check assertion at runtime in non-optimized code (with a specified message).
assert(list<boolean>): Check assertion at runtime in non-optimized code.
assert(list<boolean>[N]): Check assertion at runtime in non-optimized code.
assert(map<T, boolean>): Check assertion at runtime in non-optimized code.
assert(map<T, boolean>[N]): Check assertion at runtime in non-optimized code.
assignFrom(T1, T2): Assign matching fields of a tuple from another one.
at(list<T>, list<uint32>): Access multiple elements of a list.
at(list<T>[N], list<uint32>): Access multiple elements of a list.
atan(T): Compute the arc-tangent.
avg(list<T>): Compute the average of a list.
avg(list<T>[N]): Compute the average of a list.
azimuth(Metric.metricType, PointPropertyType.point128, PointPropertyType.point128): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::azimuth instead. This function computes the distance between the two points using the algorithm provided in the metric type
azimuth(Metric.metricType, PointPropertyType.point32, PointPropertyType.point32): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::azimuth instead. This function computes the distance between the two points using the algorithm provided in the metric type
azimuth(Metric.metricType, PointPropertyType.point64, PointPropertyType.point64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::azimuth instead. This function computes the distance between the two points using the algorithm provided in the metric type
azimuth(T, T): Computes the azimuth between two points expressed in WGS84 coordinates, the input points are in WKT format.
base32GeohashToBinary(T): Converts a geohash in base32 format to a binary string.
binaryGeohashToBase32(T): Converts a geohash in binary format to a base32 string.
blobSize(blob): Get the size of a blob.
block(float64): Block until shutdown is requested, or the specified amount of time has elapsed, whichever comes first.
bytesProcessed(): This function returns the number of bytes of network data processed by the operator since it started, including the current packet, excluding any packets that were ignored by the input filter, if the inputFilter parameter was specified.
calcCallCharm(float64, float64, float64, float64, float64, float64)
calcCallDelta(float64, float64, float64, float64, float64, float64)
calcCallDualDelta(float64, float64, float64, float64, float64, float64)
calcCallRho(float64, float64, float64, float64, float64, float64)
calcCallTheta(float64, float64, float64, float64, float64, float64)
calcCallValue1(float64, float64, float64, float64, float64, float64)
calcCallValue2(float64, float64, float64, float64, float64, float64)
calcColor(float64, float64, float64, float64, float64, float64)
calcDualGamma(float64, float64, float64, float64, float64, float64)
calcDvegaDtime(float64, float64, float64, float64, float64, float64)
calcGamma(float64, float64, float64, float64, float64, float64)
calcGreeks(float64, float64, float64, float64, float64, float64)
calcPutCharm(float64, float64, float64, float64, float64, float64)
calcPutDelta(float64, float64, float64, float64, float64, float64)
calcPutDualDelta(float64, float64, float64, float64, float64, float64)
calcPutRho(float64, float64, float64, float64, float64, float64)
calcPutTheta(float64, float64, float64, float64, float64, float64)
calcPutValue1(float64, float64, float64, float64, float64, float64)
calcPutValue2(float64, float64, float64, float64, float64, float64)
calcSpeed(float64, float64, float64, float64, float64, float64)
calcVanna(float64, float64, float64, float64, float64, float64)
calcVega(float64, float64, float64, float64, float64, float64)
calcVomma(float64, float64, float64, float64, float64, float64)
calcZomma(float64, float64, float64, float64, float64, float64)
ceil(T): Compute the smallest integer value equal to or greater than a value.
ceil(decimal32): Compute the smallest integer value equal to or greater than a value.
ceil(decimal64): Compute the smallest integer value equal to or greater than a value.
checkTopicFilter(rstring): Check a topic filter is valid.
checkTopicName(rstring): Check a topic name is valid.
clearM(T): Clear (empty) a list.
clearM(blob): Clear (empty) a list.
clearerr(uint64): Clear the error and end-of-file indicators for an open file.
compactIPV6(rstring): Compacts a valid IPv6 address (RFC3513).
compare(rstring, rstring): Returns -1 if ip1 is less than ip2.
concat(list<T>, list<T>): Concatenate two lists.
concat(list<T>, list<T>[N]): Concatenate two lists.
concat(list<T>[N], list<T>): Concatenate two lists.
concat(list<T>[N], list<T>[M]): Concatenate two lists.
concat(rstring, rstring): Concatenate two rstring strings, returning an rstring.
concat(rstring, rstring[N]): Concatenate an rstring with a bounded rstring, returning an rstring.
concat(rstring[N], rstring): Concatenate a bounded rstring with an rstring, returning an rstring.
concat(rstring[N], rstring[M]): Concatenate two bounded rstring strings, returning an rstring.
concatM(list<T>, list<T>): Concatenate two lists (mutating version).
concatM(list<T>, list<T>[N]): Concatenate two lists (mutating version).
concatM(list<T>[N], list<T>): Concatenate two lists (mutating version).
concatM(list<T>[N], list<T>[M]): Concatenate two lists (mutating version).
concatM(set<T>, set<T>): Concatenate two sets (mutating version).
concatM(set<T>, set<T>[N]): Concatenate two sets (mutating version).
concatM(set<T>[N], set<T>): Concatenate two sets (mutating version).
concatM(set<T>[N], set<T>[M]): Concatenate two sets (mutating version).
containingGeohash(T, float64): Provides a utility method to do spatial aggregation on point geometry data, where the input geometry is expected to be a point (in WGS84 coordinates) in WKT format and a boxSize in meters.
contains(T, T): Determines if the first geometry contains the second geometry, geometries are specified in WKT format.
convertFromBlob(blob): Convert a blob to an rstring.
convertFromUtf8(rstring, rstring): Convert a UTF-8 encoded string into data as raw bytes with a specified encoding.
convertFromUtf8ToString(rstring, rstring): Convert a UTF-8 encoded string into a string with a specified encoding.
convertHostnameToIPV4AddressNumeric(rstring): This function converts a hostname into a binary IPv4 address.
convertHostnameToIPV4AddressString(rstring): This function converts a hostname into a string representation of an IPv4 address.
convertIPV4AddressNumericToHostname(uint32): This function converts a four-byte binary representation of an IPv4 address into a hostname.
convertIPV4AddressNumericToString(uint32): This function converts a four-byte binary representation of an IPv4 address into a string representation.
convertIPV4AddressNumericToSubnet(uint32, int32): This function converts a four-byte binary representation of an IPv4 address into a four-byte binary subnet address, using the specified number of mask bits.
convertIPV4AddressStringToHostname(rstring): This function converts a string containing an IPv4 address into a domain name, if the address has one.
convertIPV4AddressStringToNumeric(rstring): This function converts a string representation of an IPv4 address to a four-byte binary representation.
convertIPV4AddressStringToSubnet(rstring, int32): This function converts a string representing an IPv4 address into a string representation of the subnet address, using the specified number of mask bits.
convertIPV6AddressNumericToString(list<uint8>[16]): This function converts a sixteen-byte binary representation of an IPv6 address into a string representation.
convertIPV6AddressStringToNumeric(rstring): This function converts a string representation of an IPv6 address into a sixteen-byte binary representation.
convertIPv4AddressStringsToNumbers(list<rstring>, list<uint16>)
convertMACAddressNumericToString(list<uint8>[6]): This function converts an ethernet MAC address from a six-byte binary value to a string representation.
convertMACAddressStringToNumeric(rstring): This function converts an ethernet MAC address from a string representation to a six-byte binary value.
convertToBlob(rstring): Convert an rstring to a blob.
convertToUtf8(list<uint8>, rstring): Convert data given as raw bytes with a specified encoding into a UTF-8 encoded string.
convertToUtf8(list<uint8>[N], rstring): Convert data given as raw bytes with a specified encoding into a UTF-8 encoded string.
convertToUtf8(rstring, rstring): Convert data given as raw bytes with a specified encoding into a UTF-8 encoded string.
convertToXML(X, T): Convert a string to XML, returning the success status.
convertToXML(X, T, int32): Convert a string to XML, returning the success status and an error code.
convolve(list<float64>, list<float64>): The convolve function generates the convolution of two time series input signals.
correlationCoefficient(list<float32>, list<float32>): An SPL function is provided in the Financial Services Toolkit for computing the Coefficient of Correlation between two series of variables.
cos(T): Compute the cosine.
countDistinct(list<T>): Compute the distinct count of a list.
countDistinct(list<T>[N]): Compute the distinct count of a list.
createCustomMetric(rstring, rstring, enum{Gauge, Counter, Time}, int64): Create the specified custom metric for the current operator and set its initial value.
createCustomMetric(ustring, ustring, enum{Gauge, Counter, Time}, int64): Create the specified custom metric for the current operator and set its initial value.
createDirectory(rstring, int32): Attempts to create the directory that the path variable identifies, as if by ISO/IEC 9945 mkdir() with a second argument of S_IRWXU|S_IRWXG|S_IRWXO.
createLineSegment128( com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point128, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point128): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::lineSegment instead. This function creates a lineSegment128
createLineSegment32( com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point32, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point32): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::lineSegment instead. This function creates a lineSegment32
createLineSegment64( com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point64, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::lineSegment instead. This function creates a lineSegment64
createLineString128( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment128>): Deprecated as of Streams version 4.0. This function creates a list of lineSegment128
createLineString32( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment32>): Deprecated as of Streams version 4.0. This function creates a list of lineSegment32
createLineString64( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment64>): Deprecated as of Streams version 4.0. This function creates a list of lineSegment64
createLinearSimplePolygon128( list<com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point128>): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::polygon or com.ibm.streams.geospatial.ext::orientedPolygon instead. This function creates a linear simple polygon128
createLinearSimplePolygon32( list<com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point32>): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::polygon or com.ibm.streams.geospatial.orientedPolygon instead. This function creates a linear simple polygon32
createLinearSimplePolygon64( list<com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point64>): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::polygon or com.ibm.streams.geospatial.ext::orientedPolygon instead. This function creates a linear simple polygon64
createPoint128(float64, float64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::point instead. This function creates a point128
createPoint32(float64, float64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::point instead. This function creates a point32
createPoint64(float64, float64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::point instead. This function creates a point64
createTimestamp(int64, uint32): Create a timestamp given the number of seconds and nanoseconds elapsed since the Epoch (00:00:00 UTC, January 1, 1970).
createTimestamp(int64, uint32, int32): Create a timestamp given the number of seconds and nanoseconds elapsed since the Epoch (00:00:00 UTC, January 1, 1970), and a machine identifier that identifies the computer where the time measurement was taken.
crosscorrelate(list<float64>, list<float64>): The crosscorrelate function generates the crosscorrelation of two time series input signals.
csvTokenize(rstring): Tokenize a string containing comma-separated values.
csvTokenize(ustring): Tokenize a string containing comma-separated values.
ctime(timestamp): Convert a timestamp to a date and time string, using the current timezone.
currentTimeMillis(): Return the number of milliseconds since the epoch (1970-01-01 00:00:00.000). Returns a value that can be used with the type TimeMillis.
currentTimestamp(): Get the current time using getTimestamp().
dataDirectory(): Return the absolute pathname to the runtime location of the data directory for the SPL application.
day(timestamp): Extract the day of month from a timestamp, using the current timezone.
dayOfWeek(timestamp): Extract the day of week from a timestamp, using the current timezone.
dayOfYear(timestamp): Extract the day of year from a timestamp, using the current timezone.
days(float64): Convert days to seconds as a float64.
days(int32): Convert whole days to seconds as a float64.
destinationPoint(T, float64, float64): Computes the destination point given a point, the heading/azimuth, and the distance in meters, the input point is in WKT format with WGS84 coordinates, the output point is in WKT WGS84 format.
destinationPoint( com.ibm.streams.geospatial.twodimension.geometry::Metric.metricType, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point128, float64, float64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::destinationPoint instead. This function computes the distance between the two points using the algorithm provided in the metric type
destinationPoint( com.ibm.streams.geospatial.twodimension.geometry::Metric.metricType, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point32, float64, float64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::destinationPoint instead. This function computes the distance between the two points using the algorithm provided in the metric type
destinationPoint( com.ibm.streams.geospatial.twodimension.geometry::Metric.metricType, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point64, float64, float64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::destinationPoint instead. This function computes the distance between the two points using the algorithm provided in the metric type
diffAsNanos(timestamp, timestamp): Compute the difference between two timestamps in nanoseconds (as int64).
diffAsSecs(timestamp, timestamp): Compute the difference between two timestamps in seconds (as float64).
dirname(rstring): Returns the parent path for the path.
distance(Metric.metricType, PointPropertyType.point128, PointPropertyType.point128): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the algorithm provided in the metric type
distance(Metric.metricType, PointPropertyType.point32, PointPropertyType.point32): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the algorithm provided in the metric type
distance(Metric.metricType, PointPropertyType.point64, PointPropertyType.point64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the algorithm provided in the metric type
distance(T, T): Computes the shortest distance in meters between given geometries in WKT format on the spherical earth model.
distanceEllipsoidal(PointPropertyType.point128, PointPropertyType.point128): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the Haversine Formula
distanceEllipsoidal(PointPropertyType.point32, PointPropertyType.point32): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the Haversine Formula
distanceEllipsoidal(PointPropertyType.point64, PointPropertyType.point64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the Haversine Formula
distanceGreatCircle(PointPropertyType.point128, PointPropertyType.point128): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the GreatCircle Formula
distanceGreatCircle(PointPropertyType.point32, PointPropertyType.point32): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the GreatCircle Formula
distanceGreatCircle(PointPropertyType.point64, PointPropertyType.point64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the GreatCircle Formula
distanceHaversine(PointPropertyType.point128, PointPropertyType.point128): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the Haversine Formula
distanceHaversine(PointPropertyType.point32, PointPropertyType.point32): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the Haversine Formula
distanceHaversine(PointPropertyType.point64, PointPropertyType.point64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the Haversine Formula
dlAcquireLock(uint64, float64, float64, uint64): Acquire lock, with an explicit lease time in seconds and a maximum time to wait to acquire the lock.
dlAcquireLock(uint64, uint64): This function can be called to acquire a distributed lock.
dlCreateOrGetLock(rstring, uint64): Create a new distributed lock with a given name or get it if it already exists.
dlGetLastDistributedLockErrorCode(): Get the error code of the last DL error
dlGetLastDistributedLockErrorString(): Get the description of the error that occurred on the most recently executed operation in the DL API, if any.
dlGetPidForLock(rstring, uint64): Get the process id that is currently holding a given lock.
dlReleaseLock(uint64, uint64): Release the given distributed lock id.
dlRemoveLock(uint64, uint64): Remove the distributed lock with the given id.
domainID(): Return the domain ID for the domain that the PE is running in.
dpsBase64Decode(rstring, rstring): Base64 decode a given string.
dpsBase64Encode(rstring, rstring): Base64 encode a given string.
dpsBeginIteration(uint64, uint64): This function gets a store iterator that can be used to iterate over all the key-value pairs in a given store id.
dpsClear(uint64, uint64): Clear the given store.
dpsCreateOrGetStore(rstring, T1, T2, uint64): Create a new process store with a given name or simply return its handle it already exists.
dpsCreateStore(rstring, T1, T2, uint64): Create a new process store with a given name.
dpsDeserialize(uint64, blob, T1, T2, uint64): This function deserializes a given blob containing one or more serialized key-value pairs.
dpsEndIteration(uint64, uint64, uint64): This function must be called once all iteration is complete.
dpsFindStore(rstring, uint64): Find a process store given its name.
dpsGet(uint64, T1, T2, uint64): Given a key, retrieves its value from the given store.
dpsGetDetailsAboutThisMachine(rstring, rstring, rstring): Get details of the client machine where this operator is running.
dpsGetLastErrorCodeTTL(): Get the error code of the last error occurred involving data that was stored with a Time To Live (TTL).
dpsGetLastErrorStringTTL(): Get the description of the last error that occurred involving data stored with a Time To Live (TTL).
dpsGetLastStoreErrorCode(): Get the error code of the last store error.
dpsGetLastStoreErrorString(): Get the description of the last store error.
dpsGetNext(uint64, uint64, T1, T2, uint64): This function is used to get the next key and value of given types in the given store when iterating over all the items in the store.
dpsGetNoSqlDbProductName(): Get the name of the NoSQL database product being used.
dpsGetSafe(uint64, T1, T2, uint64): Given a key, retrieve its value from the given store.
dpsGetSplTypeNameForKey(uint64): Get the SPL type name for the key of a given store id.
dpsGetSplTypeNameForValue(uint64): Get the SPL type name for the value of a given store id.
dpsGetStoreName(uint64): Get the store name for a given store id.
dpsGetTTL(T1, T2, uint64): Get an item that was stored with a TTL (Time To Live in seconds) value.
dpsHas(uint64, T1, uint64): Check if an item exists in the given store.
dpsHasTTL(T1, uint64): Check if an item exists that was stored with a TTL (Time To Live in seconds) value.
dpsPut(uint64, T1, T2, uint64): Put a new key-value pair into a store.
dpsPutSafe(uint64, T1, T2, uint64): Put an item into the given store.
dpsPutTTL(T1, T2, uint32, uint64): Put an key-value pair with in a TTL (Time To Live in seconds) value into the global area of the back-end data store.
dpsRemove(uint64, T1, uint64): Remove an item from the given store.
dpsRemoveStore(uint64, uint64): Remove a process store given its handle.
dpsRemoveTTL(T1, uint64): Remove an item that was stored with a TTL (Time To Live in seconds) value.
dpsRunDataStoreCommand(rstring, uint64): This function can be used to execute simple arbitrary back-end data store (fire and forget) native commands.
dpsRunDataStoreCommand(uint32, rstring, rstring, rstring, rstring, rstring, rstring, uint64): This is an advanced function that can be used to execute arbitrary back-end data store two way native commands for database technologies that work with cURL.
dpsSerialize(uint64, blob, T1, T2, uint64): This function serializes all the key-value pairs in a given store id into a blob.
dpsSize(uint64, uint64): Get the total number of key-value pairs in the given store.
dtw(list<float64>, list<float64>): This function uses dynamic time warping (DTW) to measure the similarity between two time series.
dtw_itakura(list<float64>, list<float64>, int32, float64): This function computes the Itakura Parallelogram DTW.
dtw_sakoe_chiba(list<float64>, list<float64>, int32): This function computes the Sakoe-Chiba Band based DTW.
entire(rstring): Returns the absolute and canonical path for the path.
entire(rstring, rstring): Returns the absolute and canonical path for the path.
equalsFilter(rstring, float64): Return a string representation of name == value for a float64 attribute.
equalsFilter(rstring, int64): Return a string representation of name == value for a int64 attribute.
equalsFilter(rstring, rstring): Return a string representation of name == value for a rstring attribute.
evalPredicate(rstring, T, int32): Evaluates an SPL predicate expression, represented as an rstring, using the given tuple.
exp(T): Compute e to a power.
exp(T): Compute e to a power.
expandIPV6(rstring): Expands a valid IPv6 address (RFC3513).
extension(rstring): Returns the extension of a given file name prefixed with a period (.). In case a file does not have an extension, the function returns an empty string.
fclose(uint64, int32): Close a file.
feetAndInchesToMeters(int32, int32): Deprecated since Streams version 4.0.
feetAndInchesToMeters(int64, int64): Deprecated since Streams version 4.0.
feetToMeters(float32): Deprecated since Streams version 4.0.
feetToMeters(float64): Deprecated since Streams version 4.0.
feetToMeters(int32): Deprecated since Streams version 4.0.
feetToMeters(int64): Deprecated since Streams version 4.0.
feof(uint64): Test if the stream is at the end of the file.
fflush(uint64, int32): Flush a file to disk.
filename(rstring): Returns the file name that is extracted from the path.
find(list<T>, T): Find the matching values in a list, given a value to search for.
find(list<T>[N], T): Find the matching values in a list, given a value to search for.
findFirst(T, T): Find a substring in a string, starting at index 0, where 0 is the first logical character in the input string.
findFirst(T, T, int32): Find a substring in a string.
findFirst(list<T>, T): Find the first occurrence of a matching value in a list, given a value to search for, starting at index 0.
findFirst(list<T>, T, int32): Find the first occurrence of a matching value in a list, given a value to search for.
findFirst(list<T>, list<T>): Find the first occurrence of a matching sequence of values in a list, starting at index 0.
findFirst(list<T>, list<T>, int32): Find the first occurrence of a matching sequence of values in a list.
findFirst(list<T>[N], T): Find the first occurrence of a matching value in a list, given a value to search for, starting at index 0.
findFirst(list<T>[N], T, int32): Find the first occurrence of a matching value in a list, given a value to search for.
findFirst(list<T>[N], list<T>[M]): Find the first occurrence of a matching sequence of values in a list, starting at index 0.
findFirst(list<T>[N], list<T>[M], int32): Find the first occurrence of a matching sequence of values in a list.
findFirstNotOf(T, T): Find a non-matching character in a string, starting at index 0, where 0 is the first logical character in the input string.
findFirstNotOf(T, T, int32): Find a non-matching character in a string.
findFirstNotOf(list<T>, list<T>): Find the first occurrence of a non-matching value in a list, given a list of values to search for, starting at index 0.
findFirstNotOf(list<T>, list<T>, int32): Find the first occurrence of a non-matching value in a list, given a list of values to search for.
findFirstNotOf(list<T>, list<T>[N]): Find the first occurrence of a non-matching value in a list, given a list of values to search for, starting at index 0.
findFirstNotOf(list<T>, list<T>[N], int32): Find the first occurrence of a non-matching value in a list, given a list of values to search for.
findFirstNotOf(list<T>[N], list<T>): Find the first occurrence of a non-matching value in a list, given a list of values to search for, starting at index 0.
findFirstNotOf(list<T>[N], list<T>, int32): Find the first occurrence of a non-matching value in a list, given a list of values to search for.
findFirstNotOf(list<T>[N], list<T>[M]): Find the first occurrence of a non-matching value in a list, given a list of values to search for, starting at index 0.
findFirstNotOf(list<T>[N], list<T>[M], int32): Find the first occurrence of a non-matching value in a list, given a list of values to search for.
findFirstOf(T, T): Find a matching character in a string, starting at index 0, where 0 is the first logical character in the input string.
findFirstOf(T, T, int32): Find a matching character in a string.
findFirstOf(list<T>, list<T>): Find the first occurrence of a matching value in a list, given a list of values to search for, starting at index 0.
findFirstOf(list<T>, list<T>, int32): Find the first occurrence of a matching value in a list, given a list of values to search for.
findFirstOf(list<T>, list<T>[N]): Find the first occurrence of a matching value in a list, given a list of values to search for, starting at index 0.
findFirstOf(list<T>, list<T>[N], int32): Find the first occurrence of a matching value in a list, given a list of values to search for.
findFirstOf(list<T>[N], list<T>): Find the first occurrence of a matching value in a list, given a list of values to search for, starting at index 0.
findFirstOf(list<T>[N], list<T>, int32): Find the first occurrence of a matching value in a list, given a list of values to search for.
findFirstOf(list<T>[N], list<T>[M]): Find the first occurrence of a matching value in a list, given a list of values to search for, starting at index 0.
findFirstOf(list<T>[N], list<T>[M], int32): Find the first occurrence of a matching value in a list, given a list of values to search for.
findLast(T, T, int32): Find a substring in a string.
findLast(list<T>, T, int32): Find the last occurrence of a matching value in a list, given a value to search for.
findLast(list<T>, list<T>, int32): Find the last occurrence of a matching sequence of values in a list.
findLast(list<T>[N], T, int32): Find the last occurrence of a matching value in a list, given a value to search for.
findLast(list<T>[N], list<T>[M], int32): Find the last occurrence of a matching sequence of values in a list.
findLastNotOf(T, T, int32): Find the last non-matching character in a string.
findLastNotOf(list<T>, list<T>, int32): Find the last occurrence of a non-matching value in a list, given a list of values to search for.
findLastNotOf(list<T>, list<T>[N], int32): Find the last occurrence of a non-matching value in a list, given a list of values to search for.
findLastNotOf(list<T>[N], list<T>, int32): Find the last occurrence of a non-matching value in a list, given a list of values to search for.
findLastNotOf(list<T>[N], list<T>[M], int32): Find the last occurrence of a non-matching value in a list, given a list of values to search for.
findLastOf(T, T, int32): Find a matching character in a string.
findLastOf(list<T>, list<T>, int32): Find the last occurrence of a matching value in a list, given a list of values to search for.
findLastOf(list<T>, list<T>[N], int32): Find the last occurrence of a matching value in a list, given a list of values to search for.
findLastOf(list<T>[N], list<T>, int32): Find the last occurrence of a matching value in a list, given a list of values to search for.
findLastOf(list<T>[N], list<T>[M], int32): Find the last occurrence of a matching value in a list, given a list of values to search for.
findNotOf(list<T>, list<T>): Find the non-matching values in a list, given a list of values to search for.
findNotOf(list<T>, list<T>[N]): Find the non-matching values in a list, given a list of values to search for.
findNotOf(list<T>[N], list<T>): Find the non-matching values in a list, given a list of values to search for.
findNotOf(list<T>[N], list<T>[M]): Find the non-matching values in a list, given a list of values to search for.
findOf(list<T>, list<T>): Find the matching values in a list, given a list of values to search for.
findOf(list<T>, list<T>[N]): Find the matching values in a list, given a list of values to search for.
findOf(list<T>[N], list<T>): Find the matching values in a list, given a list of values to search for.
findOf(list<T>[N], list<T>[M]): Find the matching values in a list, given a list of values to search for.
floor(T): Compute the largest integer value equal to or less than a value.
flushStdio(): Flush all stdio output streams.
fmod(T, T): Return the floating point remainder (see man 3 fmod for details and return values).
fopen(rstring, rstring, int32): Open a file.
fopen(ustring, ustring, int32): Open a file.
formatElapsedTime(float64): This function formats a value representing elapsed time, in seconds including a fractional part, as a string representation of that time in the form 'DDDDd HHh MMm SS.FFFFFFs', with leading zeros omitted.
formatElapsedTime(float64, uint32): This function formats a value representing elapsed time, in seconds including a fractional part, as a string representation of that time in the form 'DDDDd HHh MMm SS.FFFFFFs', with leading zeros omitted.
formatElapsedTime(uint32): This function formats an integer representing elapsed time, in seconds, as a string representation of that time in the form 'DDDDd HHh MMm SSs', with leading zeros omitted.
formatEpoch(uint32, rstring): This function formats an integer representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string, according to an 'strftime' format pattern.
formatEpochDateTime(float64): This function formats the integer and fractional parts of a value representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string in the form 'YYYY-MM-DD HH:MM:SS.FFFFFF' in the local time zone.
formatEpochDateTime(float64, uint32): This function formats the integer and fractional parts of a value representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string in the form 'YYYY-MM-DD HH:MM:SS.FFFFFF' in the local time zone.
formatEpochDateTime(timestamp): This function formats the integer and fractional parts of a timestamp representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string in the form 'YYYY-MM-DD HH:MM:SS.FFFFFF' in the local time zone.
formatEpochDateTime(timestamp, uint32): This function formats the integer and fractional parts of a timestamp representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string in the form 'YYYY-MM-DD HH:MM:SS.FFFFFF' in the local time zone.
formatEpochDateTime(uint32): This function formats an integer representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string in the form 'YYYY-MM-DD HH:MM:SS' in the local time zone.
formatEpochTime(float64): This function formats the integer and fractional parts of a value representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string in the form 'HH:MM:SS.FFFFFF' in the local time zone.
formatEpochTime(float64, uint32): This function formats the integer and fractional parts of a value representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string in the form 'HH:MM:SS.FFFFFF' in the local time zone.
formatEpochTime(timestamp): This function formats the integer and fractional parts of a timestamp representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string in the form 'HH:MM:SS.FFFFFF' in the local time zone.
formatEpochTime(timestamp, uint32): This function formats the integer and fractional parts of a timestamp representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string in the form 'HH:MM:SS.FFFFFF' in the local time zone.
formatEpochTime(uint32): This function formats an integer representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string in the form 'HH:MM:SS' in the local time zone.
formatNumber(float64): Format a float using locale specific format.
formatNumber(float64, uint32, uint32, boolean): Format a float using locale specific format.
formatNumber(int64): Format an integer using locale specific format.
formatNumber(int64, uint32): Format an integer using locale specific format.
formatSubseconds(float64, uint32): This function formats the integer and fractional parts of a value representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string, with the specified precision for the fractional part.
formatSubseconds(timestamp, uint32): This function formats the integer and fractional parts of a timestamp representing 'Unix epoch' time (that is, seconds since January 1st, 1970 at midnight in Greenwich, England) as a string, with the specified precision for the fractional part.
fread(list<uint8>, uint64, uint64, int32): Read a list of bytes from a file using binary format.
freadBin(T, uint64, int32): Read an SPL value from a file using binary format.
freadLine(uint64, int32): Read a line from a file.
freadToken(uint64, int32): Read a 'token' from a file.
freadTxt(T, uint64, int32): Read an SPL value from a file as a text string.
freadfile(blob, uint64, int32): Read a whole file into a blob as binary.
fromDecimal128(decimal128): Convert to a timestamp a decimal128 value that preserves the precision of a timestamp, and represents the time as the number of seconds (including fractions) elapsed since the Epoch (00:00:00 UTC, January 1, 1970).
fromIso8601ToMillis(T): Convert a full ISO 8601 date to number of milliseconds since the epoch.
fromIso8601ToTimestamp(rstring): Get a SPL timestamp from a full ISO 8601 date.
fromIso8601ToTimestamp(rstring, int32): Get a SPL timestamp from a full ISO 8601 date and a machine identifier.
fseek(uint64, int64, int32, int32): Set the current file position.
fstat(rstring, rstring, timestamp, int32): Return timestamp information about a file.
fstat(rstring, rstring, uint64, int32): Return information about a file.
fstat(uint64, rstring, timestamp, int32): Return timestamp information about a file.
fstat(uint64, rstring, uint64, int32): Return information about a file.
fstat(uint64, ustring, timestamp, int32): Return timestamp information about a file.
fstat(uint64, ustring, uint64, int32): Return information about a file.
fstat(ustring, ustring, timestamp, int32): Return timestamp information about a file.
fstat(ustring, ustring, uint64, int32): Return information about a file.
ftell(uint64, int32): Return the current file position.
fwrite(list<uint8>, uint64, uint64, uint64, int32): Write a list of bytes to a file using binary format.
fwriteBin(T, uint64, int32): Write an SPL value to a file using binary format.
fwriteString(T, uint64, int32): Write a string to a file.
fwriteTxt(T, uint64, int32): Write an SPL value to a file as a text string.
fwriteblob(blob, uint64, int32): Write a blob into a file as binary.
generate_pulsetrain_wave(float64, uint32, float64, uint32): Generates a pulse train representation of a time series, with a specified frequency, duration, sampling rate, and hump size.
generate_sawtooth_wave(float64, uint32, uint32): Generates a sawtooth wave representation of a time series, with a specified frequency, duration, and sampling rate.
generate_sine_wave(float64, uint32, uint32): Generates a sine wave representation of a time series, with a specified frequency, duration, and sampling rate.
generate_square_wave(float64, uint32, uint32): Generates a square wave representation of time series with a specific frequency, duration, and sampling rate.
generate_triangular_wave(float64, uint32, uint32): Generates a triangular wave representation of a time series, with a specified frequency, duration, and sampling rate.
geohashDecode(T): Decodes a given geohash to its corresponding geometry in WKT format.
geohashDistanceEncode(T, float64): Encodes the input geometry as a bit representation geohash.
geohashEncode(T): Encodes the provided geometry as a geohash in bit representation.
geohashStringDecode(T): Decodes a given base 32 encoded geohash to its corresponding point geometry in WKT format.
geohashStringEncode(T): Encodes the provided point as a base 32 encoded string.
getAllAddressesInNetwork(rstring): Returns a list of all IP addresses in the network.
getAllChannels(): Get the parallel channel indexes for all nested parallel regions.
getAllMaxChannels(): Get the maximum number of parallel channels for all nested parallel regions.
getApplicationConfiguration(map<rstring, rstring>, rstring): Get the application configuration with the given name.
getApplicationConfigurationProperty(rstring, rstring, int32): Get the value associated with the given configuration property propertyName from the configuration identified by configName.
getApplicationConfigurationProperty(rstring, rstring, rstring): Get the value associated with the given configuration property propertyName from the configuration identified by configName.
getApplicationDir(): Return the runtime location of the full path to the SPL application directory.
getApplicationName(): Return the name of the application that is executing this operator.
getCPUCounterInNanoSeconds(): Obtain the CPU counter, which is an indication of relative time, in nanoseconds.
getChannel(): Get the parallel channel index.
getCompileTimeListValue(rstring): Return the named compiler invocation argument list value (name="value0,value1").
getCompileTimeValue(rstring): Return a named compiler invocation argument value (name=value).
getCompileTimeValue(rstring, rstring): Return a named compiler invocation argument value (name=value).
getConfiguredHostName(): Get the hostname used by the streams instance for this host.
getConsistentRegionIndex(): Gets the index of the consistent region.
getCustomMetricNames(): Return the names of the custom metrics for the current operator.
getCustomMetricValue(rstring, int64): Get the specified custom metric value for the current operator.
getCustomMetricValue(ustring, int64): Get the specified custom metric value for the current operator.
getDrainTimeout(): Gets the drain timeout of a consistent region.
getEnvironmentVariable(rstring): Get the value of an environment variable.
getEnvironmentVariable(rstring, boolean): Get the value of an environment variable.
getEnvironmentVariable(rstring, rstring): Get the value of an environment variable.
getHostName(): Get the host name.
getIPAddress(): Get the IP address for the current host.
getInputPortImportFilterExpression(uint32, int32): Get the filter expression for an input port that receives a stream that is imported.
getInputPortImportSubscription(uint32, int32): Get the import subscription for an input port that receives a stream that is imported by subscription.
getInputPortMetricValue(uint32, enum{nTuplesProcessed, nTuplesDropped, nTuplesQueued, nWindowPunctsProcessed, nFinalPunctsProcessed, nWindowPunctsQueued, nFinalPunctsQueued, queueSize}, int64): Get the specified input port metric value for the current operator.
getJobGroup(): Return the name of the job group for the current job that this operator is executing in.
getJobName(): Return the name of the current job that this operator is executing in.
getLatitude(PointPropertyType.point128): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLatitude instead. This function computes the latitude from a point
getLatitude(PointPropertyType.point32): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLatitude instead. This function computes the latitude from a point
getLatitude(PointPropertyType.point64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLatitude instead. his function computes the latitude from a point
getLatitude(T): Extract latitude from WKT point geometry
getLocalChannel(): Get the parallel channel index.
getLocalMaxChannels(): Get the maximum number of parallel channels.
getLongitude(PointPropertyType.point128): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLongitude instead. This function computes the Longitude from a point
getLongitude(PointPropertyType.point32): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLongitude instead. This function computes the Longitude from a point
getLongitude(PointPropertyType.point64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLongitude instead. This function computes the Longitude from a point
getLongitude(T): Extract longitude from WKT point geometry
getMachineId(timestamp): Extract the machine identifier from a timestamp.
getMainCompositeName(): Return the name of the main composite.
getMaxChannels(): Get the maximum number of parallel channels.
getNanoseconds(timestamp): Extract the part of a timestamp that represents the number of namoseconds elapsed since a whole number of seconds since the Epoch (00:00:00 UTC, January 1, 1970).
getOSuid(): This function shall return the real user ID of the job.
getOutputPortCongestionFactor(uint32): Return the maximum congestion factor for all the connections from an output port that connect to another PE.
getOutputPortExportProperties(list<tuple<rstring name, rstring value, rstring typ>>, uint32): Get the export properties for an output port that produces a stream that is exported with properties.
getOutputPortMetricValue(uint32, enum{nTuplesSubmitted, nWindowPunctsSubmitted, nFinalPunctsSubmitted}, int64): Get the specified output port metric value for the current operator.
getPEOutputPortConnections(uint32, list<tuple<int64 pe, int64 port, uint8 congestionFactor, uint64 nTuplesFilteredOut>>): Return the connection information for an output port that connects to another PE.
getRelaunchCount(): Return the number of times the PE that the operator is executing in has been relaunched.
getResetAttempt(): If the operator is in a consistent region, this function returns the number of attempts made to reset the consistent region to a consistent state.
getResetTimeout(): Gets the reset timeout of a consistent region.
getSeconds(timestamp): Extract the part of a timestamp that represents the number of whole seconds elapsed since the Epoch (00:00:00 UTC, January 1, 1970).
getSegmentPrefix(rstring): Creates the prefix for the physical shared memory segment.
getSequenceId(): Gets the current sequence identifier of a consistent region.
getShortHostName(): Get the short host name.
getSubmissionTimeListValue(rstring): Return the named submission time list value (name="value0,value1").
getSubmissionTimeListValue(rstring, list<rstring>): Return the named submission time list value (name="value0,value1").
getSubmissionTimeValue(rstring): Return the named submission time value (name="value").
getSubmissionTimeValue(rstring, rstring): Return the named submission time value (name="value").
getThisCompositeInstanceName(): Return the name of the current composite instance.
getThisFileDir(): Return the full pathname of the runtime location of the directory containing the current SPL file as an rstring.
getThisFileName(): Return the current SPL file name as an rstring.
getThisFilePath(): Return the full pathname of the runtime location of the current SPL file as an rstring.
getThisLine(): Return the current line number as an int32.
getThisOperatorLogicalName(): Get the logical name of the operator.
getThisOperatorName(): Get the physical name of the operator.
getThisToolkitDir(): Return the full path to the runtime location of the root directory of the toolkit containing the current SPL file.
getTimestamp(): Get the current wall clock time as a timestamp.
getTimestampInSecs(): Get the current wall clock time as the number of seconds (including fractions) elapsed since the Epoch (00:00:00 UTC, January 1, 1970).
getTopicSubscription(rstring): Get the subscription that matches a topic for topic based subscription.
getTopicSubscription(rstring, boolean): Get the subscription that matches a topic for topic based subscription with explicit matching for the publisher allowing filters.
gmday(timestamp): Extract the day of month from a timestamp, using the UTC timezone.
gmdayOfWeek(timestamp): Extract the day of week from a timestamp, using the UTC timezone.
gmdayOfYear(timestamp): Extract the day of year from a timestamp, using the UTC timezone.
gmhour(timestamp): Extract the hour from a timestamp, using the UTC timezone.
gmminute(timestamp): Extract the minute from a timestamp, using the UTC timezone.
gmmonth(timestamp): Extract the month from a timestamp, using the UTC timezone.
gmsecond(timestamp): Extract the second from a timestamp, using the UTC timezone.
gmtime(timestamp, tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>): Convert a timestamp to a broken-down time (using the Sys.tm type), using the UTC timezone.
gmyear(timestamp): Extract the year from a timestamp, using the UTC timezone.
has(list<T>, T): Find whether a given value exists in a list.
has(list<T>[N], T): Find whether a given value exists in a list.
has(map<K, V>, K): Find whether a given key exists in a map.
has(map<K, V>[N], K): Find whether a given key exists in a map.
has(set<T>, T): Find whether a given value exists in a set.
has(set<T>[N], T): Find whether a given value exists in a set.
hasCustomMetric(rstring): Check if the specified custom metric exists.
hasCustomMetric(ustring): Check if the specified custom metric exists.
hashCode(T): Compute the hash of a value.
hashCodeForEach(L): Compute hashes of a list of values, using the same hashing method as hashCode().
hour(timestamp): Extract the hour from a timestamp, using the current timezone.
hours(float64): Convert hours to seconds as a float64.
hours(int32): Convert whole hours to seconds as a float64.
imag(complex32): Return the 'imaginary' part of a complex number.
imag(complex64): Return the 'imaginary' part of a complex number.
inFilter(rstring, list<rstring>): Return a string representation of filter name in values for a rstring attribute.
inchesToMeters(float32): Deprecated since Streams version 4.0.
inchesToMeters(float64): Deprecated since Streams version 4.0.
inchesToMeters(int32): Deprecated since Streams version 4.0.
inchesToMeters(int64): Deprecated since Streams version 4.0.
infl(): Return a float64 infinity.
infw(): Return a float32 infinity.
inputPort(T): Return the index corresponding to an input port.
insert(list<T>, T, int32): Insert a value into a list.
insert(list<T>, list<T>, int32): Insert a list of values into a list.
insert(list<T>, list<T>[N], int32): Insert a list of values into a list.
insert(list<T>[N], T, int32): Insert a value into a list.
insert(list<T>[N], list<T>, int32): Insert a list of values into a list.
insert(list<T>[N], list<T>[M], int32): Insert a list of values into a list.
insert(map<K, V>, K, V): Insert an element into a map.
insert(map<K, V>[N], K, V): Insert an element into a map.
insert(set<V>, V): Insert a value into a set.
insert(set<V>[N], V): Insert a value into a set.
insertM(list<T>, T, int32): Insert a value into a list (mutating version).
insertM(list<T>, list<T>, int32): Insert values into a list (mutating version).
insertM(list<T>, list<T>[N], int32): Insert values into a list (mutating version).
insertM(list<T>[N], T, int32): Insert a value into a list (mutating version).
insertM(list<T>[N], list<T>, int32): Insert values into a list (mutating version).
insertM(list<T>[N], list<T>[M], int32): Insert values into a list (mutating version).
insertM(map<K, V>, K, V): Insert an element into a map (mutating version).
insertM(map<K, V>[N], K, V): Insert an element into a map (mutating version).
insertM(set<V>, V): Insert a value into a set (mutating version).
insertM(set<V>[N], V): Insert a value into a set (mutating version).
instanceID(): Return the Streams instance ID that the PE is running in.
interpretRStringLiteral(rstring): Interpret a string literal stored in a UTF-8 encoded string as an rstring.
interpretUStringLiteral(rstring): Interpret a string literal stored in a UTF-8 encoded string as a ustring.
intersects(T, T): Computes if the two geometries intersect, resulting in either true/false as the output.
isConsistentInputPort(uint32): Check if the input port is consistent.
isContained(CurvePropertyType.lineSegment128, PointPropertyType.point128): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a lineSegment128 contains a point128
isContained(CurvePropertyType.lineSegment32, PointPropertyType.point32): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a lineSegment32 contains a point32
isContained(CurvePropertyType.lineSegment64, PointPropertyType.point64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a lineSegment64 contains a point64
isContained(list<PointPropertyType.point128>, PointPropertyType.point128): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon128 contains a linearsimplepolygon128
isContained(list<PointPropertyType.point128>, list<PointPropertyType.point128>): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon128 contains a linearsimplepolygon128
isContained(list<PointPropertyType.point32>, PointPropertyType.point32): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon32 contains a linearsimplepolygon32
isContained(list<PointPropertyType.point32>, list<PointPropertyType.point32>): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon32 contains a linearsimplepolygon32
isContained(list<PointPropertyType.point64>, PointPropertyType.point64): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon64 contains a linearsimplepolygon64
isContained(list<PointPropertyType.point64>, list<PointPropertyType.point64>): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon64 contains a linearsimplepolygon64
isControlInputPort(uint32): Check if the input port is a control port.
isDefaultValue(X): Return if this XML value contains the default (uninitialized) value.
isEACCES(int32): Return whether the value is EACCES.
isEAGAIN(int32): Return whether the value is EAGAIN.
isEBADF(int32): Return whether the value is EBADF.
isEFAULT(int32): Return whether the value is EFAULT.
isEFBIG(int32): Return whether the value is EFBIG.
isEINTR(int32): Return whether the value is EINTR.
isEINVAL(int32): Return whether the value is EINVAL.
isEIO(int32): Return whether the value is EIO.
isEISDIR(int32): Return whether the value is EISDIR.
isELOOP(int32): Return whether the value is ELOOP.
isEMFILE(int32): Return whether the value is EMFILE.
isENAMETOOLONG(int32): Return whether the value is ENAMETOOLONG.
isENFILE(int32): Return whether the value is ENFILE.
isENODEV(int32): Return whether the value is ENODEV.
isENOENT(int32): Return whether the value is ENOENT.
isENOMEM(int32): Return whether the value is ENOMEM.
isENOSPC(int32): Return whether the value is ENOSPC.
isENOTDIR(int32): Return whether the value is ENOTDIR.
isENXIO(int32): Return whether the value is ENXIO.
isEOF(int32): Return whether the value is EOF.
isEOVERFLOW(int32): Return whether the value is EOVERFLOW.
isEPERM(int32): Return whether the value is EPERM.
isEPIPE(int32): Return whether the value is EPIPE.
isEROFS(int32): Return whether the value is EROFS.
isESPIPE(int32): Return whether the value is ESPIPE.
isETXTBSY(int32): Return whether the value is ETXTBSY.
isEWOULDBLOCK(int32): Return whether the value is EWOULDBLOCK.
isEndOfConsistentRegion(): Check if the operator is an end operator of a consistent region.
isEqualTo(rstring, rstring): Returns true if ip1 and ip2 are valid IPv4 addresses and ip1 address is equal to ip2 address.
isEqualTo(rstring, rstring): Returns true if ip1 and ip2 are valid IPv6 addresses and ip1 address is equal to ip2 address.
isGlobal(rstring): Returns true if a valid IPv4 address was provided and the IP address is not a reserved address.
isGreaterThan(rstring, rstring): Returns true if ip1 and ip2 are valid IPv4 addresses and ip1 address is greater than ip2 address.
isGreaterThan(rstring, rstring): Returns true if ip1 and ip2 are valid IPv6 addresses and ip1 address is greater than ip2 address.
isIPV4Address(rstring): Returns true if the value parameter contains a valid IPv4 address in dotted-decimal notation (i.e 0.0.0.0), otherwise returns false.
isIPV4CIDRNotation(rstring): Returns true if a the networkCIDR argument contains a valid network address in CIDR format (i.e. 0.0.0.0/24). Otherwise returns false.
isIPV6Address(rstring): Returns true if the value parameter contains a valid IPv6 address.
isIPV6CIDRNotation(rstring): Returns true if the networkCIDR argument contains a valid IPv6 network address in CIDR format (i.e. 2001:db8::/32). Otherwise returns false.
isInConsistentRegion(): Check if the operator is in a consistent region.
isInIPRange(rstring, rstring, rstring): Returns true if startIP, endIP and ip are valid IPv4 addresses and ip falls within the range from startIP (inclusive) to endIP (exclusive).
isInIPRange(rstring, rstring, rstring): Returns true if startIP, endIP and ip are valid IPv6 addresses and ip falls within the range from startIP (inclusive) to endIP (exclusive).
isInNetwork(rstring, rstring): Return true if ip address is in the network provided by the networkCIDR argument.
isInNetwork(rstring, rstring): Return true if ip address is in the network provided by the networkCIDR argument.
isInNetwork(rstring, uint32): Return true if ip address is in the network provided by the networkCIDR argument.
isInNetworkList(list<rstring>, rstring): Return true if ip address is in at least one of the networks provided by the networkList argument.
isInNetworkList(list<rstring>, rstring): Return true if ip address is in at least one of the networks provided by the networkList argument.
isInf(T): Return whether the floating point value is an infinity.
isInf(T): Return whether the complex value is an infinity.
isLessThan(rstring, rstring): Returns true if ip1 and ip2 are valid IPv4 addresses and ip1 address is less than ip2 address.
isLessThan(rstring, rstring): Returns true if ip1 and ip2 are valid IPv6 addresses and ip1 address is less than ip2 address.
isLinkLocal(rstring): Returns true if a valid IPv4 address was provided and the IP address is a link local address (RFC3927).
isLinkLocal(rstring): Returns true if a valid IPv6 address was provided and the IP address is a link-local address (RFC3513).
isLoggable(enum{error, warn, info}): Determine whether a message at the given level would be logged.
isLoopback(rstring): Returns true if a valid IPv4 address was provided and the IP address is a loopback address (RFC6890).
isLoopback(rstring): Returns true if a valid IPv6 address was provided and the IP address is a loopback address (RFC3513).
isMulticast(rstring): Returns true if a valid IPv4 address was provided and the IP address is a multicast address (RFC5771).
isMulticast(rstring): Returns true if a valid IPv6 address was provided and the IP address is a multicast address (RFC3513).
isNaN(T): Return whether the floating point value is a NaN (Not A Number).
isNaN(T): Return whether the complex value is a NaN (Not A Number).
isNetworkOverlap(rstring, rstring): Returns true if networkCIDR1 and networkCIDR2 are valid networks in CIDR format and the networks overlap.
isPrivate(rstring): Returns true if a valid IPv4 address was provided and the IP address is a private address (RFC1918).
isReserved(rstring): Returns true if a valid IPv4 address was provided and the IP address is a reserved address (RFC1918).
isShutdown(): Check if shutdown is requested.
isSiteLocal(rstring): Returns true if a valid IPv6 address was provided and the IP address is a site-local address (RFC3513).
isStartOfConsistentRegion(): Check if the operator is a start operator of a consistent region.
isTraceable(enum{error, warn, info, debug, trace}): Determine whether a message at the given level would be traced.
isTriggerOfConsistentRegion(): Check if the operator is the trigger operator of an operator-driven consistent region.
isUnspecified(rstring): Returns true if a valid IPv6 address was provided and the IP address is a unspecified (RFC3513).
isV4Compatible(rstring): Returns true if a valid IPv6 address was provided and the IP address is an "IPv4-compatible IPv6 address" (RFC3513).
isV4Mapped(rstring): Returns true if a valid IPv6 address was provided and the IP address is an "IPv4-mapped IPv6 address" (RFC3513).
isValid(T): Validates the given input geometry, the input is in WKT format and the output is a true/false
jobID(): Return the Job ID for the current job that this operator is executing in.
keys(map<K, V>): Return a list of the keys in the given map.
keys(map<K, V>[N]): Return a list of the keys in the given map.
kilometersToMeters(float32): Deprecated since Streams version 4.0.
kilometersToMeters(float64): Deprecated since Streams version 4.0.
kilometersToMeters(int32): Deprecated since Streams version 4.0.
kilometersToMeters(int64): Deprecated since Streams version 4.0.
kthelem(list<T>, uint32): Compute the kth element in ascending order.
kthelem(list<T>[N], uint32): Compute the kth element in ascending order.
laggedConvolve(list<float64>, list<float64>, enum{STANDARD, FFT}): The laggedConvolve function generates the convolution of two time series input signals.
laggedCrosscorrelate(list<float64>, list<float64>, int32, enum{STANDARD, FFT}): The laggedCrosscorrelate function generates the lagged crosscorrelation of two time series input signals.
lcss(list<float64>, list<float64>, int32, float64): This function computer the longest common subsequence (LCSS) between two time series.
length(T): Get the length of a string (the number of raw bytes).
lexicographicalCompare(list<T>, list<T>): Compare two lists in lexicographical order.
lexicographicalCompare(list<T>[N], list<T>[M]): Compare two lists in lexicographical order.
lg(T): Compute log base 10.
lg(T): Compute log base 10.
lineSegment(float64, float64, float64, float64): Constructs a line segment from four doubles, the order is specified as 'startlongitude, startlatitude, endlongitude, endlatitude' and the output is a WKT formatted geometry
ln(T): Compute log base e.
ln(T): Compute log base e.
loadAndFormatResource(rstring, rstring, rstring): Loads a string from a toolkit resource using the execution locale.
loadAndFormatResource(rstring, rstring, rstring, T): Loads and formats a string from a toolkit resource using the execution locale.
loadAndFormatResource(rstring, rstring, rstring, T, rstring): Loads and formats a string from a toolkit resource using the specified locale.
loadAndFormatResource(rstring, rstring, rstring, rstring): Loads a string from a toolkit resource using the specified locale.
locationCityName(list<uint8>[16]): This result function returns the city name for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationCityName(uint32): This result function returns the city name for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationCityNames(list<uint32>): This result function returns a list of city names corresponding to the specified list of IP version 4 addresses.
locationContinentCode(list<uint8>[16]): This result function returns the continent code for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationContinentCode(uint32): This result function returns the continent code for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationContinentCodes(list<uint32>): This result function returns a list of continent codes corresponding to the specified list of IP version 4 addresses.
locationContinentName(list<uint8>[16]): This result function returns the continent name for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationContinentName(uint32): This result function returns the continent name for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationContinentNames(list<uint32>): This result function returns a list of continent names corresponding to the specified list of IP version 4 addresses.
locationCountryCode(list<uint8>[16]): This result function returns the country code for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationCountryCode(uint32): This result function returns the country code for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationCountryCodes(list<uint32>): This result function returns a list of country codes corresponding to the specified list of IP version 4 addresses.
locationCountryName(list<uint8>[16]): This result function returns the country name for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationCountryName(uint32): This result function returns the country name for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationCountryNames(list<uint32>): This result function returns a list of country names corresponding to the specified list of IP version 4 addresses.
locationFound(list<uint8>[16]): This parser result function returns true if the location of the specified IP version 6 address was found, or false if not.
locationFound(uint32): This parser result function returns true if the location of the specified IP version 4 address was found, or false if not.
locationID(list<uint8>[16]): This result function returns the location identifier for the specified IP version 6 address, if one was found, or an empty string if not.
locationID(uint32): This result function returns the location identifier for the specified IP version 4 address, if one was found, or an empty string if not.
locationIDs(list<uint32>): This result function returns a list of IDs corresponding to the specified list of IP version 4 addresses.
locationLatitude(list<uint8>[16]): This result function returns the latitude for the specified IP version 6 address, if its location was found, or zero if not.
locationLatitude(uint32): This result function returns the latitude for the specified IP version 4 address, if its location was found, or zero if not.
locationLatitudes(list<uint32>): This result function returns a list of latitudes corresponding to the specified list of IP version 4 addresses.
locationLongitude(list<uint8>[16]): This result function returns the longitude for the specified IP version 6 address, if its location was found, or zero if not.
locationLongitude(uint32): This result function returns the longitude for the specified IP version 4 address, if its location was found, or zero if not.
locationLongitudes(list<uint32>): This result function returns a list of longitudes corresponding to the specified list of IP version 4 addresses.
locationMetroCode(list<uint8>[16]): This result function returns the metro code for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationMetroCode(uint32): This result function returns the metro code for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationPostalCode(list<uint8>[16]): This result function returns the postal code for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationPostalCode(uint32): This result function returns the postal code for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationPostalCodes(list<uint32>): This result function returns a list of postal codes corresponding to the specified list of IP version 4 addresses.
locationRadii(list<uint32>): This result function returns a list of accuracy radii corresponding to the specified list of IP version 4 addresses.
locationRadius(list<uint8>[16]): This result function returns the accuracy of the latitude and longitude, expressed as a radius, for the specified IP version 6 address, if its location was found, or zero if not.
locationRadius(uint32): This result function returns the accuracy of the latitude and longitude for the specified IP version 4 address, expressed as a radius, if its location was found, or zero if not.
locationSubdivision1Code(list<uint8>[16]): This result function returns the first division code (typically a state or province) for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationSubdivision1Code(uint32): This result function returns the first division code (typically a state or province) for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationSubdivision1Codes(list<uint32>): This result function returns a list of first subdivision codes corresponding to the specified list of IP version 4 addresses.
locationSubdivision1Name(list<uint8>[16]): This result function returns the first division name (typically a state or province) for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationSubdivision1Name(uint32): This result function returns the first division name (typically a state or province) for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationSubdivision1Names(list<uint32>): This result function returns a list of the first subdivision names corresponding to the specified list of IP version 4 addresses.
locationSubdivision2Code(list<uint8>[16]): This result function returns the second division code for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationSubdivision2Code(uint32): This result function returns the second division code for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationSubdivision2Codes(list<uint32>): This result function returns a list of second subdivision codes corresponding to the specified list of IP version 4 addresses.
locationSubdivision2Name(list<uint8>[16]): This result function returns the second division name for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationSubdivision2Name(uint32): This result function returns the second division name for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationSubdivision2Names(list<uint32>): This result function returns a list of the second subdivision names corresponding to the specified list of IP version 4 addresses.
locationSubnet(list<uint8>[16]): This result function returns the IP subnet address and mask, in CIDR notation, for the specified IP version 6 address, if one was found, or an empty string if not.
locationSubnet(uint32): This result function returns the IP subnet address and mask, in CIDR notation, for the specified IP version 4 address, if one was found, or an empty string if not.
locationSubnetAddress(list<uint8>[16]): This result function returns the IP version 6 subnet address for the specified IP version 6 address, if one was found, or zero if not.
locationSubnetAddress(uint32): This result function returns the IP version 4 subnet address for the specified IP version 4 address, if one was found, or zero if not.
locationSubnetAddresses(list<uint32>): This result function returns a list of subnet addresses corresponding to the specified list of IP version 4 addresses.
locationSubnetMask(list<uint8>[16]): This result function returns the IP version 6 subnet mask for the specified IP version 6 address, if one was found, or zero if not.
locationSubnetMask(uint32): This result function returns the IP version 4 subnet mask for the specified IP version 4 address, if one was found, or zero if not.
locationSubnetMasks(list<uint32>): This result function returns a list of subnet masks corresponding to the specified list of IP version 4 addresses.
locationSubnets(list<uint32>): This result function returns a list of IP subnets and masks, in CIDR notation, corresponding to the specified list of IP version 4 addresses.
locationTimezone(list<uint8>[16]): This result function returns the continent time zone for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
locationTimezone(uint32): This result function returns the continent time zone for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
locationTimezones(list<uint32>): This result function returns a list of time zones corresponding to the specified list of IP version 4 addresses.
locationsFound(list<uint32>): This result function returns a list of booleans indicating whether or not the specified list of IP version 4 addresses were found.
log(T): Compute log base e.
log(T): Compute log base e.
log(enum{error, info, debug, trace}, T): Log a message in the tracing system.
log(enum{error, info, debug, trace}, T, T): Log a message in the tracing system.
log10(T): Compute log base 10.
log10(T): Compute log base 10.
lower(T): Convert a string to lowercase.
lpNorm(list<float64>, list<float64>, float64): This function computes the Lp distance between two time series.
ltrim(T, T): Remove the leading characters from a string.
makeRStringLiteral(rstring): Make a string literal from an rstring.
makeSequence(T, int32): Make a sequence.
makeSequence(T, int32): Make a sequence.
makeSequence(T, int32, T): Make a sequence.
makeUStringLiteral(ustring): Make a string literal from a ustring.
mapPointToLineString( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment128>, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point128, R): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::nearestPoint instead. This functions provides with the ability to (a) find coordinates of a point Q on a given line string route (e.g., route traveled by the bus) that is closest to a given point P (e.g., a position on the diverted route taken by the bus); (b) compute distance between point P and Q (e.g., to determine how far the bus has taken diversion from the original route) which is returned in variable crossTrackDistance, and (c) compute distance along the line string from start (first point) of line string (route) and point Q which is returned in the variable alongTrackDistance.
mapPointToLineString( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment32>, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point32, R): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::nearestPoint instead. This functions provides the ability to (a) find coordinates of a point Q on a given line string route (e.g., route traveled by the bus) that is closest to a given point P (e.g., a position on the diverted route taken by the bus); (b) compute distance between point P and Q (e.g., to determine how far the bus has taken diversion from the original route) which is returned in variable crossTrackDistance, and (c) compute distance along the line string from start (first point) of line string (route) and point Q which is returned in the variable alongTrackDistance.
mapPointToLineString( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment64>, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point64, R): Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::nearestPoint instead. This functions provides the ability to (a) find coordinates of a point Q on a given line string route (e.g., route traveled by the bus) that is closest to a given point P (e.g., a position on the diverted route taken by the bus); (b) compute distance between point P and Q (e.g., to determine how far the bus has taken diversion from the original route) which is returned in variable crossTrackDistance, and (c) compute distance along the line string from start (first point) of line string (route) and point Q which is returned in the variable alongTrackDistance.
mapToJSON(map<S, T>): Convert a map to JSON object encoded as a serialized JSON string.
max(T, T): Compute the maximimum of two values.
max(list<T>): Find the maximum value in a list.
max(list<T>[N]): Find the maximum value in a list.
median(list<T>): Compute the median of a list for numeric types that have overloaded the arithmetic operators.
median(list<T>[N]): Compute the median of a list for numeric types that have overloaded the arithmetic operators.
messagesProcessed(): This parser result function returns the number of messages processed by the operator since it started, including the current message.
metricsIntervalBytesProcessed(): This function returns the number of bytes of network data processed by the operator during the most recent metrics interval, excluding any packets that were ignored by the input filter, if the inputFilter parameter was specified.
metricsIntervalElapsed(): This function returns the duration of the most recent metrics interval, in seconds with a resolution of at least microseconds, if there is one, or zero if not.
metricsIntervalPacketsDropped(): This function returns the number of packets dropped by the network interface during the most recent metrics interval, if there is one, or zero if not.
metricsIntervalPacketsProcessed(): This function returns the number of network packets processed by the operator during the most recent metrics interval, excluding any packets that were ignored by the input filter, if the inputFilter parameter was specified.
metricsIntervalPacketsReceived(): This function returns the number of packets received from the network interface during the most recent metrics interval, if there is one, or zero if not.
metricsUpdated(): This function returns true for the first tuple produced after a new metrics interval begins, and returns false for all subsequent tuples produced in the same metrics interval.
milesToMeters(float32): Deprecated since Streams version 4.0.
milesToMeters(float64): Deprecated since Streams version 4.0.
milesToMeters(int32): Deprecated since Streams version 4.0.
milesToMeters(int64): Deprecated since Streams version 4.0.
min(T, T): Compute the minimum of two values.
min(list<T>): Find the minimum value in a list.
min(list<T>[N]): Find the minimum value in a list.
minute(timestamp): Extract the minute from a timestamp, using the current timezone.
minutes(float64): Convert minutes to seconds as a float64.
minutes(int32): Convert whole minutes to seconds as a float64.
mkdir(rstring, uint32, int32): Create a directory
mktemp(rstring): Return the name of a temporary file created using a template.
month(timestamp): Extract the month from a timestamp, using the current timezone.
nanl(): Return a float64 NaN (Not A Number).
nanw(): Return a float32 NaN (Not A Number).
nearestPoint(T, T): Finds the nearest point on a linestring from a given point, where both geometries are specified in WKT format and WGS84 coordinates.
newControlSignal(MQTTSourceUpdate.TopicsUpdateAction, list<rstring>, uint32): Convenience method for creating a control signal that modifies subscription setting for MQTTSource operator
now(): Get the current time using getTimestamp().
numAddressesInIPRange(rstring, rstring): Returns the number of IP addresses between ipStart (inclusive) and ipEnd (exclusive).
numAddressesInNetwork(rstring): Returns the number of IP addresses contained within the network range.
optSEEK_CUR(): Return the indicator for specifying to seek relative to the current file position.
optSEEK_END(): Return the indicator for specifying to seek relative to the end of the file.
optSEEK_SET(): Return the indicator for specifying to seek relative to the start of the file.
orFilter(rstring, rstring): Return a string representation of cond1 || cond2.
orientedPolygon(T): Constructs a polygon that has its orientation specified, the polygon is a simple polygon and specified as a string with comma separated longitude, latitude values (in WGS84 decimal degrees).
outputPort(T): Return the index corresponding to an output port.
packetsDropped(): This function returns the number of packets dropped by the network interface since the operator started, as of the most recent metrics interval, if there is one, or zero if not.
packetsProcessed(): This function returns the number of network packets processed by the operator since it started, including the current packet, but excluding any packets that were ignored by the input filter, if the inputFilter parameter was specified.
packetsReceived(): This function returns the number of packets received from the network interface since the operator started, as of the most recent metrics interval, if there is one, or zero if not.
pairwiseCompare(T, list<T>): Compare a list, element-wise, with a scalar value.
pairwiseCompare(T, list<T>[N]): Compare a list, element-wise, with a scalar value.
pairwiseCompare(list<T>, T): Compare a list, element-wise, with a scalar value.
pairwiseCompare(list<T>, list<T>): Compare two lists, element-wise, up to the end of the shorter list, or of both lists if they are of equal length.
pairwiseCompare(list<T>[N], T): Compare a list, element-wise, with a scalar value.
pairwiseCompare(list<T>[N], list<T>[N]): Compare two lists, element-wise, up to the end of the shorter list, or of both lists if they are of equal length.
pairwiseMax(list<T>, list<T>): Compare two lists, element-wise, and fetch the larger or equal value, up to the end of the shorter list, or of both lists if they are of equal length.
pairwiseMax(list<T>[N], list<T>[N]): Compare two lists, element-wise, and fetch the larger or equal value, up to the end of the shorter list, or of both lists if they are of equal length.
pairwiseMin(list<T>, list<T>): Compare two lists, element-wise, and fetch the smaller or equal value, up to the end of the shorter list, or of both lists if they are of equal length.
pairwiseMin(list<T>[N], list<T>[N]): Compare two lists, element-wise, and fetch the smaller or equal value, up to the end of the shorter list, or of both lists if they are of equal length.
parseError(): This parser result function returns true if an encoding error was detected while decoding the current packet, or false otherwise.
parseErrorDescription(): This parser result function returns a description of an encoding error found while decoding the current packet, or an empty string if no enoding errors were found.
parseErrorOffset(): This parser result function returns the offset from the beginning of the message to the encoding error found, or zero if no encoding errors were found.
parseNumber(float64, rstring): Parse a string that represents a number, using the current locale.
parseNumber(float64, ustring): Parse a string that represents a number, using the current locale.
parseNumber(int64, rstring): Parse a string that represents a base 10 number, using the current locale.
parseNumber(int64, rstring, int32): Parse a string that represents a number of the specified base, using the current locale.
parseNumber(int64, ustring): Parse a string that represents a number, using the current locale.
pathToSentimentDictionaries(): This function returns a value that can be passed to the modulePath parameter of the TextExtract operator, or the dictionaryPath parameter of the SentimentExtractor operator.
point(float64, float64): Constructs a point geometry from a longitude and a latitude, both specified in decimal degrees in WGS84 Datum.
polygon(T): Constructs a polygon from a String representation, where the polygon is a simple polygon (without any holes) and is specified as follows: 'longitude_1, latitude_1, longitude_2, latitude_2, ... , longitude_n, latitude_n', where n is the number of points. This constructor will re-orient the polygon so that it always constructs the 'smaller' polygon. The output format is a WKT geometry
pow(T, T): Perform exponentiation.
pow(T, T): Perform exponentiation.
pow(T, T): Perform exponentiation.
print(T): Write any SPL type to the standard output stdout as an SPL literal.
printString(T): Write a string to the standard output, stdout.
printStringLn(T): Write a string to the standard output, stdout, followed by a newline, then flush the output.
println(T): Write any SPL type to the standard output, stdout, in serialized form, followed by a newline.
random(): Return a random number.
random(int32): Return a list of random numbers.
range(T): Return a list of values in the range from 0 to size(l)-1
range(int32): Return a list of values in the range from 0 to limit-1
range(int32, int32): Return a list of values in the range from start to limit-1
range(int32, int32, int32): Return a list of values in the range from start to limit-1, with an increment of step
real(complex32): Return the 'real' part of a complex number.
real(complex64): Return the 'real' part of a complex number.
regexMatch(rstring, rstring): Match a string with a regular expression, using POSIX Extended Regular Expressions (ERE), including sub-expression (capture group) matching using parentheses "()".
regexMatch(ustring, ustring): Match a string with a regular expression, using POSIX Extended Regular Expressions (ERE), including sub-expression (capture group) matching using parentheses "()".
regexMatchPerl(rstring, rstring): Match a string with a regular expression, using a Perl regular expression, including sub-expression (capture group) matching using parentheses "()".
regexMatchPerl(ustring, ustring): Match a string with a regular expression, using a Perl regular expression, including sub-expression (capture group) matching using parentheses "()".
regexReplace(rstring, rstring, rstring, boolean): Match and replace a string with a regular expression, using POSIX Extended Regular Expressions (ERE), including sub-expression (capture group) matching using parentheses "()".
regexReplace(ustring, ustring, ustring, boolean): Match and replace a string with a regular expression, using POSIX Extended Regular Expressions (ERE), including sub-expression (capture group) matching using parentheses "()".
regexReplacePerl(rstring, rstring, rstring, boolean): Match and replace a string with a regular expression, using a Perl regular expression, including sub-expression (capture group) matching using parentheses "()".
regexReplacePerl(ustring, ustring, ustring, boolean): Match and replace a string with a regular expression, using a Perl regular expression, including sub-expression (capture group) matching using parentheses "()".
remove(T, int32): Remove a value from a list.
remove(T, int32, int32): Remove values from a list using a range.
remove(T, list<int32>): Remove values from a list using an index list.
remove(map<K, V>, K): Remove an element from a map.
remove(map<K, V>[N], K): Remove an element from a map.
remove(rstring, int32): Remove a file or directory.
remove(set<K>, K): Return a set with a value removed.
remove(set<K>[N], K): Return a set with a value removed.
remove(ustring, int32): Remove a file or directory.
removeM(T, int32): Remove a value from a list (mutating version).
removeM(T, int32, int32): Remove values from a list using a range (mutating version).
removeM(map<K, V>, K): Remove an element from a map (mutating version).
removeM(map<K, V>[N], K): Remove an element from a map (mutating version).
removeM(set<K>, K): Remove a value from a set (mutating version).
removeM(set<K>[N], K): Remove a value from a set (mutating version).
rename(rstring, rstring, int32): Renames a file or directory, as if by ISO/IEC 9945 rename().
resetConsistentRegion(): This function requests the ConsistentRegionControllerMXBean to restore the consistent region to the last established consistent state.
reverse(T): Reverse a list of values.
reverseM(T): Reverse a list of values (mutating version).
rewind(uint64): Set the current file position to the start of the file.
rms(list<T>): The rms function generates the root mean square value from a list of numerical values.
round(T): Round a floating point value to the nearest integer.
rtrim(T, T): Remove the trailing characters from a string.
second(timestamp): Extract the second from a timestamp, using the current timezone.
seconds(float64): Returns the same value.
seconds(int32): Convert whole seconds to seconds as a float64.
selectFromList(list<boolean>, T, T): Select element-wise from two lists.
setCustomMetricValue(rstring, int64): Set the specified custom metric value for the current operator.
setCustomMetricValue(ustring, int64): Set the specified custom metric value for the current operator.
setDifference(T, T): Compute the difference of two sets.
setInputPortImportFilterExpression(rstring, uint32): Set the filter expression for an input port that receives a stream that is imported.
setInputPortImportSubscription(rstring, uint32): Set the import subscription for an input port that receives a stream that is imported by subscription.
setIntersection(T, T): Compute the intersection of two sets.
setOutputPortExportProperties(T, uint32): Set the export properties for an output port that produces a stream that is exported with properties.
setOutputPortExportProperties(list<tuple<rstring name, rstring value, rstring typ>>, uint32): Set the export properties for an output port that produces a stream that is exported with properties.
setSubscribeFilter(rstring): Set filter for input port zero.
setSubscribeSubscription(rstring): Set a subscription expression adding in UDP channel based matching if the subscriber is in a parallel region.
setUnion(T, T): Compute the union of two sets.
sha2hash160(blob): Computes a 160-bit SHA-2 hash value from a given input value.
sha2hash160(rstring): Computes a 160-bit SHA-2 hash value from a given input value.
sha2hash160raw(blob): Computes a 160-bit SHA-2 hash value from a given input value.
sha2hash160raw(rstring): Computes a 160-bit SHA-2 hash value from a given input value.
sha2hash224(blob): Computes a 224-bit SHA-2 hash value from a given input value.
sha2hash224(rstring): Computes a 224-bit SHA-2 hash value from a given input value.
sha2hash224raw(blob): Computes a 224-bit SHA-2 hash value from a given input value.
sha2hash224raw(rstring): Computes a 224-bit SHA-2 hash value from a given input value.
sha2hash256(blob): Computes a 256-bit SHA-2 hash value from a given input value.
sha2hash256(rstring): Computes a 256-bit SHA-2 hash value from a given input value.
sha2hash256raw(blob): Computes a 256-bit SHA-2 hash value from a given input value.
sha2hash256raw(rstring): Computes a 256-bit SHA-2 hash value from a given input value.
sha2hash384(blob): Computes a 384-bit SHA-2 hash value from a given input value.
sha2hash384(rstring): Computes a 384-bit SHA-2 hash value from a given input value.
sha2hash384raw(blob): Computes a 384-bit SHA-2 hash value from a given input value.
sha2hash384raw(rstring): Computes a 384-bit SHA-2 hash value from a given input value.
sha2hash512(blob): Computes a 512-bit SHA-2 hash value from a given input value.
sha2hash512(rstring): Computes a 512-bit SHA-2 hash value from a given input value.
sha2hash512raw(blob): Computes a 512-bit SHA-2 hash value from a given input value.
sha2hash512raw(rstring): Computes a 512-bit SHA-2 hash value from a given input value.
shutdownPE(): Shutdown the current processing element (PE).
sin(T): Compute the sine.
size(T): Get the size of a list.
size(blob): Get the size of a list.
slice(T, int32, int32): Slice a list: extract items from a list.
slice(T, int32, int32, int32): Slice a list: extract items from a list.
slice(T, int32, int32, int32, int32): Slice a list: extract items from a list.
sort(list<T>): Sort a list of values.
sort(list<T>[N]): Sort a list of values.
sortIndices(list<T>): Sort a list of values and return a list of indexes that specify the values in sorted order.
sortIndices(list<T>[N]): Sort a list of values and return a list of indexes that specify the values in sorted order.
sortM(list<T>): Sort a list of values (mutating version).
sortM(list<T>[N]): Sort a list of values (mutating version).
space(rstring, Types.SpaceInfo, int32): Returns space information about a mounted file system.
space(rstring, uint64, uint64, uint64, int32): Returns space information about a mounted file system.
sqrt(T): Compute the square root.
srand(int32): Seed the random number generator.
stddev(list<T>): Compute the standard deviation of a list.
stddev(list<T>, boolean): Compute the standard deviation of a list.
stddev(list<T>[N]): Compute the standard deviation of a list.
stddev(list<T>[N], boolean): Compute the standard deviation of a list.
stem(rstring): Returns the string before the period (.) in the file name.
strerror(int32): Convert an errno value to a string for intelligent printing.
strftime(tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>, rstring): Convert a broken-down time (using the Sys.tm type) to a date and time string, using strftime.
strptime(rstring, rstring, tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>, uint32): Convert a date and time string to a broken-down time (using the Sys.tm type), using strptime.
strtod(rstring): Convert a string to a floating point number.
strtod(rstring, int32): Convert a string to a floating point number.
strtoll(rstring, int32): Convert a string in base 2 to 36 to an signed number.
strtoll(rstring, int32, int32): Convert a string in base 2 to 36 to an signed number.
strtoull(rstring, int32): Convert a string in base 2 to 36 to an unsigned number.
strtoull(rstring, int32, int32): Convert a string in base 2 to 36 to an unsigned number.
substring(T, int32, int32): Get a substring from a string.
sum(list<T>): Compute the sum of a list.
sum(list<T>[N]): Compute the sum of a list.
swap(T, T): Swap any two SPL values
symlink(rstring, rstring, int32): Creates a symbolic link in the file system.
tan(T): Compute the tangent.
time(timestamp, rstring, tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>): Convert a timestamp to a broken-down time (using the Sys.tm type), using a specified timezone.
time(timestamp, tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>): Convert a timestamp to a broken-down time (using the Sys.tm type), using the current timezone.
timeBoxesForPeriod(int64, int64, int32): Computes the discrete time period covered by the start and end.
timeBoxesForPeriod(uint64, uint64, uint32): Computes the discrete time period covered by the start and end.
timeStringToTimestamp(rstring, rstring, boolean): Convert date and time strings into a timestamp, using the current timezone.
timeStringToTimestamp(rstring, rstring, rstring, boolean): Convert date and time strings into a timestamp, using the specified timezone.
timeStringToTimestamp(ustring, ustring, boolean): Convert date and time strings into a timestamp, using the current timezone.
timeStringToTimestamp(ustring, ustring, ustring, boolean): Convert date and time strings into a timestamp, using the specified timezone.
timeStringtoTimestamp(rstring, rstring, boolean): DEPRECATED.
timeStringtoTimestamp(rstring, rstring, rstring, boolean): DEPRECATED.
timeStringtoTimestamp(ustring, ustring, boolean): DEPRECATED.
timeStringtoTimestamp(ustring, ustring, ustring, boolean): DEPRECATED.
toCharacterCode(T): Convert the first character of a string to its corresponding ASCII code.
toDecimal128(timestamp): Convert a timestamp to a decimal128 value that preserves the precision of the timestamp, and represents the time as the number of seconds (including fractions) elapsed since the Epoch (00:00:00 UTC, January 1, 1970).
toGeoJSON(T): Convert the given WKT formatted geometry to a GeoJSON format.
toIso8601(int64): Convert a TimeMillis value to an full ISO 8061 date using UTC as the time zone.
toIso8601(uint64): Convert a TimeMillis value to an full ISO 8061 date using UTC as the time zone.
toJSON(S, T): Convert a value to JSON object with a single key encoded as a serialized JSON string.
toSet(list<T>): Convert a list to a set.
toSet(list<T>[N]): Convert a list to a set.
toTimeMillis(timestamp): Get a TimeMillis value from a SPL timestamp value.
toTimestamp(TimeMillis): Get a SPL timestamp from a TimeMillis.
toTimestamp(TimeMillis, int32): Get a SPL timestamp from a TimeMillis and a machine identifier.
toTimestamp(enum{YYYYMMDDhhmmss, YYYY_MM_DD_hh_mm_ss, MM_DD_YYYY_hh_mm_ss, DD_MM_YYYY_hh_mm_ss, YYYY_MM_DD_hh_mm_ss_mmm, MM_DD_YYYY_hh_mm_ss_mmm, DD_MM_YYYY_hh_mm_ss_mmm}, T): Converts a date and time string into a timestamp, using the current timezone.
toTimestamp(enum{YYYYMMDDhhmmss, YYYY_MM_DD_hh_mm_ss, MM_DD_YYYY_hh_mm_ss, DD_MM_YYYY_hh_mm_ss, YYYY_MM_DD_hh_mm_ss_mmm, MM_DD_YYYY_hh_mm_ss_mmm, DD_MM_YYYY_hh_mm_ss_mmm}, T, T): Converts a date and time string into a timestamp, using the specified timezone.
toTimestamp(tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>): Convert a broken-down time (using the Sys.tm type) into a timestamp.
toTimestamp(tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>, boolean): Convert a broken-down time (using the Sys.tm type) into a timestamp, using a parameter to specify whether to use the default timezone.
tokenize(rstring, rstring, boolean): Tokenize a string.
tokenize(rstring, rstring, boolean, boolean, list<rstring>): Tokenize a string.
tokenize(ustring, ustring, boolean): Tokenize a string.
tokenize(ustring, ustring, boolean, boolean, list<ustring>): Tokenize a string.
trim(T, T): Remove the leading and trailing characters from a string.
tupleToJSON(T): Convert a tuple to JSON object encoded as a serialized JSON String.
upper(T): Convert a string to uppercase.
within(T, T): Returns true if the first geometry is within the second.
withinDistance(T, T, float64): Returns true if the first geometry and the second geometry are within the specified distance in meters.
xquery(X, rstring): Execute an XQuery program against an XML value and return a list of results.
xquery(X, rstring, int32): Execute an XQuery program against an XML value and return a list of results.
xquery(X, rstring, map<rstring, rstring>): Execute an XQuery program against an XML value and return a list of results.
xquery(X, rstring, map<rstring, rstring>, int32): Execute an XQuery program against an XML value and return a list of results.
xquery(X, ustring): Execute an XQuery program against an XML value and return a list of results.
xquery(X, ustring, int32): Execute an XQuery program against an XML value and return a list of results.
xquery(X, ustring, map<ustring, ustring>): Execute an XQuery program against an XML value and return a list of results.
xquery(X, ustring, map<ustring, ustring>, int32): Execute an XQuery program against an XML value and return a list of results.
yardsToMeters(float32): Deprecated since Streams version 4.0.
yardsToMeters(float64): Deprecated since Streams version 4.0.
yardsToMeters(int32): Deprecated since Streams version 4.0.
yardsToMeters(int64): Deprecated since Streams version 4.0.
year(timestamp): Extract the year from a timestamp, using the current timezone.