Class Settings

java.lang.Object
org.elasticsearch.hadoop.cfg.Settings
Direct Known Subclasses:
CompositeSettings, FilteredSettings, HadoopSettings, PropertiesSettings, SparkSettings

public abstract class Settings extends 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 Details

    • Settings

      public Settings()
  • Method Details

    • 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 String getNodes()
    • getPort

      public int getPort()
    • getNodesDiscovery

      public boolean getNodesDiscovery()
    • getShardPreference

      public String getShardPreference()
    • getNodesPathPrefix

      public 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 String getBatchWriteRetryPolicy()
    • getBatchRefreshAfterWrite

      public boolean getBatchRefreshAfterWrite()
    • getBatchFlushManual

      public boolean getBatchFlushManual()
    • getScrollKeepAlive

      public long getScrollKeepAlive()
    • getScrollSize

      public long getScrollSize()
    • getScrollLimit

      public long getScrollLimit()
    • getScrollFields

      public String getScrollFields()
    • getExcludeSource

      public boolean getExcludeSource()
    • getSerializerValueWriterClassName

      public String getSerializerValueWriterClassName()
    • getSerializerBytesConverterClassName

      public String getSerializerBytesConverterClassName()
    • getSerializerValueReaderClassName

      public String getSerializerValueReaderClassName()
    • getIndexAutoCreate

      public boolean getIndexAutoCreate()
    • getIndexReadMissingAsEmpty

      public boolean getIndexReadMissingAsEmpty()
    • getIndexReadAllowRedStatus

      public boolean getIndexReadAllowRedStatus()
    • getInputAsJson

      public boolean getInputAsJson()
    • getOutputAsJson

      public boolean getOutputAsJson()
    • getOperation

      public String getOperation()
    • getMappingId

      public String getMappingId()
    • getMappingParent

      public String getMappingParent()
    • getMappingJoin

      public String getMappingJoin()
    • getMappingVersion

      public String getMappingVersion()
    • hasMappingVersionType

      public boolean hasMappingVersionType()
    • getMappingVersionType

      public String getMappingVersionType()
    • getMappingRouting

      public String getMappingRouting()
    • getMappingTtl

      public String getMappingTtl()
    • getMappingTimestamp

      public String getMappingTimestamp()
    • getMappingDefaultClassExtractor

      public String getMappingDefaultClassExtractor()
    • getMappingMetadataExtractorClassName

      public String getMappingMetadataExtractorClassName()
    • getMappingIdExtractorClassName

      public String getMappingIdExtractorClassName()
    • getMappingParentExtractorClassName

      public String getMappingParentExtractorClassName()
    • getMappingJoinExtractorClassName

      public String getMappingJoinExtractorClassName()
    • getMappingVersionExtractorClassName

      public String getMappingVersionExtractorClassName()
    • getMappingRoutingExtractorClassName

      public String getMappingRoutingExtractorClassName()
    • getMappingTtlExtractorClassName

      public String getMappingTtlExtractorClassName()
    • getMappingTimestampExtractorClassName

      public String getMappingTimestampExtractorClassName()
    • getMappingIndexExtractorClassName

      public String getMappingIndexExtractorClassName()
    • getMappingIndexFormatterClassName

      public String getMappingIndexFormatterClassName()
    • getMappingParamsExtractorClassName

      public String getMappingParamsExtractorClassName()
    • getMappingConstantAutoQuote

      public boolean getMappingConstantAutoQuote()
    • getMappingDateRich

      public boolean getMappingDateRich()
    • getMappingIncludes

      public String getMappingIncludes()
    • getMappingExcludes

      public String getMappingExcludes()
    • getIngestPipeline

      public String getIngestPipeline()
    • getUpdateRetryOnConflict

      public int getUpdateRetryOnConflict()
    • getUpdateScript

      public String getUpdateScript()
    • getUpdateScriptInline

      public String getUpdateScriptInline()
    • getUpdateScriptUpsert

      public Boolean getUpdateScriptUpsert()
    • getUpdateScriptFile

      public String getUpdateScriptFile()
    • getUpdateScriptStored

      public String getUpdateScriptStored()
    • getUpdateScriptLang

      public String getUpdateScriptLang()
    • getUpdateScriptParams

      public String getUpdateScriptParams()
    • getUpdateScriptParamsJson

      public 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 String getReadFieldInclude()
    • getReadFieldExclude

      public String getReadFieldExclude()
    • getReadFieldAsArrayInclude

      public String getReadFieldAsArrayInclude()
    • getReadFieldAsArrayExclude

      public String getReadFieldAsArrayExclude()
    • getReadSourceFilter

      public 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 String getNetworkSSLKeyStoreLocation()
    • getNetworkSSLProtocol

      public String getNetworkSSLProtocol()
    • getNetworkSSLKeyStoreType

      public String getNetworkSSLKeyStoreType()
    • getNetworkSSLKeyStorePass

      @Deprecated public String getNetworkSSLKeyStorePass()
      Deprecated.
    • getNetworkSSLTrustStoreLocation

      public String getNetworkSSLTrustStoreLocation()
    • getNetworkSSLTrustStorePass

      @Deprecated public String getNetworkSSLTrustStorePass()
      Deprecated.
    • getNetworkSSLAcceptSelfSignedCert

      public boolean getNetworkSSLAcceptSelfSignedCert()
    • getNetworkHttpAuthUser

      public String getNetworkHttpAuthUser()
    • getNetworkHttpAuthPass

      @Deprecated public String getNetworkHttpAuthPass()
      Deprecated.
    • getNetworkSpnegoAuthElasticsearchPrincipal

      public String getNetworkSpnegoAuthElasticsearchPrincipal()
    • getNetworkSpnegoAuthMutual

      public boolean getNetworkSpnegoAuthMutual()
    • getNetworkProxyHttpHost

      public String getNetworkProxyHttpHost()
    • getNetworkProxyHttpPort

      public int getNetworkProxyHttpPort()
    • getNetworkProxyHttpUser

      public String getNetworkProxyHttpUser()
    • getNetworkProxyHttpPass

      @Deprecated public String getNetworkProxyHttpPass()
      Deprecated.
    • getNetworkHttpUseSystemProperties

      public boolean getNetworkHttpUseSystemProperties()
    • getNetworkProxyHttpsHost

      public String getNetworkProxyHttpsHost()
    • getNetworkProxyHttpsPort

      public int getNetworkProxyHttpsPort()
    • getNetworkProxyHttpsUser

      public String getNetworkProxyHttpsUser()
    • getNetworkProxyHttpsPass

      @Deprecated public String getNetworkProxyHttpsPass()
      Deprecated.
    • getNetworkHttpsUseSystemProperties

      public boolean getNetworkHttpsUseSystemProperties()
    • getNetworkProxySocksHost

      public String getNetworkProxySocksHost()
    • getNetworkProxySocksPort

      public int getNetworkProxySocksPort()
    • getNetworkProxySocksUser

      public String getNetworkProxySocksUser()
    • getNetworkProxySocksPass

      @Deprecated public 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(String hosts)
    • setHosts

      @Deprecated public Settings setHosts(String hosts)
      Deprecated.
    • setPort

      public Settings setPort(int port)
    • setResourceRead

      public Settings setResourceRead(String index)
    • setResourceWrite

      public Settings setResourceWrite(String index)
    • setQuery

      public Settings setQuery(String query)
    • setMaxDocsPerPartition

      public Settings setMaxDocsPerPartition(int size)
    • getResource

      protected String getResource()
    • getResourceRead

      public String getResourceRead()
    • getResourceWrite

      public String getResourceWrite()
    • getQuery

      public String getQuery()
    • getMaxDocsPerPartition

      public Integer getMaxDocsPerPartition()
    • getReadMetadata

      public boolean getReadMetadata()
    • getReadMetadataField

      public String getReadMetadataField()
    • getReadMetadataVersion

      public boolean getReadMetadataVersion()
    • getReadMappingMissingFieldsIgnore

      public boolean getReadMappingMissingFieldsIgnore()
    • getDataFrameWriteNullValues

      public boolean getDataFrameWriteNullValues()
    • getSecurityAuthenticationMethod

      public AuthenticationMethod getSecurityAuthenticationMethod()
    • getSecurityUserProviderClass

      public String getSecurityUserProviderClass()
    • loadResource

      public abstract InputStream loadResource(String location)
    • copy

      public abstract Settings copy()
    • getProperty

      public String getProperty(String name, String defaultValue)
    • getProperty

      public abstract String getProperty(String name)
    • setProperty

      public abstract void setProperty(String name, String value)
    • getSettingsView

      public Settings getSettingsView(String name)
    • excludeFilter

      public Settings excludeFilter(String prefix)
    • merge

      public Settings merge(Properties properties)
    • merge

      public Settings merge(Map<String,String> map)
    • load

      public Settings load(String source)
    • save

      public String save()
    • asProperties

      public abstract Properties asProperties()
    • setOpaqueId

      public Settings setOpaqueId(String opaqueId)
    • getOpaqueId

      public String getOpaqueId()
    • setUserAgent

      public Settings setUserAgent(String userAgent)