com.opendxl.databus.cli

Enum Options

java.lang.Object

java.lang.Enum<Options>

com.opendxl.databus.cli.Options

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Options>

public enum Options
extends java.lang.Enum<Options>

Each enumerated represents a command line option. Each option is made up by --optionName value

Enum Constant Summary

Enum Constants

Enum Constant and Description
BROKER_LIST The option name for the broker list
CG The option name indicating the name of the consumer group
CONFIG The option name for extra producer configurations
CONSUME_RECORDS The option name indicating the number of records to consume
CONSUME_TIMEOUT The option name indicating the timeout value for the consumer
FROM_TOPIC The option name indicating the name of the topic where the message will be consumed
HEADERS The option name used to add Headers
MESSAGE The option name for the message payload
OPERATION The option name indicating the name of the operation to execute
PARTITION The option name indicating the number of the topic partition
SHARDING_KEY The option name used to add a sharding ket
TENANT_GROUP The option name used to add a tenant group name
TO_TOPIC The option name indicating the name of the topic

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TO_TOPIC

public static final Options TO_TOPIC

The option name indicating the name of the topic

OPERATION

public static final Options OPERATION

The option name indicating the name of the operation to execute

BROKER_LIST

public static final Options BROKER_LIST

The option name for the broker list

MESSAGE

public static final Options MESSAGE

The option name for the message payload

CONFIG

public static final Options CONFIG

The option name for extra producer configurations

TENANT_GROUP

public static final Options TENANT_GROUP

The option name used to add a tenant group name

SHARDING_KEY

public static final Options SHARDING_KEY

The option name used to add a sharding ket

HEADERS

public static final Options HEADERS

The option name used to add Headers

FROM_TOPIC

public static final Options FROM_TOPIC

The option name indicating the name of the topic where the message will be consumed

CONSUME_TIMEOUT

public static final Options CONSUME_TIMEOUT

The option name indicating the timeout value for the consumer

CG

public static final Options CG

The option name indicating the name of the consumer group

CONSUME_RECORDS

public static final Options CONSUME_RECORDS

The option name indicating the number of records to consume

PARTITION

public static final Options PARTITION

The option name indicating the number of the topic partition

Method Detail

values

public static Options[] 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 (Options c : Options.values())
    System.out.println(c);

Returns:

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

valueOf

public static Options valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getOptionName

public java.lang.String getOptionName()

Gets and specific option name

Returns:

The option name as string