java.lang.Object
- io.fabric8.openshift.api.model.monitoring.v1alpha1.DockerSwarmSDConfig

All Implemented Interfaces:

Editable<DockerSwarmSDConfigBuilder>, KubernetesResource, Serializable
```
@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class DockerSwarmSDConfig
extends Object
implements Editable<DockerSwarmSDConfigBuilder>, KubernetesResource
```
DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`DockerSwarmSDConfig()`	No args constructor for use in serialization
`DockerSwarmSDConfig(SafeAuthorization authorization, BasicAuth basicAuth, Boolean enableHTTP2, List<Filter> filters, Boolean followRedirects, String host, String noProxy, OAuth2 oauth2, Integer port, Map<String,List<SecretKeySelector>> proxyConnectHeader, Boolean proxyFromEnvironment, String proxyUrl, String refreshInterval, String role, SafeTLSConfig tlsConfig)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DockerSwarmSDConfigBuilder`	`edit()`
`Map<String,Object>`	`getAdditionalProperties()`
`SafeAuthorization`	`getAuthorization()`	DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine.
`BasicAuth`	`getBasicAuth()`	DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine.
`Boolean`	`getEnableHTTP2()`	enableHTTP2 defines whether to enable HTTP2.
`List<Filter>`	`getFilters()`	filters defines the filters to limit the discovery process to a subset of available resources.
`Boolean`	`getFollowRedirects()`	followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
`String`	`getHost()`	host defines the address of the Docker daemon
`String`	`getNoProxy()`	noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying.
`OAuth2`	`getOauth2()`	DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine.
`Integer`	`getPort()`	port defines the port to scrape metrics from.
`Map<String,List<SecretKeySelector>>`	`getProxyConnectHeader()`	proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
`Boolean`	`getProxyFromEnvironment()`	proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
`String`	`getProxyUrl()`	proxyUrl defines the HTTP proxy server to use.
`String`	`getRefreshInterval()`	refreshInterval defines the time after which the provided names are refreshed.
`String`	`getRole()`	role of the targets to retrieve.
`SafeTLSConfig`	`getTlsConfig()`	DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine.
`void`	`setAdditionalProperties(Map<String,Object> additionalProperties)`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setAuthorization(SafeAuthorization authorization)`	DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine.
`void`	`setBasicAuth(BasicAuth basicAuth)`	DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine.
`void`	`setEnableHTTP2(Boolean enableHTTP2)`	enableHTTP2 defines whether to enable HTTP2.
`void`	`setFilters(List<Filter> filters)`	filters defines the filters to limit the discovery process to a subset of available resources.
`void`	`setFollowRedirects(Boolean followRedirects)`	followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
`void`	`setHost(String host)`	host defines the address of the Docker daemon
`void`	`setNoProxy(String noProxy)`	noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying.
`void`	`setOauth2(OAuth2 oauth2)`	DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine.
`void`	`setPort(Integer port)`	port defines the port to scrape metrics from.
`void`	`setProxyConnectHeader(Map<String,List<SecretKeySelector>> proxyConnectHeader)`	proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
`void`	`setProxyFromEnvironment(Boolean proxyFromEnvironment)`	proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
`void`	`setProxyUrl(String proxyUrl)`	proxyUrl defines the HTTP proxy server to use.
`void`	`setRefreshInterval(String refreshInterval)`	refreshInterval defines the time after which the provided names are refreshed.
`void`	`setRole(String role)`	role of the targets to retrieve.
`void`	`setTlsConfig(SafeTLSConfig tlsConfig)`	DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine.
`DockerSwarmSDConfigBuilder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DockerSwarmSDConfig
```
public DockerSwarmSDConfig()
```
    No args constructor for use in serialization
  - DockerSwarmSDConfig
```
public DockerSwarmSDConfig(SafeAuthorization authorization,
                           BasicAuth basicAuth,
                           Boolean enableHTTP2,
                           List<Filter> filters,
                           Boolean followRedirects,
                           String host,
                           String noProxy,
                           OAuth2 oauth2,
                           Integer port,
                           Map<String,List<SecretKeySelector>> proxyConnectHeader,
                           Boolean proxyFromEnvironment,
                           String proxyUrl,
                           String refreshInterval,
                           String role,
                           SafeTLSConfig tlsConfig)
```
- Method Detail
  - getAuthorization
```
public SafeAuthorization getAuthorization()
```
    DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config
  - setAuthorization
