The `permissions.py` module#

Summary#

Classes

`Resource`	!!! abstract “Usage Documentation”
`Subject`	!!! abstract “Usage Documentation”
`RoleAssignment`	!!! abstract “Usage Documentation”
`RoleQuery`	!!! abstract “Usage Documentation”

Enums

`ResourceType`	Create a collection of name/value pairs.
`RoleType`	Create a collection of name/value pairs.
`SubjectType`	Create a collection of name/value pairs.

Module detail#

class permissions.Resource(/, **data: Any)#

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

Attributes:

__class_vars__: The names of the class variables defined on the model. __private_attributes__: Metadata about the private attributes of the model. __signature__: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__: Whether model building is completed, or if there are still undefined fields. __pydantic_core_schema__: The core schema of the model. __pydantic_custom_init__: Whether the model has a custom __init__ function. __pydantic_decorators__: Metadata containing the decorators defined on the model.

This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to: __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models. __pydantic_post_init__: The name of the post-init method for the model, if defined. __pydantic_root_model__: Whether the model is a [RootModel][pydantic.root_model.RootModel]. __pydantic_serializer__: The pydantic-core SchemaSerializer used to dump instances of the model. __pydantic_validator__: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects. __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra]: is set to ‘allow’.

__pydantic_fields_set__: The names of fields explicitly set during instantiation. __pydantic_private__: Values of private attributes set on the model instance.

Overview#

Attributes

`path`
`type`

Import detail#

from ansys.hps.data_transfer.client.models.permissions import Resource

Attribute detail#

Resource.path: str | None = 'my/path/to/data/file.txt'#

Resource.type: ResourceType | None = None#

class Resource.Subject(/, **data: Any)#

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

Attributes:

__class_vars__: The names of the class variables defined on the model. __private_attributes__: Metadata about the private attributes of the model. __signature__: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__: Whether model building is completed, or if there are still undefined fields. __pydantic_core_schema__: The core schema of the model. __pydantic_custom_init__: Whether the model has a custom __init__ function. __pydantic_decorators__: Metadata containing the decorators defined on the model.

This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to: __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models. __pydantic_post_init__: The name of the post-init method for the model, if defined. __pydantic_root_model__: Whether the model is a [RootModel][pydantic.root_model.RootModel]. __pydantic_serializer__: The pydantic-core SchemaSerializer used to dump instances of the model. __pydantic_validator__: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects. __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra]: is set to ‘allow’.

__pydantic_fields_set__: The names of fields explicitly set during instantiation. __pydantic_private__: Values of private attributes set on the model instance.

Overview#

Attributes

`id`
`type`

Import detail#

from ansys.hps.data_transfer.client.models.permissions import Subject

Attribute detail#

Subject.id: str | None = '946991ec-828c-4de4-acbe-962ada8bc441'#

Subject.type: SubjectType | None = None#

class Subject.RoleAssignment(/, **data: Any)#

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

Attributes:

__class_vars__: The names of the class variables defined on the model. __private_attributes__: Metadata about the private attributes of the model. __signature__: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__: Whether model building is completed, or if there are still undefined fields. __pydantic_core_schema__: The core schema of the model. __pydantic_custom_init__: Whether the model has a custom __init__ function. __pydantic_decorators__: Metadata containing the decorators defined on the model.

This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to: __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models. __pydantic_post_init__: The name of the post-init method for the model, if defined. __pydantic_root_model__: Whether the model is a [RootModel][pydantic.root_model.RootModel]. __pydantic_serializer__: The pydantic-core SchemaSerializer used to dump instances of the model. __pydantic_validator__: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects. __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra]: is set to ‘allow’.

__pydantic_fields_set__: The names of fields explicitly set during instantiation. __pydantic_private__: Values of private attributes set on the model instance.

Overview#

Attributes

`resource`
`role`
`subject`

Import detail#

from ansys.hps.data_transfer.client.models.permissions import RoleAssignment

Attribute detail#

RoleAssignment.resource: Resource | None = None#

RoleAssignment.role: RoleType | None = None#

RoleAssignment.subject: Subject | None = None#

class RoleAssignment.RoleQuery(/, **data: Any)#

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

Attributes:

__class_vars__: The names of the class variables defined on the model. __private_attributes__: Metadata about the private attributes of the model. __signature__: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__: Whether model building is completed, or if there are still undefined fields. __pydantic_core_schema__: The core schema of the model. __pydantic_custom_init__: Whether the model has a custom __init__ function. __pydantic_decorators__: Metadata containing the decorators defined on the model.

This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to: __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models. __pydantic_post_init__: The name of the post-init method for the model, if defined. __pydantic_root_model__: Whether the model is a [RootModel][pydantic.root_model.RootModel]. __pydantic_serializer__: The pydantic-core SchemaSerializer used to dump instances of the model. __pydantic_validator__: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects. __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra]: is set to ‘allow’.

__pydantic_fields_set__: The names of fields explicitly set during instantiation. __pydantic_private__: Values of private attributes set on the model instance.

Overview#

Attributes

`resource`
`role`
`subject`

Import detail#

from ansys.hps.data_transfer.client.models.permissions import RoleQuery

Attribute detail#

RoleQuery.resource: Resource | None = None#

RoleQuery.role: RoleType | None = None#

RoleQuery.subject: Subject | None = None#

class RoleQuery.ResourceType(*args, **kwds)#

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
```
value lookup:
```
>>> Color(1)
```
name lookup:
```
>>> Color['RED']
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[, , ]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

Overview#

Attributes

Doc

Import detail#

from ansys.hps.data_transfer.client.models.permissions import ResourceType

Attribute detail#

ResourceType.Doc = 'document'#

class ResourceType.RoleType(*args, **kwds)#

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
```
value lookup:
```
>>> Color(1)
```
name lookup:
```
>>> Color['RED']
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[, , ]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

Overview#

Attributes

`Reader`
`Writer`
`Admin`

Import detail#

from ansys.hps.data_transfer.client.models.permissions import RoleType

Attribute detail#

RoleType.Reader = 'reader'#

RoleType.Writer = 'writer'#

RoleType.Admin = 'admin'#

class RoleType.SubjectType(*args, **kwds)#

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
```
value lookup:
```
>>> Color(1)
```
name lookup:
```
>>> Color['RED']
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[, , ]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

Overview#

Attributes

`User`
`Group`
`Any`

Import detail#

from ansys.hps.data_transfer.client.models.permissions import SubjectType

Attribute detail#

SubjectType.User = 'user'#

SubjectType.Group = 'group'#

SubjectType.Any = 'any'#

The permissions.py module#

Summary#

Module detail#

Overview#

Import detail#

Attribute detail#

Overview#

Import detail#

Attribute detail#

Overview#

Import detail#

Attribute detail#

Overview#

Import detail#

Attribute detail#

Overview#

Import detail#

Attribute detail#

Overview#

Import detail#

Attribute detail#

Overview#

Import detail#

Attribute detail#

The `permissions.py` module#