Skip to content

CreateLinkRequest

Source code in docs_src/capo_rtbfabric/types/create_link_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class CreateLinkRequest(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>"""
    attributes: NotRequired["capo_rtbfabric.types.link_attributes.LinkAttributes"]
    """<p>Attributes of the link.</p>"""
    http_responder_allowed: NotRequired["bool"]
    """<p>Boolean to specify if an HTTP responder is allowed.</p>"""
    tags: NotRequired["capo_rtbfabric.types.tags_map.TagsMap"]
    """<p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>"""
    log_settings: "capo_rtbfabric.types.link_log_settings.LinkLogSettings"
    """<p>Application log settings for the link. This value is required. Under <code>applicationLogs.sampling</code>, the <code>errorLog</code> and <code>filterLog</code> fields set the percentage of eligible events to log. Valid values range from <code>0</code> through <code>100</code>. To turn off application logs, set both fields to <code>0</code>, as in <code>{"applicationLogs":{"sampling":{"errorLog":0,"filterLog":0}}}</code>.</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.

gateway_id: GatewayId

The unique identifier of the gateway.

http_responder_allowed: NotRequired[bool]

Boolean to specify if an HTTP responder is allowed.

log_settings: LinkLogSettings

Application log settings for the link. This value is required. Under applicationLogs.sampling, the errorLog and filterLog fields set the percentage of eligible events to log. Valid values range from 0 through 100. To turn off application logs, set both fields to 0, as in {"applicationLogs":{"sampling":{"errorLog":0,"filterLog":0}}}.

peer_gateway_id: GatewayId

The unique identifier of the peer gateway.

tags: NotRequired[TagsMap]

A map of the key-value pairs of the tag or tags to assign to the resource.

timeout_in_millis: NotRequired[LinkTimeoutInMillis]

The timeout value in milliseconds.