nodeum-sdk-go

README

Go API client for nodeum

Nodeum API # Filter parameters When browsing a list of items, multiple filter parameters may be applied. Some operators can be added to the value as a prefix: - = value is equal. Default operator, may be omitted - != value is different - > greater than - >= greater than or equal - < lower than - >= lower than or equal - >< included in list, items should be separated by | - !>< not included in list, items should be separated by | - ~ pattern matching, may include % (any characters) and _ (one character) - !~ pattern not matching, may include % (any characters) and _ (one character)

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

• API version: 2.0.0
• Package version: 2.0.0
• Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./nodeum"

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v2

Class	Method	HTTP request	Description
CloudBucketsApi	IndexCloudBuckets	Get /cloud_buckets	Lists all cloud buckets.
CloudBucketsApi	IndexCloudBucketsByCloudConnector	Get /cloud_connectors/{cloud_connector_id}/cloud_buckets	Lists all cloud buckets.
CloudBucketsApi	IndexCloudBucketsByCloudPool	Get /cloud_pools/{cloud_pool_id}/cloud_buckets	Lists all cloud buckets.
CloudBucketsApi	ShowCloudBucket	Get /cloud_buckets/{cloud_bucket_id}	Displays a specific cloud bucket.
CloudBucketsApi	ShowCloudBucketByCloudConnector	Get /cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}	Displays a specific cloud bucket.
CloudBucketsApi	ShowCloudBucketByCloudPool	Get /cloud_pools/{cloud_pool_id}/cloud_buckets/{cloud_bucket_id}	Displays a specific cloud bucket.
CloudBucketsApi	SyncCloudBuckets	Put /cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync	Synchronize internal cloud buckets with their remote equivalent.
CloudBucketsApi	SyncResultCloudBuckets	Get /cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync	Check result of cloud connector sync job.
CloudConnectorsApi	CreateCloudConnector	Post /cloud_connectors	Creates a new cloud connector.
CloudConnectorsApi	DestroyCloudConnector	Delete /cloud_connectors/{cloud_connector_id}	Destroys a specific cloud connector.
CloudConnectorsApi	IndexCloudConnectors	Get /cloud_connectors	Lists all cloud connectors.
CloudConnectorsApi	ShowCloudConnector	Get /cloud_connectors/{cloud_connector_id}	Displays a specific cloud connector.
CloudConnectorsApi	TestCloudConnector	Put /cloud_connectors/-/test	Test an unsaved cloud connector.
CloudConnectorsApi	TestResultCloudConnector	Get /cloud_connectors/-/test	Check result of cloud connector test job.
CloudConnectorsApi	UpdateCloudConnector	Put /cloud_connectors/{cloud_connector_id}	Updates a specific cloud connector.
CloudPoolsApi	CreateCloudPool	Post /cloud_pools	Creates a new cloud pool.
CloudPoolsApi	DestroyCloudPool	Delete /cloud_pools/{cloud_pool_id}	Destroys a specific cloud pool.
CloudPoolsApi	IndexCloudPools	Get /cloud_pools	Lists all cloud pools.
CloudPoolsApi	ShowCloudPool	Get /cloud_pools/{cloud_pool_id}	Displays a specific cloud pool.
CloudPoolsApi	UpdateCloudPool	Put /cloud_pools/{cloud_pool_id}	Updates a specific cloud pool.
ContainersApi	CreateContainer	Post /containers	Creates a new container.
ContainersApi	CreateContainerPrivilege	Post /containers/{container_id}/container_privileges	Creates a new privilege on the container.
ContainersApi	DestroyContainer	Delete /containers/{container_id}	Destroys a specific container.
ContainersApi	DestroyContainerPrivilege	Delete /containers/{container_id}/container_privileges/{container_privilege_id}	Destroys a specific privilege.
ContainersApi	IndexContainerPrivileges	Get /containers/{container_id}/container_privileges	Lists all privilege on the container.
ContainersApi	IndexContainers	Get /containers	Lists all containers.
ContainersApi	ShowContainer	Get /containers/{container_id}	Displays a specific container.
ContainersApi	ShowContainerPrivilege	Get /containers/{container_id}/container_privileges/{container_privilege_id}	Displays a specific privilege.
ContainersApi	UpdateContainer	Put /containers/{container_id}	Updates a specific container.
ContainersApi	UpdateContainerPrivilege	Put /containers/{container_id}/container_privileges/{container_privilege_id}	Updates a specific privilege.
FilesApi	FilesChildren	Get /files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	FilesChildrenByCloudPool	Get /cloud_pools/{cloud_pool_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	FilesChildrenByContainer	Get /containers/{container_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	FilesChildrenByNasPool	Get /nas_pools/{nas_pool_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	FilesChildrenByTapePool	Get /tape_pools/{tape_pool_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	FilesChildrenByTask	Get /tasks/{task_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	FilesChildrenByTaskExecution	Get /task_executions/{task_execution_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	FilesChildrenByTaskExecutionByTask	Get /tasks/{task_id}/task_executions/{task_execution_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	IndexFiles	Get /files	Lists files on root.
FilesApi	IndexFilesByCloudPool	Get /cloud_pools/{cloud_pool_id}/files	Lists files on root.
FilesApi	IndexFilesByContainer	Get /containers/{container_id}/files	Lists files on root.
FilesApi	IndexFilesByNasPool	Get /nas_pools/{nas_pool_id}/files	Lists files on root.
FilesApi	IndexFilesByTapePool	Get /tape_pools/{tape_pool_id}/files	Lists files on root.
FilesApi	IndexFilesByTask	Get /tasks/{task_id}/files	Lists files on root.
FilesApi	IndexFilesByTaskExecution	Get /task_executions/{task_execution_id}/files	Lists files on root.
FilesApi	IndexFilesByTaskExecutionByTask	Get /tasks/{task_id}/task_executions/{task_execution_id}/files	Lists files on root.
FilesApi	ShowFile	Get /files/{file_id}	Displays a specific file.
FilesApi	ShowFileByCloudPool	Get /cloud_pools/{cloud_pool_id}/files/{file_id}	Displays a specific file.
FilesApi	ShowFileByContainer	Get /containers/{container_id}/files/{file_id}	Displays a specific file.
FilesApi	ShowFileByNasPool	Get /nas_pools/{nas_pool_id}/files/{file_id}	Displays a specific file.
FilesApi	ShowFileByTapePool	Get /tape_pools/{tape_pool_id}/files/{file_id}	Displays a specific file.
FilesApi	ShowFileByTask	Get /tasks/{task_id}/files/{file_id}	Displays a specific file.
FilesApi	ShowFileByTaskExecution	Get /task_executions/{task_execution_id}/files/{file_id}	Displays a specific file.
FilesApi	ShowFileByTaskExecutionByTask	Get /tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}	Displays a specific file.
MountPointsApi	CreateMountPoint	Post /mount_points	Creates a new mount point.
MountPointsApi	DestroyMountPoint	Delete /mount_points/{mount_point_id}	Destroys a specific mount point.
MountPointsApi	IndexMountPoints	Get /mount_points	Lists all mount points.
MountPointsApi	ShowMountPoint	Get /mount_points/{mount_point_id}	Displays a specific mount point`.
MountPointsApi	UpdateMountPoint	Put /mount_points/{mount_point_id}	Updates a specific mount point`.
NasApi	CreateNas	Post /nas	Creates a new NAS.
NasApi	DestroyNas	Delete /nas/{nas_id}	Destroys a specific NAS.
NasApi	IndexNas	Get /nas	Lists all NAS.
NasApi	ShowNas	Get /nas/{nas_id}	Displays a specific NAS.
NasApi	UpdateNas	Put /nas/{nas_id}	Updates a specific NAS.
NasPoolsApi	CreateNasPool	Post /nas_pools	Creates a new NAS pool.
NasPoolsApi	DestroyNasPool	Delete /nas_pools/{nas_pool_id}	Destroys a specific NAS pool.
NasPoolsApi	IndexNasPools	Get /nas_pools	Lists all NAS pools.
NasPoolsApi	ShowNasPool	Get /nas_pools/{nas_pool_id}	Displays a specific NAS pool.
NasPoolsApi	UpdateNasPool	Put /nas_pools/{nas_pool_id}	Updates a specific NAS pool.
NasSharesApi	CreateNasShareByNas	Post /nas/{nas_id}/nas_shares	Creates a new NAS share.
NasSharesApi	DestroyNasShare	Delete /nas_shares/{nas_share_id}	Destroys a specific NAS share.
NasSharesApi	DestroyNasShareByNas	Delete /nas/{nas_id}/nas_shares/{nas_share_id}	Destroys a specific NAS share.
NasSharesApi	DestroyNasShareByNasPool	Delete /nas_pools/{nas_pool_id}/nas_shares/{nas_share_id}	Destroys a specific NAS share.
NasSharesApi	IndexNasShares	Get /nas_shares	Lists all NAS shares.
NasSharesApi	IndexNasSharesByNas	Get /nas/{nas_id}/nas_shares	Lists all NAS shares.
NasSharesApi	IndexNasSharesByNasPool	Get /nas_pools/{nas_pool_id}/nas_shares	Lists all NAS shares.
NasSharesApi	ShowNasShareByNas	Get /nas/{nas_id}/nas_shares/{nas_share_id}	Displays a specific NAS share.
NasSharesApi	ShowNasShares	Get /nas_shares/{nas_share_id}	Displays a specific NAS share.
NasSharesApi	ShowNasSharesByNasPool	Get /nas_pools/{nas_pool_id}/nas_shares/{nas_share_id}	Displays a specific NAS share.
NasSharesApi	TestNasShare	Put /nas/{nas_id}/nas_shares/-/test	Test an unsaved NAS Share.
NasSharesApi	TestResultNasShare	Get /nas/{nas_id}/nas_shares/-/test	Check result of a NAS Share test job.
NasSharesApi	UpdateNasShare	Put /nas_shares/{nas_share_id}	Updates a specific NAS share.
NasSharesApi	UpdateNasShareByNas	Put /nas/{nas_id}/nas_shares/{nas_share_id}	Updates a specific NAS share.
NasSharesApi	UpdateNasShareByNasPool	Put /nas_pools/{nas_pool_id}/nas_shares/{nas_share_id}	Updates a specific NAS share.
TapeDrivesApi	CreateTapeDriveByTapeLibrary	Post /tape_libraries/{tape_library_id}/tape_drives	Creates a new tape drive.
TapeDrivesApi	DestroyTapeDrive	Delete /tape_drives/{tape_drive_id}	Destroys a specific tape drive.
TapeDrivesApi	DestroyTapeDriveByTapeLibrary	Delete /tape_libraries/{tape_library_id}/tape_drives/{tape_drive_id}	Destroys a specific tape drive.
TapeDrivesApi	IndexTapeDriveDevices	Get /tape_libraries/{tape_library_id}/tape_drives/-/devices	Lists tape drives devices.
TapeDrivesApi	IndexTapeDrives	Get /tape_drives	Lists all tape drives.
TapeDrivesApi	IndexTapeDrivesByTapeLibrary	Get /tape_libraries/{tape_library_id}/tape_drives	Lists all tape drives.
TapeDrivesApi	ShowTapeDrive	Get /tape_drives/{tape_drive_id}	Displays a specific tape drive.
TapeDrivesApi	ShowTapeDriveByTapeLibrary	Get /tape_libraries/{tape_library_id}/tape_drives/{tape_drive_id}	Displays a specific tape drive.
TapeDrivesApi	UpdateTapeDrive	Put /tape_drives/{tape_drive_id}	Updates a specific tape drive.
TapeDrivesApi	UpdateTapeDriveByTapeLibrary	Put /tape_libraries/{tape_library_id}/tape_drives/{tape_drive_id}	Updates a specific tape drive.
TapeLibrariesApi	CreateTapeLibrary	Post /tape_libraries	Creates a new tape library.
TapeLibrariesApi	DestroyTapeLibrary	Delete /tape_libraries/{tape_library_id}	Destroys a specific tape library.
TapeLibrariesApi	IndexTapeLibraries	Get /tape_libraries	Lists all tape libraries.
TapeLibrariesApi	IndexTapeLibraryDevices	Get /tape_libraries/-/devices	Lists tape libraries devices.
TapeLibrariesApi	ShowTapeLibrary	Get /tape_libraries/{tape_library_id}	Displays a specific tape library.
TapeLibrariesApi	UpdateTapeLibrary	Put /tape_libraries/{tape_library_id}	Updates a specific tape library.
TapePoolsApi	CreateTapePool	Post /tape_pools	Creates a new tape pool.
TapePoolsApi	DestroyTapePool	Delete /tape_pools/{tape_pool_id}	Destroys a specific tape pool.
TapePoolsApi	IndexTapePools	Get /tape_pools	Lists all tape pools.
TapePoolsApi	ShowTapePool	Get /tape_pools/{tape_pool_id}	Displays a specific tape pool.
TapePoolsApi	UpdateTapePool	Put /tape_pools/{tape_pool_id}	Updates a specific tape pool.
TapesApi	IndexTapes	Get /tapes	Lists all tapes.
TapesApi	IndexTapesByTapeLibrary	Get /tape_libraries/{tape_library_id}/tapes	Lists all tapes.
TapesApi	IndexTapesByTapePool	Get /tape_pools/{tape_pool_id}/tapes	Lists all tapes.
TapesApi	ShowTape	Get /tapes/{tape_id}	Displays a specific tape.
TapesApi	ShowTapeByTapeLibrary	Get /tape_libraries/{tape_library_id}/tapes/{tape_id}	Displays a specific tape.
TapesApi	ShowTapeByTapePool	Get /tape_pools/{tape_pool_id}/tapes/{tape_id}	Displays a specific tape.
TaskDestinationsApi	CreateTaskDestination	Post /tasks/{task_id}/task_destinations	Creates a new task destination.
TaskDestinationsApi	DestroyTaskDestination	Delete /tasks/{task_id}/task_destinations/{task_destination_id}	Destroys a specific task destination.
TaskDestinationsApi	IndexTaskDestinations	Get /tasks/{task_id}/task_destinations	Lists all task destinations.
TaskDestinationsApi	ShowTaskDestination	Get /tasks/{task_id}/task_destinations/{task_destination_id}	Displays a specific task destination.
TaskDestinationsApi	UpdateTaskDestination	Put /tasks/{task_id}/task_destinations/{task_destination_id}	Updates a specific task destination.
TaskExecutionsApi	IndexTaskExecutions	Get /task_executions	Lists all task executions.
TaskExecutionsApi	IndexTaskExecutionsByTask	Get /tasks/{task_id}/task_executions	Lists all task executions.
TaskExecutionsApi	ShowTaskExecution	Get /task_executions/{task_execution_id}	Displays a specific task execution.
TaskExecutionsApi	ShowTaskExecutionByTask	Get /tasks/{task_id}/task_executions/{task_execution_id}	Displays a specific task execution.
TaskMetadataApi	CreateTaskMetadatum	Post /tasks/{task_id}/task_metadata	Creates a new task metadatum.
TaskMetadataApi	DestroyTaskMetadatum	Delete /tasks/{task_id}/task_metadata/{task_metadatum_id}	Destroys a specific task metadatum.
TaskMetadataApi	IndexTaskMetadata	Get /tasks/{task_id}/task_metadata	Lists all task metadata.
TaskMetadataApi	ShowTaskMetadat	Get /tasks/{task_id}/task_metadata/{task_metadatum_id}	Displays a specific task metadatum.
TaskMetadataApi	UpdateTaskMetadatum	Put /tasks/{task_id}/task_metadata/{task_metadatum_id}	Updates a specific task metadatum.
TaskOptionsApi	CreateTaskOption	Post /tasks/{task_id}/task_options	Creates a new task option.
TaskOptionsApi	DestroyTaskOption	Delete /tasks/{task_id}/task_options/{task_option_id}	Destroys a specific task option.
TaskOptionsApi	IndexTaskOptions	Get /tasks/{task_id}/task_options	Lists all task options.
TaskOptionsApi	ShowTaskOption	Get /tasks/{task_id}/task_options/{task_option_id}	Displays a specific task option.
TaskOptionsApi	UpdateTaskOption	Put /tasks/{task_id}/task_options/{task_option_id}	Updates a specific task option.
TaskSourcesApi	CreateTaskSource	Post /tasks/{task_id}/task_sources	Creates a new task source.
TaskSourcesApi	DestroyTaskSource	Delete /tasks/{task_id}/task_sources/{task_source_id}	Destroys a specific task source.
TaskSourcesApi	IndexTaskSources	Get /tasks/{task_id}/task_sources	Lists all task sources.
TaskSourcesApi	ShowTaskSource	Get /tasks/{task_id}/task_sources/{task_source_id}	Displays a specific task source.
TaskSourcesApi	UpdateTaskSource	Put /tasks/{task_id}/task_sources/{task_source_id}	Updates a specific task source.
TasksApi	CreateTask	Post /tasks	Creates a new task.
TasksApi	DestroyTask	Delete /tasks/{task_id}	Destroys a specific task.
TasksApi	IndexTasks	Get /tasks	Lists all tasks.
TasksApi	ShowTask	Get /tasks/{task_id}	Displays a specific task.
TasksApi	UpdateTask	Put /tasks/{task_id}	Updates a specific task.
UsersApi	CreateApiKey	Post /users/me/api_keys	Creates a new API Key for current user.
UsersApi	DestroyApiKey	Delete /users/me/api_keys/{api_key_id}	Destroys a specific API Key.
UsersApi	IndexApiKeys	Get /users/me/api_keys	Lists all API keys of current user.
UsersApi	ShowApiKey	Get /users/me/api_keys/{api_key_id}	Displays a specific API Key with its scopes.
UsersApi	UpdateApiKey	Put /users/me/api_keys/{api_key_id}	Updates a specific API Key.

Documentation For Models

• ActiveJobStatus
• ApiKey
• ApiKeyCollection
• ApiKeyFull
• ApiKeyScope
• AttributeError
• Blank
• CloudBucket
• CloudBucketCollection
• CloudBucketSimpleCollection
• CloudConnector
• CloudConnectorCollection
• CloudPool
• CloudPoolCollection
• CloudPoolUp
• Container
• ContainerCollection
• ContainerPrivilege
• ContainerPrivilegeCollection
• Frozen
• GreaterThan
• GreaterThanOrEqualTo
• ImportFile
• Invalid
• LessThan
• LessThanOrEqualTo
• ModelError
• MountPoint
• MountPointCollection
• Nas
• NasCollection
• NasPool
• NasPoolCollection
• NasPoolUp
• NasShare
• NasShareCollection
• NodeumFile
• NodeumFileCollection
• NodeumFileWithPath
• OccurrenceLessThan
• OccurrenceLessThanOrEqualTo
• QuotaOnCache
• Taken
• Tape
• TapeCollection
• TapeDrive
• TapeDriveCollection
• TapeDriveDevice
• TapeDriveDeviceCollection
• TapeLibrary
• TapeLibraryCollection
• TapeLibraryDevice
• TapeLibraryDeviceCollection
• TapePool
• TapePoolCollection
• TapePoolUp
• Task
• TaskCollection
• TaskDestinationCollection
• TaskDestinationDown
• TaskDestinationUp
• TaskExecution
• TaskExecutionCollection
• TaskMetadatum
• TaskMetadatumCollection
• TaskOption
• TaskOptionCollection
• TaskSourceCollection
• TaskSourceDown
• TaskSourceUp
• TooLong
• TooShort

Documentation For Authorization

BasicAuth

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

BearerAuth

• Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author