```
public void setAuthorization(SafeAuthorization authorization)
```
    DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config
  - getBasicAuth
```
public BasicAuth getBasicAuth()
```
    DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config
  - setBasicAuth
```
public void setBasicAuth(BasicAuth basicAuth)
```
    DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config
  - getEnableHTTP2
```
public Boolean getEnableHTTP2()
```
    enableHTTP2 defines whether to enable HTTP2.
  - setEnableHTTP2
```
public void setEnableHTTP2(Boolean enableHTTP2)
```
    enableHTTP2 defines whether to enable HTTP2.
  - getFilters
```
public List<Filter> getFilters()
```
    filters defines the filters to limit the discovery process to a subset of available resources. The available filters are listed in the upstream documentation: Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList Tasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList Nodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList
  - setFilters
```
public void setFilters(List<Filter> filters)
```
    filters defines the filters to limit the discovery process to a subset of available resources. The available filters are listed in the upstream documentation: Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList Tasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList Nodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList
  - getFollowRedirects
```
public Boolean getFollowRedirects()
```
    followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
  - setFollowRedirects
```
public void setFollowRedirects(Boolean followRedirects)
```
    followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
  - getHost
```
public String getHost()
```
    host defines the address of the Docker daemon
  - setHost
```
public void setHost(String host)
```
    host defines the address of the Docker daemon
  - getNoProxy
```
public String getNoProxy()
```
    noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.
    
    It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
  - setNoProxy
```
public void setNoProxy(String noProxy)
```
    noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.
    
    It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
  - getOauth2
```
public OAuth2 getOauth2()
```
    DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config
  - setOauth2
```
public void setOauth2(OAuth2 oauth2)
```
    DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config
  - getPort
```
public Integer getPort()
```
    port defines the port to scrape metrics from. If using the public IP address, this must tasks and services that don't have published ports.
  - setPort
```
public void setPort(Integer port)
```
    port defines the port to scrape metrics from. If using the public IP address, this must tasks and services that don't have published ports.
  - getProxyConnectHeader
```
public Map<String,List<SecretKeySelector>> getProxyConnectHeader()
```
    proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
    
    It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
  - setProxyConnectHeader
```
public void setProxyConnectHeader(Map<String,List<SecretKeySelector>> proxyConnectHeader)
```
    proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
    
    It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
  - getProxyFromEnvironment
```
public Boolean getProxyFromEnvironment()
```
    proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
    
    It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
  - setProxyFromEnvironment
```
public void setProxyFromEnvironment(Boolean proxyFromEnvironment)
```
    proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
    
    It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
  - getProxyUrl
```
public String getProxyUrl()
```
    proxyUrl defines the HTTP proxy server to use.
  - setProxyUrl
```
public void setProxyUrl(String proxyUrl)
```
    proxyUrl defines the HTTP proxy server to use.
  - getRefreshInterval
```
public String getRefreshInterval()
```
    refreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
  - setRefreshInterval
```
public void setRefreshInterval(String refreshInterval)
```
    refreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
  - getRole
```
public String getRole()
```
    role of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`.
  - setRole
```
public void setRole(String role)
```
    role of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`.
  - getTlsConfig
```
public SafeTLSConfig getTlsConfig()
```
    DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config
  - setTlsConfig
```
public void setTlsConfig(SafeTLSConfig tlsConfig)
```
    DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config
  - edit
```
public DockerSwarmSDConfigBuilder edit()
```
    Specified by:
    
    edit in interface Editable<DockerSwarmSDConfigBuilder>
  - toBuilder
```
public DockerSwarmSDConfigBuilder toBuilder()
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```

Class DockerSwarmSDConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DockerSwarmSDConfig

DockerSwarmSDConfig

Method Detail

getAuthorization

setAuthorization

getBasicAuth

setBasicAuth

getEnableHTTP2

setEnableHTTP2

getFilters

setFilters

getFollowRedirects

setFollowRedirects

getHost

setHost

getNoProxy

setNoProxy

getOauth2

setOauth2

getPort

setPort

getProxyConnectHeader

setProxyConnectHeader

getProxyFromEnvironment

setProxyFromEnvironment

getProxyUrl

setProxyUrl

getRefreshInterval

setRefreshInterval

getRole

setRole

getTlsConfig

setTlsConfig

edit

toBuilder

getAdditionalProperties

setAdditionalProperty

setAdditionalProperties