Skip to content

get_harness

Operation

get_harness

get_harness(request: GetHarnessInput | GetHarnessInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetHarnessInputDict]) -> GetHarnessOutput

Operation to get a single harness.

Parameters:

Name Type Description Default
request GetHarnessInput | GetHarnessInputDict | 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[GetHarnessInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetHarnessOutput

An instance of GetHarnessOutput.

get_harness async

get_harness(request: GetHarnessInput | GetHarnessInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetHarnessInputDict]) -> GetHarnessOutput

Operation to get a single harness.

Parameters:

Name Type Description Default
request GetHarnessInput | GetHarnessInputDict | 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[GetHarnessInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetHarnessOutput

An instance of GetHarnessOutput.

Input

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

GetHarnessInputDict

Bases: TypedDict

Dictionary form of GetHarnessInput.

Attributes

harness_id instance-attribute
harness_id: Required[str]

The ID of the harness to retrieve.

harness_version instance-attribute
harness_version: str | None

Specific version of the harness to retrieve. If omitted, returns the current Harness configuration, including its status.

GetHarnessInput dataclass

Bases: _SerdeShape

Dataclass for GetHarnessInput structure.

Attributes

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

The ID of the harness to retrieve.

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

Specific version of the harness to retrieve. If omitted, returns the current Harness configuration, including its status.

Output

GetHarnessOutput dataclass

Bases: _SerdeShape

Dataclass for GetHarnessOutput structure.

Attributes

harness instance-attribute
harness: Harness

The harness resource.

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.