get_base_path_mappings¶
Operation¶
get_base_path_mappings
¶
get_base_path_mappings(request: GetBasePathMappingsInput | GetBasePathMappingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBasePathMappingsInputDict]) -> GetBasePathMappingsOutput
Represents a collection of BasePathMapping resources.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetBasePathMappingsInput | GetBasePathMappingsInputDict | 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[GetBasePathMappingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetBasePathMappingsOutput
|
An instance of |
get_base_path_mappings
async
¶
get_base_path_mappings(request: GetBasePathMappingsInput | GetBasePathMappingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBasePathMappingsInputDict]) -> GetBasePathMappingsOutput
Represents a collection of BasePathMapping resources.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetBasePathMappingsInput | GetBasePathMappingsInputDict | 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[GetBasePathMappingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetBasePathMappingsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetBasePathMappingsInputDict
¶
Bases: TypedDict
Dictionary form of GetBasePathMappingsInput.
Attributes¶
domain_name
instance-attribute
¶
The domain name of a BasePathMapping resource.
domain_name_id
instance-attribute
¶
domain_name_id: str | None
The identifier for the domain name resource. Supported only for private custom domain names.
GetBasePathMappingsInput
dataclass
¶
Bases: _SerdeShape
A request to get information about a collection of BasePathMapping resources.
Attributes¶
domain_name
class-attribute
instance-attribute
¶
domain_name: str | None = ...
The domain name of a BasePathMapping resource.
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¶
GetBasePathMappingsOutput
dataclass
¶
Bases: _SerdeShape
Represents a collection of BasePathMapping resources.
Attributes¶
items
class-attribute
instance-attribute
¶
items: list[BasePathMapping] | None = ...
The current page of elements from this collection.
position
class-attribute
instance-attribute
¶
position: str | None = ...
The current pagination position in the paged result set.
response_metadata
class-attribute
instance-attribute
¶
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.