The msg.py module

Summary

Classes

BuildInfo	Provides the build information schema for the current build.
CheckPermissionsResponse	Check the permissions response schema for the current user.
CopyMetadataRequest	Provides the request schema for copying metadata.
FileDownloadTokenResponse	Provides the token response schema for for downloading a file.
GetMetadataRequest	Provides the request schema for getting metadata.
MetadataConfigResponse	Provides the response schema for metadata configuration for the current user.
MoveMetadataRequest	Provides the request schema for moving metadata.
OpIdResponse	Provides the response schema for an operation ID.
OpsRequest	Provides the request schema for operations.
PermissionsConfigResponse	Provides the response schema for permissions configuration for the current user.
RemoveMetadataRequest	Provides the request schema for removing metadata.
SetMetadataRequest	Provides the request schema for setting metadata.
Status	Provides the request schema for getting the build status.
StorageConfigResponse	Provides the response schema for storage configuration for the current user.
StoragePath	Provides the schema for a storage path with a remote.
PathOperations	Provides the schema for path operations for a list of storage paths.
SrcDst	Provides the schema for a source destination and destination storage path pair.
SrcDstOperations	Provides the schema for source destination operations for a list of source and destination storage path pairs.
OpsResponse	Provides the response schema for a list of operations.
CheckPermissionsRequest	Provides the request schema for checking permissions for the current user.
GetPermissionsRequest	Provides the request schema for getting permissions for the current user.
GetPermissionsResponse	Provides the response schema for getting permissions for the current user.
RemovePermissionsRequest	Provides the request schema for removing permissions for the current user.
SetPermissionsRequest	Provides the request schema for setting permissions for the current user.

Description

Provides the build information schema and response schemas for other data transfer operations.

Module detail

class msg.BuildInfo(/, **data: Any)

Provides the build information schema for the current build.

Overview

Attributes

branch
mode
revision
short_revision
timestamp
version
version_hash

Import detail

from ansys.hps.data_transfer.client.models.msg import BuildInfo

Attribute detail

BuildInfo.branch: str | None = None

BuildInfo.mode: str | None = None

BuildInfo.revision: str | None = None

BuildInfo.short_revision: str | None = None

BuildInfo.timestamp: str | None = None

BuildInfo.version: str | None = None

BuildInfo.version_hash: str | None = None

class BuildInfo.CheckPermissionsResponse(/, **data: Any)

Check the permissions response schema for the current user.

Overview

Attributes

allowed

Import detail

from ansys.hps.data_transfer.client.models.msg import CheckPermissionsResponse

Attribute detail

CheckPermissionsResponse.allowed: bool | None = None

class CheckPermissionsResponse.CopyMetadataRequest(/, **data: Any)

Provides the request schema for copying metadata.

Overview

Attributes

recursive
src_dst

Import detail

from ansys.hps.data_transfer.client.models.msg import CopyMetadataRequest

Attribute detail

CopyMetadataRequest.recursive: bool | None = None

CopyMetadataRequest.src_dst: list[ansys.hps.data_transfer.client.models.metadata.SrcDst]

class CopyMetadataRequest.FileDownloadTokenResponse(/, **data: Any)

Provides the token response schema for for downloading a file.

Overview

Attributes

token

Import detail

from ansys.hps.data_transfer.client.models.msg import FileDownloadTokenResponse

Attribute detail

FileDownloadTokenResponse.token: str | None = None

class FileDownloadTokenResponse.GetMetadataRequest(/, **data: Any)

Provides the request schema for getting metadata.

Overview

Attributes

paths

Import detail

from ansys.hps.data_transfer.client.models.msg import GetMetadataRequest

Attribute detail

GetMetadataRequest.paths: list[str] | None = None

class GetMetadataRequest.MetadataConfigResponse(/, **data: Any)

Provides the response schema for metadata configuration for the current user.

Overview

Attributes

config

Import detail

from ansys.hps.data_transfer.client.models.msg import MetadataConfigResponse

Attribute detail

MetadataConfigResponse.config: dict[str, Any] | None = None

class MetadataConfigResponse.MoveMetadataRequest(/, **data: Any)

Provides the request schema for moving metadata.

Overview

Attributes

recursive
src_dst

Import detail

from ansys.hps.data_transfer.client.models.msg import MoveMetadataRequest

Attribute detail

MoveMetadataRequest.recursive: bool | None = None

MoveMetadataRequest.src_dst: list[ansys.hps.data_transfer.client.models.metadata.SrcDst]

class MoveMetadataRequest.OpIdResponse(/, **data: Any)

Provides the response schema for an operation ID.

Overview

Attributes

id
location

Import detail

from ansys.hps.data_transfer.client.models.msg import OpIdResponse

Attribute detail

OpIdResponse.id: str | None = '2diK2kCkpgeHAQSNthIZ1JYyPte'

OpIdResponse.location: str | None = '/api/v1/operations/2diK2kCkpgeHAQSNthIZ1JYyPte'

class OpIdResponse.OpsRequest(/, **data: Any)

Provides the request schema for operations.

Overview

Attributes

ids

Import detail

