Ice.PropertiesAdminPrx

class Ice.PropertiesAdminPrx

Bases: ObjectPrx

Provides remote access to the properties of a communicator.

Notes

The Slice compiler generated this proxy class from Slice interface ::Ice::PropertiesAdmin.

getProperty(key: str, context: dict[str, str] | None = None) → str

Gets a property by key.

Parameters:

  • key (str) – The property key.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

The property value. This value is empty if the property is not set.

Return type:

str

getPropertyAsync(key: str, context: dict[str, str] | None = None) → Awaitable[str]

Gets a property by key.

Parameters:

  • key (str) – The property key.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

The property value. This value is empty if the property is not set.

Return type:

Awaitable[str]

getPropertiesForPrefix(prefix: str, context: dict[str, str] | None = None) → dict[str, str]

Gets all properties whose keys begin with prefix. If prefix is the empty string then all properties are returned.

Parameters:

  • prefix (str) – The prefix to search for. May be empty.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

The matching property set.

Return type:

dict[str, str]

getPropertiesForPrefixAsync(prefix: str, context: dict[str, str] | None = None) → Awaitable[dict[str, str]]

Gets all properties whose keys begin with prefix. If prefix is the empty string then all properties are returned.

Parameters:

  • prefix (str) – The prefix to search for. May be empty.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

The matching property set.

Return type:

Awaitable[dict[str, str]]

setProperties(newProperties: Mapping[str, str], context: dict[str, str] | None = None) → None

Updates the communicator’s properties with the given property set. If an entry in newProperties matches the name of an existing property, that property’s value is replaced with the new value. If the new value is the empty string, the property is removed. Existing properties that are not modified or removed by the entries in newProperties are not affected by this update.

Parameters:

  • newProperties (Mapping[str, str]) – Properties to add, change, or remove.

  • context (dict[str, str]) – The request context for the invocation.

Return type:

None

setPropertiesAsync(newProperties: Mapping[str, str], context: dict[str, str] | None = None) → Awaitable[None]

Updates the communicator’s properties with the given property set. If an entry in newProperties matches the name of an existing property, that property’s value is replaced with the new value. If the new value is the empty string, the property is removed. Existing properties that are not modified or removed by the entries in newProperties are not affected by this update.

Parameters:

  • newProperties (Mapping[str, str]) – Properties to add, change, or remove.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → PropertiesAdminPrx | None

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

  • context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static checkedCastAsync(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → Awaitable[PropertiesAdminPrx | None]

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

  • context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → PropertiesAdminPrx
static uncheckedCast(proxy: None, facet: str | None = None) → None

Creates a new proxy from an existing proxy.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

Returns:

A new proxy with the requested facet, or None if the source proxy is None.

Return type:

ObjectPrx | None

static ice_staticId() → str

Returns the Slice type ID associated with this type.

Returns:

The Slice type ID.

Return type:

str