AbstractMetadataClient (CDAP Common 3.5.1 API)

java.lang.Object
- co.cask.cdap.common.metadata.AbstractMetadataClient

```
public abstract class AbstractMetadataClient
extends Object
```
Common implementation of methods to interact with metadata service over HTTP.

Constructor Summary

Constructors
Constructor and Description

AbstractMetadataClient()

Constructors
Constructor and Description
`AbstractMetadataClient()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addProperties(Id.Application appId, Map<String,String> properties)` Adds properties to an application.
`void`	`addProperties(Id.Artifact artifactId, Map<String,String> properties)` Adds properties to an artifact.
`void`	`addProperties(Id.DatasetInstance datasetInstance, Map<String,String> properties)` Adds properties to a dataset.
`void`	`addProperties(Id.Program programId, Map<String,String> properties)` Adds properties to a program.
`void`	`addProperties(Id.Stream.View viewId, Map<String,String> properties)` Adds properties to a view.
`void`	`addProperties(Id.Stream streamId, Map<String,String> properties)` Adds properties to a stream.
`void`	`addProperties(Id id, Map<String,String> properties)`
`void`	`addTags(Id.Application appId, Set<String> tags)` Adds tags to an application.
`void`	`addTags(Id.Artifact artifactId, Set<String> tags)` Adds tags to an artifact.
`void`	`addTags(Id.DatasetInstance datasetInstance, Set<String> tags)` Adds tags to a dataset.
`void`	`addTags(Id.Program programId, Set<String> tags)` Adds tags to a program.
`void`	`addTags(Id.Stream.View viewId, Set<String> tags)` Adds tags to a view.
`void`	`addTags(Id.Stream streamId, Set<String> tags)` Adds tags to a stream.
`void`	`addTags(Id id, Set<String> tags)`
`protected abstract co.cask.common.http.HttpResponse`	`execute(co.cask.common.http.HttpRequest request, int... allowedErrorCodes)` Executes an HTTP request.
`Set<MetadataRecord>`	`getMetadata(Id.Application appId, MetadataScope scope)`
`Set<MetadataRecord>`	`getMetadata(Id.Artifact artifactId, MetadataScope scope)`
`Set<MetadataRecord>`	`getMetadata(Id.DatasetInstance datasetInstance, MetadataScope scope)`
`Set<MetadataRecord>`	`getMetadata(Id.Program programId, MetadataScope scope)`
`Set<MetadataRecord>`	`getMetadata(Id.Run runId)`
`Set<MetadataRecord>`	`getMetadata(Id.Stream.View viewId, MetadataScope scope)`
`Set<MetadataRecord>`	`getMetadata(Id.Stream streamId, MetadataScope scope)`
`Set<MetadataRecord>`	`getMetadata(Id id)`
`Set<MetadataRecord>`	`getMetadata(Id id, MetadataScope scope)`
`Map<String,String>`	`getProperties(Id.Application appId, MetadataScope scope)`
`Map<String,String>`	`getProperties(Id.Artifact artifactId, MetadataScope scope)`
`Map<String,String>`	`getProperties(Id.DatasetInstance datasetInstance, MetadataScope scope)`
`Map<String,String>`	`getProperties(Id.Program programId, MetadataScope scope)`
`Map<String,String>`	`getProperties(Id.Stream.View viewId, MetadataScope scope)`
`Map<String,String>`	`getProperties(Id.Stream streamId, MetadataScope scope)`
`Map<String,String>`	`getProperties(Id id)`
`Map<String,String>`	`getProperties(Id id, MetadataScope scope)`
`Set<String>`	`getTags(Id.Application appId, MetadataScope scope)`
`Set<String>`	`getTags(Id.Artifact artifactId, MetadataScope scope)`
`Set<String>`	`getTags(Id.DatasetInstance datasetInstance, MetadataScope scope)`
`Set<String>`	`getTags(Id.Program programId, MetadataScope scope)`
`Set<String>`	`getTags(Id.Stream.View viewId, MetadataScope scope)`
`Set<String>`	`getTags(Id.Stream streamId, MetadataScope scope)`
`Set<String>`	`getTags(Id id)`
`Set<String>`	`getTags(Id id, MetadataScope scope)`
`void`	`removeMetadata(Id.Application appId)` Removes metadata from an application.
`void`	`removeMetadata(Id.Artifact artifactId)` Removes metadata from an artifact.
`void`	`removeMetadata(Id.DatasetInstance datasetInstance)` Removes metadata from a dataset.
`void`	`removeMetadata(Id.Program programId)` Removes metadata from a program.
`void`	`removeMetadata(Id.Stream.View viewId)` Removes metadata from a view.
`void`	`removeMetadata(Id.Stream streamId)` Removes metadata from a stream.
`void`	`removeMetadata(Id id)`
`void`	`removeProperties(Id.Application appId)` Removes all properties from an application.
`void`	`removeProperties(Id.Artifact artifactId)` Removes all properties from an artifact.
`void`	`removeProperties(Id.DatasetInstance datasetInstance)` Removes all properties from a dataset.
`void`	`removeProperties(Id.Program programId)` Removes all properties from a program.
`void`	`removeProperties(Id.Stream.View viewId)` Removes all properties from a view.
`void`	`removeProperties(Id.Stream streamId)` Removes all properties from a stream.
`void`	`removeProperties(Id id)`
`void`	`removeProperty(Id.Application appId, String propertyToRemove)` Removes a property from an application.
`void`	`removeProperty(Id.Artifact artifactId, String propertyToRemove)` Removes a property from an artifact.
`void`	`removeProperty(Id.DatasetInstance datasetInstance, String propertyToRemove)` Removes a property from a dataset.
`void`	`removeProperty(Id.Program programId, String propertyToRemove)` Removes a property from a program.
`void`	`removeProperty(Id.Stream.View viewId, String propertyToRemove)` Removes a property from a view.
`void`	`removeProperty(Id.Stream streamId, String propertyToRemove)` Removes a property from a stream.
`void`	`removeProperty(Id id, String property)`
`void`	`removeTag(Id.Application appId, String tagToRemove)` Removes a tag from an application.
`void`	`removeTag(Id.Artifact artifactId, String tagToRemove)` Removes a tag from an artifact.
`void`	`removeTag(Id.DatasetInstance datasetInstance, String tagToRemove)` Removes a tag from a dataset.
`void`	`removeTag(Id.Program programId, String tagToRemove)` Removes a tag from a program.
`void`	`removeTag(Id.Stream.View viewId, String tagToRemove)` Removes a tag from a view.
`void`	`removeTag(Id.Stream streamId, String tagToRemove)` Removes a tag from a stream.
`void`	`removeTag(Id id, String tag)`
`void`	`removeTags(Id.Application appId)` Removes all tags from an application.
`void`	`removeTags(Id.Artifact artifactId)` Removes all tags from an artifact.
`void`	`removeTags(Id.DatasetInstance datasetInstance)` Removes all tags from a dataset.
`void`	`removeTags(Id.Program programId)` Removes all tags from a program.
`void`	`removeTags(Id.Stream.View viewId)` Removes all tags from a view.
`void`	`removeTags(Id.Stream streamId)` Removes all tags from a stream.
`void`	`removeTags(Id id)`
`protected abstract URL`	`resolve(Id.Namespace namesapace, String resource)` Resolves the specified URL.
`Set<MetadataSearchResultRecord>`	`searchMetadata(Id.Namespace namespace, String query, MetadataSearchTargetType target)` Searches entities in the specified namespace whose metadata matches the specified query.
`Set<MetadataSearchResultRecord>`	`searchMetadata(Id.Namespace namespace, String query, Set<MetadataSearchTargetType> targets)` Searches entities in the specified namespace whose metadata matches the specified query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- AbstractMetadataClient
```
public AbstractMetadataClient()
```

