io.cdap.cdap.api.metadata

Interface MetadataWriter

All Known Subinterfaces:

CustomActionContext, HttpServiceContext, MapReduceContext, ServiceContext, SparkClientContext, WorkerContext, WorkflowContext

@Beta
public interface MetadataWriter

The context for emitting metadata from programs

Method Summary

Modifier and Type	Method and Description
void	addProperties(MetadataEntity metadataEntity, Map<String,String> properties) Adds the specified Map to the metadata of the specified metadataEntity.
void	addTags(MetadataEntity metadataEntity, Iterable<String> tags) Adds all the specified tags to specified MetadataEntity.
void	addTags(MetadataEntity metadataEntity, String... tags) Adds the specified tags to specified MetadataEntity.
void	removeMetadata(MetadataEntity metadataEntity) Removes all the user metadata (including properties and tags) for the specified MetadataEntity.
void	removeProperties(MetadataEntity metadataEntity) Removes all properties from the user metadata of the specified MetadataEntity.
void	removeProperties(MetadataEntity metadataEntity, String... keys) Removes the specified keys from the user metadata properties of the specified MetadataEntity.
void	removeTags(MetadataEntity metadataEntity) Removes all user tags from the specified MetadataEntity.
void	removeTags(MetadataEntity metadataEntity, String... tags) Removes the specified user tags from the specified MetadataEntity.

Method Detail

addProperties

void addProperties(MetadataEntity metadataEntity,
                   Map<String,String> properties)

Adds the specified Map to the metadata of the specified metadataEntity. Existing keys will be updated with new values.

addTags

void addTags(MetadataEntity metadataEntity,
             String... tags)

Adds the specified tags to specified MetadataEntity. If a given tag already exists for the metadata entity it will be skipped.

addTags

void addTags(MetadataEntity metadataEntity,
             Iterable<String> tags)

Adds all the specified tags to specified MetadataEntity. If a given tag already exists for the metadata entity it will be skipped.

removeMetadata

void removeMetadata(MetadataEntity metadataEntity)

Removes all the user metadata (including properties and tags) for the specified MetadataEntity.

Parameters:

metadataEntity - the MetadataEntity to remove user metadata for

removeProperties

void removeProperties(MetadataEntity metadataEntity)

Removes all properties from the user metadata of the specified MetadataEntity.

Parameters:

metadataEntity - the MetadataEntity to remove properties for

removeProperties

void removeProperties(MetadataEntity metadataEntity,
                      String... keys)

Removes the specified keys from the user metadata properties of the specified MetadataEntity.

Parameters:

metadataEntity - the MetadataEntity to remove the specified properties for

keys - the metadata property keys to remove

removeTags

void removeTags(MetadataEntity metadataEntity)

Removes all user tags from the specified MetadataEntity.

Parameters:

metadataEntity - the MetadataEntity to remove tags for

removeTags

void removeTags(MetadataEntity metadataEntity,
                String... tags)

Removes the specified user tags from the specified MetadataEntity.

Parameters:

metadataEntity - the MetadataEntity to remove the specified tags for

tags - the tags to remove