RssClient
Attributes
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewFeed': {'operation_id': 'OnNewFeed', 'path': '/{connectionId}/OnNewFeed', 'method': 'get', 'required_parameters': ['feedUrl'], 'callback_payload_type': 'TriggerBatchResponseFeedItem'}}
Classes
dataclass
dataclass
FeedItem(title: str, *, id: Optional[str] = None, primary_link: Optional[str] = None, links: Optional[List[str]] = None, updated_on: Optional[str] = None, publish_date: Optional[str] = None, summary: Optional[str] = None, copyright: Optional[str] = None, categories: Optional[List[str]] = None)
Response for List all RSS feed items
Attributes
class-attribute
instance-attribute
Feed ID
class-attribute
instance-attribute
primary_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'primaryLink'})
Primary feed link
class-attribute
instance-attribute
Feed links
class-attribute
instance-attribute
updated_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'updatedOn'})
Feed updated on
class-attribute
instance-attribute
publish_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'publishDate'})
Feed published date
class-attribute
instance-attribute
Feed item summary
class-attribute
instance-attribute
Copyright information
RssClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for rss connector.
Initialize a RssClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
list_feed_items(feed_url: str, *, since: Optional[str] = None, since_property: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List all RSS feed items
This operation retrieves all items from an RSS feed.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListFeedItems.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
feed_url
|
str
|
The RSS feed URL (Example: http://rss.cnn.com/rss/cnn_topstories.rss). |
required |
since
|
Optional[str]
|
The date since when RSS feed should be retrieved (Example: 2018-12-29 10:24:05Z). |
None
|
since_property
|
Optional[str]
|
Chosen property will be used for trigger state. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |