ArtifactCacheBuckConfig (Buck)

java.lang.Object
- com.facebook.buck.artifact_cache.config.ArtifactCacheBuckConfig

All Implemented Interfaces:

ConfigView<BuckConfig>
```
public class ArtifactCacheBuckConfig
extends Object
implements ConfigView<BuckConfig>
```
Represents configuration specific to the ArtifactCache.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ArtifactCacheBuckConfig.Executor
Thread pools that are available for task execution.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ArtifactCacheBuckConfig.Executor` Thread pools that are available for task execution.

Field Summary

Fields
Modifier and Type Field and Description

static String MULTI_CHECK

static String MULTI_FETCH

Fields
Modifier and Type	Field and Description
`static String`	`MULTI_CHECK`
`static String`	`MULTI_FETCH`

Constructor Summary

Constructors
Constructor and Description

ArtifactCacheBuckConfig(BuckConfig buckConfig)

Constructors
Constructor and Description
`ArtifactCacheBuckConfig(BuckConfig buckConfig)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.common.collect.ImmutableSet<ArtifactCacheMode>`	`getArtifactCacheModes()`
`com.google.common.collect.ImmutableList<String>`	`getArtifactCacheModesRaw()`
`com.google.common.collect.ImmutableSet<String>`	`getBlacklistedWifiSsids()`
`ArtifactCacheEntries`	`getCacheEntries()`
`int`	`getCasDeadline()`
`Optional<String>`	`getCasHost()`
`int`	`getCasPort()`
`Optional<Path>`	`getClientTlsCertificate()` Gets the path to a PEM encoded X509 certificate to use as the TLS client certificate for HTTP cache requests from the content of the env var specified in http_client_tls_cert_env_var if set or the field value
`boolean`	`getClientTlsCertRequired()` If true, fail if client TLS certificate or key paths are unspecified, don't exist, are not the right format or have expired
`boolean`	`getClientTlsForSlb()` If true, use TLS client authentication certificate, private key and extra trusted certificates also for CLIENT_SLB mode alive pings.
`Optional<Path>`	`getClientTlsKey()` Gets the path to a PEM encoded PCKS#8 key to use as the TLS client key for HTTP cache requests from the content of the env var specified in http_client_tls_key_env_var if set or the field value.
`Optional<Path>`	`getClientTlsTrustedCertificates()` Gets the path to a file containing PEM encoded X509 certificates to use as an additional list of trusted certificates from the content of the env var specified in http_client_tls_ca_env_var if set or the field value.
`BuckConfig`	`getDelegate()`
`ArtifactCacheBuckConfig.Executor`	`getDirCacheStoreExecutor()`
`Boolean`	`getEnableWriteToCas()`
`static String`	`getEnvVarFieldNameForField(String field)`
`int`	`getErrorMessageLimit()`
`String`	`getHostToReportToRemoteCacheServer()`
`int`	`getHttpFetchConcurrency()`
`int`	`getHttpMaxConcurrentWrites()`
`int`	`getHttpWriterShutdownTimeout()`
`Optional<String>`	`getHybridThriftEndpoint()`
`LoadBalancingType`	`getLoadBalancingType()`
`int`	`getMaxFetchRetries()`
`int`	`getMaxStoreAttempts()`
`boolean`	`getMultiCheckEnabled()`
`int`	`getMultiFetchLimit()`
`MultiFetchType`	`getMultiFetchType()`
`String`	`getRepository()`
`String`	`getScheduleType()`
`Optional<DirCacheEntry>`	`getServedLocalCache()`
`SlbBuckConfig`	`getSlbConfig()`
`long`	`getStoreRetryIntervalMillis()`
`static Optional<String>`	`getStringOrEnvironmentVariable(BuckConfig buckConfig, String section, String field)`
`long`	`getThreadPoolKeepAliveDurationMillis()`
`long`	`getThreadPoolSize()`
`boolean`	`getTwoLevelCachingEnabled()`
`Optional<Long>`	`getTwoLevelCachingMaximumSize()`
`long`	`getTwoLevelCachingMinimumSize()`
`boolean`	`hasAtLeastOneWriteableRemoteCache()`
`static ArtifactCacheBuckConfig`	`of(BuckConfig delegate)`

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

- Field Detail
  - MULTI_FETCH
```
public static final String MULTI_FETCH
```
    See Also:
    
    Constant Field Values
  - MULTI_CHECK
```
public static final String MULTI_CHECK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ArtifactCacheBuckConfig
```
public ArtifactCacheBuckConfig(BuckConfig buckConfig)
```
- Method Detail
  - of
```
public static ArtifactCacheBuckConfig of(BuckConfig delegate)
```
  - getMultiFetchType
```
public MultiFetchType getMultiFetchType()
```
  - getMultiCheckEnabled
```
public boolean getMultiCheckEnabled()
```
  - getDelegate
```
public BuckConfig getDelegate()
```
    Specified by:
    
    getDelegate in interface ConfigView<BuckConfig>
  - getHttpFetchConcurrency
```
public int getHttpFetchConcurrency()
```
  - getMultiFetchLimit
```
public int getMultiFetchLimit()
```
  - getRepository
```
public String getRepository()
```
  - getScheduleType
```
public String getScheduleType()
```
  - getSlbConfig
```
public SlbBuckConfig getSlbConfig()
```
  - getHybridThriftEndpoint
```
public Optional<String> getHybridThriftEndpoint()
```
  - getEnableWriteToCas
```
public Boolean getEnableWriteToCas()
```
  - getCasHost
```
public Optional<String> getCasHost()
```
  - getCasPort
