EndpointSettings
Table of Contents
- $aliases : array<string|int, string>|null
- $driverOpts : array<string|int, string>|null
- DriverOpts is a mapping of driver options and values. These options.
- $endpointID : string|null
- Unique ID for the service endpoint in a Sandbox.
- $gateway : string|null
- Gateway address for this network.
- $globalIPv6Address : string|null
- Global IPv6 address.
- $globalIPv6PrefixLen : int|null
- Mask length of the global IPv6 address.
- $iPAddress : string|null
- IPv4 address.
- $iPAMConfig : EndpointIPAMConfig|null
- EndpointIPAMConfig represents an endpoint's IPAM configuration.
- $iPPrefixLen : int|null
- Mask length of the IPv4 address.
- $iPv6Gateway : string|null
- IPv6 gateway address.
- $links : array<string|int, string>|null
- $macAddress : string|null
- MAC address for the endpoint on this network.
- $networkID : string|null
- Unique ID of the network.
- getAliases() : array<string|int, string>|null
- getDriverOpts() : array<string|int, string>|null
- DriverOpts is a mapping of driver options and values. These options.
- getEndpointID() : string|null
- Unique ID for the service endpoint in a Sandbox.
- getGateway() : string|null
- Gateway address for this network.
- getGlobalIPv6Address() : string|null
- Global IPv6 address.
- getGlobalIPv6PrefixLen() : int|null
- Mask length of the global IPv6 address.
- getIPAddress() : string|null
- IPv4 address.
- getIPAMConfig() : EndpointIPAMConfig|null
- EndpointIPAMConfig represents an endpoint's IPAM configuration.
- getIPPrefixLen() : int|null
- Mask length of the IPv4 address.
- getIPv6Gateway() : string|null
- IPv6 gateway address.
- getLinks() : array<string|int, string>|null
- getMacAddress() : string|null
- MAC address for the endpoint on this network.
- getNetworkID() : string|null
- Unique ID of the network.
- setAliases() : self
- setDriverOpts() : self
- DriverOpts is a mapping of driver options and values. These options.
- setEndpointID() : self
- Unique ID for the service endpoint in a Sandbox.
- setGateway() : self
- Gateway address for this network.
- setGlobalIPv6Address() : self
- Global IPv6 address.
- setGlobalIPv6PrefixLen() : self
- Mask length of the global IPv6 address.
- setIPAddress() : self
- IPv4 address.
- setIPAMConfig() : self
- EndpointIPAMConfig represents an endpoint's IPAM configuration.
- setIPPrefixLen() : self
- Mask length of the IPv4 address.
- setIPv6Gateway() : self
- IPv6 gateway address.
- setLinks() : self
- setMacAddress() : self
- MAC address for the endpoint on this network.
- setNetworkID() : self
- Unique ID of the network.
Properties
$aliases
protected
array<string|int, string>|null
$aliases
$driverOpts
DriverOpts is a mapping of driver options and values. These options.
protected
array<string|int, string>|null
$driverOpts
$endpointID
Unique ID for the service endpoint in a Sandbox.
protected
string|null
$endpointID
$gateway
Gateway address for this network.
protected
string|null
$gateway
$globalIPv6Address
Global IPv6 address.
protected
string|null
$globalIPv6Address
$globalIPv6PrefixLen
Mask length of the global IPv6 address.
protected
int|null
$globalIPv6PrefixLen
$iPAddress
IPv4 address.
protected
string|null
$iPAddress
$iPAMConfig
EndpointIPAMConfig represents an endpoint's IPAM configuration.
protected
EndpointIPAMConfig|null
$iPAMConfig
$iPPrefixLen
Mask length of the IPv4 address.
protected
int|null
$iPPrefixLen
$iPv6Gateway
IPv6 gateway address.
protected
string|null
$iPv6Gateway
$links
protected
array<string|int, string>|null
$links
$macAddress
MAC address for the endpoint on this network.
protected
string|null
$macAddress
$networkID
Unique ID of the network.
protected
string|null
$networkID
Methods
getAliases()
public
getAliases() : array<string|int, string>|null
Return values
array<string|int, string>|null —getDriverOpts()
DriverOpts is a mapping of driver options and values. These options.
public
getDriverOpts() : array<string|int, string>|null
Return values
array<string|int, string>|null —getEndpointID()
Unique ID for the service endpoint in a Sandbox.
public
getEndpointID() : string|null
Return values
string|null —getGateway()
Gateway address for this network.
public
getGateway() : string|null
Return values
string|null —getGlobalIPv6Address()
Global IPv6 address.
public
getGlobalIPv6Address() : string|null
Return values
string|null —getGlobalIPv6PrefixLen()
Mask length of the global IPv6 address.
public
getGlobalIPv6PrefixLen() : int|null
Return values
int|null —getIPAddress()
IPv4 address.
public
getIPAddress() : string|null
Return values
string|null —getIPAMConfig()
EndpointIPAMConfig represents an endpoint's IPAM configuration.
public
getIPAMConfig() : EndpointIPAMConfig|null
Return values
EndpointIPAMConfig|null —getIPPrefixLen()
Mask length of the IPv4 address.
public
getIPPrefixLen() : int|null
Return values
int|null —getIPv6Gateway()
IPv6 gateway address.
public
getIPv6Gateway() : string|null
Return values
string|null —getLinks()
public
getLinks() : array<string|int, string>|null
Return values
array<string|int, string>|null —getMacAddress()
MAC address for the endpoint on this network.
public
getMacAddress() : string|null
Return values
string|null —getNetworkID()
Unique ID of the network.
public
getNetworkID() : string|null
Return values
string|null —setAliases()
public
setAliases(array<string|int, string>|null $aliases) : self
Parameters
- $aliases : array<string|int, string>|null
Return values
self —setDriverOpts()
DriverOpts is a mapping of driver options and values. These options.
public
setDriverOpts(array<string|int, string>|null $driverOpts) : self
Parameters
- $driverOpts : array<string|int, string>|null
Return values
self —setEndpointID()
Unique ID for the service endpoint in a Sandbox.
public
setEndpointID(string|null $endpointID) : self
Parameters
- $endpointID : string|null
Return values
self —setGateway()
Gateway address for this network.
public
setGateway(string|null $gateway) : self
Parameters
- $gateway : string|null
Return values
self —setGlobalIPv6Address()
Global IPv6 address.
public
setGlobalIPv6Address(string|null $globalIPv6Address) : self
Parameters
- $globalIPv6Address : string|null
Return values
self —setGlobalIPv6PrefixLen()
Mask length of the global IPv6 address.
public
setGlobalIPv6PrefixLen(int|null $globalIPv6PrefixLen) : self
Parameters
- $globalIPv6PrefixLen : int|null
Return values
self —setIPAddress()
IPv4 address.
public
setIPAddress(string|null $iPAddress) : self
Parameters
- $iPAddress : string|null
Return values
self —setIPAMConfig()
EndpointIPAMConfig represents an endpoint's IPAM configuration.
public
setIPAMConfig(EndpointIPAMConfig|null $iPAMConfig) : self
Parameters
- $iPAMConfig : EndpointIPAMConfig|null
Return values
self —setIPPrefixLen()
Mask length of the IPv4 address.
public
setIPPrefixLen(int|null $iPPrefixLen) : self
Parameters
- $iPPrefixLen : int|null
Return values
self —setIPv6Gateway()
IPv6 gateway address.
public
setIPv6Gateway(string|null $iPv6Gateway) : self
Parameters
- $iPv6Gateway : string|null
Return values
self —setLinks()
public
setLinks(array<string|int, string>|null $links) : self
Parameters
- $links : array<string|int, string>|null
Return values
self —setMacAddress()
MAC address for the endpoint on this network.
public
setMacAddress(string|null $macAddress) : self
Parameters
- $macAddress : string|null
Return values
self —setNetworkID()
Unique ID of the network.
public
setNetworkID(string|null $networkID) : self
Parameters
- $networkID : string|null