Method Detail

execute

protected abstract co.cask.common.http.HttpResponse execute(co.cask.common.http.HttpRequest request,
                                       int... allowedErrorCodes)
                                                     throws IOException,
                                                            UnauthenticatedException,
                                                            UnauthorizedException

Executes an HTTP request.

Throws:: IOException; UnauthenticatedException; UnauthorizedException

resolve

protected abstract URL resolve(Id.Namespace namesapace,
          String resource)
                        throws IOException

Resolves the specified URL.

Throws:: IOException

searchMetadata

public Set<MetadataSearchResultRecord> searchMetadata(Id.Namespace namespace,
                                             String query,
                                             @Nullable
                                             MetadataSearchTargetType target)
                                               throws IOException,
                                                      UnauthenticatedException,
                                                      UnauthorizedException

Searches entities in the specified namespace whose metadata matches the specified query.

Parameters:: namespace - the namespace to search in; query - the query string with which to search; target - the target type. If null, all possible types will be searched
Returns:: A set of MetadataSearchResultRecord for the given query.
Throws:: IOException; UnauthenticatedException; UnauthorizedException

searchMetadata

public Set<MetadataSearchResultRecord> searchMetadata(Id.Namespace namespace,
                                             String query,
                                             Set<MetadataSearchTargetType> targets)
                                               throws IOException,
                                                      UnauthenticatedException,
                                                      UnauthorizedException

