Skip to content

GetLinkResponse

Source code in docs_src/capo_rtbfabric/types/get_link_response.py
class GetLinkResponse(TypedDict, closed=True):
    gateway_id: "capo_rtbfabric.types.gateway_id.GatewayId"
    """<p>The unique identifier of the gateway.</p>"""
    peer_gateway_id: "capo_rtbfabric.types.gateway_id.GatewayId"
    """<p>The unique identifier of the peer gateway.</p>"""
    status: "capo_rtbfabric.types.link_status.LinkStatus"
    """<p>The status of the link.</p>"""
    created_at: "datetime.datetime"
    """<p>The timestamp of when the link was created.</p>"""
    updated_at: "datetime.datetime"
    """<p>The timestamp of when the link was updated.</p>"""
    direction: NotRequired["capo_rtbfabric.types.link_direction.LinkDirection"]
    """<p>The direction of the link.</p>"""
    flow_modules: NotRequired[
        "capo_rtbfabric.types.module_configuration_list.ModuleConfigurationList"
    ]
    """<p>The configuration of flow modules.</p>"""
    pending_flow_modules: NotRequired[
        "capo_rtbfabric.types.module_configuration_list.ModuleConfigurationList"
    ]
    """<p>The configuration of pending flow modules.</p>"""
    attributes: NotRequired["capo_rtbfabric.types.link_attributes.LinkAttributes"]
    """<p>Attributes of the link.</p>"""
    log_settings: NotRequired["capo_rtbfabric.types.link_log_settings.LinkLogSettings"]
    """<p>Settings for the application logs.</p>"""
    connectivity_type: NotRequired[
        "capo_rtbfabric.types.connectivity_type.ConnectivityType"
    ]
    """<p>The connectivity type of the link.</p>"""
    link_id: "capo_rtbfabric.types.link_id.LinkId"
    """<p>The unique identifier of the link.</p>"""
    tags: NotRequired["capo_rtbfabric.types.tags_map.TagsMap"]
    """<p>A map of the key-value pairs for the tag or tags assigned to the specified resource.</p>"""
    http_responder_allowed: NotRequired["bool"]
    """<p>Boolean to specify if an HTTP responder is allowed.</p>"""
    timeout_in_millis: NotRequired[
        "capo_rtbfabric.types.link_timeout_in_millis.LinkTimeoutInMillis"
    ]
    """<p>The timeout value in milliseconds.</p>"""
attributes: NotRequired[LinkAttributes]

Attributes of the link.

connectivity_type: NotRequired[ConnectivityType]

The connectivity type of the link.

created_at: datetime

The timestamp of when the link was created.

direction: NotRequired[LinkDirection]

The direction of the link.

flow_modules: NotRequired[ModuleConfigurationList]

The configuration of flow modules.

gateway_id: GatewayId

The unique identifier of the gateway.

http_responder_allowed: NotRequired[bool]

Boolean to specify if an HTTP responder is allowed.

link_id: LinkId

The unique identifier of the link.

log_settings: NotRequired[LinkLogSettings]

Settings for the application logs.

peer_gateway_id: GatewayId

The unique identifier of the peer gateway.

pending_flow_modules: NotRequired[ModuleConfigurationList]

The configuration of pending flow modules.

status: LinkStatus

The status of the link.

tags: NotRequired[TagsMap]

A map of the key-value pairs for the tag or tags assigned to the specified resource.

timeout_in_millis: NotRequired[LinkTimeoutInMillis]

The timeout value in milliseconds.

updated_at: datetime

The timestamp of when the link was updated.