Skip to content

Endpoint

Source code in docs_src/capo_pcs/types/endpoint.py 
13
14
15
16
17
18
19
20
21
22
23
class Endpoint(TypedDict, closed=True):
    type: "capo_pcs.types.endpoint_type.EndpointType"
    """<p>Indicates the type of endpoint running at the specific IP address.</p>"""
    private_ip_address: "str"
    """<p>For clusters that use IPv4, this is the endpoint's private IP address.</p> <p>Example: <code>10.1.2.3</code> </p> <p>For clusters configured to use IPv6, this is an empty string.</p>"""
    public_ip_address: NotRequired["str"]
    """<p>The endpoint's public IP address.</p> <p>Example: <code>192.0.2.1</code> </p>"""
    ipv6_address: NotRequired["str"]
    """<p>The endpoint's IPv6 address.</p> <p>Example: <code>2001:db8::1</code> </p>"""
    port: "str"
    """<p>The endpoint's connection port number.</p> <p> Example: <code>1234</code> </p>"""

ipv6_address instance-attribute 

ipv6_address: NotRequired[str]

The endpoint's IPv6 address.

Example: 2001:db8::1

port instance-attribute 

port: str

The endpoint's connection port number.

Example: 1234

private_ip_address instance-attribute 

private_ip_address: str

For clusters that use IPv4, this is the endpoint's private IP address.

Example: 10.1.2.3

For clusters configured to use IPv6, this is an empty string.

public_ip_address instance-attribute 

public_ip_address: NotRequired[str]

The endpoint's public IP address.

Example: 192.0.2.1

type instance-attribute 

type: EndpointType

Indicates the type of endpoint running at the specific IP address.