OData Class

Properties   Methods   Events   Config Settings   Errors  

The OData class implements the Open Data Protocol (OData). It can be used to query, parse, and update or modify data contained within an OData service.

Syntax

class ipworks.OData

Remarks

The OData Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL-related settings are also supported through the config method.

The OData component allows you to easily query OData services and create, update, and delete entries within a service. To query a service, you can set the service_root_uri to the service's root URI and resource_path to the collection within the service that you wish to query. Optionally you can set the Query*** properties to filter the results. query_service can then be called to retrieve the results (which can be viewed via the Entry*** properties).

Example 1. Query a Service: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products" OData1.QueryService()

To create a new entry, you can set the service_root_uri to the service's root URI and resource_path to the collection within the service that you wish to add the entry to. The Entry*** properties can be set to the values you wish to use to create the entry. create_entry can then be called to create the entry.

Example 2. Create a New Entry: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products" OData1.EntryProperties OData1.CreateEntry()

If you wish to update an entry, you can set the service_root_uri to the service's root URI and resource_path to the specific entry you wish to update. The Entry*** properties can be set to the values you wish to update. update_entry can then be called to update the entry.

Example 3. Update an Entry: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products(1)" // Index 1 is the "Name" property. OData1.EntryProperties[1].Value = "MyNewName" OData1.UpdateEntry()

Deleting an entry requires that you first set the service_root_uri to the service's root URI and resource_path to the specific entry you wish to delete. delete_entry can then be called to delete the entry.

Example 4. Delete an Entry: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products(1)" OData1.DeleteEntry()

In addition to querying a service and manipulating its containing data, the OData component also allows you to retrieve the schema (metadata document) to determine the structure of a service. After setting service_root_uri to the root URI of the service, get_schema can be called to retrieve the metadata document. The Schema*** properties will be populated upon successful retrieval of the metadata document allowing you to identify the structure of the service.

Example 5. Retrieve the Scheme: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.GetSchema()

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

authorization Property

This property includes the Authorization string to be sent to the server.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

Default Value

""

Remarks

If the authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".

auth_scheme Property

This property specifies the authentication scheme to use when server authentication is required.

Syntax

def get_auth_scheme() -> int: ...
def set_auth_scheme(value: int) -> None: ...

auth_scheme = property(get_auth_scheme, set_auth_scheme)

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the user and password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the user and password properties are set, the class will attempt HTTP Basic Authentication. If auth_scheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If auth_scheme is set to authProprietary (2), then the authorization token must be supplied through the authorization property.

If auth_scheme is set to authOAuth (6), then the authorization string must be supplied through the authorization property.

Note: If you set the authorization property and auth_scheme is not authProprietary or authOAuth, then the auth_scheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of user, password, and Authorization.

channel_author_email Property

This property contains the email address of the author.

Syntax

def get_channel_author_email() -> str: ...
def set_channel_author_email(value: str) -> None: ...

channel_author_email = property(get_channel_author_email, set_channel_author_email)

Default Value

""

Remarks

This property contains the email address of the author.

channel_author_name Property

This property contains the name of the author.

Syntax

def get_channel_author_name() -> str: ...
def set_channel_author_name(value: str) -> None: ...

channel_author_name = property(get_channel_author_name, set_channel_author_name)

Default Value

""

Remarks

This property contains the name of the author.

channel_author_uri Property

This property contains the uniform resource identifier (URI) of the author.

Syntax

def get_channel_author_uri() -> str: ...
def set_channel_author_uri(value: str) -> None: ...

channel_author_uri = property(get_channel_author_uri, set_channel_author_uri)

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the author.

channel_category_label Property

This property contains a textual description of the label for the category.

Syntax

def get_channel_category_label() -> str: ...
def set_channel_category_label(value: str) -> None: ...

channel_category_label = property(get_channel_category_label, set_channel_category_label)

Default Value

""

Remarks

This property contains a textual description of the label for the category.

channel_category_scheme Property

This property identifies a categorization scheme.

Syntax

def get_channel_category_scheme() -> str: ...
def set_channel_category_scheme(value: str) -> None: ...

channel_category_scheme = property(get_channel_category_scheme, set_channel_category_scheme)

Default Value

""

Remarks

This property identifies a categorization scheme.

channel_category_term Property

This property contains the category to which the entry or feed belongs.

Syntax

def get_channel_category_term() -> str: ...
def set_channel_category_term(value: str) -> None: ...

channel_category_term = property(get_channel_category_term, set_channel_category_term)

Default Value

""

Remarks

This property contains the category to which the entry or feed belongs.

channel_contributor_email Property

This property contains the email address of the contributor.

Syntax

def get_channel_contributor_email() -> str: ...
def set_channel_contributor_email(value: str) -> None: ...

channel_contributor_email = property(get_channel_contributor_email, set_channel_contributor_email)

Default Value

""

Remarks

This property contains the email address of the contributor.

channel_contributor_name Property

This property contains the name of the contributor.

Syntax

def get_channel_contributor_name() -> str: ...
def set_channel_contributor_name(value: str) -> None: ...

channel_contributor_name = property(get_channel_contributor_name, set_channel_contributor_name)

Default Value

""

Remarks

This property contains the name of the contributor.

channel_contributor_uri Property

This property contains the uniform resource identifier (URI) of the contributor.

Syntax

def get_channel_contributor_uri() -> str: ...
def set_channel_contributor_uri(value: str) -> None: ...

channel_contributor_uri = property(get_channel_contributor_uri, set_channel_contributor_uri)

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the contributor.

channel_generator Property

This property identifies the generator of the feed.

Syntax

def get_channel_generator() -> str: ...
def set_channel_generator(value: str) -> None: ...

channel_generator = property(get_channel_generator, set_channel_generator)

Default Value

""

Remarks

This property identifies the generator of the feed.

channel_icon Property

This property contains a reference to the image that represents this feed.

Syntax

def get_channel_icon() -> str: ...
def set_channel_icon(value: str) -> None: ...

channel_icon = property(get_channel_icon, set_channel_icon)

Default Value

""

Remarks

This property contains a reference to the image that represents this feed.

channel_id Property

The Id conveys a permanent, universally unique identifier for an entry or feed.

Syntax

def get_channel_id() -> str: ...
def set_channel_id(value: str) -> None: ...

channel_id = property(get_channel_id, set_channel_id)

Default Value

""

Remarks

The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an IRI as defined by RFC 3987.

channel_link_href Property

This property contains the location of the link.

Syntax

def get_channel_link_href() -> str: ...
def set_channel_link_href(value: str) -> None: ...

channel_link_href = property(get_channel_link_href, set_channel_link_href)

Default Value

""

Remarks

This property contains the location of the link.

channel_link_href_lang Property

This property contains the language of the content at the link.

Syntax

def get_channel_link_href_lang() -> str: ...
def set_channel_link_href_lang(value: str) -> None: ...

channel_link_href_lang = property(get_channel_link_href_lang, set_channel_link_href_lang)

Default Value

""

Remarks

This property contains the language of the content at the link.

channel_link_length Property

This property contains the length (in bytes) of the content at the link.

Syntax

def get_channel_link_length() -> str: ...
def set_channel_link_length(value: str) -> None: ...