Searches entities in the specified namespace whose metadata matches the specified query.

Parameters:: namespace - the namespace to search in; query - the query string with which to search; targets - MetadataSearchTargetTypes to search. If empty, all possible types will be searched
Returns:: A set of MetadataSearchResultRecord for the given query.
Throws:: IOException; UnauthenticatedException; UnauthorizedException

getMetadata

public Set<MetadataRecord> getMetadata(Id id)
                                throws UnauthenticatedException,
                                       BadRequestException,
                                       NotFoundException,
                                       IOException,
                                       UnauthorizedException

Parameters:: id - the entity for which to retrieve metadata across MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata for the entity.
Throws:: UnauthenticatedException; BadRequestException; NotFoundException; IOException; UnauthorizedException

getMetadata

public Set<MetadataRecord> getMetadata(Id id,
                              @Nullable
                              MetadataScope scope)
                                throws NotFoundException,
                                       BadRequestException,
                                       UnauthenticatedException,
                                       IOException,
                                       UnauthorizedException

Parameters:: id - the entity for which to retrieve metadata; scope - the MetadataScope to retrieve the metadata from. If null, this method retrieves metadata from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata for the entity.
Throws:: NotFoundException; BadRequestException; UnauthenticatedException; IOException; UnauthorizedException

getProperties

public Map<String,String> getProperties(Id id)
                                 throws UnauthenticatedException,
                                        BadRequestException,
                                        NotFoundException,
                                        IOException,
                                        UnauthorizedException

Parameters:: id - the entity for which to retrieve metadata properties across MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata properties for the entity.
Throws:: UnauthenticatedException; BadRequestException; NotFoundException; IOException; UnauthorizedException

getProperties

public Map<String,String> getProperties(Id id,
                               @Nullable
                               MetadataScope scope)
                                 throws NotFoundException,
                                        BadRequestException,
                                        UnauthenticatedException,
                                        IOException,
                                        UnauthorizedException

Parameters:: id - the entity for which to retrieve metadata properties; scope - the MetadataScope to retrieve the properties from. If null, this method retrieves properties from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata properties for the entity.
Throws:: NotFoundException; BadRequestException; UnauthenticatedException; IOException; UnauthorizedException

getTags

public Set<String> getTags(Id id)
                    throws UnauthenticatedException,
                           BadRequestException,
                           NotFoundException,
                           IOException,
                           UnauthorizedException

Parameters:: id - the entity for which to retrieve metadata tags across MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata tags for the entity.
Throws:: UnauthenticatedException; BadRequestException; NotFoundException; IOException; UnauthorizedException

getTags

public Set<String> getTags(Id id,
                  @Nullable
                  MetadataScope scope)
                    throws NotFoundException,
                           BadRequestException,
                           UnauthenticatedException,
                           IOException,
                           UnauthorizedException

Parameters:: id - the entity for which to retrieve metadata tags; scope - the MetadataScope to retrieve the tags from. If null, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata tags for the entity.
Throws:: NotFoundException; BadRequestException; UnauthenticatedException; IOException; UnauthorizedException

addProperties