```
public int getCasPort()
```
  - getCasDeadline
```
public int getCasDeadline()
```
  - getLoadBalancingType
```
public LoadBalancingType getLoadBalancingType()
```
  - getHttpMaxConcurrentWrites
```
public int getHttpMaxConcurrentWrites()
```
  - getHttpWriterShutdownTimeout
```
public int getHttpWriterShutdownTimeout()
```
  - getMaxFetchRetries
```
public int getMaxFetchRetries()
```
  - getMaxStoreAttempts
```
public int getMaxStoreAttempts()
```
  - getErrorMessageLimit
```
public int getErrorMessageLimit()
```
  - getStoreRetryIntervalMillis
```
public long getStoreRetryIntervalMillis()
```
  - hasAtLeastOneWriteableRemoteCache
```
public boolean hasAtLeastOneWriteableRemoteCache()
```
  - getHostToReportToRemoteCacheServer
```
public String getHostToReportToRemoteCacheServer()
```
  - getArtifactCacheModesRaw
```
public com.google.common.collect.ImmutableList<String> getArtifactCacheModesRaw()
```
  - getArtifactCacheModes
```
public com.google.common.collect.ImmutableSet<ArtifactCacheMode> getArtifactCacheModes()
```
  - getServedLocalCache
```
public Optional<DirCacheEntry> getServedLocalCache()
```
  - getCacheEntries
```
public ArtifactCacheEntries getCacheEntries()
```
  - getThreadPoolSize
```
public long getThreadPoolSize()
```
  - getThreadPoolKeepAliveDurationMillis
```
public long getThreadPoolKeepAliveDurationMillis()
```
  - getTwoLevelCachingEnabled
```
public boolean getTwoLevelCachingEnabled()
```
  - getTwoLevelCachingMinimumSize
```
public long getTwoLevelCachingMinimumSize()
```
  - getTwoLevelCachingMaximumSize
```
public Optional<Long> getTwoLevelCachingMaximumSize()
```
  - getClientTlsCertRequired
```
public boolean getClientTlsCertRequired()
```
    If true, fail if client TLS certificate or key paths are unspecified, don't exist, are not the right format or have expired
  - getClientTlsForSlb
```
public boolean getClientTlsForSlb()
```
    If true, use TLS client authentication certificate, private key and extra trusted certificates also for CLIENT_SLB mode alive pings.
  - getClientTlsCertificate
```
public Optional<Path> getClientTlsCertificate()
```
    Gets the path to a PEM encoded X509 certificate to use as the TLS client certificate for HTTP cache requests from the content of the env var specified in http_client_tls_cert_env_var if set or the field value
    Both the key and certificate must be set for client TLS certificates to be used
  - getClientTlsKey
```
public Optional<Path> getClientTlsKey()
```
    Gets the path to a PEM encoded PCKS#8 key to use as the TLS client key for HTTP cache requests from the content of the env var specified in http_client_tls_key_env_var if set or the field value. This may be a file that contains both the private key and the certificate if both objects are newline delimited.
    Both the key and certificate must be set for client TLS certificates to be used
  - getClientTlsTrustedCertificates
```
public Optional<Path> getClientTlsTrustedCertificates()
```
    Gets the path to a file containing PEM encoded X509 certificates to use as an additional list of trusted certificates from the content of the env var specified in http_client_tls_ca_env_var if set or the field value.
    Both the key and certificate must be set for client TLS certificates to be used
  - getDirCacheStoreExecutor
```
public ArtifactCacheBuckConfig.Executor getDirCacheStoreExecutor()
```
    Returns:
    
    The thread pool dir cache store operations should be executed on.
  - getBlacklistedWifiSsids
```
public com.google.common.collect.ImmutableSet<String> getBlacklistedWifiSsids()
```
  - getStringOrEnvironmentVariable
```
public static Optional<String> getStringOrEnvironmentVariable(BuckConfig buckConfig,
                                                              String section,
                                                              String field)
```
    Returns:
    
    field value or content of environment variable specified in field "${section}.${field}_env_var" if this environment variable exists and does not just contain 0 or more whitespaces
  - getEnvVarFieldNameForField
```
public static String getEnvVarFieldNameForField(String field)
```
    Parameters:
    
    field -
    
    Returns:
    
    append the to the {field}

Class ArtifactCacheBuckConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MULTI_FETCH

MULTI_CHECK

Constructor Detail

ArtifactCacheBuckConfig

Method Detail

of

getMultiFetchType

getMultiCheckEnabled

getDelegate

getHttpFetchConcurrency

getMultiFetchLimit

getRepository

getScheduleType

getSlbConfig

getHybridThriftEndpoint

getEnableWriteToCas

getCasHost

getCasPort

getCasDeadline

getLoadBalancingType

getHttpMaxConcurrentWrites

getHttpWriterShutdownTimeout

getMaxFetchRetries

getMaxStoreAttempts

getErrorMessageLimit

getStoreRetryIntervalMillis

hasAtLeastOneWriteableRemoteCache

getHostToReportToRemoteCacheServer

getArtifactCacheModesRaw

getArtifactCacheModes

getServedLocalCache

getCacheEntries

getThreadPoolSize

getThreadPoolKeepAliveDurationMillis

getTwoLevelCachingEnabled

getTwoLevelCachingMinimumSize

getTwoLevelCachingMaximumSize

getClientTlsCertRequired

getClientTlsForSlb

getClientTlsCertificate

getClientTlsKey

getClientTlsTrustedCertificates

getDirCacheStoreExecutor

getBlacklistedWifiSsids

getStringOrEnvironmentVariable

getEnvVarFieldNameForField