Reference documentation and code samples for the Google Cloud Container V1 Client class HostConfig.
HostConfig configures the registry host under a given Server.
Generated from protobuf message google.container.v1.ContainerdConfig.RegistryHostConfig.HostConfig
Namespace
Google \ Cloud \ Container \ V1 \ ContainerdConfig \ RegistryHostConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ host |
string
Host configures the registry host/mirror. It supports fully qualified domain names (FQDN) and IP addresses: Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 |
↳ capabilities |
array
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. |
↳ override_path |
bool
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. |
↳ header |
array<RegistryHeader>
Header configures the registry host headers. |
↳ ca |
array<CertificateConfig>
CA configures the registry host certificate. |
↳ client |
array<CertificateConfigPair>
Client configures the registry host client certificate and key. |
↳ dial_timeout |
Google\Protobuf\Duration
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 |
getHost
Host configures the registry host/mirror.
It supports fully qualified domain names (FQDN) and IP addresses: Specifying port is supported. Wildcards are NOT supported. Examples:
- my.customdomain.com
- 10.0.1.2:5000
| Returns | |
|---|---|
| Type | Description |
string |
|
setHost
Host configures the registry host/mirror.
It supports fully qualified domain names (FQDN) and IP addresses: Specifying port is supported. Wildcards are NOT supported. Examples:
- my.customdomain.com
- 10.0.1.2:5000
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCapabilities
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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 | |
|---|---|
| Type | Description |
bool |
|
setOverridePath
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHeader
Header configures the registry host headers.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setHeader
Header configures the registry host headers.
| Parameter | |
|---|---|
| Name | Description |
var |
array<RegistryHeader>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCa
CA configures the registry host certificate.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCa
CA configures the registry host certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CertificateConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClient
Client configures the registry host client certificate and key.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setClient
Client configures the registry host client certificate and key.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CertificateConfigPair>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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 | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasDialTimeout
clearDialTimeout
setDialTimeout
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|