Mixins

endpointSubset

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: { Addresses: [{“ip”: “10.10.1.1”}, {“ip”: “10.10.2.2”}], Ports: [{“name”: “a”, “port”: 8675}, {“name”: “b”, “port”: 309}] } The resulting set of endpoints can be viewed as: a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]

Constuctors

Functions
  • withAddresses

    withAddresses(addresses)
    

    IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.

    withAddresses takes an array of type addressesType. You can create an instance of addressesType with hidden.core.v1.endpointAddress.new().

    see hidden.core.v1.endpointAddress


  • withAddressesMixin

    withAddressesMixin(addresses)
    

    IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.

    withAddressesMixin takes an array of type addressesType. You can create an instance of addressesType with hidden.core.v1.endpointAddress.new().

    see hidden.core.v1.endpointAddress


  • withNotReadyAddresses

    withNotReadyAddresses(notReadyAddresses)
    

    IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.

    withNotReadyAddresses takes an array of type notReadyAddressesType. You can create an instance of notReadyAddressesType with hidden.core.v1.endpointAddress.new().

    see hidden.core.v1.endpointAddress


  • withNotReadyAddressesMixin

    withNotReadyAddressesMixin(notReadyAddresses)
    

    IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.

    withNotReadyAddressesMixin takes an array of type notReadyAddressesType. You can create an instance of notReadyAddressesType with hidden.core.v1.endpointAddress.new().

    see hidden.core.v1.endpointAddress


  • withPorts

    withPorts(ports)
    

    Port numbers available on the related IP addresses.

    withPorts takes an array of type portsType. You can create an instance of portsType with hidden.core.v1.endpointPort.new().

    see hidden.core.v1.endpointPort


  • withPortsMixin

    withPortsMixin(ports)
    

    Port numbers available on the related IP addresses.

    withPortsMixin takes an array of type portsType. You can create an instance of portsType with hidden.core.v1.endpointPort.new().

    see hidden.core.v1.endpointPort