Skip to content

delete_base_path_mapping

Operation

delete_base_path_mapping

delete_base_path_mapping(request: DeleteBasePathMappingInput | DeleteBasePathMappingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteBasePathMappingInputDict]) -> DeleteBasePathMappingOutput

Deletes the BasePathMapping resource.

Parameters:

Name Type Description Default
request DeleteBasePathMappingInput | DeleteBasePathMappingInputDict | 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[DeleteBasePathMappingInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteBasePathMappingOutput

An instance of DeleteBasePathMappingOutput.

delete_base_path_mapping async

delete_base_path_mapping(request: DeleteBasePathMappingInput | DeleteBasePathMappingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteBasePathMappingInputDict]) -> DeleteBasePathMappingOutput

Deletes the BasePathMapping resource.

Parameters:

Name Type Description Default
request DeleteBasePathMappingInput | DeleteBasePathMappingInputDict | 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[DeleteBasePathMappingInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteBasePathMappingOutput

An instance of DeleteBasePathMappingOutput.

Input

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

DeleteBasePathMappingInputDict

Bases: TypedDict

Dictionary form of DeleteBasePathMappingInput.

Attributes

base_path instance-attribute
base_path: Required[str]

The base path name of the BasePathMapping resource to delete.

To specify an empty base path, set this parameter to '(none)'.

domain_name instance-attribute
domain_name: Required[str]

The domain name of the BasePathMapping resource to delete.

domain_name_id instance-attribute
domain_name_id: str | None

The identifier for the domain name resource. Supported only for private custom domain names.

DeleteBasePathMappingInput dataclass

Bases: _SerdeShape

A request to delete the BasePathMapping resource.

Attributes

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

The base path name of the BasePathMapping resource to delete.

To specify an empty base path, set this parameter to '(none)'.

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

The domain name of the BasePathMapping resource to delete.

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

The identifier for the domain name resource. Supported only for private custom domain names.

Output

DeleteBasePathMappingOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteBasePathMappingOutput structure.

Attributes

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.