channel_link_length = property(get_channel_link_length, set_channel_link_length)

Default Value

""

Remarks

This property contains the length (in bytes) of the content at the link.

channel_link_rel Property

This property indicates the relation of the linked content to the feed.

Syntax

def get_channel_link_rel() -> str: ...
def set_channel_link_rel(value: str) -> None: ...

channel_link_rel = property(get_channel_link_rel, set_channel_link_rel)

Default Value

""

Remarks

This property indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287:

• alternate
• related
• self
• enclosure
• via

channel_link_title Property

This property contains the title of the link.

Syntax

def get_channel_link_title() -> str: ...
def set_channel_link_title(value: str) -> None: ...

channel_link_title = property(get_channel_link_title, set_channel_link_title)

Default Value

""

Remarks

This property contains the title of the link.

channel_link_type Property

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

Syntax

def get_channel_link_type() -> str: ...
def set_channel_link_type(value: str) -> None: ...

channel_link_type = property(get_channel_link_type, set_channel_link_type)

Default Value

""

Remarks

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

channel_logo Property

This property contains the logo for an image that represents the feed.

Syntax

def get_channel_logo() -> str: ...
def set_channel_logo(value: str) -> None: ...

channel_logo = property(get_channel_logo, set_channel_logo)

Default Value

""

Remarks

This property contains the logo for an image that represents the feed.

channel_rights Property

This property contains information about the rights of the given feed.

Syntax

def get_channel_rights() -> str: ...
def set_channel_rights(value: str) -> None: ...

channel_rights = property(get_channel_rights, set_channel_rights)

Default Value

""

Remarks

This property contains information about the rights of the given feed.

channel_rights_text_type Property

This property contains the text type of the rights of the feed.

Syntax

def get_channel_rights_text_type() -> int: ...
def set_channel_rights_text_type(value: int) -> None: ...

channel_rights_text_type = property(get_channel_rights_text_type, set_channel_rights_text_type)

Default Value

0

Remarks

This property contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.

channel_subtitle Property

This property contains a short description of the Atom feed.

Syntax

def get_channel_subtitle() -> str: ...
def set_channel_subtitle(value: str) -> None: ...

channel_subtitle = property(get_channel_subtitle, set_channel_subtitle)

Default Value

""

Remarks

This property contains a short description of the Atom feed.

channel_subtitle_text_type Property

This property contains the text type of the subtitle of the feed.

Syntax

def get_channel_subtitle_text_type() -> int: ...
def set_channel_subtitle_text_type(value: int) -> None: ...

channel_subtitle_text_type = property(get_channel_subtitle_text_type, set_channel_subtitle_text_type)

Default Value

0

Remarks

This property contains the text type of the subtitle of the feed. Atom textual content can be HTML, XHTML, or text.

channel_title Property

This property contains the title of the current Atom feed.

Syntax

def get_channel_title() -> str: ...
def set_channel_title(value: str) -> None: ...

channel_title = property(get_channel_title, set_channel_title)

Default Value

""

Remarks

This property contains the title of the current Atom feed. Typically, the title of the channel is similar to that of the web page where the Atom content is hosted.

channel_title_text_type Property

This property contains the text type of the title of the feed.

Syntax

def get_channel_title_text_type() -> int: ...
def set_channel_title_text_type(value: int) -> None: ...

channel_title_text_type = property(get_channel_title_text_type, set_channel_title_text_type)

Default Value

0

Remarks

This property contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.

channel_updated Property

This property contains the date and time that the feed was updated.

Syntax

def get_channel_updated() -> str: ...
def set_channel_updated(value: str) -> None: ...

channel_updated = property(get_channel_updated, set_channel_updated)

Default Value

""

Remarks

This property contains the date and time that the feed was updated.

cookie_count Property

The number of records in the Cookie arrays.

Syntax

def get_cookie_count() -> int: ...
def set_cookie_count(value: int) -> None: ...

