nisystemlink.clients.core

pydantic model nisystemlink.clients.core.ApiError[source]

Represents the standard error structure for SystemLink API responses.

Show JSON schema

{
   "$defs": {
      "ApiError": {
         "description": "Represents the standard error structure for SystemLink API responses.",
         "properties": {
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "code": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Code"
            },
            "message": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message"
            },
            "args": {
               "default": [],
               "items": {
                  "type": "string"
               },
               "title": "Args",
               "type": "array"
            },
            "resourceType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resourcetype"
            },
            "resourceId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resourceid"
            },
            "innerErrors": {
               "default": [],
               "items": {
                  "$ref": "#/$defs/ApiError"
               },
               "title": "Innererrors",
               "type": "array"
            }
         },
         "title": "ApiError",
         "type": "object"
      }
   },
   "$ref": "#/$defs/ApiError"
}

Fields

args
code
inner_errors
message
name
resource_id
resource_type

field args: List[str] = []: Positional arguments for the error code.

field code: Optional[int] = None: Numeric error code.

field inner_errors: List[ApiError] = []: Inner errors when the top-level error represents more than one error.

field message: Optional[str] = None: Complete error message.

field name: Optional[str] = None: String error code.

field resource_id: Optional[str] = None: Identifier of the resource associated with the error.

field resource_type: Optional[str] = None: Type of resource associated with the error.

classmethod construct(_fields_set=None, **values)

Return type: Self

copy(*, include=None, exclude=None, update=None, deep=False)

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters

include (AbstractSetIntStr | MappingIntStrAny | None) – Optional set or mapping specifying which fields to include in the copied model.
exclude (AbstractSetIntStr | MappingIntStrAny | None) – Optional set or mapping specifying which fields to exclude in the copied model.
update (Dict[str, Any] | None) – Optional dictionary of field-value pairs to override field values in the copied model.
deep (bool) – If True, the values of fields that are Pydantic models will be deep-copied.

Return type

Self

Returns

A copy of the model with included, excluded and updated fields as specified.

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)

Return type: Dict[str, Any]

classmethod from_orm(obj)

Return type: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)

Return type: str

classmethod model_construct(_fields_set=None, **values)

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters

_fields_set (Optional[set[str]]) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type

Self

Returns

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)