public void addProperties(Id id,
                 Map<String,String> properties)
                   throws NotFoundException,
                          BadRequestException,
                          UnauthenticatedException,
                          IOException,
                          UnauthorizedException

Parameters:: id - the entity for which to add metadata properties; properties - the metadata properties
Throws:: NotFoundException; BadRequestException; UnauthenticatedException; IOException; UnauthorizedException

addTags

public void addTags(Id id,
           Set<String> tags)
             throws NotFoundException,
                    BadRequestException,
                    UnauthenticatedException,
                    IOException,
                    UnauthorizedException

Parameters:: id - the entity for which to add metadata tags; tags - the metadata tags
Throws:: NotFoundException; BadRequestException; UnauthenticatedException; IOException; UnauthorizedException

removeMetadata

public void removeMetadata(Id id)
                    throws NotFoundException,
                           BadRequestException,
                           UnauthenticatedException,
                           IOException,
                           UnauthorizedException

Parameters:: id - the entity for which to remove metadata
Throws:: NotFoundException; BadRequestException; UnauthenticatedException; IOException; UnauthorizedException

removeProperties

public void removeProperties(Id id)
                      throws NotFoundException,
                             BadRequestException,
                             UnauthenticatedException,
                             IOException,
                             UnauthorizedException

Parameters:: id - the entity for which to remove metadata properties
Throws:: NotFoundException; BadRequestException; UnauthenticatedException; IOException; UnauthorizedException

removeTags

public void removeTags(Id id)
                throws NotFoundException,
                       BadRequestException,
                       UnauthenticatedException,
                       IOException,
                       UnauthorizedException

Parameters:: id - the entity for which to remove metadata tags
Throws:: NotFoundException; BadRequestException; UnauthenticatedException; IOException; UnauthorizedException

removeProperty

public void removeProperty(Id id,
                  String property)
                    throws NotFoundException,
                           BadRequestException,
                           UnauthenticatedException,
                           IOException,
                           UnauthorizedException

Parameters:: id - the entity for which to remove a metadata property; property - the property to remove
Throws:: NotFoundException; BadRequestException; UnauthenticatedException; IOException; UnauthorizedException

removeTag

public void removeTag(Id id,
             String tag)
               throws NotFoundException,
                      BadRequestException,
                      UnauthenticatedException,
                      IOException,
                      UnauthorizedException

Parameters:: id - the entity for which to remove a metadata tag; tag - the tag to remove
Throws:: NotFoundException; BadRequestException; UnauthenticatedException; IOException; UnauthorizedException

getMetadata

public Set<MetadataRecord> getMetadata(Id.Application appId,
                              @Nullable
                              MetadataScope scope)
                                throws IOException,
                                       UnauthenticatedException,
                                       NotFoundException,
                                       BadRequestException,
                                       UnauthorizedException

Parameters:: appId - the app for which to retrieve metadata
Returns:: The metadata for the application.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getMetadata

public Set<MetadataRecord> getMetadata(Id.Artifact artifactId,
                              @Nullable
                              MetadataScope scope)
                                throws IOException,
                                       UnauthenticatedException,
                                       NotFoundException,
                                       BadRequestException,
                                       UnauthorizedException

Parameters:: artifactId - the artifact for which to retrieve metadata
Returns:: The metadata for the artifact.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getMetadata

public Set<MetadataRecord> getMetadata(Id.DatasetInstance datasetInstance,
                              @Nullable
                              MetadataScope scope)
                                throws IOException,
                                       UnauthenticatedException,
                                       NotFoundException,
                                       BadRequestException,
                                       UnauthorizedException

Parameters:: datasetInstance - the dataset for which to retrieve metadata
Returns:: The metadata for the dataset.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getMetadata

public Set<MetadataRecord> getMetadata(Id.Stream streamId,
                              @Nullable
                              MetadataScope scope)
                                throws IOException,
                                       UnauthenticatedException,
                                       NotFoundException,
                                       BadRequestException,
                                       UnauthorizedException

Parameters:: streamId - the stream for which to retrieve metadata
Returns:: The metadata for the stream.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getMetadata

public Set<MetadataRecord> getMetadata(Id.Stream.View viewId,
                              @Nullable
                              MetadataScope scope)
                                throws IOException,
                                       UnauthenticatedException,
                                       NotFoundException,
                                       BadRequestException,
                                       UnauthorizedException

