Rust API client for tapis-streams

Manage Tapis Streams API.

For more information, please visit https://tapis-project.org

Overview

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

API version: 1
Package version: 0.2.0
Generator version: 7.18.0
Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named tapis-streams and add the following to Cargo.toml under [dependencies]:

tapis-streams = { path = "./tapis-streams" }

Documentation for API Endpoints

All URIs are relative to http://localhost:5000

Class	Method	HTTP request	Description
ArchivesApi	archive_project	POST /v3/streams/projects/{project_id}/archives	Archive a projects data and metadata
ArchivesApi	list_archives	GET /v3/streams/projects/{project_id}/archives	List Archive policies for a project
ChannelsApi	create_channels	POST /v3/streams/channels	Create channels.
ChannelsApi	delete_channel	DELETE /v3/streams/channels/{channel_id}	Delete a channel
ChannelsApi	get_channel	GET /v3/streams/channels/{channel_id}	Get channels details
ChannelsApi	list_alerts	GET /v3/streams/channels/{channel_id}/alerts	List alerts for given channel id
ChannelsApi	list_channels	GET /v3/streams/channels	List channels.
ChannelsApi	update_channel	PUT /v3/streams/channels/{channel_id}	Update a channel
ChannelsApi	update_status	POST /v3/streams/channels/{channel_id}	Update channel status
HealthcheckApi	healthcheck	GET /v3/streams/healthcheck	Healthcheck
HelloApi	hello	GET /v3/streams/hello	Say Hello
InstrumentsApi	create_instrument	POST /v3/streams/projects/{project_id}/sites/{site_id}/instruments	Create instruments (single or bulk)
InstrumentsApi	delete_instrument	DELETE /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}	Delete an instrument
InstrumentsApi	get_instrument	GET /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}	Get instrument details
InstrumentsApi	list_instruments	GET /v3/streams/projects/{project_id}/sites/{site_id}/instruments	List instruments
InstrumentsApi	update_instrument	PUT /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}	Update an instrument
MeasuredPropertiesApi	list_measured_properties	GET /measured_properties	List measured_properties.
MeasurementsApi	create_measurement	POST /v3/streams/measurements	Create a measurement.
MeasurementsApi	download_measurements	GET /v3/streams/measurements/{inst_id}	List measurements when only inst_id is provided
MeasurementsApi	list_measurements	GET /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/measurements	List measurements.
OntologiesApi	add_ontology	POST /v3/streams/ontologies	Add an ontology .
OntologiesApi	delete_ontology	DELETE /v3/streams/ontologies/{onto_id}	Delete an ontology
OntologiesApi	get_ontology	GET /v3/streams/ontologies/{onto_id}	Get ontology details.
OntologiesApi	list_ontologies	GET /v3/streams/ontologies	List ontologies.
OntologiesApi	update_ontology	PUT /v3/streams/ontologies/{onto_id}	Update an ontology
ProjectsApi	create_project	POST /v3/streams/projects	Create a project.
ProjectsApi	delete_project	DELETE /v3/streams/projects/{project_id}	Delete a project
ProjectsApi	get_project	GET /v3/streams/projects/{project_id}	Get project details.
ProjectsApi	list_projects	GET /v3/streams/projects	List projects.
ProjectsApi	update_project	PUT /v3/streams/projects/{project_id}	Update a project
ReadyApi	ready	GET /v3/streams/ready	Check readiness of InfluxDB, Chords and Kapacitor
RevokeRolesApi	revoke_role	POST /v3/streams/roles/revokeRole	Revoke user role.
RolesApi	grant_role	POST /v3/streams/roles	Grant user role.
RolesApi	list_roles	GET /v3/streams/roles	List roles for a given user
SearchAcrossAllStreamsEndPointsApi	search	GET /v3/streams/search/{resource_type}	Search projects, sites, intruments and variables owned by a user
SitesApi	create_site	POST /v3/streams/projects/{project_id}/sites	Create a site. (single or bulk)
SitesApi	delete_site	DELETE /v3/streams/projects/{project_id}/sites/{site_id}	Delete a site
SitesApi	get_site	GET /v3/streams/projects/{project_id}/sites/{site_id}	Get site details.
SitesApi	list_sites	GET /v3/streams/projects/{project_id}/sites	List sites.
SitesApi	update_site	PUT /v3/streams/projects/{project_id}/sites/{site_id}	Update a site
TemplatesApi	create_template	POST /v3/streams/templates	Create template.
TemplatesApi	get_template	GET /v3/streams/templates/{template_id}	Get templates.
TemplatesApi	list_templates	GET /v3/streams/templates	List templates.
TemplatesApi	update_template	PUT /v3/streams/templates/{template_id}	Update template.
TransferInstrumentDataApi	transfer_data	POST /v3/streams/transfer	Transfer an instruments data to a system
UnitsApi	list_units	GET /units	List units.
VariablesApi	create_variable	POST /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/variables	Create variable (single or bulk).
VariablesApi	delete_variable	DELETE /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/variables/{var_id}	Delete a variable
VariablesApi	get_variable	GET /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/variables/{var_id}	Get variable details
VariablesApi	list_variables	GET /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/variables	List variables.
VariablesApi	update_variable	PUT /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/variables/{var_id}	Update a variable

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author