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 |
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 |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
TestConnectionFunctionInput
dataclass
¶
Bases: _SerdeShape
Dataclass for TestConnectionFunctionInput structure.
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
¶
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.