org.apache.nifi.remote.protocol

Enum HandshakeProperty

java.lang.Object

java.lang.Enum<HandshakeProperty>

org.apache.nifi.remote.protocol.HandshakeProperty

All Implemented Interfaces:

Serializable, Comparable<HandshakeProperty>

public enum HandshakeProperty
extends Enum<HandshakeProperty>

Enumeration of Properties that can be used for the Site-to-Site Socket Protocol.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BATCH_COUNT The preferred number of FlowFiles that the server should send to the client when pulling data.
BATCH_DURATION The preferred amount of time that the server should send data to the client when pulling data.
BATCH_SIZE The preferred number of bytes that the server should send to the client when pulling data.
GZIP Boolean value indicating whether or not the contents of a FlowFile should be GZipped when transferred.
PORT_IDENTIFIER The unique identifier of the port to communicate with
REQUEST_EXPIRATION_MILLIS Indicates the number of milliseconds after the request was made that the client will wait for a response.

Method Summary

Modifier and Type	Method and Description
static HandshakeProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static HandshakeProperty[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GZIP

public static final HandshakeProperty GZIP

Boolean value indicating whether or not the contents of a FlowFile should be GZipped when transferred.

PORT_IDENTIFIER

public static final HandshakeProperty PORT_IDENTIFIER

The unique identifier of the port to communicate with

REQUEST_EXPIRATION_MILLIS

public static final HandshakeProperty REQUEST_EXPIRATION_MILLIS

Indicates the number of milliseconds after the request was made that the client will wait for a response. If no response has been received by the time this value expires, the server can move on without attempting to service the request because the client will have already disconnected.

BATCH_COUNT

public static final HandshakeProperty BATCH_COUNT

The preferred number of FlowFiles that the server should send to the client when pulling data. This property was introduced in version 5 of the protocol.

BATCH_SIZE

public static final HandshakeProperty BATCH_SIZE

The preferred number of bytes that the server should send to the client when pulling data. This property was introduced in version 5 of the protocol.

BATCH_DURATION

public static final HandshakeProperty BATCH_DURATION

The preferred amount of time that the server should send data to the client when pulling data. This property was introduced in version 5 of the protocol. Value is in milliseconds.

Method Detail

values

public static HandshakeProperty[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HandshakeProperty c : HandshakeProperty.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HandshakeProperty valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null