com.influxdb.client

Interface TemplatesApi

@ThreadSafe
public interface TemplatesApi

Author:

Jakub Bednar (bednar@github) (25/03/2019 09:11)

Method Summary

Modifier and Type	Method and Description
LabelResponse	addLabel(Label label, Document template) Add a label to a template.
LabelResponse	addLabel(String labelID, String templateID) Add a label to a template.
Document	cloneTemplate(String clonedName, Document template) Clone a template.
Document	cloneTemplate(String clonedName, String templateID) Clone a template.
Document	createTemplate(DocumentCreate templateCreate) Create a template.
void	deleteLabel(Label label, Document template) Delete a label from a template.
void	deleteLabel(String labelID, String templateID) Delete a label from a template.
void	deleteTemplate(Document template) Delete a template.
void	deleteTemplate(String templateID) Delete a template.
Document	findTemplateByID(String templateID) Retrieve a template.
List<DocumentListEntry>	findTemplates(Organization organization) List of template documents.
List<DocumentListEntry>	findTemplates(String orgName) List of template documents.
List<Label>	getLabels(Document template) List all labels for a template.
List<Label>	getLabels(String templateID) List all labels for a template.
Document	updateTemplate(Document template) Update a template.
Document	updateTemplate(String templateID, DocumentUpdate template) Update a template.

Method Detail

createTemplate

@Nonnull
Document createTemplate(@Nonnull
                                 DocumentCreate templateCreate)

Create a template.

Parameters:

templateCreate - template that will be created

Returns:

Template created

updateTemplate

@Nonnull
Document updateTemplate(@Nonnull
                                 Document template)

Update a template.

Parameters:

template - template that will be updated

Returns:

the newly updated template

updateTemplate

@Nonnull
Document updateTemplate(@Nonnull
                                 String templateID,
                                 @Nonnull
                                 DocumentUpdate template)

Update a template.

Parameters:

templateID - ID of template

template - template that will be updated

Returns:

the newly updated template

deleteTemplate

void deleteTemplate(@Nonnull
                    Document template)

Delete a template.

Parameters:

template - template to delete

deleteTemplate

void deleteTemplate(@Nonnull
                    String templateID)

Delete a template.

Parameters:

templateID - ID of template to delete

getLabels

@Nonnull
List<Label> getLabels(@Nonnull
                               Document template)

List all labels for a template.

Parameters:

template - the template

Returns:

return a list of all labels for a template

getLabels

@Nonnull
List<Label> getLabels(@Nonnull
                               String templateID)

List all labels for a template.

Parameters:

templateID - ID of template

Returns:

return a list of all labels for a template

addLabel

@Nonnull
LabelResponse addLabel(@Nonnull
                                Label label,
                                @Nonnull
                                Document template)

Add a label to a template.

Parameters:

label - label to add

template - the template

Returns:

added label

addLabel

@Nonnull
LabelResponse addLabel(@Nonnull
                                String labelID,
                                @Nonnull
                                String templateID)

Add a label to a template.

Parameters:

templateID - ID of template

labelID - the ID of label to add

Returns:

added label

deleteLabel

void deleteLabel(@Nonnull
                 Label label,
                 @Nonnull
                 Document template)

Delete a label from a template.

Parameters:

label - the label

template - the template

deleteLabel

void deleteLabel(@Nonnull
                 String labelID,
                 @Nonnull
                 String templateID)

Delete a label from a template.

Parameters:

templateID - ID of template

labelID - the label ID

cloneTemplate

@Nonnull
Document cloneTemplate(@Nonnull
                                String clonedName,
                                @Nonnull
                                String templateID)

Clone a template.

Parameters:

clonedName - name of cloned template

templateID - ID of template to clone

Returns:

cloned template

cloneTemplate

@Nonnull
Document cloneTemplate(@Nonnull
                                String clonedName,
                                @Nonnull
                                Document template)

Clone a template.

Parameters:

clonedName - name of cloned template

template - template to clone

Returns:

cloned template

findTemplateByID

@Nonnull
Document findTemplateByID(@Nonnull
                                   String templateID)

Retrieve a template.

Parameters:

templateID - ID of template

Returns:

the template requested

findTemplates

@Nonnull
List<DocumentListEntry> findTemplates(@Nonnull
                                               Organization organization)

List of template documents.

Parameters:

organization - specifies the organization of the template (required)

Returns:

a list of template documents

findTemplates

@Nonnull
List<DocumentListEntry> findTemplates(@Nonnull
                                               String orgName)

List of template documents.

Parameters:

orgName - specifies the name of the organization of the template (required)

Returns:

a list of template documents