Package org.apache.pinot.spi.config.instance

Class Instance

java.lang.Object

org.apache.pinot.spi.config.BaseJsonConfig

org.apache.pinot.spi.config.instance.Instance

All Implemented Interfaces:

Serializable

public class Instance
extends BaseJsonConfig

Instance configuration.

 Example:
 {
   "host": "hostname.example.com",
   "port": 1234,
   "type": "SERVER",
   "tags": ["example_OFFLINE"],
   "pools": {
     "example_OFFLINE": 0
   },
   "grpcPort": 8090
 }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	NOT_SET_ADMIN_PORT_VALUE
static int	NOT_SET_GRPC_PORT_VALUE
static int	NOT_SET_QUERY_MAILBOX_PORT_VALUE
static int	NOT_SET_QUERY_SERVER_PORT_VALUE

Constructor Summary

Constructors

Constructor	Description
Instance(String host, int port, InstanceType type, List<String> tags, Map<String,Integer> pools, int grpcPort, int adminPort, int queryServicePort, int queryMailboxPort, boolean queriesDisabled)

Method Summary

Modifier and Type	Method	Description
int	getAdminPort()
int	getGrpcPort()
String	getHost()
Map<String,Integer>	getPools()
int	getPort()
int	getQueryMailboxPort()
int	getQueryServicePort()
List<String>	getTags()
InstanceType	getType()
boolean	isQueriesDisabled()

Methods inherited from class org.apache.pinot.spi.config.BaseJsonConfig

equals, hashCode, toJsonNode, toJsonString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NOT_SET_GRPC_PORT_VALUE

public static final int NOT_SET_GRPC_PORT_VALUE

See Also:

Constant Field Values

NOT_SET_ADMIN_PORT_VALUE

public static final int NOT_SET_ADMIN_PORT_VALUE

See Also:

Constant Field Values

NOT_SET_QUERY_SERVER_PORT_VALUE

public static final int NOT_SET_QUERY_SERVER_PORT_VALUE

See Also:

Constant Field Values

NOT_SET_QUERY_MAILBOX_PORT_VALUE

public static final int NOT_SET_QUERY_MAILBOX_PORT_VALUE

See Also:

Constant Field Values

Constructor Detail

Instance

public Instance(String host,
                int port,
                InstanceType type,
                @Nullable
                List<String> tags,
                @Nullable
                Map<String,Integer> pools,
                int grpcPort,
                int adminPort,
                int queryServicePort,
                int queryMailboxPort,
                boolean queriesDisabled)

Method Detail

getHost

public String getHost()

getPort

public int getPort()

getType

public InstanceType getType()

getTags

@Nullable
public List<String> getTags()

getPools

@Nullable
public Map<String,Integer> getPools()

getGrpcPort

public int getGrpcPort()

getAdminPort

public int getAdminPort()

getQueryServicePort

public int getQueryServicePort()

getQueryMailboxPort

public int getQueryMailboxPort()

isQueriesDisabled

public boolean isQueriesDisabled()