Skip to content

test_connection_function

Operation

test_connection_function

test_connection_function(request: TestConnectionFunctionInput | TestConnectionFunctionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TestConnectionFunctionInputDict]) -> TestConnectionFunctionOutput

Tests a connection function.

Parameters:

Name Type Description Default
request TestConnectionFunctionInput | TestConnectionFunctionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[TestConnectionFunctionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
TestConnectionFunctionOutput

An instance of TestConnectionFunctionOutput.

test_connection_function async

test_connection_function(request: TestConnectionFunctionInput | TestConnectionFunctionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TestConnectionFunctionInputDict]) -> TestConnectionFunctionOutput

Tests a connection function.

Parameters:

Name Type Description Default
request TestConnectionFunctionInput | TestConnectionFunctionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[TestConnectionFunctionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
TestConnectionFunctionOutput

An instance of TestConnectionFunctionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

TestConnectionFunctionInputDict

Bases: TypedDict

Dictionary form of TestConnectionFunctionInput.

Attributes

connection_object instance-attribute
connection_object: Required[bytes]

The connection object.

id instance-attribute

The connection function ID.

if_match instance-attribute
if_match: Required[str]

The current version (ETag value) of the connection function.

stage instance-attribute
stage: str | None

The connection function stage.

TestConnectionFunctionInput dataclass

Bases: _SerdeShape

Dataclass for TestConnectionFunctionInput structure.

Attributes

connection_object class-attribute instance-attribute
connection_object: bytes | None = ...

The connection object.

id class-attribute instance-attribute
id: str | None = ...

The connection function ID.

if_match class-attribute instance-attribute
if_match: str | None = ...

The current version (ETag value) of the connection function.

stage class-attribute instance-attribute
stage: str | None = ...

The connection function stage.

Output

TestConnectionFunctionOutput dataclass

Bases: _SerdeShape

Dataclass for TestConnectionFunctionOutput structure.

Attributes

connection_function_test_result class-attribute instance-attribute
connection_function_test_result: ConnectionFunctionTestResult | None = ...

The connection function test result.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.