Pollination Server
Project description
pollination-sdk
Pollination Server OpenAPI Definition
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.10.19
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://pollination.cloud
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import pollination_sdk
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import pollination_sdk
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import pollination_sdk
from pollination_sdk.rest import ApiException
from pprint import pprint
# Defining host is optional and default to https://api.pollination.cloud
configuration.host = "https://api.pollination.cloud"
# Create an instance of the API class
api_instance = pollination_sdk.UsersApi(pollination_sdk.ApiClient(configuration))
search = ['search_example'] # list[str] | You know, for search (optional)
page = 1 # int | Page number starting from 1 (optional) (default to 1)
per_page = 25 # int | Number of items per page (optional) (default to 25)
try:
# List Users
api_response = api_instance.list_users(search=search, page=page, per_page=per_page)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->list_users: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.pollination.cloud
Class | Method | HTTP request | Description |
---|---|---|---|
APITokensApi | create_token | POST /tokens | Create a new API token |
APITokensApi | delete_token | DELETE /tokens/{token_id} | Delete an API Token |
APITokensApi | list_tokens | GET /tokens | List user API tokens |
APITokensApi | regenerate_token | PUT /tokens/{token_id} | Regenerate an API token |
AccountsApi | get_account | GET /accounts/{name} | Get an account by name |
AccountsApi | list_accounts | GET /accounts | List Accounts on the Pollination platform |
ArtifactsApi | create_artifact | POST /projects/{owner}/{name}/artifacts | Get an Artifact upload link. |
ArtifactsApi | delete_artifact | DELETE /projects/{owner}/{name}/artifacts | Delete one or many artifacts by key/prefix |
ArtifactsApi | download_artifact | GET /projects/{owner}/{name}/artifacts/download | Download an artifact from the project folder |
ArtifactsApi | list_artifacts | GET /projects/{owner}/{name}/artifacts | List artifacts in a project folder |
OrgsApi | create_org | POST /orgs | Create an Org |
OrgsApi | delete_org | DELETE /orgs/{name} | Delete an Org |
OrgsApi | delete_org_member | DELETE /orgs/{name}/members/{username} | Remove an Org member |
OrgsApi | get_org | GET /orgs/{name} | Get an Org |
OrgsApi | get_org_members | GET /orgs/{name}/members | List organization members |
OrgsApi | list_orgs | GET /orgs | List Orgs |
OrgsApi | update_org | PUT /orgs/{name} | Update an Org |
OrgsApi | upsert_org_member | PATCH /orgs/{name}/members/{username}/{role} | Add or update the role of an Org Member |
PluginsApi | create_plugin | POST /plugins/{owner} | Create a plugin |
PluginsApi | create_plugin_package | POST /plugins/{owner}/{name}/tags | Create a new Plugin package |
PluginsApi | delete_plugin | DELETE /plugins/{owner}/{name} | Delete a plugin |
PluginsApi | delete_plugin_org_permission | DELETE /plugins/{owner}/{name}/permissions | Remove a Repository permissions |
PluginsApi | get_plugin | GET /plugins/{owner}/{name} | Get a plugin |
PluginsApi | get_plugin_access_permissions | GET /plugins/{owner}/{name}/permissions | Get plugin access permissions |
PluginsApi | get_plugin_by_tag | GET /plugins/{owner}/{name}/tags/{tag} | Get a plugin tag |
PluginsApi | list_plugin_tags | GET /plugins/{owner}/{name}/tags | Get a plugin tags |
PluginsApi | list_plugins | GET /plugins | List plugins |
PluginsApi | update_plugin | PUT /plugins/{owner}/{name} | Update a plugin |
PluginsApi | upsert_plugin_permission | PATCH /plugins/{owner}/{name}/permissions | Upsert a new permission to a plugin |
ProjectsApi | create_project | POST /projects/{owner} | Create a Project |
ProjectsApi | create_project_recipe_filter | POST /projects/{owner}/{name}/recipes/filters | Upsert a recipe filter to a project |
ProjectsApi | delete_project | DELETE /projects/{owner}/{name} | Delete a Project |
ProjectsApi | delete_project_org_permission | DELETE /projects/{owner}/{name}/permissions | Remove a Project permissions |
ProjectsApi | delete_project_recipe_filter | DELETE /projects/{owner}/{name}/recipes/filters | Remove a Project permissions |
ProjectsApi | get_project | GET /projects/{owner}/{name} | Get a project |
ProjectsApi | get_project_access_permissions | GET /projects/{owner}/{name}/permissions | Get project access permissions |
ProjectsApi | get_project_recipe_filters | GET /projects/{owner}/{name}/recipes/filters | Get project recipe filters |
ProjectsApi | get_project_recipes | GET /projects/{owner}/{name}/recipes | Get project recipes |
ProjectsApi | list_projects | GET /projects | List Projects |
ProjectsApi | update | PUT /projects/{owner}/{name} | Update a Project |
ProjectsApi | upsert_project_permission | PATCH /projects/{owner}/{name}/permissions | Upsert a new permission to a project |
RecipesApi | create_recipe | POST /recipes/{owner} | Create a Recipe |
RecipesApi | create_recipe_package | POST /recipes/{owner}/{name}/tags | Create a new Recipe package |
RecipesApi | delete_recipe | DELETE /recipes/{owner}/{name} | Delete a Recipe |
RecipesApi | delete_recipe_org_permission | DELETE /recipes/{owner}/{name}/permissions | Remove a Repository permissions |
RecipesApi | get_recipe | GET /recipes/{owner}/{name} | Get a recipe |
RecipesApi | get_recipe_access_permissions | GET /recipes/{owner}/{name}/permissions | Get recipe access permissions |
RecipesApi | get_recipe_by_tag | GET /recipes/{owner}/{name}/tags/{tag} | Get a recipe tag |
RecipesApi | list_recipe_tags | GET /recipes/{owner}/{name}/tags | Get a recipe tags |
RecipesApi | list_recipes | GET /recipes | List recipes |
RecipesApi | update_recipe | PUT /recipes/{owner}/{name} | Update a Recipe |
RecipesApi | upsert_recipe_permission | PATCH /recipes/{owner}/{name}/permissions | Upsert a new permission to a recipe |
RegistriesApi | get_package | GET /registries/{owner}/{type}/{name}/{digest} | Get Package |
RegistriesApi | get_package_json | GET /registries/{owner}/{type}/{name}/{digest}/json | Get Package in JSON format |
RegistriesApi | get_registry_index | GET /registries/{owner}/index.json | Get Registry Index |
RegistriesApi | post_plugin | POST /registries/{owner}/plugins | Push a plugin to the registry |
RegistriesApi | post_recipe | POST /registries/{owner}/recipes | Push an Recipe to the registry |
RunsApi | create_run | POST /projects/{owner}/{name}/runs | Schedule a run |
RunsApi | download_run_artifact | GET /projects/{owner}/{name}/runs/{run_id}/artifacts/download | Download an artifact from the run folder |
RunsApi | get_run | GET /projects/{owner}/{name}/runs/{run_id} | Get a Run |
RunsApi | get_run_output | GET /projects/{owner}/{name}/runs/{run_id}/outputs/{output_name} | Get run output by name |
RunsApi | get_run_step_logs | GET /projects/{owner}/{name}/runs/{run_id}/steps/{step_id}/logs | Get the logs of a specific step of the run |
RunsApi | get_run_steps | GET /projects/{owner}/{name}/runs/{run_id}/steps | Query the steps of a run |
RunsApi | list_run_artifacts | GET /projects/{owner}/{name}/runs/{run_id}/artifacts | List artifacts in a run folder |
RunsApi | list_runs | GET /projects/{owner}/{name}/runs | List runs |
RunsApi | resume_run | PUT /projects/{owner}/{name}/runs/{run_id}/resume | resume a run |
RunsApi | stop_run | PUT /projects/{owner}/{name}/runs/{run_id}/stop | Stop a run |
RunsApi | suspend_run | PUT /projects/{owner}/{name}/runs/{run_id}/suspend | Suspend a run |
TeamsApi | create_team | POST /orgs/{org_name}/teams | Create a Team |
TeamsApi | delete_org_team_member | DELETE /orgs/{org_name}/teams/{team_slug}/members/{username} | Remove a team member |
TeamsApi | delete_team | DELETE /orgs/{org_name}/teams/{team_slug} | Delete a Team |
TeamsApi | get_org_team_members | GET /orgs/{org_name}/teams/{team_slug}/members | List team members |
TeamsApi | get_team | GET /orgs/{org_name}/teams/{team_slug} | Get a Team |
TeamsApi | list_org_teams | GET /orgs/{org_name}/teams | List Teams |
TeamsApi | update_team | PUT /orgs/{org_name}/teams/{team_slug} | Update a Team |
TeamsApi | upsert_org_team_member | PATCH /orgs/{org_name}/teams/{team_slug}/members/{username}/{role} | Add or update the role of an Team Member |
UserApi | create_user | POST /user | Register a new user |
UserApi | get_me | GET /user | Get authenticated user profile. |
UserApi | get_roles | GET /user/roles | Get the authenticated user roles |
UserApi | update_user_profile | PUT /user | Update the authenticated user |
UsersApi | check_username | GET /users/check_username/{username} | Check if a username is already taken |
UsersApi | get_one_user | GET /users/{name} | Get a specific user profile |
UsersApi | list_users | GET /users | List Users |
Documentation For Models
- APIToken
- APITokenCreate
- APITokenList
- APITokenPrivate
- Accepted
- AccountPublic
- BodyPostPluginRegistriesOwnerPluginsPost
- BodyPostRecipeRegistriesOwnerRecipesPost
- CreatedContent
- DAG
- DAGArrayInput
- DAGArrayInputAlias
- DAGArrayOutput
- DAGArrayOutputAlias
- DAGBooleanInput
- DAGBooleanInputAlias
- DAGBooleanOutput
- DAGBooleanOutputAlias
- DAGFileInput
- DAGFileInputAlias
- DAGFileOutput
- DAGFileOutputAlias
- DAGFolderInput
- DAGFolderInputAlias
- DAGFolderOutput
- DAGFolderOutputAlias
- DAGGenericInput
- DAGGenericInputAlias
- DAGGenericOutput
- DAGGenericOutputAlias
- DAGIntegerInput
- DAGIntegerInputAlias
- DAGIntegerOutput
- DAGIntegerOutputAlias
- DAGJSONObjectInput
- DAGJSONObjectInputAlias
- DAGJSONObjectOutput
- DAGJSONObjectOutputAlias
- DAGLinkedInputAlias
- DAGLinkedOutputAlias
- DAGNumberInput
- DAGNumberInputAlias
- DAGNumberOutput
- DAGNumberOutputAlias
- DAGPathInput
- DAGPathInputAlias
- DAGPathOutput
- DAGPathOutputAlias
- DAGStringInput
- DAGStringInputAlias
- DAGStringOutput
- DAGStringOutputAlias
- DAGTask
- DAGTaskLoop
- Dependency
- DependencyKind
- DockerConfig
- FileMeta
- FileReference
- FolderReference
- Function
- FunctionArrayInput
- FunctionArrayOutput
- FunctionBooleanInput
- FunctionBooleanOutput
- FunctionFileInput
- FunctionFileOutput
- FunctionFolderInput
- FunctionFolderOutput
- FunctionIntegerInput
- FunctionIntegerOutput
- FunctionJSONObjectInput
- FunctionJSONObjectOutput
- FunctionNumberInput
- FunctionNumberOutput
- FunctionPathInput
- FunctionPathOutput
- FunctionStringInput
- FunctionStringOutput
- HTTP
- HTTPValidationError
- IOAliasHandler
- InputFileReference
- InputFolderReference
- InputPathReference
- InputReference
- ItemReference
- ItemType
- Job
- JobArgument
- JobPathArgument
- JobStatus
- KeyRequest
- License
- LocalConfig
- Maintainer
- MetaData
- NewPluginPackage
- NewRecipePackage
- Organization
- OrganizationCreate
- OrganizationList
- OrganizationMember
- OrganizationMemberList
- OrganizationRoleEnum
- OrganizationUpdate
- PackageVersion
- Permission
- Plugin
- PluginConfig
- PluginPackage
- PluginPackageList
- PolicySubject
- Project
- ProjectAccessPolicy
- ProjectAccessPolicyList
- ProjectCreate
- ProjectFolder
- ProjectList
- ProjectPolicySubject
- ProjectRecipeFilter
- ProjectRecipeFilterList
- ProjectUpdate
- ProjectUserPermissions
- PublicAccountList
- Recipe
- RecipeInterface
- RecipeInterfaceList
- RecipePackage
- RecipePackageList
- Repository
- RepositoryAccessPolicy
- RepositoryAccessPolicyList
- RepositoryCreate
- RepositoryIndex
- RepositoryList
- RepositoryMetadata
- RepositoryPolicySubject
- RepositoryUpdate
- RepositoryUserPermissions
- Run
- RunList
- S3
- S3UploadRequest
- StatusType
- StepArrayInput
- StepArrayOutput
- StepBooleanInput
- StepBooleanOutput
- StepFileInput
- StepFileOutput
- StepFolderInput
- StepFolderOutput
- StepIntegerInput
- StepIntegerOutput
- StepJSONObjectInput
- StepJSONObjectOutput
- StepList
- StepNumberInput
- StepNumberOutput
- StepPathInput
- StepPathOutput
- StepStatus
- StepStringInput
- StepStringOutput
- SubjectType
- TaskArgument
- TaskFileReference
- TaskFolderReference
- TaskPathArgument
- TaskPathReference
- TaskPathReturn
- TaskReference
- TaskReturn
- Team
- TeamCreate
- TeamList
- TeamMember
- TeamMemberList
- TeamRoleEnum
- TeamUpdate
- UpdateAccepted
- UserCreate
- UserPrivate
- UserPublic
- UserPublicList
- UserUpdate
- ValidationError
- ValueFileReference
- ValueFolderReference
- ValueListReference
- ValueReference
Documentation For Authorization
APIKeyAuth
- Type: API key
- API key parameter name: x-pollination-token
- Location: HTTP header
JWTAuth
- Type: Bearer authentication
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pollination-sdk-0.10.19.tar.gz
(191.6 kB
view hashes)
Built Distribution
Close
Hashes for pollination_sdk-0.10.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4220b6f419e929ec8c2d191cb2c11e597e58730a578f48bafecc040c082d06df |
|
MD5 | 9b4fa19b9f7dc9d83c3e87a54414c7d4 |
|
BLAKE2b-256 | 847752563a879a807b5b3153de6012bd901a6cdd3c86fb8acbc56e524628d1aa |