!!! abstract “Usage Documentation”: [model_copy](../concepts/models.md#model-copy)

Returns a copy of the model.

!!! note: The underlying instance’s [__dict__][object. attribute is copied. This might have unexpected side effects if you store anything in it, on top of the model fields (e.g. the value of [cached properties][functools.cached_property]).

Parameters

update (Optional[collections.abc.Mapping[str, Any]]) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type

Self

Returns

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, exclude_computed_fields=False, round_trip=False, warnings=True, fallback=None, serialize_as_any=False)

!!! abstract “Usage Documentation”: [model_dump](../concepts/serialization.md#python-mode)

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.
include (Union[set[int], set[str], collections.abc.Mapping[int, Union[set[int], set[str], collections.abc.Mapping[int, Union[IncEx, bool]], collections.abc.Mapping[str, Union[IncEx, bool]], bool]], collections.abc.Mapping[str, Union[set[int], set[str], collections.abc.Mapping[int, Union[IncEx, bool]], collections.abc.Mapping[str, Union[IncEx, bool]], bool]], None]) – A set of fields to include in the output.
exclude (Union[set[int], set[str], collections.abc.Mapping[int, Union[set[int], set[str], collections.abc.Mapping[int, Union[IncEx, bool]], collections.abc.Mapping[str, Union[IncEx, bool]], bool]], collections.abc.Mapping[str, Union[set[int], set[str], collections.abc.Mapping[int, Union[IncEx, bool]], collections.abc.Mapping[str, Union[IncEx, bool]], bool]], None]) – A set of fields to exclude from the output.
context (Optional[Any]) – Additional context to pass to the serializer.
by_alias (Optional[bool]) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
exclude_computed_fields (bool) – Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated round_trip parameter instead.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
fallback (Optional[Callable[[Any], Any]]) – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type

dict[str, Any]

Returns

A dictionary representation of the model.

model_dump_json(*, indent=None, ensure_ascii=False, include=None, exclude=None, context=None, by_alias=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, exclude_computed_fields=False, round_trip=False, warnings=True, fallback=None, serialize_as_any=False)

!!! abstract “Usage Documentation”: [model_dump_json](../concepts/serialization.md#json-mode)

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters

indent (Optional[int]) – Indentation to use in the JSON output. If None is passed, the output will be compact.
ensure_ascii (bool) – If True, the output is guaranteed to have all incoming non-ASCII characters escaped. If False (the default), these characters will be output as-is.
include (Union[set[int], set[str], collections.abc.Mapping[int, Union[set[int], set[str], collections.abc.Mapping[int, Union[IncEx, bool]], collections.abc.Mapping[str, Union[IncEx, bool]], bool]], collections.abc.Mapping[str, Union[set[int], set[str], collections.abc.Mapping[int, Union[IncEx, bool]], collections.abc.Mapping[str, Union[IncEx, bool]], bool]], None]) – Field(s) to include in the JSON output.
exclude (Union[set[int], set[str], collections.abc.Mapping[int, Union[set[int], set[str], collections.abc.Mapping[int, Union[IncEx, bool]], collections.abc.Mapping[str, Union[IncEx, bool]], bool]], collections.abc.Mapping[str, Union[set[int], set[str], collections.abc.Mapping[int, Union[IncEx, bool]], collections.abc.Mapping[str, Union[IncEx, bool]], bool]], None]) – Field(s) to exclude from the JSON output.
context (Optional[Any]) – Additional context to pass to the serializer.
by_alias (Optional[bool]) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
exclude_computed_fields (bool) – Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated round_trip parameter instead.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
fallback (Optional[Callable[[Any], Any]]) – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type

str

Returns

A JSON string representation of the model.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation', *, union_format='any_of')

Generates a JSON schema for a model class.

Parameters

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
union_format (Literal['any_of', 'primitive_type_array']) –
The format to use when combining schemas from unions together. Can be one of:
- ’any_of’: Use the [anyOf](https://json-schema.org/understanding-json-schema/reference/combining#anyOf)
keyword to combine schemas (the default). - ‘primitive_type_array’: Use the [type](https://json-schema.org/understanding-json-schema/reference/type) keyword as an array of strings, containing each type of the combination. If any of the schemas is not a primitive type (string, boolean, null, integer or number) or contains constraints/metadata, falls back to any_of.
schema_generator (type[pydantic.json_schema.GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type

dict[str, Any]

Returns

The JSON schema for the given model class.

classmethod model_parametrized_name(params)

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type: str
Returns: String representing the new class where params are passed to cls as type variables.
Raises: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(context, /)

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)

Try to rebuild the pydantic-core schema for the model.

This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.

Parameters

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (Optional[collections.abc.Mapping[str, Any]]) – The types namespace, defaults to None.

Return type

Optional[bool]

Returns

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, extra=None, from_attributes=None, context=None, by_alias=None, by_name=None)

Validate a pydantic model instance.

Parameters

obj (Any) – The object to validate.
strict (Optional[bool]) – Whether to enforce types strictly.
extra (Optional[Literal['allow', 'ignore', 'forbid']]) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
from_attributes (Optional[bool]) – Whether to extract data from object attributes.
context (Optional[Any]) – Additional context to pass to the validator.
by_alias (Optional[bool]) – Whether to use the field’s alias when validating against the provided input data.
by_name (Optional[bool]) – Whether to use the field’s name when validating against the provided input data.

Raises

ValidationError – If the object could not be validated.

Return type

Self

Returns

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, extra=None, context=None, by_alias=None, by_name=None)

!!! abstract “Usage Documentation”: [JSON Parsing](../concepts/json.md#json-parsing)

Validate the given JSON data against the Pydantic model.

Parameters

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (Optional[bool]) – Whether to enforce types strictly.
extra (Optional[Literal['allow', 'ignore', 'forbid']]) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
context (Optional[Any]) – Extra variables to pass to the validator.
by_alias (Optional[bool]) – Whether to use the field’s alias when validating against the provided input data.
by_name (Optional[bool]) – Whether to use the field’s name when validating against the provided input data.

Return type

Self

Returns

The validated Pydantic model.

Raises

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, extra=None, context=None, by_alias=None, by_name=None)

Validate the given object with string data against the Pydantic model.

Parameters

obj (Any) – The object containing string data to validate.
strict (Optional[bool]) – Whether to enforce types strictly.
extra (Optional[Literal['allow', 'ignore', 'forbid']]) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
context (Optional[Any]) – Extra variables to pass to the validator.
by_alias (Optional[bool]) – Whether to use the field’s alias when validating against the provided input data.
by_name (Optional[bool]) – Whether to use the field’s name when validating against the provided input data.

Return type

Self

Returns

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)

Return type: Self

classmethod parse_obj(obj)

Return type: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)

Return type: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')

Return type: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)

Return type: str

classmethod update_forward_refs(**localns)

Return type: None

classmethod validate(value)

Return type: Self

property model_extra: dict[str, Any] | None

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to “allow”.

property model_fields_set: set[str]

Returns the set of fields that have been explicitly set on this model instance.

Returns

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

exception nisystemlink.clients.core.ApiException(message=None, error=None, http_status_code=None, inner=None)[source]

Represents errors that occur when calling SystemLink APIs.

property error: nisystemlink.clients.core._api_error.ApiError | None: The error information returned by the SystemLink API, or None if the API did not return one or the error occurred trying to call the API.

property http_status_code: int | None: The HTTP status code, if this exception was the result of an HTTP error.

property inner_exception: Exception | None: The exception that caused this failure, if any.

property message: str | None: The error message.

with_traceback(): Exception.with_traceback(tb) – set self.to tb and return self.

class nisystemlink.clients.core.CloudHttpConfiguration(api_key)[source]

An HttpConfiguration specifically for use with SystemLink Cloud.

DEFAULT_TIMEOUT_MILLISECONDS = 60000: The default value of timeout_milliseconds to use when making API calls.

property api_keys: Optional[Dict[str, str]]: The available API keys to use for authorization, or None if none were provided.

property cert_path: pathlib.Path | None: Local path to an SSL certificate file.

property password: str | None: The password to use for HTTP authentication, or None if none was provided.

property server_uri: str

The urllib.parse.urlparse().scheme, urllib.parse.urlparse().hostname, and urllib.parse.urlparse().port of the web server hosting the SystemLink service to connect to.

Additional Uri properties such as urllib.parse.urlparse().path and urllib.parse.urlparse().query are ignored.

property timeout_milliseconds: int

The number of milliseconds before a request times out with an error.

Changing the timeout will not affect APIs that have already read the configuration.

property user_agent: str | None

The string to pass the web server as the product name or names making the request, or None to use a library-specific default.

Changing the user-agent will not affect APIs that have already read the configuration.

property username: str | None: The username to use for HTTP authentication, or None if none was provided.

property verify: bool: Verify the security certificate for connection.

property workspace: str | None: ID of workspace to use for Client operations.

class nisystemlink.clients.core.HttpConfiguration(server_uri, api_key=None, username=None, password=None, cert_path=None, workspace=None, verify=True)[source]

Represents the configuration for accessing a SystemLink service over HTTP.

DEFAULT_TIMEOUT_MILLISECONDS = 60000: The default value of timeout_milliseconds to use when making API calls.

property api_keys: Optional[Dict[str, str]]: The available API keys to use for authorization, or None if none were provided.

property cert_path: pathlib.Path | None: Local path to an SSL certificate file.

property password: str | None: The password to use for HTTP authentication, or None if none was provided.

property server_uri: str

The urllib.parse.urlparse().scheme, urllib.parse.urlparse().hostname, and urllib.parse.urlparse().port of the web server hosting the SystemLink service to connect to.

Additional Uri properties such as urllib.parse.urlparse().path and urllib.parse.urlparse().query are ignored.

property timeout_milliseconds: int

The number of milliseconds before a request times out with an error.

Changing the timeout will not affect APIs that have already read the configuration.

property user_agent: str | None

The string to pass the web server as the product name or names making the request, or None to use a library-specific default.

Changing the user-agent will not affect APIs that have already read the configuration.

property username: str | None: The username to use for HTTP authentication, or None if none was provided.

property verify: bool: Verify the security certificate for connection.

property workspace: str | None: ID of workspace to use for Client operations.

class nisystemlink.clients.core.HttpConfigurationManager[source]

Factory for HttpConfiguration objects.

HTTP_LOCALHOST_CONFIGURATION_ID = 'SYSTEMLINK_LOCALHOST': The default ID of the SystemLink Server’s configuration on the SystemLink Server itself.

HTTP_MASTER_CONFIGURATION_ID = 'SYSTEMLINK_MASTER': The default ID of the SystemLink Server’s configuration on systems registered using SystemLink Client.

classmethod get_configuration(id=None, enable_fallbacks=True)[source]

Get the requested or default configuration.

Parameters

id (Optional[str]) – The ID of the configuration to find.
enable_fallbacks (Optional[bool]) – Whether or not to fallback to other known configurations, if id is unavailable.

Return type

nisystemlink.clients.core.HttpConfiguration

Returns

The configuration.

Raises

ValueError – if id is None and enable_fallbacks is False.
ApiException – if the specified (or default) configuration is not found.

class nisystemlink.clients.core.JupyterHttpConfiguration[source]

An HttpConfiguration for Jupyter notebooks running in a SystemLink environment.

DEFAULT_TIMEOUT_MILLISECONDS = 60000: The default value of timeout_milliseconds to use when making API calls.

property api_keys: Optional[Dict[str, str]]: The available API keys to use for authorization, or None if none were provided.

property cert_path: pathlib.Path | None: Local path to an SSL certificate file.

property password: str | None: The password to use for HTTP authentication, or None if none was provided.

property server_uri: str

The urllib.parse.urlparse().scheme, urllib.parse.urlparse().hostname, and urllib.parse.urlparse().port of the web server hosting the SystemLink service to connect to.

Additional Uri properties such as urllib.parse.urlparse().path and urllib.parse.urlparse().query are ignored.

property timeout_milliseconds: int

The number of milliseconds before a request times out with an error.

Changing the timeout will not affect APIs that have already read the configuration.

property user_agent: str | None

The string to pass the web server as the product name or names making the request, or None to use a library-specific default.

Changing the user-agent will not affect APIs that have already read the configuration.

property username: str | None: The username to use for HTTP authentication, or None if none was provided.

property verify: bool: Verify the security certificate for connection.

property workspace: str | None: ID of workspace to use for Client operations.

class nisystemlink.clients.core.helpers.IteratorFileLike(iterator)[source]

A file-like object adapter that wraps a python iterator, providing a way to read from the iterator as if it was a file.

read(size=-1)[source]

Read at most size bytes from the file-like object. If size is not specified or is negative, read until the iterator is exhausted and returns all bytes or characters read.

Return type: bytes

nisystemlink.clients.core.helpers.paginate(fetch_function, items_field, **fetch_kwargs)[source]

Generate items from paginated API responses using continuation tokens.

This helper function provides a convenient way to iterate over all items from a paginated API endpoint that uses continuation tokens. It automatically handles fetching subsequent pages until all items are retrieved.

Parameters

fetch_function (Callable[..., WithPaging]) – The API function to call to fetch each page of items. Must accept a continuation_token parameter and return a response that derives from WithPaging.
items_field (str) – The name of the field in the response object that contains the list of items to yield.
**fetch_kwargs (Any) – Additional keyword arguments to pass to the fetch function on every call (e.g., filters, take limits, etc.).

Yields

Individual items from each page of results.

Return type

Generator[Any, None, None]

Note

The fetch function will be called with the continuation_token parameter set to None on the first call, then with each subsequent token until the response contains a None continuation token.

nisystemlink.clients.core.helpers.read_minion_id()[source]

Read the minion ID from the Salt configuration.

Returns: The minion ID content if the file exists, None otherwise.
Return type: str | None