Skip to content

delete_harness

Operation

delete_harness

delete_harness(request: DeleteHarnessInput | DeleteHarnessInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteHarnessInputDict]) -> DeleteHarnessOutput

Operation to delete a Harness.

Parameters:

Name Type Description Default
request DeleteHarnessInput | DeleteHarnessInputDict | 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[DeleteHarnessInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteHarnessOutput

An instance of DeleteHarnessOutput.

delete_harness async

delete_harness(request: DeleteHarnessInput | DeleteHarnessInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteHarnessInputDict]) -> DeleteHarnessOutput

Operation to delete a Harness.

Parameters:

Name Type Description Default
request DeleteHarnessInput | DeleteHarnessInputDict | 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[DeleteHarnessInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteHarnessOutput

An instance of DeleteHarnessOutput.

Input

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

DeleteHarnessInputDict

Bases: TypedDict

Dictionary form of DeleteHarnessInput.

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.

delete_managed_memory instance-attribute
delete_managed_memory: bool | None

Whether to delete the managed memory on harness deletion. Default: true. If false, the memory is disassociated and becomes a regular customer-owned resource.

harness_id instance-attribute
harness_id: Required[str]

The ID of the harness to delete.

DeleteHarnessInput dataclass

Bases: _SerdeShape

Dataclass for DeleteHarnessInput 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.

delete_managed_memory class-attribute instance-attribute
delete_managed_memory: bool | None = ...

Whether to delete the managed memory on harness deletion. Default: true. If false, the memory is disassociated and becomes a regular customer-owned resource.

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

The ID of the harness to delete.

Output

DeleteHarnessOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteHarnessOutput structure.

Attributes

harness class-attribute instance-attribute
harness: Harness | None = ...

The harness that was deleted.

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.