org.elasticsearch.hadoop.cfg

Class Settings

java.lang.Object

org.elasticsearch.hadoop.cfg.Settings

Direct Known Subclasses:

CompositeSettings, FilteredSettings, HadoopSettings, PropertiesSettings, SparkSettings

public abstract class Settings
extends java.lang.Object

Holder class containing the various configuration bits used by ElasticSearch Hadoop. Handles internally the fall back to defaults when looking for undefined, optional settings.

Constructor Summary

Constructors

Constructor and Description
Settings()

Method Summary

Modifier and Type	Method and Description
abstract java.util.Properties	asProperties()
abstract Settings	copy()
Settings	excludeFilter(java.lang.String prefix)
boolean	getBatchFlushManual()
boolean	getBatchRefreshAfterWrite()
int	getBatchSizeInBytes()
int	getBatchSizeInEntries()
int	getBatchWriteRetryCount()
int	getBatchWriteRetryLimit()
java.lang.String	getBatchWriteRetryPolicy()
long	getBatchWriteRetryWait()
org.elasticsearch.hadoop.util.ClusterInfo	getClusterInfoOrNull() Get the internal cluster name and version or null if not present in the settings
org.elasticsearch.hadoop.util.ClusterInfo	getClusterInfoOrThrow() Get the internal cluster name and version or throw an IllegalArgumentException if not present
org.elasticsearch.hadoop.util.ClusterInfo	getClusterInfoOrUnnamedLatest() Deprecated. This is a dangerous method to use, because it assumes that you care about which cluster you are working with, but the info you receive from this call may not be accurate, and thus, cannot be trusted to let you make accurate decisions about the ES cluster you are speaking with. Prefer to use the getClusterInfoOrThrow() instead.
boolean	getDataFrameWriteNullValues()
boolean	getExcludeSource()
org.elasticsearch.hadoop.util.unit.TimeValue	getHeartBeatLead()
int	getHttpRetries()
long	getHttpTimeout()
boolean	getIndexAutoCreate()
boolean	getIndexReadAllowRedStatus()
boolean	getIndexReadMissingAsEmpty()
java.lang.String	getIngestPipeline()
boolean	getInputAsJson()
org.elasticsearch.hadoop.util.EsMajorVersion	getInternalVersionOrLatest() Deprecated. This is kind of a dangerous method to use, because it assumes that you care about which version you are working with, but the version you receive from this call may not be accurate, and thus, cannot be trusted to let you make accurate decisions about the version of ES you are speaking with. Prefer to use the getInternalVersionOrThrow() instead.
org.elasticsearch.hadoop.util.EsMajorVersion	getInternalVersionOrThrow() Get the internal version or throw an IllegalArgumentException if not present
boolean	getMappingConstantAutoQuote()
boolean	getMappingDateRich()
java.lang.String	getMappingDefaultClassExtractor()
java.lang.String	getMappingExcludes()
java.lang.String	getMappingId()
java.lang.String	getMappingIdExtractorClassName()
java.lang.String	getMappingIncludes()
java.lang.String	getMappingIndexExtractorClassName()
java.lang.String	getMappingIndexFormatterClassName()
java.lang.String	getMappingJoin()
java.lang.String	getMappingJoinExtractorClassName()
java.lang.String	getMappingMetadataExtractorClassName()
java.lang.String	getMappingParamsExtractorClassName()
java.lang.String	getMappingParent()
java.lang.String	getMappingParentExtractorClassName()
java.lang.String	getMappingRouting()
java.lang.String	getMappingRoutingExtractorClassName()
java.lang.String	getMappingTimestamp()
java.lang.String	getMappingTimestampExtractorClassName()
java.lang.String	getMappingTtl()
java.lang.String	getMappingTtlExtractorClassName()
java.lang.String	getMappingVersion()
java.lang.String	getMappingVersionExtractorClassName()
java.lang.String	getMappingVersionType()
java.lang.Integer	getMaxDocsPerPartition()
java.lang.String	getNetworkHttpAuthPass() Deprecated.
java.lang.String	getNetworkHttpAuthUser()
boolean	getNetworkHttpsUseSystemProperties()
boolean	getNetworkHttpUseSystemProperties()
java.lang.String	getNetworkProxyHttpHost()
java.lang.String	getNetworkProxyHttpPass() Deprecated.
int	getNetworkProxyHttpPort()
java.lang.String	getNetworkProxyHttpsHost()
java.lang.String	getNetworkProxyHttpsPass() Deprecated.
int	getNetworkProxyHttpsPort()
java.lang.String	getNetworkProxyHttpsUser()
java.lang.String	getNetworkProxyHttpUser()
java.lang.String	getNetworkProxySocksHost()
java.lang.String	getNetworkProxySocksPass() Deprecated.
int	getNetworkProxySocksPort()
java.lang.String	getNetworkProxySocksUser()
boolean	getNetworkSocksUseSystemProperties()
java.lang.String	getNetworkSpnegoAuthElasticsearchPrincipal()
boolean	getNetworkSpnegoAuthMutual()
boolean	getNetworkSSLAcceptSelfSignedCert()
boolean	getNetworkSSLEnabled()
java.lang.String	getNetworkSSLKeyStoreLocation()
java.lang.String	getNetworkSSLKeyStorePass() Deprecated.
java.lang.String	getNetworkSSLKeyStoreType()
java.lang.String	getNetworkSSLProtocol()
java.lang.String	getNetworkSSLTrustStoreLocation()
java.lang.String	getNetworkSSLTrustStorePass() Deprecated.
java.lang.String	getNodes()
boolean	getNodesClientOnly()
boolean	getNodesDataOnly()
boolean	getNodesDiscovery()
boolean	getNodesIngestOnly()
java.lang.String	getNodesPathPrefix()
boolean	getNodesResolveHostnames()
boolean	getNodesWANOnly()
java.lang.String	getOpaqueId()
java.lang.String	getOperation()
boolean	getOutputAsJson()
int	getPort()
abstract java.lang.String	getProperty(java.lang.String name)
java.lang.String	getProperty(java.lang.String name, java.lang.String defaultValue)
java.lang.String	getQuery()
java.lang.String	getReadFieldAsArrayExclude()
java.lang.String	getReadFieldAsArrayInclude()
boolean	getReadFieldEmptyAsNull()
java.lang.String	getReadFieldExclude()
FieldPresenceValidation	getReadFieldExistanceValidation()
java.lang.String	getReadFieldInclude()
boolean	getReadMappingMissingFieldsIgnore()
boolean	getReadMetadata()
java.lang.String	getReadMetadataField()
boolean	getReadMetadataVersion()
java.lang.String	getReadSourceFilter()
protected java.lang.String	getResource()
java.lang.String	getResourceRead()
java.lang.String	getResourceWrite()
java.lang.String	getScrollFields()
long	getScrollKeepAlive()
long	getScrollLimit()
long	getScrollSize()
AuthenticationMethod	getSecurityAuthenticationMethod()
java.lang.String	getSecurityUserProviderClass()
java.lang.String	getSerializerBytesConverterClassName()
java.lang.String	getSerializerValueReaderClassName()
java.lang.String	getSerializerValueWriterClassName()
Settings	getSettingsView(java.lang.String name)
java.lang.String	getShardPreference()
org.elasticsearch.hadoop.util.unit.TimeValue	getTransportPoolingExpirationTimeout()
int	getUpdateRetryOnConflict()
java.lang.String	getUpdateScript()
java.lang.String	getUpdateScriptFile()
java.lang.String	getUpdateScriptInline()
java.lang.String	getUpdateScriptLang()
java.lang.String	getUpdateScriptParams()
java.lang.String	getUpdateScriptParamsJson()
java.lang.String	getUpdateScriptStored()
java.lang.Boolean	getUpdateScriptUpsert()
boolean	hasMappingVersionType()
boolean	hasScriptUpsert()
boolean	hasUpdateScript()
boolean	hasUpdateScriptParams()
boolean	hasUpdateScriptParamsJson()
Settings	load(java.lang.String source)
abstract java.io.InputStream	loadResource(java.lang.String location)
Settings	merge(java.util.Map<java.lang.String,java.lang.String> map)
Settings	merge(java.util.Properties properties)
java.lang.String	save()
Settings	setHosts(java.lang.String hosts) Deprecated.
Settings	setInternalClusterInfo(org.elasticsearch.hadoop.util.ClusterInfo clusterInfo)
Settings	setInternalVersion(org.elasticsearch.hadoop.util.EsMajorVersion version) Deprecated. prefer to use Settings#setInternalClusterInfo
Settings	setMaxDocsPerPartition(int size)
Settings	setNodes(java.lang.String hosts)
Settings	setOpaqueId(java.lang.String opaqueId)
Settings	setPort(int port)
abstract void	setProperty(java.lang.String name, java.lang.String value)
Settings	setQuery(java.lang.String query)
Settings	setResourceRead(java.lang.String index)
Settings	setResourceWrite(java.lang.String index)
Settings	setUserAgent(java.lang.String userAgent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Settings

public Settings()

Method Detail

getInternalVersionOrThrow

public org.elasticsearch.hadoop.util.EsMajorVersion getInternalVersionOrThrow()

Get the internal version or throw an IllegalArgumentException if not present

Returns:

The EsMajorVersion extracted from the properties

getInternalVersionOrLatest

@Deprecated
public org.elasticsearch.hadoop.util.EsMajorVersion getInternalVersionOrLatest()

Deprecated. This is kind of a dangerous method to use, because it assumes that you care about which version you are working with, but the version you receive from this call may not be accurate, and thus, cannot be trusted to let you make accurate decisions about the version of ES you are speaking with. Prefer to use the getInternalVersionOrThrow() instead.

Get the internal version or EsMajorVersion.LATEST if not present

Returns:

The EsMajorVersion extracted from the properties or EsMajorVersion.LATEST if not present

getClusterInfoOrThrow

public org.elasticsearch.hadoop.util.ClusterInfo getClusterInfoOrThrow()

Get the internal cluster name and version or throw an IllegalArgumentException if not present

Returns:

the ClusterInfo extracted from the properties

getClusterInfoOrNull

public org.elasticsearch.hadoop.util.ClusterInfo getClusterInfoOrNull()

Get the internal cluster name and version or null if not present in the settings

Returns:

the ClusterInfo extracted from the properties or null if not present

getClusterInfoOrUnnamedLatest

@Deprecated
public org.elasticsearch.hadoop.util.ClusterInfo getClusterInfoOrUnnamedLatest()

Deprecated. This is a dangerous method to use, because it assumes that you care about which cluster you are working with, but the info you receive from this call may not be accurate, and thus, cannot be trusted to let you make accurate decisions about the ES cluster you are speaking with. Prefer to use the getClusterInfoOrThrow() instead.

Get the internal cluster name and version or throw an IllegalArgumentException if not present

Returns:

the ClusterInfo extracted from the properties

getNodes

public java.lang.String getNodes()

getPort

public int getPort()

getNodesDiscovery

public boolean getNodesDiscovery()

getShardPreference

public java.lang.String getShardPreference()

getNodesPathPrefix

public java.lang.String getNodesPathPrefix()

getNodesDataOnly

public boolean getNodesDataOnly()

getNodesIngestOnly

public boolean getNodesIngestOnly()

getNodesClientOnly

public boolean getNodesClientOnly()

getNodesWANOnly

public boolean getNodesWANOnly()

getHttpTimeout

public long getHttpTimeout()

getHttpRetries

public int getHttpRetries()

getBatchSizeInBytes

public int getBatchSizeInBytes()

getBatchSizeInEntries

public int getBatchSizeInEntries()

getBatchWriteRetryCount

public int getBatchWriteRetryCount()

getBatchWriteRetryLimit

public int getBatchWriteRetryLimit()

getBatchWriteRetryWait

public long getBatchWriteRetryWait()

getBatchWriteRetryPolicy

public java.lang.String getBatchWriteRetryPolicy()

getBatchRefreshAfterWrite

public boolean getBatchRefreshAfterWrite()

getBatchFlushManual

public boolean getBatchFlushManual()

getScrollKeepAlive

public long getScrollKeepAlive()

getScrollSize

public long getScrollSize()

getScrollLimit

public long getScrollLimit()

getScrollFields

public java.lang.String getScrollFields()

getExcludeSource

public boolean getExcludeSource()

getSerializerValueWriterClassName

public java.lang.String getSerializerValueWriterClassName()

getSerializerBytesConverterClassName

public java.lang.String getSerializerBytesConverterClassName()

getSerializerValueReaderClassName

public java.lang.String getSerializerValueReaderClassName()

getIndexAutoCreate

public boolean getIndexAutoCreate()

getIndexReadMissingAsEmpty

public boolean getIndexReadMissingAsEmpty()

getIndexReadAllowRedStatus

public boolean getIndexReadAllowRedStatus()

getInputAsJson

public boolean getInputAsJson()

getOutputAsJson

public boolean getOutputAsJson()

getOperation

public java.lang.String getOperation()

getMappingId

public java.lang.String getMappingId()

getMappingParent

public java.lang.String getMappingParent()

getMappingJoin

public java.lang.String getMappingJoin()

getMappingVersion

public java.lang.String getMappingVersion()

hasMappingVersionType

public boolean hasMappingVersionType()

getMappingVersionType

public java.lang.String getMappingVersionType()

getMappingRouting

public java.lang.String getMappingRouting()

getMappingTtl

public java.lang.String getMappingTtl()

getMappingTimestamp

public java.lang.String getMappingTimestamp()

getMappingDefaultClassExtractor

public java.lang.String getMappingDefaultClassExtractor()

getMappingMetadataExtractorClassName

public java.lang.String getMappingMetadataExtractorClassName()

getMappingIdExtractorClassName

public java.lang.String getMappingIdExtractorClassName()

getMappingParentExtractorClassName

public java.lang.String getMappingParentExtractorClassName()

getMappingJoinExtractorClassName

public java.lang.String getMappingJoinExtractorClassName()

getMappingVersionExtractorClassName

public java.lang.String getMappingVersionExtractorClassName()

getMappingRoutingExtractorClassName

public java.lang.String getMappingRoutingExtractorClassName()

getMappingTtlExtractorClassName

public java.lang.String getMappingTtlExtractorClassName()

getMappingTimestampExtractorClassName

public java.lang.String getMappingTimestampExtractorClassName()

getMappingIndexExtractorClassName

public java.lang.String getMappingIndexExtractorClassName()

getMappingIndexFormatterClassName

public java.lang.String getMappingIndexFormatterClassName()

getMappingParamsExtractorClassName

public java.lang.String getMappingParamsExtractorClassName()

getMappingConstantAutoQuote

public boolean getMappingConstantAutoQuote()

getMappingDateRich

public boolean getMappingDateRich()

getMappingIncludes

public java.lang.String getMappingIncludes()

getMappingExcludes

public java.lang.String getMappingExcludes()

getIngestPipeline

public java.lang.String getIngestPipeline()

getUpdateRetryOnConflict

public int getUpdateRetryOnConflict()

getUpdateScript

public java.lang.String getUpdateScript()

getUpdateScriptInline

public java.lang.String getUpdateScriptInline()

getUpdateScriptUpsert

public java.lang.Boolean getUpdateScriptUpsert()

getUpdateScriptFile

public java.lang.String getUpdateScriptFile()

getUpdateScriptStored

public java.lang.String getUpdateScriptStored()

getUpdateScriptLang

public java.lang.String getUpdateScriptLang()

getUpdateScriptParams

public java.lang.String getUpdateScriptParams()

getUpdateScriptParamsJson

public java.lang.String getUpdateScriptParamsJson()

hasUpdateScript

public boolean hasUpdateScript()

hasUpdateScriptParams

public boolean hasUpdateScriptParams()

hasUpdateScriptParamsJson

public boolean hasUpdateScriptParamsJson()

hasScriptUpsert

public boolean hasScriptUpsert()

getReadFieldEmptyAsNull

public boolean getReadFieldEmptyAsNull()

getReadFieldExistanceValidation

public FieldPresenceValidation getReadFieldExistanceValidation()

getReadFieldInclude

public java.lang.String getReadFieldInclude()

getReadFieldExclude

public java.lang.String getReadFieldExclude()

getReadFieldAsArrayInclude

public java.lang.String getReadFieldAsArrayInclude()

getReadFieldAsArrayExclude

public java.lang.String getReadFieldAsArrayExclude()

getReadSourceFilter

public java.lang.String getReadSourceFilter()

getHeartBeatLead

public org.elasticsearch.hadoop.util.unit.TimeValue getHeartBeatLead()

getTransportPoolingExpirationTimeout

public org.elasticsearch.hadoop.util.unit.TimeValue getTransportPoolingExpirationTimeout()

getNetworkSSLEnabled

public boolean getNetworkSSLEnabled()

getNetworkSSLKeyStoreLocation

public java.lang.String getNetworkSSLKeyStoreLocation()

getNetworkSSLProtocol

public java.lang.String getNetworkSSLProtocol()

getNetworkSSLKeyStoreType

public java.lang.String getNetworkSSLKeyStoreType()

getNetworkSSLKeyStorePass

@Deprecated
public java.lang.String getNetworkSSLKeyStorePass()

Deprecated.

getNetworkSSLTrustStoreLocation

public java.lang.String getNetworkSSLTrustStoreLocation()

getNetworkSSLTrustStorePass

@Deprecated
public java.lang.String getNetworkSSLTrustStorePass()

Deprecated.

getNetworkSSLAcceptSelfSignedCert

public boolean getNetworkSSLAcceptSelfSignedCert()

getNetworkHttpAuthUser

public java.lang.String getNetworkHttpAuthUser()

getNetworkHttpAuthPass

@Deprecated
public java.lang.String getNetworkHttpAuthPass()

Deprecated.

getNetworkSpnegoAuthElasticsearchPrincipal

public java.lang.String getNetworkSpnegoAuthElasticsearchPrincipal()

getNetworkSpnegoAuthMutual

public boolean getNetworkSpnegoAuthMutual()

getNetworkProxyHttpHost

public java.lang.String getNetworkProxyHttpHost()

getNetworkProxyHttpPort

public int getNetworkProxyHttpPort()

getNetworkProxyHttpUser

public java.lang.String getNetworkProxyHttpUser()

getNetworkProxyHttpPass

@Deprecated
public java.lang.String getNetworkProxyHttpPass()

Deprecated.

getNetworkHttpUseSystemProperties

public boolean getNetworkHttpUseSystemProperties()

getNetworkProxyHttpsHost

public java.lang.String getNetworkProxyHttpsHost()

getNetworkProxyHttpsPort

public int getNetworkProxyHttpsPort()

getNetworkProxyHttpsUser

public java.lang.String getNetworkProxyHttpsUser()

getNetworkProxyHttpsPass

@Deprecated
public java.lang.String getNetworkProxyHttpsPass()

Deprecated.

getNetworkHttpsUseSystemProperties

public boolean getNetworkHttpsUseSystemProperties()

getNetworkProxySocksHost

public java.lang.String getNetworkProxySocksHost()

getNetworkProxySocksPort

public int getNetworkProxySocksPort()

getNetworkProxySocksUser

public java.lang.String getNetworkProxySocksUser()

getNetworkProxySocksPass

@Deprecated
public java.lang.String getNetworkProxySocksPass()

Deprecated.

getNetworkSocksUseSystemProperties

public boolean getNetworkSocksUseSystemProperties()

getNodesResolveHostnames

public boolean getNodesResolveHostnames()

setInternalClusterInfo

public Settings setInternalClusterInfo(org.elasticsearch.hadoop.util.ClusterInfo clusterInfo)

setInternalVersion

@Deprecated
public Settings setInternalVersion(org.elasticsearch.hadoop.util.EsMajorVersion version)

Deprecated. prefer to use Settings#setInternalClusterInfo

setNodes

public Settings setNodes(java.lang.String hosts)

setHosts

@Deprecated
public Settings setHosts(java.lang.String hosts)

Deprecated.

setPort

public Settings setPort(int port)

setResourceRead

public Settings setResourceRead(java.lang.String index)

setResourceWrite

public Settings setResourceWrite(java.lang.String index)

setQuery

public Settings setQuery(java.lang.String query)

setMaxDocsPerPartition

public Settings setMaxDocsPerPartition(int size)

getResource

protected java.lang.String getResource()

getResourceRead

public java.lang.String getResourceRead()

getResourceWrite

public java.lang.String getResourceWrite()

getQuery

public java.lang.String getQuery()

getMaxDocsPerPartition

public java.lang.Integer getMaxDocsPerPartition()

getReadMetadata

public boolean getReadMetadata()

getReadMetadataField

public java.lang.String getReadMetadataField()

getReadMetadataVersion

public boolean getReadMetadataVersion()

getReadMappingMissingFieldsIgnore

public boolean getReadMappingMissingFieldsIgnore()

getDataFrameWriteNullValues

public boolean getDataFrameWriteNullValues()

getSecurityAuthenticationMethod

public AuthenticationMethod getSecurityAuthenticationMethod()

getSecurityUserProviderClass

public java.lang.String getSecurityUserProviderClass()

loadResource

public abstract java.io.InputStream loadResource(java.lang.String location)

copy

public abstract Settings copy()

getProperty

public java.lang.String getProperty(java.lang.String name,
                                    java.lang.String defaultValue)

getProperty

public abstract java.lang.String getProperty(java.lang.String name)

setProperty

public abstract void setProperty(java.lang.String name,
                                 java.lang.String value)

getSettingsView

public Settings getSettingsView(java.lang.String name)

excludeFilter

public Settings excludeFilter(java.lang.String prefix)

merge

public Settings merge(java.util.Properties properties)

merge

public Settings merge(java.util.Map<java.lang.String,java.lang.String> map)

load

public Settings load(java.lang.String source)

save

public java.lang.String save()

asProperties

public abstract java.util.Properties asProperties()

setOpaqueId

public Settings setOpaqueId(java.lang.String opaqueId)

getOpaqueId

public java.lang.String getOpaqueId()

setUserAgent

public Settings setUserAgent(java.lang.String userAgent)