Parameters:: viewId - the view for which to retrieve metadata
Returns:: The metadata for the view.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getMetadata

public Set<MetadataRecord> getMetadata(Id.Program programId,
                              @Nullable
                              MetadataScope scope)
                                throws IOException,
                                       UnauthenticatedException,
                                       NotFoundException,
                                       BadRequestException,
                                       UnauthorizedException

Parameters:: programId - the program for which to retrieve metadata
Returns:: The metadata for the program.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getMetadata

public Set<MetadataRecord> getMetadata(Id.Run runId)
                                throws IOException,
                                       UnauthenticatedException,
                                       NotFoundException,
                                       BadRequestException,
                                       UnauthorizedException

Parameters:: runId - the run for which to retrieve metadata
Returns:: The metadata for the run.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getProperties

public Map<String,String> getProperties(Id.Application appId,
                               @Nullable
                               MetadataScope scope)
                                 throws IOException,
                                        UnauthenticatedException,
                                        NotFoundException,
                                        BadRequestException,
                                        UnauthorizedException

Parameters:: appId - the app for which to retrieve metadata properties; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata properties for the application.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getProperties

public Map<String,String> getProperties(Id.Artifact artifactId,
                               @Nullable
                               MetadataScope scope)
                                 throws IOException,
                                        UnauthenticatedException,
                                        NotFoundException,
                                        BadRequestException,
                                        UnauthorizedException

Parameters:: artifactId - the artifact for which to retrieve metadata properties; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata properties for the artifact.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getProperties

public Map<String,String> getProperties(Id.DatasetInstance datasetInstance,
                               @Nullable
                               MetadataScope scope)
                                 throws IOException,
                                        UnauthenticatedException,
                                        NotFoundException,
                                        BadRequestException,
                                        UnauthorizedException

Parameters:: datasetInstance - the dataset for which to retrieve metadata properties; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata properties for the dataset.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getProperties

public Map<String,String> getProperties(Id.Stream streamId,
                               @Nullable
                               MetadataScope scope)
                                 throws IOException,
                                        UnauthenticatedException,
                                        NotFoundException,
                                        BadRequestException,
                                        UnauthorizedException

Parameters:: streamId - the stream for which to retrieve metadata properties; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata properties for the stream.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getProperties

public Map<String,String> getProperties(Id.Stream.View viewId,
                               @Nullable
                               MetadataScope scope)
                                 throws IOException,
                                        UnauthenticatedException,
                                        NotFoundException,
                                        BadRequestException,
                                        UnauthorizedException

Parameters:: viewId - the view for which to retrieve metadata properties; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata properties for the view.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getProperties

public Map<String,String> getProperties(Id.Program programId,
                               @Nullable
                               MetadataScope scope)
                                 throws IOException,
                                        UnauthenticatedException,
                                        NotFoundException,
                                        BadRequestException,
                                        UnauthorizedException

Parameters:: programId - the program for which to retrieve metadata properties; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata properties for the program.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getTags

public Set<String> getTags(Id.Application appId,
                  @Nullable
                  MetadataScope scope)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Parameters:: appId - the app for which to retrieve metadata tags; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata tags for the application.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getTags

public Set<String> getTags(Id.Artifact artifactId,
                  @Nullable
                  MetadataScope scope)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Parameters:: artifactId - the artifact for which to retrieve metadata tags; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata tags for the artifact.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getTags

public Set<String> getTags(Id.DatasetInstance datasetInstance,
                  @Nullable
                  MetadataScope scope)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Parameters:: datasetInstance - the dataset for which to retrieve metadata tags; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata tags for the dataset.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getTags

public Set<String> getTags(Id.Stream streamId,
                  @Nullable
                  MetadataScope scope)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Parameters:: streamId - the stream for which to retrieve metadata tags; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata tags for the stream.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getTags

public Set<String> getTags(Id.Stream.View viewId,
                  @Nullable
                  MetadataScope scope)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Parameters:: viewId - the view for which to retrieve metadata tags; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata tags for the view.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

getTags

