Package org.springframework.cloud.consul.discovery

Class ConsulDiscoveryProperties

  • @ConfigurationProperties("spring.cloud.consul.discovery")
public class ConsulDiscoveryProperties
extends Object
    Defines configuration for service discovery and registration.
    Author:
    Spencer Gibb, Donnabell Dmello, Venil Noronha, Richard Kettelerij

    • Constructor Detail

      • ConsulDiscoveryProperties

        public ConsulDiscoveryProperties​(org.springframework.cloud.commons.util.InetUtils inetUtils)

    • Method Detail

      • getQueryTagForService

        public String getQueryTagForService​(String serviceId)
        Gets the tag to use when looking up the instances for a particular service. If the service has an entry in serverListQueryTags that will be used. Otherwise the content of defaultQueryTag will be used.
        Parameters:
        serviceId - the service whose instances are being looked up
        Returns:
        the tag to filter the service instances by or null if no tags are configured for the service and the default query tag is not configured

      • getQueryTagsForService

        @Nullable
public String[] getQueryTagsForService​(String serviceId)
        Gets the array of tags to use when looking up the instances for a particular service. If the service has an entry in serverListQueryTags that will be used. Otherwise the content of defaultQueryTag will be used. This differs from getQueryTagForService(String) in that it assumes the configured tag property value may represent multiple tags when separated by commas. When the tag property is set to a single tag then this method behaves identical to its aforementioned counterpart except that it returns a single element array with the single tag value.

        The expected format of the tag property value is tag1,tag2,..,tagN. Whitespace will be trimmed off each entry.

        Parameters:
        serviceId - the service whose instances are being looked up
        Returns:
        the array of tags to filter the service instances by - it will be null if no tags are configured for the service and the default query tag is not configured or if a single tag is configured and it is the empty string

      • getHostname

        public String getHostname()

      • setHostname

        public void setHostname​(String hostname)

      • getAclToken

        public String getAclToken()

      • setAclToken

        public void setAclToken​(String aclToken)

      • setTags

        public void setTags​(List<String> tags)

      • isEnableTagOverride

        public boolean isEnableTagOverride()

      • setEnableTagOverride

        public void setEnableTagOverride​(boolean enableTagOverride)

      • setMetadata

        public void setMetadata​(Map<String,​String> metadata)

      • isEnabled

        public boolean isEnabled()

      • setEnabled

        public void setEnabled​(boolean enabled)

      • getManagementTags

        public List<String> getManagementTags()

      • setManagementTags

        public void setManagementTags​(List<String> managementTags)

      • getHealthCheckPath

        public String getHealthCheckPath()

      • setHealthCheckPath

        public void setHealthCheckPath​(String healthCheckPath)

      • getHealthCheckUrl

        public String getHealthCheckUrl()

      • setHealthCheckUrl

        public void setHealthCheckUrl​(String healthCheckUrl)

      • setHealthCheckHeaders

        public void setHealthCheckHeaders​(Map<String,​List<String>> healthCheckHeaders)

      • getHealthCheckInterval

        public String getHealthCheckInterval()

      • setHealthCheckInterval

        public void setHealthCheckInterval​(String healthCheckInterval)

      • getHealthCheckTimeout

        public String getHealthCheckTimeout()

      • setHealthCheckTimeout

        public void setHealthCheckTimeout​(String healthCheckTimeout)

      • getHealthCheckCriticalTimeout

        public String getHealthCheckCriticalTimeout()

      • setHealthCheckCriticalTimeout

        public void setHealthCheckCriticalTimeout​(String healthCheckCriticalTimeout)

      • getIpAddress

        public String getIpAddress()

      • setIpAddress

        public void setIpAddress​(String ipAddress)

      • getPort

        public Integer getPort()

      • setPort

        public void setPort​(Integer port)

      • getManagementPort

        public Integer getManagementPort()

      • setManagementPort

        public void setManagementPort​(Integer managementPort)

      • isPreferIpAddress

        public boolean isPreferIpAddress()

      • setPreferIpAddress

        public void setPreferIpAddress​(boolean preferIpAddress)

      • isPreferAgentAddress

        public boolean isPreferAgentAddress()

      • setPreferAgentAddress

        public void setPreferAgentAddress​(boolean preferAgentAddress)

      • getCatalogServicesWatchDelay

        public int getCatalogServicesWatchDelay()

      • setCatalogServicesWatchDelay

        public void setCatalogServicesWatchDelay​(int catalogServicesWatchDelay)

      • getCatalogServicesWatchTimeout

        public int getCatalogServicesWatchTimeout()

      • setCatalogServicesWatchTimeout

        public void setCatalogServicesWatchTimeout​(int catalogServicesWatchTimeout)

      • getServiceName

        public String getServiceName()

      • setServiceName

        public void setServiceName​(String serviceName)

      • getInstanceId

        public String getInstanceId()

      • setInstanceId

        public void setInstanceId​(String instanceId)

      • getInstanceZone

        public String getInstanceZone()

      • setInstanceZone

        public void setInstanceZone​(String instanceZone)

      • getInstanceGroup

        public String getInstanceGroup()

      • setInstanceGroup

        public void setInstanceGroup​(String instanceGroup)

      • isIncludeHostnameInInstanceId

        public boolean isIncludeHostnameInInstanceId()

      • setIncludeHostnameInInstanceId

        public void setIncludeHostnameInInstanceId​(boolean includeHostnameInInstanceId)

      • getConsistencyMode

        public com.ecwid.consul.v1.ConsistencyMode getConsistencyMode()

      • setConsistencyMode

        public void setConsistencyMode​(com.ecwid.consul.v1.ConsistencyMode consistencyMode)

      • getDefaultZoneMetadataName

        public String getDefaultZoneMetadataName()

      • setDefaultZoneMetadataName

        public void setDefaultZoneMetadataName​(String defaultZoneMetadataName)

      • getScheme

        public String getScheme()

      • setScheme

        public void setScheme​(String scheme)

      • getManagementSuffix

        public String getManagementSuffix()

      • setManagementSuffix

        public void setManagementSuffix​(String managementSuffix)

      • getServerListQueryTags

        public Map<String,​String> getServerListQueryTags()

      • setServerListQueryTags

        public void setServerListQueryTags​(Map<String,​String> serverListQueryTags)

      • setDatacenters

        public void setDatacenters​(Map<String,​String> datacenters)

      • getDefaultQueryTag

        public String getDefaultQueryTag()

      • setDefaultQueryTag

        public void setDefaultQueryTag​(String defaultQueryTag)

      • isQueryPassing

        public boolean isQueryPassing()

      • setQueryPassing

        public void setQueryPassing​(boolean queryPassing)

      • isRegister

        public boolean isRegister()

      • setRegister

        public void setRegister​(boolean register)

      • isDeregister

        public boolean isDeregister()

      • setDeregister

        public void setDeregister​(boolean deregister)

      • isRegisterHealthCheck

        public boolean isRegisterHealthCheck()

      • setRegisterHealthCheck

        public void setRegisterHealthCheck​(boolean registerHealthCheck)

      • isFailFast

        public boolean isFailFast()

      • setFailFast

        public void setFailFast​(boolean failFast)

      • getHealthCheckTlsSkipVerify

        public Boolean getHealthCheckTlsSkipVerify()

      • setHealthCheckTlsSkipVerify

        public void setHealthCheckTlsSkipVerify​(Boolean healthCheckTlsSkipVerify)

      • getOrder

        public int getOrder()

      • setOrder

        public void setOrder​(int order)

      • getManagementMetadata

        public Map<String,​String> getManagementMetadata()

      • setManagementMetadata

        public void setManagementMetadata​(Map<String,​String> managementMetadata)

      • getEnableTagOverride

        public Boolean getEnableTagOverride()

      • setEnableTagOverride

        public void setEnableTagOverride​(Boolean enableTagOverride)

      • getManagementEnableTagOverride

        public Boolean getManagementEnableTagOverride()

      • setManagementEnableTagOverride

        public void setManagementEnableTagOverride​(Boolean managementEnableTagOverride)