Glacier2.StringSetPrx

class Glacier2.StringSetPrx

Bases: ObjectPrx

Manages a set of constraints on a Glacier2.SessionPrx.

Notes

The Slice compiler generated this proxy class from Slice interface ::Glacier2::StringSet.

add(additions: Sequence[str], context: dict[str, str] | None = None) → None

Adds a sequence of strings to this set of constraints. Order is not preserved and duplicates are implicitly removed.

Parameters:

  • additions (Sequence[str]) – The sequence of strings to add.

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

Return type:

None

addAsync(additions: Sequence[str], context: dict[str, str] | None = None) → Awaitable[None]

Adds a sequence of strings to this set of constraints. Order is not preserved and duplicates are implicitly removed.

Parameters:

  • additions (Sequence[str]) – The sequence of strings to add.

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

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

remove(deletions: Sequence[str], context: dict[str, str] | None = None) → None

Removes a sequence of strings from this set of constraints. No errors are returned if an entry is not found.

Parameters:

  • deletions (Sequence[str]) – The sequence of strings to remove.

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

Return type:

None

removeAsync(deletions: Sequence[str], context: dict[str, str] | None = None) → Awaitable[None]

Removes a sequence of strings from this set of constraints. No errors are returned if an entry is not found.

Parameters:

  • deletions (Sequence[str]) – The sequence of strings to 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]

get(context: dict[str, str] | None = None) → list[str]

Gets a sequence of strings describing the constraints in this set.

Parameters:

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

Returns:

The sequence of strings for this set.

Return type:

list[str]

getAsync(context: dict[str, str] | None = None) → Awaitable[list[str]]

Gets a sequence of strings describing the constraints in this set.

Parameters:

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

Returns:

The sequence of strings for this set.

Return type:

Awaitable[list[str]]

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → StringSetPrx | 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[StringSetPrx | 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:

An Awaitable that completes when the invocation completes. It holds 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:

Awaitable[ObjectPrx | None]

static uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → StringSetPrx
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