public Set<String> getTags(Id.Program programId,
                  @Nullable
                  MetadataScope scope)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Parameters:: programId - the program for which to retrieve metadata tags; scope - the MetadataScope to retrieve the tags from. If unspecified, this method retrieves tags from both MetadataScope.SYSTEM and MetadataScope.USER
Returns:: The metadata tags for the program.
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addTags

public void addTags(Id.Application appId,
           Set<String> tags)
             throws IOException,
                    UnauthenticatedException,
                    NotFoundException,
                    BadRequestException,
                    UnauthorizedException

Adds tags to an application.

Parameters:: appId - app to add tags to; tags - tags to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addTags

public void addTags(Id.Artifact artifactId,
           Set<String> tags)
             throws IOException,
                    UnauthenticatedException,
                    NotFoundException,
                    BadRequestException,
                    UnauthorizedException

Adds tags to an artifact.

Parameters:: artifactId - artifact to add tags to; tags - tags to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addTags

public void addTags(Id.DatasetInstance datasetInstance,
           Set<String> tags)
             throws IOException,
                    UnauthenticatedException,
                    NotFoundException,
                    BadRequestException,
                    UnauthorizedException

Adds tags to a dataset.

Parameters:: datasetInstance - dataset to add tags to; tags - tags to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addTags

public void addTags(Id.Stream streamId,
           Set<String> tags)
             throws IOException,
                    UnauthenticatedException,
                    NotFoundException,
                    BadRequestException,
                    UnauthorizedException

Adds tags to a stream.

Parameters:: streamId - stream to add tags to; tags - tags to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addTags

public void addTags(Id.Stream.View viewId,
           Set<String> tags)
             throws IOException,
                    UnauthenticatedException,
                    NotFoundException,
                    BadRequestException,
                    UnauthorizedException

Adds tags to a view.

Parameters:: viewId - view to add tags to; tags - tags to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addTags

public void addTags(Id.Program programId,
           Set<String> tags)
             throws IOException,
                    UnauthenticatedException,
                    NotFoundException,
                    BadRequestException,
                    UnauthorizedException

Adds tags to a program.

Parameters:: programId - program to add tags to; tags - tags to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addProperties

public void addProperties(Id.Application appId,
                 Map<String,String> properties)
                   throws IOException,
                          UnauthenticatedException,
                          NotFoundException,
                          BadRequestException,
                          UnauthorizedException

Adds properties to an application.

Parameters:: appId - app to add properties to; properties - properties to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addProperties

public void addProperties(Id.Artifact artifactId,
                 Map<String,String> properties)
                   throws IOException,
                          UnauthenticatedException,
                          NotFoundException,
                          BadRequestException,
                          UnauthorizedException

Adds properties to an artifact.

Parameters:: artifactId - artifact to add properties to; properties - properties to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addProperties

public void addProperties(Id.DatasetInstance datasetInstance,
                 Map<String,String> properties)
                   throws IOException,
                          UnauthenticatedException,
                          NotFoundException,
                          BadRequestException,
                          UnauthorizedException

Adds properties to a dataset.

Parameters:: datasetInstance - dataset to add properties to; properties - properties to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addProperties

public void addProperties(Id.Stream streamId,
                 Map<String,String> properties)
                   throws IOException,
                          UnauthenticatedException,
                          NotFoundException,
                          BadRequestException,
                          UnauthorizedException

Adds properties to a stream.

Parameters:: streamId - stream to add properties to; properties - properties to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addProperties

public void addProperties(Id.Stream.View viewId,
                 Map<String,String> properties)
                   throws IOException,
                          UnauthenticatedException,
                          NotFoundException,
                          BadRequestException,
                          UnauthorizedException

Adds properties to a view.

Parameters:: viewId - view to add properties to; properties - properties to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

addProperties

public void addProperties(Id.Program programId,
                 Map<String,String> properties)
                   throws IOException,
                          UnauthenticatedException,
                          NotFoundException,
                          BadRequestException,
                          UnauthorizedException

Adds properties to a program.

Parameters:: programId - program to add properties to; properties - properties to be added
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperty

public void removeProperty(Id.Application appId,
                  String propertyToRemove)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes a property from an application.

