de.gesellix.docker.remote.api.SwarmJoinRequest.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docker-remote-api-model-1-45 Show documentation
API model for the Docker remote api v1.45
There is a newer version: 2024-11-04T20-53-00
Show newest version
/**
 *
 * Please note:
 * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit this file manually.
 *
 */

@file:Suppress(
    "ArrayInDataClass",
    "EnumEntryName",
    "RemoveRedundantQualifierName",
    "UnusedImport",
)

package de.gesellix.docker.remote.api

import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass

/**
 *
 *
 * @param listenAddr Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP).
 * @param advertiseAddr Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible.
 * @param dataPathAddr Address or interface to use for data path traffic (format: ``), for example,  `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used.  The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster.
 * @param remoteAddrs Addresses of manager nodes already participating in the swarm.
 * @param joinToken Secret token for joining this swarm.
 */
@JsonClass(generateAdapter = true)
data class SwarmJoinRequest(
    // Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP).
    @Json(name = "ListenAddr")
    var listenAddr: kotlin.String? = null,
    // Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible.
    @Json(name = "AdvertiseAddr")
    var advertiseAddr: kotlin.String? = null,
    // Address or interface to use for data path traffic (format: ``), for example,  `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used.  The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster.
    @Json(name = "DataPathAddr")
    var dataPathAddr: kotlin.String? = null,
    // Addresses of manager nodes already participating in the swarm.
    @Json(name = "RemoteAddrs")
    var remoteAddrs: kotlin.collections.MutableList? = null,
    // Secret token for joining this swarm.
    @Json(name = "JoinToken")
    var joinToken: kotlin.String? = null,
)