Skip to content

get_harness_endpoint

Operation

get_harness_endpoint

get_harness_endpoint(request: GetHarnessEndpointInput | GetHarnessEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetHarnessEndpointInputDict]) -> GetHarnessEndpointOutput

Operation to get a single harness endpoint.

Parameters:

Name Type Description Default
request GetHarnessEndpointInput | GetHarnessEndpointInputDict | 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[GetHarnessEndpointInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetHarnessEndpointOutput

An instance of GetHarnessEndpointOutput.

get_harness_endpoint async

get_harness_endpoint(request: GetHarnessEndpointInput | GetHarnessEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetHarnessEndpointInputDict]) -> GetHarnessEndpointOutput

Operation to get a single harness endpoint.

Parameters:

Name Type Description Default
request GetHarnessEndpointInput | GetHarnessEndpointInputDict | 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[GetHarnessEndpointInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetHarnessEndpointOutput

An instance of GetHarnessEndpointOutput.

Input

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

GetHarnessEndpointInputDict

Bases: TypedDict

Dictionary form of GetHarnessEndpointInput.

Attributes

endpoint_name instance-attribute
endpoint_name: Required[str]

The name of the endpoint to retrieve.

harness_id instance-attribute
harness_id: Required[str]

The ID of the harness that the endpoint belongs to.

GetHarnessEndpointInput dataclass

Bases: _SerdeShape

Dataclass for GetHarnessEndpointInput structure.

Attributes

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

The name of the endpoint to retrieve.

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

The ID of the harness that the endpoint belongs to.

Output

GetHarnessEndpointOutput dataclass

Bases: _SerdeShape

Dataclass for GetHarnessEndpointOutput structure.

Attributes

endpoint instance-attribute
endpoint: HarnessEndpoint

The endpoint 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.