Parameters:: appId - app to remove property from; propertyToRemove - property to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperty

public void removeProperty(Id.Artifact artifactId,
                  String propertyToRemove)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes a property from an artifact.

Parameters:: artifactId - artifact to remove property from; propertyToRemove - property to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperty

public void removeProperty(Id.DatasetInstance datasetInstance,
                  String propertyToRemove)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes a property from a dataset.

Parameters:: datasetInstance - dataset to remove property from; propertyToRemove - property to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperty

public void removeProperty(Id.Stream streamId,
                  String propertyToRemove)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes a property from a stream.

Parameters:: streamId - stream to remove property from; propertyToRemove - property to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperty

public void removeProperty(Id.Stream.View viewId,
                  String propertyToRemove)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes a property from a view.

Parameters:: viewId - view to remove property from; propertyToRemove - property to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperty

public void removeProperty(Id.Program programId,
                  String propertyToRemove)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes a property from a program.

Parameters:: programId - program to remove property from; propertyToRemove - property to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperties

public void removeProperties(Id.Application appId)
                      throws IOException,
                             UnauthenticatedException,
                             NotFoundException,
                             BadRequestException,
                             UnauthorizedException

Removes all properties from an application.

Parameters:: appId - app to remove properties from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperties

public void removeProperties(Id.Artifact artifactId)
                      throws IOException,
                             UnauthenticatedException,
                             NotFoundException,
                             BadRequestException,
                             UnauthorizedException

Removes all properties from an artifact.

Parameters:: artifactId - artifact to remove properties from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperties

public void removeProperties(Id.DatasetInstance datasetInstance)
                      throws IOException,
                             UnauthenticatedException,
                             NotFoundException,
                             BadRequestException,
                             UnauthorizedException

Removes all properties from a dataset.

Parameters:: datasetInstance - dataset to remove properties from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperties

public void removeProperties(Id.Stream streamId)
                      throws IOException,
                             UnauthenticatedException,
                             NotFoundException,
                             BadRequestException,
                             UnauthorizedException

Removes all properties from a stream.

Parameters:: streamId - stream to remove properties from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperties

public void removeProperties(Id.Stream.View viewId)
                      throws IOException,
                             UnauthenticatedException,
                             NotFoundException,
                             BadRequestException,
                             UnauthorizedException

Removes all properties from a view.

Parameters:: viewId - view to remove properties from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeProperties

public void removeProperties(Id.Program programId)
                      throws IOException,
                             UnauthenticatedException,
                             NotFoundException,
                             BadRequestException,
                             UnauthorizedException

Removes all properties from a program.

Parameters:: programId - program to remove properties from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTag

public void removeTag(Id.Application appId,
             String tagToRemove)
               throws IOException,
                      UnauthenticatedException,
                      NotFoundException,
                      BadRequestException,
                      UnauthorizedException

Removes a tag from an application.

Parameters:: appId - app to remove tag from; tagToRemove - tag to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTag

public void removeTag(Id.Artifact artifactId,
             String tagToRemove)
               throws IOException,
                      UnauthenticatedException,
                      NotFoundException,
                      BadRequestException,
                      UnauthorizedException

Removes a tag from an artifact.

Parameters:: artifactId - artifact to remove tag from; tagToRemove - tag to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTag

public void removeTag(Id.DatasetInstance datasetInstance,
             String tagToRemove)
               throws IOException,
                      UnauthenticatedException,
                      NotFoundException,
                      BadRequestException,
                      UnauthorizedException

Removes a tag from a dataset.

Parameters:: datasetInstance - dataset to remove tag from; tagToRemove - tag to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTag

public void removeTag(Id.Stream streamId,
             String tagToRemove)
               throws IOException,
                      UnauthenticatedException,
                      NotFoundException,
                      BadRequestException,
                      UnauthorizedException

Removes a tag from a stream.

Parameters:: streamId - stream to remove tag from; tagToRemove - tag to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTag

public void removeTag(Id.Stream.View viewId,
             String tagToRemove)
               throws IOException,
                      UnauthenticatedException,
                      NotFoundException,
                      BadRequestException,
                      UnauthorizedException

