MetaApi: Agave Meta API operations

In deardooley/agave-rlang-sdk: Agave Platform client SDK for R

Description

MetaApi Class

Usage

meta <- MetaApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )

Format

An object of class R6ClassGenerator of length 24.

Details

The Agave Metadata service allows you to manage metadata and associate it with Agave entities via associated UUIDs. It supports JSON schema for structured JSON metadata; it also accepts any valid JSON-formatted metadata or plain text String when no schema is specified. As with other Agave services, a full access control layer is available, enabling you to keep your metadata private or share it with your colleagues.

Read more about the Meta API in the Agave Developer's Guide

Arguments

apiClient a rAgave::ApiClient instance preconfigured to speak to the Agave Platform.

cache an rAgave::AgaveCache instance pointing to the persistent auth cache file on disk.

responseType the default object type methods of this class should return. Valid values are:

• raw: the raw JSON string response from the API. You may optionally include pretty=TRUE in the method call to receive pretty printed JSON.

• list: a standard R list object. This is the default value.

• dt: a data table

Methods

$addMetadata() Update or Add new Metadata.

Usage

meta$addMetadata$listMeta(body, naked, )

$addMetadataPermission() Add a user permission for the given metadata.

Usage

meta$addMetadataPermission$listMeta(uuid, body, naked, )

$addMetadataSchema() Add a new Metadata Schema.

Usage

meta$addMetadataSchema$listMeta(body, naked, )

$addMetadataSchemaPermission() Add a user permission for the given schema.

Usage

meta$addMetadataSchemaPermission$listMeta(uuid, body, naked, )

$clearMetadataPermissions() Deletes all permissions on the given metadata.

Usage

meta$clearMetadataPermissions$listMeta(uuid, naked, )

$clearMetadataSchemaPermissions() Deletes all permissions on the given schema.

Usage

meta$clearMetadataSchemaPermissions$listMeta(uuid, naked, )

$deleteMetadata() Remove Metadata from the system.

Usage

meta$deleteMetadata$listMeta(uuid, naked, )

$deleteMetadataPermission() Removes user permissions for a user on a given metadata resource.

Usage

meta$deleteMetadataPermission$listMeta(uuid, username, naked, )

$deleteMetadataSchema() Remove Metadata Schema from the system.

Usage

meta$deleteMetadataSchema$listMeta(uuid, naked, )

$deleteSchemaPermission() Deletes all metadata schema permissions on the given metadata.

Usage

meta$deleteSchemaPermission$listMeta(uuid, username, naked, )

$getMetadata() Retrieve Metadata.

Usage

meta$getMetadata$listMeta(uuid, naked, )

$getMetadataPermission() Get the user permission for this metadata.

Usage

meta$getMetadataPermission$listMeta(uuid, username, naked, )

$getMetadataSchema() Retrieve Metadata Schemata.

Usage

meta$getMetadataSchema$listMeta(uuid, naked, )

$getMetadataSchemaPermission() Get the user permission for this schema.

Usage

meta$getMetadataSchemaPermission$listMeta(uuid, username, naked, )

$listMetadata() List and/or search metadata.

Usage

meta$listMetadata$listMeta(q, naked, limit, offset, search, )
meta$listMetadata$listMeta(search=list("foo"="bar"))

$listMetadataPermissions() Get the permission ACL for this metadata.

Usage

meta$listMetadataPermissions$listMeta(uuid, naked, limit, offset, search, )
meta$listMetadataPermissions$listMeta(search=list("foo"="bar"))

$listMetadataSchema() List and query Metadata Schemata.

Usage

meta$listMetadataSchema$listMeta(q, naked, limit, offset, search, )
meta$listMetadataSchema$listMeta(search=list("foo"="bar"))

$listMetadataSchemaPermissions() Get the permission for this schema.

Usage

meta$listMetadataSchemaPermissions$listMeta(uuid, naked, limit, offset, search, )
meta$listMetadataSchemaPermissions$listMeta(search=list("foo"="bar"))

$updateMetadata() Update or Add new Metadata.

Usage

meta$updateMetadata$listMeta(uuid, body, naked, )

$updateMetadataPermission() Update a user permission for the given metadata.

Usage

meta$updateMetadataPermission$listMeta(uuid, username, body, naked, )

$updateMetadataSchema() Update an existing Metadata Schema.

Usage

meta$updateMetadataSchema$listMeta(uuid, body, naked, )

$updateMetadataSchemaPermission() Add or update a user permission for the given metadata schema.

Usage

meta$updateMetadataSchemaPermission$listMeta(uuid, username, body, naked, )

See Also

rAgave::ApiClient rAgave::Agave [rAgave::Metadata][rAgave::MetadataSchema][rAgave::Permission]

deardooley/agave-rlang-sdk documentation built on May 17, 2019, 10:12 p.m.