Skip to content

get_resources

Operation

get_resources

get_resources(request: GetResourcesInput | GetResourcesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourcesInputDict]) -> GetResourcesOutput

Lists information about a collection of Resource resources.

Parameters:

Name Type Description Default
request GetResourcesInput | GetResourcesInputDict | 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[GetResourcesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetResourcesOutput

An instance of GetResourcesOutput.

get_resources async

get_resources(request: GetResourcesInput | GetResourcesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourcesInputDict]) -> GetResourcesOutput

Lists information about a collection of Resource resources.

Parameters:

Name Type Description Default
request GetResourcesInput | GetResourcesInputDict | 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[GetResourcesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetResourcesOutput

An instance of GetResourcesOutput.

Input

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

GetResourcesInputDict

Bases: TypedDict

Dictionary form of GetResourcesInput.

Attributes

embed instance-attribute
embed: Sequence[str] | None

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

limit instance-attribute
limit: int | None

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position instance-attribute
position: str | None

The current pagination position in the paged result set.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

GetResourcesInput dataclass

Bases: _SerdeShape

Request to list information about a collection of resources.

Attributes

embed class-attribute instance-attribute
embed: list[str] | None = ...

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

limit class-attribute instance-attribute
limit: int | None = ...

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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

The current pagination position in the paged result set.

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

The string identifier of the associated RestApi.

Output

GetResourcesOutput dataclass

Bases: _SerdeShape

Represents a collection of Resource resources.

Attributes

items class-attribute instance-attribute
items: list[Resource] | 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
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.