Removes a tag from a view.

Parameters:: viewId - view to remove tag from; tagToRemove - tag to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTag

public void removeTag(Id.Program programId,
             String tagToRemove)
               throws IOException,
                      UnauthenticatedException,
                      NotFoundException,
                      BadRequestException,
                      UnauthorizedException

Removes a tag from a program.

Parameters:: programId - program to remove tag from; tagToRemove - tag to be removed
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTags

public void removeTags(Id.Application appId)
                throws IOException,
                       UnauthenticatedException,
                       NotFoundException,
                       BadRequestException,
                       UnauthorizedException

Removes all tags from an application.

Parameters:: appId - app to remove tags from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTags

public void removeTags(Id.Artifact artifactId)
                throws IOException,
                       UnauthenticatedException,
                       NotFoundException,
                       BadRequestException,
                       UnauthorizedException

Removes all tags from an artifact.

Parameters:: artifactId - artifact to remove tags from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTags

public void removeTags(Id.DatasetInstance datasetInstance)
                throws IOException,
                       UnauthenticatedException,
                       NotFoundException,
                       BadRequestException,
                       UnauthorizedException

Removes all tags from a dataset.

Parameters:: datasetInstance - dataset to remove tags from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTags

public void removeTags(Id.Stream streamId)
                throws IOException,
                       UnauthenticatedException,
                       NotFoundException,
                       BadRequestException,
                       UnauthorizedException

Removes all tags from a stream.

Parameters:: streamId - stream to remove tags from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTags

public void removeTags(Id.Stream.View viewId)
                throws IOException,
                       UnauthenticatedException,
                       NotFoundException,
                       BadRequestException,
                       UnauthorizedException

Removes all tags from a view.

Parameters:: viewId - view to remove tags from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeTags

public void removeTags(Id.Program programId)
                throws IOException,
                       UnauthenticatedException,
                       NotFoundException,
                       BadRequestException,
                       UnauthorizedException

Removes all tags from a program.

Parameters:: programId - program to remove tags from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeMetadata

public void removeMetadata(Id.Application appId)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes metadata from an application.

Parameters:: appId - app to remove metadata from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeMetadata

public void removeMetadata(Id.Artifact artifactId)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes metadata from an artifact.

Parameters:: artifactId - artifact to remove metadata from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeMetadata

public void removeMetadata(Id.DatasetInstance datasetInstance)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes metadata from a dataset.

Parameters:: datasetInstance - dataset to remove metadata from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeMetadata

public void removeMetadata(Id.Stream streamId)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes metadata from a stream.

Parameters:: streamId - stream to remove metadata from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeMetadata

public void removeMetadata(Id.Stream.View viewId)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes metadata from a view.

Parameters:: viewId - view to remove metadata from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

removeMetadata

public void removeMetadata(Id.Program programId)
                    throws IOException,
                           UnauthenticatedException,
                           NotFoundException,
                           BadRequestException,
                           UnauthorizedException

Removes metadata from a program.

Parameters:: programId - program to remove metadata from
Throws:: IOException; UnauthenticatedException; NotFoundException; BadRequestException; UnauthorizedException

Class AbstractMetadataClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractMetadataClient

Method Detail

execute

resolve

searchMetadata

searchMetadata

getMetadata

getMetadata

getProperties

getProperties

getTags

getTags

addProperties

addTags

removeMetadata

removeProperties

removeTags

removeProperty

removeTag

getMetadata

getMetadata

getMetadata

getMetadata

getMetadata

getMetadata

getMetadata

getProperties

getProperties

getProperties

getProperties

getProperties

getProperties

getTags

getTags

getTags

getTags

getTags

getTags

addTags

addTags

addTags

addTags

addTags

addTags

addProperties

addProperties

addProperties

addProperties

addProperties

addProperties

removeProperty

removeProperty

removeProperty

removeProperty

removeProperty

removeProperty

removeProperties

removeProperties

removeProperties

removeProperties

removeProperties

removeProperties

removeTag

removeTag

removeTag

removeTag

removeTag

removeTag

removeTags

removeTags

removeTags

removeTags

removeTags

removeTags

removeMetadata