from ansys.hps.data_transfer.client.models.msg import OpsRequest

Attribute detail

OpsRequest.ids: list[str]

class OpsRequest.PermissionsConfigResponse(/, **data: Any)

Provides the response schema for permissions configuration for the current user.

Overview

Attributes

config

Import detail

from ansys.hps.data_transfer.client.models.msg import PermissionsConfigResponse

Attribute detail

PermissionsConfigResponse.config: dict[str, Any] | None = None

class PermissionsConfigResponse.RemoveMetadataRequest(/, **data: Any)

Provides the request schema for removing metadata.

Overview

Attributes

paths
recursive

Import detail

from ansys.hps.data_transfer.client.models.msg import RemoveMetadataRequest

Attribute detail

RemoveMetadataRequest.paths: list[str]

RemoveMetadataRequest.recursive: bool | None = None

class RemoveMetadataRequest.SetMetadataRequest(/, **data: Any)

Provides the request schema for setting metadata.

Overview

Attributes

metadata

Import detail

from ansys.hps.data_transfer.client.models.msg import SetMetadataRequest

Attribute detail

SetMetadataRequest.metadata: SetMetadataRequest.metadata

class SetMetadataRequest.Status(/, **data: Any)

Provides the request schema for getting the build status.

Overview

Attributes

build_info
ready
time

Import detail

from ansys.hps.data_transfer.client.models.msg import Status

Attribute detail

Status.build_info: BuildInfo | None = None

Status.ready: bool | None = None

Status.time: str | None = None

class Status.StorageConfigResponse(/, **data: Any)

Provides the response schema for storage configuration for the current user.

Overview

Attributes

storage

Import detail

from ansys.hps.data_transfer.client.models.msg import StorageConfigResponse

Attribute detail

StorageConfigResponse.storage: list[dict[str, Any]] | None = None

class StorageConfigResponse.StoragePath(/, **data: Any)

Provides the schema for a storage path with a remote.

Overview

Attributes

path
remote

Import detail

from ansys.hps.data_transfer.client.models.msg import StoragePath

Attribute detail

StoragePath.path: str

StoragePath.remote: str | None = 'any'

class StoragePath.PathOperations(/, **data: Any)

Provides the schema for path operations for a list of storage paths.

Overview

Attributes

operations

Import detail

from ansys.hps.data_transfer.client.models.msg import PathOperations

Attribute detail

PathOperations.operations: list[StoragePath]

class PathOperations.SrcDst(/, **data: Any)

Provides the schema for a source destination and destination storage path pair.

Overview

Attributes

dst
src

Import detail

from ansys.hps.data_transfer.client.models.msg import SrcDst

Attribute detail

SrcDst.dst: StoragePath

SrcDst.src: StoragePath

class SrcDst.SrcDstOperations(/, **data: Any)

Provides the schema for source destination operations for a list of source and destination storage path pairs.

Overview

Attributes

operations

Import detail

from ansys.hps.data_transfer.client.models.msg import SrcDstOperations

Attribute detail

SrcDstOperations.operations: list[SrcDst]

class SrcDstOperations.OpsResponse(/, **data: Any)

Provides the response schema for a list of operations.

Overview

Attributes

operations

Import detail

from ansys.hps.data_transfer.client.models.msg import OpsResponse

Attribute detail

OpsResponse.operations: list[ansys.hps.data_transfer.client.models.ops.Operation] | None = None

class OpsResponse.CheckPermissionsRequest(/, **data: Any)

Provides the request schema for checking permissions for the current user.

Overview

Attributes

permissions

Import detail

from ansys.hps.data_transfer.client.models.msg import CheckPermissionsRequest

Attribute detail

CheckPermissionsRequest.permissions: list[perms.RoleAssignment] | None = None

class CheckPermissionsRequest.GetPermissionsRequest(/, **data: Any)

Provides the request schema for getting permissions for the current user.

Overview

Attributes

permissions

Import detail

from ansys.hps.data_transfer.client.models.msg import GetPermissionsRequest

Attribute detail

GetPermissionsRequest.permissions: list[perms.RoleQuery] | None = None

class GetPermissionsRequest.GetPermissionsResponse(/, **data: Any)

Provides the response schema for getting permissions for the current user.

Overview

Attributes

permissions

Import detail

from ansys.hps.data_transfer.client.models.msg import GetPermissionsResponse

Attribute detail

GetPermissionsResponse.permissions: list[perms.RoleAssignment] | None = None

class GetPermissionsResponse.RemovePermissionsRequest(/, **data: Any)

Provides the request schema for removing permissions for the current user.

Overview

Attributes

permissions

Import detail

from ansys.hps.data_transfer.client.models.msg import RemovePermissionsRequest

Attribute detail

RemovePermissionsRequest.permissions: list[perms.RoleAssignment] | None = None

class RemovePermissionsRequest.SetPermissionsRequest(/, **data: Any)

Provides the request schema for setting permissions for the current user.

Overview

Attributes

permissions

Import detail

from ansys.hps.data_transfer.client.models.msg import SetPermissionsRequest

Attribute detail

SetPermissionsRequest.permissions: list[perms.RoleAssignment] | None = None