com.google.api.services.container.model

Class HostConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.container.model.HostConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class HostConfig
extends com.google.api.client.json.GenericJson

HostConfig configures the registry host under a given Server.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Kubernetes Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
HostConfig()

Method Summary

Modifier and Type	Method and Description
HostConfig	clone()
List<CertificateConfig>	getCa() CA configures the registry host certificate.
List<String>	getCapabilities() Capabilities represent the capabilities of the registry host, specifying what operations a host is capable of performing.
List<CertificateConfigPair>	getClient() Client configures the registry host client certificate and key.
String	getDialTimeout() Specifies the maximum duration allowed for a connection attempt to complete.
List<RegistryHeader>	getHeader() Header configures the registry host headers.
String	getHost() Host configures the registry host/mirror.
Boolean	getOverridePath() OverridePath is used to indicate the host's API root endpoint is defined in the URL path rather than by the API specification.
HostConfig	set(String fieldName, Object value)
HostConfig	setCa(List<CertificateConfig> ca) CA configures the registry host certificate.
HostConfig	setCapabilities(List<String> capabilities) Capabilities represent the capabilities of the registry host, specifying what operations a host is capable of performing.
HostConfig	setClient(List<CertificateConfigPair> client) Client configures the registry host client certificate and key.
HostConfig	setDialTimeout(String dialTimeout) Specifies the maximum duration allowed for a connection attempt to complete.
HostConfig	setHeader(List<RegistryHeader> header) Header configures the registry host headers.
HostConfig	setHost(String host) Host configures the registry host/mirror.
HostConfig	setOverridePath(Boolean overridePath) OverridePath is used to indicate the host's API root endpoint is defined in the URL path rather than by the API specification.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

HostConfig

public HostConfig()

Method Detail

getCa

public List<CertificateConfig> getCa()

CA configures the registry host certificate.

Returns:

value or null for none

setCa

public HostConfig setCa(List<CertificateConfig> ca)

CA configures the registry host certificate.

Parameters:

ca - ca or null for none

getCapabilities

public List<String> getCapabilities()

Capabilities represent the capabilities of the registry host, specifying what operations a host is capable of performing. If not set, containerd enables all capabilities by default.

Returns:

value or null for none

setCapabilities

public HostConfig setCapabilities(List<String> capabilities)

Capabilities represent the capabilities of the registry host, specifying what operations a host is capable of performing. If not set, containerd enables all capabilities by default.

Parameters:

capabilities - capabilities or null for none

getClient

public List<CertificateConfigPair> getClient()

Client configures the registry host client certificate and key.

Returns:

value or null for none

setClient

public HostConfig setClient(List<CertificateConfigPair> client)

Client configures the registry host client certificate and key.

Parameters:

client - client or null for none

getDialTimeout

public String getDialTimeout()

Specifies the maximum duration allowed for a connection attempt to complete. A shorter timeout helps reduce delays when falling back to the original registry if the mirror is unreachable. Maximum allowed value is 180s. If not set, containerd sets default 30s. The value should be a decimal number of seconds with an `s` suffix.

Returns:

value or null for none

setDialTimeout

public HostConfig setDialTimeout(String dialTimeout)

Specifies the maximum duration allowed for a connection attempt to complete. A shorter timeout helps reduce delays when falling back to the original registry if the mirror is unreachable. Maximum allowed value is 180s. If not set, containerd sets default 30s. The value should be a decimal number of seconds with an `s` suffix.

Parameters:

dialTimeout - dialTimeout or null for none

getHeader

public List<RegistryHeader> getHeader()

Header configures the registry host headers.

Returns:

value or null for none

setHeader

public HostConfig setHeader(List<RegistryHeader> header)

Header configures the registry host headers.

Parameters:

header - header or null for none

getHost

public String getHost()

Host configures the registry host/mirror. It supports fully qualified domain names (FQDNs) and IP addresses. Specifying scheme, port or path is supported. Scheme can only be http or https. Wildcards are NOT supported. Examples: - `my.customdomain.com` - `https://my.customdomain.com/path` - `10.0.1.2:5000`

Returns:

value or null for none

setHost

public HostConfig setHost(String host)

Host configures the registry host/mirror. It supports fully qualified domain names (FQDNs) and IP addresses. Specifying scheme, port or path is supported. Scheme can only be http or https. Wildcards are NOT supported. Examples: - `my.customdomain.com` - `https://my.customdomain.com/path` - `10.0.1.2:5000`

Parameters:

host - host or null for none

getOverridePath

public Boolean getOverridePath()

OverridePath is used to indicate the host's API root endpoint is defined in the URL path rather than by the API specification. This may be used with non-compliant OCI registries which are missing the /v2 prefix. If not set, containerd sets default false.

Returns:

value or null for none

setOverridePath

public HostConfig setOverridePath(Boolean overridePath)

OverridePath is used to indicate the host's API root endpoint is defined in the URL path rather than by the API specification. This may be used with non-compliant OCI registries which are missing the /v2 prefix. If not set, containerd sets default false.

Parameters:

overridePath - overridePath or null for none

set

public HostConfig set(String fieldName,
                      Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public HostConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson