Skip to content

update_harness_endpoint

Operation

update_harness_endpoint

update_harness_endpoint(request: UpdateHarnessEndpointInput | UpdateHarnessEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateHarnessEndpointInputDict]) -> UpdateHarnessEndpointOutput

Operation to update a harness endpoint.

Parameters:

Name Type Description Default
request UpdateHarnessEndpointInput | UpdateHarnessEndpointInputDict | 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[UpdateHarnessEndpointInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateHarnessEndpointOutput

An instance of UpdateHarnessEndpointOutput.

update_harness_endpoint async

update_harness_endpoint(request: UpdateHarnessEndpointInput | UpdateHarnessEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateHarnessEndpointInputDict]) -> UpdateHarnessEndpointOutput

Operation to update a harness endpoint.

Parameters:

Name Type Description Default
request UpdateHarnessEndpointInput | UpdateHarnessEndpointInputDict | 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[UpdateHarnessEndpointInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateHarnessEndpointOutput

An instance of UpdateHarnessEndpointOutput.

Input

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

UpdateHarnessEndpointInputDict

Bases: TypedDict

Dictionary form of UpdateHarnessEndpointInput.

Attributes

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.

description instance-attribute
description: str | None

A description of the endpoint. If not specified, the existing value is retained.

endpoint_name instance-attribute
endpoint_name: Required[str]

The name of the endpoint to update.

harness_id instance-attribute
harness_id: Required[str]

The ID of the harness that the endpoint belongs to.

target_version instance-attribute
target_version: str | None

The harness version that the endpoint points to. If not specified, the existing value is retained.

UpdateHarnessEndpointInput dataclass

Bases: _SerdeShape

Dataclass for UpdateHarnessEndpointInput structure.

Attributes

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

A unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.

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

A description of the endpoint. If not specified, the existing value is retained.

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

The name of the endpoint to update.

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

The ID of the harness that the endpoint belongs to.

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

The harness version that the endpoint points to. If not specified, the existing value is retained.

Output

UpdateHarnessEndpointOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateHarnessEndpointOutput structure.

Attributes

endpoint instance-attribute
endpoint: HarnessEndpoint

The updated endpoint.

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.