cookie_count = property(get_cookie_count, set_cookie_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• cookie_domain
• cookie_expiration
• cookie_name
• cookie_path
• cookie_secure
• cookie_value

The array indices start at 0 and end at cookie_count - 1.

cookie_domain Property

This is the domain of a received cookie.

Syntax

def get_cookie_domain(cookie_index: int) -> str: ...

Default Value

""

Remarks

This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_expiration Property

This property contains an expiration time for the cookie (if provided by the server).

Syntax

def get_cookie_expiration(cookie_index: int) -> str: ...

Default Value

""

Remarks

This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_name Property

This property, contains the name of the cookie.

Syntax

def get_cookie_name(cookie_index: int) -> str: ...
def set_cookie_name(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property, contains the name of the cookie.

This property, along with cookie_value, stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

cookie_path Property

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

def get_cookie_path(cookie_index: int) -> str: ...

Default Value

""

Remarks

This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_secure Property

This property contains the security flag of the received cookie.

Syntax

def get_cookie_secure(cookie_index: int) -> bool: ...

Default Value

FALSE

Remarks

This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_value Property

This property contains the value of the cookie.

Syntax

def get_cookie_value(cookie_index: int) -> str: ...
def set_cookie_value(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the cookie. A corresponding value is associated with the cookie specified by cookie_name. This property holds that value.

The on_set_cookie event provides the cookies set by the server.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

entry_author Property

This property includes the author of the current entry in an OData feed.

Syntax

def get_entry_author() -> str: ...
def set_entry_author(value: str) -> None: ...

entry_author = property(get_entry_author, set_entry_author)

Default Value

""

Remarks

This property contains the author of the specified entry within an OData feed. This value will be populated once entry_index is set (provided that an author can be found).

This property is not applicable to OData V4 feeds.

entry_count Property

This property includes the number of entries contained within an OData feed.

Syntax

def get_entry_count() -> int: ...

entry_count = property(get_entry_count, None)

Default Value

0

Remarks

This property is updated to reflect the total number of entries returned within a response (whether you are retrieving a feed/entry or making changes to a feed/entry).

This property is read-only.

entry_e_tag Property

This property includes the ETag of the current entry in an OData feed.

Syntax

def get_entry_e_tag() -> str: ...
def set_entry_e_tag(value: str) -> None: ...

entry_e_tag = property(get_entry_e_tag, set_entry_e_tag)

Default Value

""

Remarks

This property is used to obtain the ETag of the specified entry within an OData feed and will be populated once the entry_index is set.

This property is also used when retrieving, updating, or deleting an entry. When EntryETag contains a nonempty string, an If-None-Match header will be sent with the entered value when query_service is called. When delete_entry or update_entry is called, an If-Match header will be sent with the entered value.

entry_id Property

This property includes the Id of the current entry in an OData feed.

Syntax

def get_entry_id() -> str: ...
def set_entry_id(value: str) -> None: ...

entry_id = property(get_entry_id, set_entry_id)

Default Value

""

Remarks

This property contains the Id of the specified entry within an OData feed. This value will be populated once entry_index is set (provided that an Id can be found).

entry_index Property

This property includes the index of the current entry in an OData feed.

Syntax

def get_entry_index() -> int: ...
def set_entry_index(value: int) -> None: ...

entry_index = property(get_entry_index, set_entry_index)

Default Value

-1

Remarks

This property is used to specify an entry within a retrieved OData feed. Once set, entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path will be populated with their respective values found within the entry.

This property takes index values from 0 to entry_count -1.

Setting EntryIndex to -1 will clear the entries contained by the component and also will reset entry_properties and entry_count.

entry_links_count Property

The number of records in the EntryLinks arrays.

Syntax

def get_entry_links_count() -> int: ...
def set_entry_links_count(value: int) -> None: ...

entry_links_count = property(get_entry_links_count, set_entry_links_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• entry_links_resource_path
• entry_links_title

The array indices start at 0 and end at entry_links_count - 1.

entry_links_resource_path Property

This property contains the resource path of the OData entry element link.

Syntax

def get_entry_links_resource_path(entry_links_index: int) -> str: ...

Default Value

""

Remarks

This property contains the resource path of the OData entry element link.

By setting this value to resource_path and calling query_service, you can retrieve the related entries of the current entry (as specified by entry_index).

The entry_links_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_links_count property.

This property is read-only.

entry_links_title Property

This property contains the title of the OData entry element link.

Syntax

def get_entry_links_title(entry_links_index: int) -> str: ...

Default Value

""

Remarks

This property contains the title of the OData entry element link.

The entry_links_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_links_count property.

This property is read-only.

entry_properties_count Property

The number of records in the EntryProperties arrays.

Syntax

def get_entry_properties_count() -> int: ...
def set_entry_properties_count(value: int) -> None: ...

entry_properties_count = property(get_entry_properties_count, set_entry_properties_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• entry_properties_attributes
• entry_properties_is_null
• entry_properties_name
• entry_properties_type
• entry_properties_value
• entry_properties_xpath

The array indices start at 0 and end at entry_properties_count - 1.

entry_properties_attributes Property

This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element.

Syntax

def get_entry_properties_attributes(entry_properties_index: int) -> str: ...
def set_entry_properties_attributes(entry_properties_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element. Such as name1="value1" name2="value2".

The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.

entry_properties_is_null Property

This property indicates whether a property value of a primitive type is null.

Syntax

def get_entry_properties_is_null(entry_properties_index: int) -> bool: ...
def set_entry_properties_is_null(entry_properties_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

This property indicates whether a property value of a primitive type is null.

The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.

entry_properties_name Property

This property contains the name of the OData entry element.

Syntax

def get_entry_properties_name(entry_properties_index: int) -> str: ...
def set_entry_properties_name(entry_properties_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the name of the OData entry element.

Note: For properties derived from a complex type, the name of the property and its subproperty will be separated by a slash (/). For example, let's say you have a property called MailingAddress that is derived from a complex type called Address. The Address complex type contains a property called City. This particular property will be returned as MailingAddress/City.

Setting this property to an empty string before calling update_entry will result in the item not being sent in the update request, thus removing it from the OData entry.

The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.

entry_properties_type Property

This property contains the type of the OData schema property.

Syntax

def get_entry_properties_type(entry_properties_index: int) -> str: ...
def set_entry_properties_type(entry_properties_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the type of the OData schema property.

The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.

entry_properties_value Property

This property contains the value of the OData entry element.

Syntax

def get_entry_properties_value(entry_properties_index: int) -> str: ...
def set_entry_properties_value(entry_properties_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the OData entry element.

The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.

entry_properties_xpath Property

This property contains the XPath of the OData entry property.

Syntax

def get_entry_properties_xpath(entry_properties_index: int) -> str: ...

Default Value

""

Remarks

This property contains the XPath of the OData entry property. This value can be used to set xpath or can be used within update_property to update a specific property.

The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.

This property is read-only.

entry_summary Property

This property includes a summary of the current entry in an OData feed.

Syntax

def get_entry_summary() -> str: ...
def set_entry_summary(value: str) -> None: ...

entry_summary = property(get_entry_summary, set_entry_summary)

Default Value

""

Remarks

This property contains the summary of a specified entry within an OData feed. This value will be populated once entry_index is set (provided that a summary can be found).

This property is not applicable to OData V4 feeds.

entry_title Property

This property includes the title of the current entry in an OData feed.

Syntax

def get_entry_title() -> str: ...
def set_entry_title(value: str) -> None: ...

entry_title = property(get_entry_title, set_entry_title)

Default Value

""

Remarks

This property contains the title of a specified entry within an OData feed. This value will be populated once entry_index is set (provided that a title can be found).

entry_type Property

This property includes the entry category or type.

Syntax

def get_entry_type() -> str: ...
def set_entry_type(value: str) -> None: ...

entry_type = property(get_entry_type, set_entry_type)

Default Value

""

Remarks

This property specifies the entry category or type. When communicating with a service using OData V3, this property specifies the category element. When communicating with a service using OData V4, this property specifies the type attribute.

entry_updated Property

This property includes the date-time when a current entry in an OData feed was updated.

Syntax

def get_entry_updated() -> str: ...

entry_updated = property(get_entry_updated, None)

Default Value

""

Remarks

This property contains the date-time when a specified entry within an OData feed was updated. This value will be populated once entry_index is set (provided that a data-time can be found).

This property is not applicable to OData V4 feeds.

This property is read-only.

entry_xml Property

This property includes the raw XML of the current entry in an OData feed.

Syntax

def get_entry_xml() -> str: ...
def set_entry_xml(value: str) -> None: ...

entry_xml = property(get_entry_xml, set_entry_xml)

Default Value

""

Remarks

This property contains the raw XML of a specified entry within an OData feed. This value will be populated once entry_index is set.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of the firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used when connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

idle Property

This property specifies the current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

local_host Property

This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: local_host is not persistent. You must always set it in code, and never in the property window.

o_data_version Property

This property includes the OData version.

Syntax

def get_o_data_version() -> int: ...
def set_o_data_version(value: int) -> None: ...

o_data_version = property(get_o_data_version, set_o_data_version)

Default Value

3

Remarks

This property specifies the OData version to be used in the request and expected in the response. Possible values are as follows:

• 0 (odV2)
• 1 (odv3)
• 3 (odV4)
• 4 (odAuto - default)

Once the version of the service has been automatically determined, it will continue to be used until reset is called.

other_headers Property

This property includes other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

other_query_options Property

This property includes additional query options to be used when querying a service.

Syntax

def get_other_query_options() -> str: ...
def set_other_query_options(value: str) -> None: ...

other_query_options = property(get_other_query_options, set_other_query_options)

Default Value

""

Remarks

This property allows you to specify additional query options that will be used when accessing a service. Query options consist of name-value pairs, and multiple entries should be separated with an "&" (i.e., name1=value1&name2=value2).

Note: All specified values will be appended (unaltered) to the end of the URL (generated by the combination of service_root_uri, resource_path, and any Query*** properties specified).

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

password Property

This property includes a password if authentication is to be used.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, the user and password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM and user and password are empty, the class will attempt to authenticate using the current user's credentials.

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

This property contains a user name if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

query_filter Property

This property selects only the entries that satisfy the specified filter (expression).

Syntax

def get_query_filter() -> str: ...
def set_query_filter(value: str) -> None: ...

query_filter = property(get_query_filter, set_query_filter)

Default Value

""

Remarks

This property allows you to specify a filter (expression) in which only the entries that satisfy it will be returned.

The following operators are supported in the expression language.

Logical Operators

Arithmetic Operators

Grouping Operators

The following functions are supported in the expression language.

String Functions

Date Functions

Math Functions

Type Functions

query_order_by Property

This property includes the value used to order entries when querying a service.

Syntax

def get_query_order_by() -> str: ...
def set_query_order_by(value: str) -> None: ...

query_order_by = property(get_query_order_by, set_query_order_by)

Default Value

""

Remarks

This property allows you to specify a value by which the returned entries will be ordered after a call to query_service.

Note: You can specify the order by which the entries are sorted (either ascending or descending) by appending asc or desc (respectively) to your OrderBy value. For example, if you want to sort the entries by Rating in descending order you would set query_order_by to Rating desc. If a specific order (asc or desc) is not specified, the entries will be returned in ascending order.

query_select Property

This property selects only the specified properties to be returned in an entry when querying a service.

Syntax

def get_query_select() -> str: ...
def set_query_select(value: str) -> None: ...

query_select = property(get_query_select, set_query_select)

Default Value

""

Remarks

This property allows you to specify the specific properties you want returned within an entry when calling query_service. The specified value should be a comma-separated list of properties (provided you wish to have more than one property returned). For example, if you wish to have only the Name and Price of each item returned you can set query_select to Name,Price.

Note: The specified values can be a property name, navigation property name (entry_links_title), or the "*" character, which returns all the properties for each entry.

query_skip Property

This property includes the number of entries to skip when querying a service.

Syntax

def get_query_skip() -> str: ...
def set_query_skip(value: str) -> None: ...

query_skip = property(get_query_skip, set_query_skip)

Default Value

""

Remarks

This property allows you to specify the number of entries to skip (from the top of the list) when calling query_service. Therefore when this property set, only the remaining entries (starting with entry N+1) will be returned. The specified value should not be a value less than zero.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use query_order_by to specify how the entries should be sorted before skipping the top N items.

This property can be used in conjunction with query_order_by and query_top to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set query_order_by to Rating desc (to order the items by Rating from highest to lowest), set query_skip to 2 (to skip the first and second items), and finally set query_top to 2 (to return only the third and fourth items).

query_skip_token Property

This property includes the token given by an OData server when the last query result collection is too large.

Syntax

def get_query_skip_token() -> str: ...
def set_query_skip_token(value: str) -> None: ...

query_skip_token = property(get_query_skip_token, set_query_skip_token)

Default Value

""

Remarks

When a returned result collection is very large, it is not uncommon for the results to be broken up into multiple pages. When this occurs, a Skip Token is returned in the response and the component will populate query_skip_token with the returned value. Calling query_service again will return the next page of results.

query_top Property

This property selects the first N entries when querying a service.

Syntax

def get_query_top() -> str: ...
def set_query_top(value: str) -> None: ...

query_top = property(get_query_top, set_query_top)

Default Value

""

Remarks

This property allows you to specify the number of entries (taken from the top of the list) to be returned when calling query_service. The specified value should not be a value less than zero.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use query_order_by to specify how the entries should be sorted before selecting the top N items.

resource_path Property

This property includes the resource path of an OData service.

Syntax

def get_resource_path() -> str: ...
def set_resource_path(value: str) -> None: ...

resource_path = property(get_resource_path, set_resource_path)

Default Value

""

Remarks

This property contains the resource path of an OData service and is used in conjunction with service_root_uri (service_root_uri/resource_path) to query feeds and modify entries.

This property will be populated when entry_index is set. You can change the value if you wish to send the request to a different resource path.

For example, a valid resource_path for the OData sample service is Products.

schema_association_contains_target Property

This property indicates whether the navigation property contains a target.

Syntax

def get_schema_association_contains_target() -> bool: ...

schema_association_contains_target = property(get_schema_association_contains_target, None)

Default Value

FALSE

Remarks

This property indicates whether the navigation property contains a target. If True, the navigation property is a containment navigation property.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_description Property

This property contains the documentation long description of the OData schema association.

Syntax

def get_schema_association_description() -> str: ...

schema_association_description = property(get_schema_association_description, None)

Default Value

""

Remarks

This property contains the documentation long description of the OData schema association.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_from_role Property

This property contains the name of the starting point of the navigation.

Syntax

def get_schema_association_from_role() -> str: ...

schema_association_from_role = property(get_schema_association_from_role, None)

Default Value

""

Remarks

This property contains the name of the starting point of the navigation.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_from_role_description Property

This property contains the documentation long description of the OData schema FromRole association endpoint.

Syntax

def get_schema_association_from_role_description() -> str: ...

schema_association_from_role_description = property(get_schema_association_from_role_description, None)

Default Value

""

Remarks

This property contains the documentation long description of the OData schema FromRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_from_role_entity Property

This property contains the name of the entity that the FromRole association endpoint maps to.

Syntax

def get_schema_association_from_role_entity() -> str: ...

schema_association_from_role_entity = property(get_schema_association_from_role_entity, None)

Default Value

""

Remarks

This property contains the name of the entity that the schema_association_from_role association endpoint maps to.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_from_role_multiplicity Property

This property contains the multiplicity of the FromRole association endpoint.

Syntax

def get_schema_association_from_role_multiplicity() -> int: ...

schema_association_from_role_multiplicity = property(get_schema_association_from_role_multiplicity, None)

Default Value

0

Remarks

This property contains the multiplicity of the schema_association_from_role association endpoint. This is used along with schema_association_to_role_multiplicity to determine the cardinality of the relationship (i.e., one-to-one or one-to-many).

The available values are as follows:

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_from_role_summary Property

This property contains the documentation summary of the OData schema FromRole association endpoint.

Syntax

def get_schema_association_from_role_summary() -> str: ...

schema_association_from_role_summary = property(get_schema_association_from_role_summary, None)

Default Value

""

Remarks

This property contains the documentation summary of the OData schema FromRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_name Property

This property contains the name of the OData schema navigation property.

Syntax

def get_schema_association_name() -> str: ...

schema_association_name = property(get_schema_association_name, None)

Default Value

""

Remarks

This property contains the name of the OData schema navigation property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_nullable Property

This property indicates whether the property defined by the schema can be a null value.

Syntax

def get_schema_association_nullable() -> bool: ...

schema_association_nullable = property(get_schema_association_nullable, None)

Default Value

TRUE

Remarks

This property indicates whether the property defined by the schema can be a null value. If False, then the object must contain a value.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_on_delete Property

This property contains the delete action to be performed.

Syntax

def get_schema_association_on_delete() -> int: ...

schema_association_on_delete = property(get_schema_association_on_delete, None)

Default Value

0

Remarks

This property contains the delete action to be performed.

The possible values are as follows:

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_partner Property

This property contains the partner value identifying a navigation property (if any).

Syntax

def get_schema_association_partner() -> str: ...

schema_association_partner = property(get_schema_association_partner, None)

Default Value

""

Remarks

This property contains the partner value identifying a navigation property (if any).

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_ref_constraint_count Property

This property contains the number of referential constraints.

Syntax

def get_schema_association_ref_constraint_count() -> int: ...

schema_association_ref_constraint_count = property(get_schema_association_ref_constraint_count, None)

Default Value

0

Remarks

This property contains the number of referential constraints. To examine the individual referential constraints set schema_association_ref_constraint_index to a value from 0 to schema_association_ref_constraint_count -1. Example. Referential Contraints: For i = 0 to odata.SchemaAssociation.RefConstraintCount - 1 odata.SchemaAssociation.RefConstraintIndex = i; Console.Write(odata.SchemaAssociation.RefConstraintProperty); Console.Write(odata.SchemaAssociation.RefConstraintReferencedProperty); Next i

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_ref_constraint_index Property

This property contains the current index of the referential constraint.

Syntax

def get_schema_association_ref_constraint_index() -> int: ...
def set_schema_association_ref_constraint_index(value: int) -> None: ...

schema_association_ref_constraint_index = property(get_schema_association_ref_constraint_index, set_schema_association_ref_constraint_index)

Default Value

0

Remarks

This property contains the current index of the referential constraint. See schema_association_ref_constraint_count for details.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

schema_association_ref_constraint_property Property

This property contains the property that takes part in the referential constraint.

Syntax

def get_schema_association_ref_constraint_property() -> str: ...

schema_association_ref_constraint_property = property(get_schema_association_ref_constraint_property, None)

Default Value

""

Remarks

This property contains the property that takes part in the referential constraint.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_ref_constraint_referenced_property Property

This property contains the corresponding property of the principal entity type.

Syntax

def get_schema_association_ref_constraint_referenced_property() -> str: ...

schema_association_ref_constraint_referenced_property = property(get_schema_association_ref_constraint_referenced_property, None)

Default Value

""

Remarks

This property contains the corresponding property of the principal entity type.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_relationship Property

This property contains the name of the relationship (association) of the navigation property.

Syntax

def get_schema_association_relationship() -> str: ...

schema_association_relationship = property(get_schema_association_relationship, None)

Default Value

""

Remarks

This property contains the name of the relationship (association) of the navigation property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_summary Property

This property contains the documentation summary of the OData schema association.

Syntax

def get_schema_association_summary() -> str: ...

schema_association_summary = property(get_schema_association_summary, None)

Default Value

""

Remarks

This property contains the documentation summary of the OData schema association.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_to_role Property

This property contains the name of the endpoint of the navigation.

Syntax

def get_schema_association_to_role() -> str: ...

schema_association_to_role = property(get_schema_association_to_role, None)

Default Value

""

Remarks

This property contains the name of the endpoint of the navigation.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_to_role_description Property

This property contains the documentation long description of the OData schema ToRole association endpoint.

Syntax

def get_schema_association_to_role_description() -> str: ...

schema_association_to_role_description = property(get_schema_association_to_role_description, None)

Default Value

""

Remarks

This property contains the documentation long description of the OData schema ToRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_to_role_entity Property

This property contains the name of the entity that the ToRole association endpoint maps to.

Syntax

def get_schema_association_to_role_entity() -> str: ...

schema_association_to_role_entity = property(get_schema_association_to_role_entity, None)

Default Value

""

Remarks

This property contains the name of the entity that the schema_association_to_role association endpoint maps to.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_to_role_multiplicity Property

This property contains the multiplicity of the ToRole association endpoint.

Syntax

def get_schema_association_to_role_multiplicity() -> int: ...

schema_association_to_role_multiplicity = property(get_schema_association_to_role_multiplicity, None)

Default Value

0

Remarks

This property contains the multiplicity of the schema_association_to_role association endpoint. This is used along with schema_association_from_role_multiplicity to determine the cardinality of the relationship (i.e., one-to-one or one-to-many).

The available values are as follows:

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_to_role_summary Property

This property contains the documentation summary of the OData schema ToRole association endpoint.

Syntax

def get_schema_association_to_role_summary() -> str: ...

schema_association_to_role_summary = property(get_schema_association_to_role_summary, None)

Default Value

""

Remarks

This property contains the documentation summary of the OData schema ToRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_type Property

This property contains the entity type.

Syntax

def get_schema_association_type() -> str: ...

schema_association_type = property(get_schema_association_type, None)

Default Value

""

Remarks

This property contains the entity type.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.

This property is read-only.

schema_association_count Property

This property includes the number of navigation properties contained within an OData schema entity.

Syntax

def get_schema_association_count() -> int: ...

schema_association_count = property(get_schema_association_count, None)

Default Value

0

Remarks

This property is updated to reflect the total number of navigation properties within the schema entity specified by schema_entity_index.

This property is read-only.

schema_association_index Property

This property includes the index of the current navigation property in an OData schema entity.

Syntax

def get_schema_association_index() -> int: ...
def set_schema_association_index(value: int) -> None: ...

schema_association_index = property(get_schema_association_index, set_schema_association_index)

Default Value

0

Remarks

This property is used to specify a navigation property within an entity (specified by schema_entity_index). Once set, schema_association will be populated.

schema_entity_description Property

This property contains the documentation long description of the OData schema entity.

Syntax

def get_schema_entity_description() -> str: ...

schema_entity_description = property(get_schema_entity_description, None)

Default Value

""

Remarks

This property contains the documentation long description of the OData schema entity.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_entity_count property.

This property is read-only.

schema_entity_name Property

This property contains the name of the OData schema entity.

Syntax

def get_schema_entity_name() -> str: ...

schema_entity_name = property(get_schema_entity_name, None)

Default Value

""

Remarks

This property contains the name of the OData schema entity.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_entity_count property.

This property is read-only.

schema_entity_summary Property

This property contains the documentation summary of the OData schema entity.

Syntax

def get_schema_entity_summary() -> str: ...

schema_entity_summary = property(get_schema_entity_summary, None)

Default Value

""

Remarks

This property contains the documentation summary of the OData schema entity.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_entity_count property.

This property is read-only.

schema_entity_count Property

This property includes the number of entities contained within an OData schema.

Syntax

def get_schema_entity_count() -> int: ...

schema_entity_count = property(get_schema_entity_count, None)

Default Value

0

Remarks

This property is updated to reflect the total number of entities within a schema (retrieved via get_schema).

This property is read-only.

schema_entity_index Property

This property includes the index of the current entity in an OData schema.

Syntax

def get_schema_entity_index() -> int: ...
def set_schema_entity_index(value: int) -> None: ...

schema_entity_index = property(get_schema_entity_index, set_schema_entity_index)

Default Value

0

Remarks

This property is used to specify an entity within a retrieved OData schema. Once set, schema_entity will be populated.

schema_keys_count Property

The number of records in the SchemaKeys array.

Syntax

def get_schema_keys_count() -> int: ...

schema_keys_count = property(get_schema_keys_count, None)

Default Value

0

Remarks

This property is read-only.

schema_keys Property

This property includes the keys for a schema entity.

Syntax

def get_schema_keys(schema_keys_index: int) -> str: ...

Default Value

"0"

Remarks

This property is used to obtain the keys contained within an entity for a service schema and is populated after setting schema_entity_index.

Note: Key values map to a property of the entity, details of which can be retrieved via schema_property.

This property is read-only.

schema_property_attributes Property

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element.

Syntax

def get_schema_property_attributes() -> str: ...

schema_property_attributes = property(get_schema_property_attributes, None)

Default Value

""

Remarks

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.

This property is read-only.

schema_property_description Property

This property contains the documentation long description of the OData schema property.

Syntax

def get_schema_property_description() -> str: ...

schema_property_description = property(get_schema_property_description, None)

Default Value

""

Remarks

This property contains the documentation long description of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.

This property is read-only.

schema_property_is_complex_type Property

This property indicates whether a property is derived from a complex type.

Syntax

def get_schema_property_is_complex_type() -> bool: ...

schema_property_is_complex_type = property(get_schema_property_is_complex_type, None)

Default Value

FALSE

Remarks

This property indicates whether a property is derived from a complex type.

When set tp True, schema_type_field can be used to navigate the properties contained within the complex type.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.

This property is read-only.

schema_property_name Property

This property contains the Name of the OData schema property.

Syntax

def get_schema_property_name() -> str: ...

schema_property_name = property(get_schema_property_name, None)

Default Value

""

Remarks

This property contains the Name of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.

This property is read-only.

schema_property_nullable Property

This property indicates whether a property can be null.

Syntax

def get_schema_property_nullable() -> bool: ...

schema_property_nullable = property(get_schema_property_nullable, None)

Default Value

FALSE

Remarks

This property indicates whether a property can be null.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.

This property is read-only.

schema_property_summary Property

This property contains the documentation summary of the OData schema property.

Syntax

def get_schema_property_summary() -> str: ...

schema_property_summary = property(get_schema_property_summary, None)

Default Value

""

Remarks

This property contains the documentation summary of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.

This property is read-only.

schema_property_type Property

This property contains the type of the OData schema property.

Syntax

def get_schema_property_type() -> str: ...

schema_property_type = property(get_schema_property_type, None)

Default Value

""

Remarks

This property contains the type of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.

This property is read-only.

schema_property_count Property

This property includes the number of properties contained within an OData schema entity.

Syntax

def get_schema_property_count() -> int: ...

schema_property_count = property(get_schema_property_count, None)

Default Value

0

Remarks

This property is updated to reflect the total number of properties within the schema entity specified by schema_entity_index.

This property is read-only.

schema_property_index Property

This property includes the index of the current property in an OData schema entity.

Syntax

def get_schema_property_index() -> int: ...
def set_schema_property_index(value: int) -> None: ...

schema_property_index = property(get_schema_property_index, set_schema_property_index)

Default Value

0

Remarks

This property is used to specify a property within an entity (specified by schema_entity_index). Once set, schema_property will be populated.

schema_type_field_attributes Property

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element.

Syntax

def get_schema_type_field_attributes() -> str: ...

schema_type_field_attributes = property(get_schema_type_field_attributes, None)

Default Value

""

Remarks

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.

This property is read-only.

schema_type_field_description Property

This property contains the documentation long description of the OData schema property.

Syntax

def get_schema_type_field_description() -> str: ...

schema_type_field_description = property(get_schema_type_field_description, None)

Default Value

""

Remarks

This property contains the documentation long description of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.

This property is read-only.

schema_type_field_is_complex_type Property

This property indicates whether a property is derived from a complex type.

Syntax

def get_schema_type_field_is_complex_type() -> bool: ...

schema_type_field_is_complex_type = property(get_schema_type_field_is_complex_type, None)

Default Value

FALSE

Remarks

This property indicates whether a property is derived from a complex type.

When set tp True, schema_type_field can be used to navigate the properties contained within the complex type.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.

This property is read-only.

schema_type_field_name Property

This property contains the Name of the OData schema property.

Syntax

def get_schema_type_field_name() -> str: ...

schema_type_field_name = property(get_schema_type_field_name, None)

Default Value

""

Remarks

This property contains the Name of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.

This property is read-only.

schema_type_field_nullable Property

This property indicates whether a property can be null.

Syntax

def get_schema_type_field_nullable() -> bool: ...

schema_type_field_nullable = property(get_schema_type_field_nullable, None)

Default Value

FALSE

Remarks

This property indicates whether a property can be null.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.

This property is read-only.

schema_type_field_summary Property

This property contains the documentation summary of the OData schema property.

Syntax

def get_schema_type_field_summary() -> str: ...

schema_type_field_summary = property(get_schema_type_field_summary, None)

Default Value

""

Remarks

This property contains the documentation summary of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.

This property is read-only.

schema_type_field_type Property

This property contains the type of the OData schema property.

Syntax

def get_schema_type_field_type() -> str: ...

schema_type_field_type = property(get_schema_type_field_type, None)

Default Value

""

Remarks

This property contains the type of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.

This property is read-only.

schema_type_field_count Property

This property includes the number of properties contained within an OData schema complex type.

Syntax

def get_schema_type_field_count() -> int: ...

schema_type_field_count = property(get_schema_type_field_count, None)

Default Value

0

Remarks

This property is updated to reflect the total number of fields (properties) within the schema complex type of a property. This is populated when navigating an entity's properties via schema_property_index or by explicitly setting the type via set_schema_type.

This property is read-only.

schema_type_field_index Property

This property includes the index of the current field (property) in an OData schema complex type.

Syntax

def get_schema_type_field_index() -> int: ...
def set_schema_type_field_index(value: int) -> None: ...

schema_type_field_index = property(get_schema_type_field_index, set_schema_type_field_index)

Default Value

0

Remarks

This property is used to specify a field (property) within a complex type. Once set, schema_type_field will be populated.

service_root_uri Property

This property includes the root URI of an OData service.

Syntax

def get_service_root_uri() -> str: ...
def set_service_root_uri(value: str) -> None: ...

service_root_uri = property(get_service_root_uri, set_service_root_uri)

Default Value

""

Remarks

This property contains the root URI of an OData service. This value is used in conjunction with resource_path (service_root_uri/resource_path) to query feeds and modify entries.

Example.

The service_root_uri of the OData sample service is "http://services.odata.org/OData/OData.svc/".

ssl_accept_server_cert_effective_date Property

This is the date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

This is the date the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

This is a comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_accept_server_cert_fingerprint Property

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_accept_server_cert_issuer Property

This is the issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_accept_server_cert_private_key Property

This is the private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

ssl_accept_server_cert_private_key_available Property

This property shows whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

This property shows whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_accept_server_cert_private_key_container Property

This is the name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

This is the name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_accept_server_cert_public_key Property

This is the public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

This property contains the textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_public_key_length Property

This is the length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_accept_server_cert_serial_number Property

This is the serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The property contains the text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).

ssl_accept_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_accept_server_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_accept_server_cert_subject_alt_names Property

This property contains comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

This property contains the MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

This property contains the SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

This property contains the SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_usage Property

This property contains the text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

This property contains the text description of ssl_accept_server_cert_usage_flags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_accept_server_cert_usage_flags Property

This property contains the flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_accept_server_cert_version Property

This property contains the certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_accept_server_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_effective_date Property

This is the date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

This is the date the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

This is a comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_cert_fingerprint Property

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_cert_fingerprint_sha1 Property

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_cert_fingerprint_sha256 Property

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_cert_issuer Property

This is the issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_cert_private_key Property

This is the private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

ssl_cert_private_key_available Property

This property shows whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

This property shows whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_cert_private_key_container Property

This is the name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

This is the name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_cert_public_key Property

This is the public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_cert_public_key_algorithm Property

This property contains the textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_public_key_length Property

This is the length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_cert_serial_number Property

This is the serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_cert_signature_algorithm Property

The property contains the text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject_alt_names Property

This property contains comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_cert_thumbprint_md5 Property

This property contains the MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha1 Property

This property contains the SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha256 Property

This property contains the SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_usage Property

This property contains the text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

This property contains the text description of ssl_cert_usage_flags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_cert_usage_flags Property

This property contains the flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_cert_version Property

This property contains the certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_provider Property

This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

ssl_server_cert_effective_date Property

This is the date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

This is the date the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

This is a comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_server_cert_fingerprint Property

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_server_cert_issuer Property

This is the issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_server_cert_private_key Property

This is the private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

ssl_server_cert_private_key_available Property

This property shows whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

This property shows whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_server_cert_private_key_container Property

This is the name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

This is the name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_server_cert_public_key Property

This is the public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_server_cert_public_key_algorithm Property

This property contains the textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_public_key_length Property

This is the length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_server_cert_serial_number Property

This is the serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_server_cert_signature_algorithm Property

The property contains the text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).

This property is read-only.

ssl_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

ssl_server_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

ssl_server_cert_subject_alt_names Property

This property contains comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

This property contains the MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

This property contains the SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

This property contains the SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_usage Property

This property contains the text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

This property contains the text description of ssl_server_cert_usage_flags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_server_cert_usage_flags Property

This property contains the flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_server_cert_version Property

This property contains the certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_server_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

timeout Property

This property includes the timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

transferred_data Property

This property includes the contents of the last response from the server.

Syntax

def get_transferred_data() -> bytes: ...

transferred_data = property(get_transferred_data, None)

Default Value

""

Remarks

This property is used to get the data of the last response from the server.

transferred_data will be populated after a successful query_service or custom_request call, provided that local_file is not set. If local_file is set, the object data will be written to the file specified.

This property is read-only.

user Property

This property includes a user name if authentication is to be used.

Syntax

def get_user() -> str: ...
def set_user(value: str) -> None: ...

user = property(get_user, set_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, The user and password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM, and user and password are empty, the class will attempt to authenticate using the current user's credentials.

config Method

This method sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_entry Method

This method creates a new entry within the specified OData service resource.

Syntax

def create_entry() -> None: ...

Remarks

The component will use the items contained within entry_properties to create a new entry within the feed service resource by service_root_uri and resource_path (service_root_uri/resource_path).

Upon a successful creation, all previous entries contained by the component, before the create_entry call, will be cleared and replaced with the response entry data. entry_index will then be set to 0 (the first entry within the response), populating the entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, and entry_properties properties. other_headers will also be cleared and thus will need to be reset accordingly with each call made.

custom_request Method

This method sends a request to the specified URL using the HTTPMethod and PostData provided.

Syntax

def custom_request(http_method: str, url: str, post_data: str) -> None: ...

Remarks

This method sends a custom request to the specified URL. The type of request sent is determined by HTTPMethod (e.g., POST) and the data sent are determined by PostData. If a custom request does not require data to be sent, simply set the PostData parameter to an empty string.

Note: All values specified are taken as entered.

other_headers can be used to specify any additional headers you would like to be sent in the custom request.

The search results are delivered in the transferred_data property, as well as through the on_transfer event. The response headers can be retrieved through the transferred_headers property as well as through the on_header event.

The class will then attempt to parse the search results. Upon successfully parsing the response, channel will be set with their associated feed element values and entry_count will be populated with the total number of entries contained within the feed. entry_index also will be set to 1, thus populating entry_properties.

delete_entry Method

This method deletes an entry within an OData service resource.

Syntax

def delete_entry() -> None: ...

Remarks

The component will delete the entry, of an OData service resource, specified by service_root_uri and resource_path (service_root_uri/resource_path).

An "If-Match" header will be sent in the delete request with the value contained within entry_e_tag.

Upon a successful entry deletion, all previous entries contained by the component, before the DeleteEntry call, will be cleared. other_headers also will be cleared and thus will need to be reset accordingly with each call made.

get_entry_property Method

This method gets an OData entry property.

Syntax

def get_entry_property(xpath: str) -> str: ...

Remarks

This method is intended to extend the functionality of the OData class and will retrieve the value of the entry property specified by XPath. XPath is the XPath of the element or attribute according to the following convention: entry[x]/element@attribute. The @attribute part is optional. When entry_index is set to an index greater than or equal to zero, a relative path also can be used: property or property@attribute. When a relative path is specified, the value of the specified XPath will be returned for the entry identified by entry_index.

entry[x] is the feed's xth entry (or any other root-level child), where the indexer x starts at 1.

property is any child of the property's element, and attribute can be any attribute of that field. If an attribute is not supplied, the get_entry_property method will return the text portion of property.

Example 1. Attribute Not Supplied: ODataControl.GetEntryProperty("entry[5]/content/properties/ID") ODataControl.GetEntryProperty("entry[5]/content/properties/ID@type")

Example 2. Relative Path: In the following example, a relative path is used to retrieve properties of the first feed entry: ODataControl.EntryIndex = 1 ODataControl.GetEntryProperty("ID") ODataControl.GetEntryProperty("ID@type") ODataControl.GetEntryProperty("Address/State")

get_schema Method

This method retrieves the schema for a service.

Syntax

def get_schema() -> None: ...

Remarks

This method will retrieve the schema (metadata document) of the service specified by service_root_uri.

Upon successful retrieval of the schema, set schema_entity_index to retrieve the names of the entities contained within the schema along with their keys, properties, and navigation properties.

Additional details about the schema can be retrieved via xpath.

has_xpath Method

This method determines whether a specific element exists in the document.

Syntax

def has_xpath(xpath: str) -> bool: ...

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through xpath.

This method returns True if the xpath exists, and False if not.

See xpath for details on the XPath syntax.

query_service Method

This method queries an OData service using the specified parameters.

Syntax

def query_service() -> None: ...

Remarks

This method queries an OData feed specified by service_root_uri and resource_path (service_root_uri/resource_path) using the query options specified in the Query*** properties and other_query_options. To retrieve an OData feed, without performing any filtering, you can leave Query*** and other_query_options empty and call query_service.

The query results are delivered in the transferred_data property, as well as through the on_transfer event. The response headers can be retrieved through the parsed_headers property as well as through the on_header event.

The class will attempt to parse the query results. Upon successfully parsing the response, channel will be set with their associated feed element values and entry_count will be populated with the total number of entries contained within the feed. entry_index will also be set to 1, thus populating entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path.

reset Method

This method resets all of properties of the class.

Syntax

def reset() -> None: ...

Remarks

The reset method resets all properties to the class's default settings. This is an easy way to clear all of the property values before repopulating the OData feed.

set_entry_property Method

This method is used to set an OData entry property.

Syntax

def set_entry_property(xpath: str, value: str) -> None: ...

Remarks

This method is intended to extend functionality of the OData class and will set the value of the entry property (specified by XPath) to the specified Value. Therefore, the value of the corresponding property will be updated within entry_properties.

XPath is the XPath of the element or attribute according to the following convention: entry[x]/element. When entry_index is set to an index greater than or equal to zero, a relative path can also be used: property. When a relative path is specified, the class will use the specified entry_index along with the property specified to update the EntryProperty value.

entry[x] is the feed's xth entry (or any other root-level child), where the indexer x starts at 1.

property is any child of the property's element.

Example 1. Set Properties: ODataControl.SetEntryProperty("entry[5]/content/properties/Name", "MyNewName") Example 2. Retrieve Properties:

The following example uses a relative path to retrieve properties of the first feed entry: ODataControl.EntryIndex = 1 ODataControl.SetEntryProperty("Name", "MyNewName") ODataControl.SetEntryProperty("Address/State", "NC")

set_schema_entity Method

This method sets the schema entity.

Syntax

def set_schema_entity(name: str) -> None: ...

Remarks

The class will set the schema entity to the Name specified. Once set, you can view the keys (via schema_keys), properties (via schema_property), and navigation properties (via schema_association) contained within the specified entity.

set_schema_property Method

This method sets the schema property.

Syntax

def set_schema_property(name: str) -> None: ...

Remarks

The class will set the schema property to the Name specified. Once set, you can view the details of the property (via schema_property) along with the complex type details (via schema_type_field); provided that the property is derived from the complex type.

set_schema_type Method

This method sets the schema type.

Syntax

def set_schema_type(name: str) -> None: ...

Remarks

The class will set the schema type to the Name specified. Once set, you can view the details of the complex type (via schema_type_field).

update_entry Method

This method updates an OData entry.

Syntax

def update_entry() -> None: ...

Remarks

The class will update the OData entry specified by service_root_uri and resource_path (service_root_uri/resource_path). It also will update the OData entry with the elements specified by entry_properties.

Upon a successful update, all previous entries contained by the component, before the update_entry call, will be cleared and replaced with the response entry data. entry_index will then be set to zero (the first entry within the response), populating the entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path properties. other_headers will also be cleared and thus will need to be reset accordingly with each call made.

update_property Method

This method updates an OData entry property.

Syntax

def update_property(xpath: str, value: str) -> None: ...

Remarks

The class will update the OData entry specified by service_root_uri and resource_path (service_root_uri/resource_path). It will update only the single entry property specified by XPath with the specified Value.

Upon a successful update, all previous entries contained by the component, before the update_property call, will be cleared and replaced with the response entry data. entry_index will then be set to zero (the first entry within the response), populating the entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path. other_headers will also be cleared and thus will need to be reset accordingly with each call made.

on_connected Event

This event is fired immediately after a connection completes (or fails).

Syntax

class ODataConnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class OData:
@property
def on_connected() -> Callable[[ODataConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[ODataConnectedEventParams], None]) -> None: ...

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

on_disconnected Event

This event is fired when a connection is closed.

Syntax

class ODataDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class OData:
@property
def on_disconnected() -> Callable[[ODataDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[ODataDisconnectedEventParams], None]) -> None: ...

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

class ODataEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class OData:
@property
def on_end_transfer() -> Callable[[ODataEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[ODataEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_entity Event

This event is fired once for each entity retrieved.

Syntax

class ODataEntityEventParams(object):
  @property
  def name() -> str: ...

# In class OData:
@property
def on_entity() -> Callable[[ODataEntityEventParams], None]: ...
@on_entity.setter
def on_entity(event_hook: Callable[[ODataEntityEventParams], None]) -> None: ...

Remarks

The on_entity event is fired once for each entity found when retrieving a service's schema (metadata document) through get_schema.

on_entry Event

This event is fired once for each entry retrieved.

Syntax

class ODataEntryEventParams(object):
  @property
  def id() -> str: ...

  @property
  def title() -> str: ...

  @property
  def summary() -> str: ...

  @property
  def e_tag() -> str: ...

# In class OData:
@property
def on_entry() -> Callable[[ODataEntryEventParams], None]: ...
@on_entry.setter
def on_entry(event_hook: Callable[[ODataEntryEventParams], None]) -> None: ...

Remarks

The on_entry event is fired once for each entry found in the response.

The entry properties are provided through entry_properties.

The entry links are provided through entry_links.

on_error Event

This event is fired for information about errors during data delivery.

Syntax

class ODataErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class OData:
@property
def on_error() -> Callable[[ODataErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[ODataErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_header Event

This event is fired every time a header line comes in.

Syntax

class ODataHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class OData:
@property
def on_header() -> Callable[[ODataHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[ODataHeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_log Event

This event fires once for each log message.

Syntax

class ODataLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class OData:
@property
def on_log() -> Callable[[ODataLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[ODataLogEventParams], None]) -> None: ...

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_property Event

This event is fired once for each property found within an entity.

Syntax

class ODataPropertyEventParams(object):
  @property
  def name() -> str: ...

  @property
  def type_name() -> str: ...

  @property
  def nullable() -> bool: ...

# In class OData:
@property
def on_property() -> Callable[[ODataPropertyEventParams], None]: ...
@on_property.setter
def on_property(event_hook: Callable[[ODataPropertyEventParams], None]) -> None: ...

Remarks

The on_property event is fired once for each property found within an entity after setting schema_entity_index.

on_set_cookie Event

This event is fired for every cookie set by the server.

Syntax

class ODataSetCookieEventParams(object):
  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

  @property
  def expires() -> str: ...

  @property
  def domain() -> str: ...

  @property
  def path() -> str: ...

  @property
  def secure() -> bool: ...

# In class OData:
@property
def on_set_cookie() -> Callable[[ODataSetCookieEventParams], None]: ...
@on_set_cookie.setter
def on_set_cookie(event_hook: Callable[[ODataSetCookieEventParams], None]) -> None: ...

Remarks

The on_set_cookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

on_ssl_server_authentication Event

This event is fired after the server presents its certificate to the client.

Syntax

class ODataSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class OData:
@property
def on_ssl_server_authentication() -> Callable[[ODataSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[ODataSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

This event shows the progress of the secure connection.

Syntax

class ODataSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class OData:
@property
def on_ssl_status() -> Callable[[ODataSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[ODataSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer Event

This event fires when a document starts transferring (after the headers).

Syntax

class ODataStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class OData:
@property
def on_start_transfer() -> Callable[[ODataStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[ODataStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_status Event

This event is fired when the HTTP status line is received from the server.

Syntax

class ODataStatusEventParams(object):
  @property
  def http_version() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class OData:
@property
def on_status() -> Callable[[ODataStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[ODataStatusEventParams], None]) -> None: ...

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

on_transfer Event

This event is fired while a document transfers (delivers document).

Syntax

class ODataTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class OData:
@property
def on_transfer() -> Callable[[ODataTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[ODataTransferEventParams], None]) -> None: ...

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

OData Config Settings

OData Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings