Interface EndpointSubset

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    EndpointSubset.Jsii$Proxy

    @Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
               date="2022-09-13T15:58:19.835Z")
    @Stability(Stable)
    public interface EndpointSubset
    extends software.amazon.jsii.JsiiSerializable
    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 ]

    • Method Detail

      • getAddresses

        @Stability(Stable)
        @Nullable
        default List<EndpointAddress> getAddresses()
        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.

      • getNotReadyAddresses

        @Stability(Stable)
        @Nullable
        default List<EndpointAddress> getNotReadyAddresses()
        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.
      • getPorts

        @Stability(Stable)
        @Nullable
        default List<EndpointPort> getPorts()
        Port numbers available on the related IP addresses.