org.finra.herd.sdk.api

Class TagApi

java.lang.Object

org.finra.herd.sdk.api.TagApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T15:10:39.441-05:00")
public class TagApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TagApi()
TagApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
Tag	tagCreateTag(TagCreateRequest tagCreateRequest) createTag Creates a new tag.
Tag	tagDeleteTag(String tagTypeCode, String tagCode) deleteTag Deletes an existing tag.
Tag	tagGetTag(String tagTypeCode, String tagCode) getTag Gets an existing tag.
TagListResponse	tagGetTags(String tagTypeCode, String tagCode) getTags Retrieves all associated tags for the specified tag type code.
TagSearchResponse	tagSearchTags(TagSearchRequest tagSearchRequest, String fields) searchTags Retrieves all tags existing in the system per specified search filters and keys.
Tag	tagUpdateTag(String tagTypeCode, String tagCode, TagUpdateRequest tagUpdateRequest) updateTag Updates an existing tag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TagApi

public TagApi()

TagApi

public TagApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

tagCreateTag

public Tag tagCreateTag(TagCreateRequest tagCreateRequest)
                 throws ApiException

createTag Creates a new tag.

Parameters:

tagCreateRequest - the information needed to create the tag

Returns:

Tag

Throws:

ApiException

tagSearchTags

public TagSearchResponse tagSearchTags(TagSearchRequest tagSearchRequest,
                                       String fields)
                                throws ApiException

searchTags Retrieves all tags existing in the system per specified search filters and keys. For each tag entity, this endpoint returns tag key by default along with any other top-level elements as specified by the \"fields\" query string parameter. The list of tags returned by this endpoint is sorted alphabetically by tag's display name ascending.

Parameters:

tagSearchRequest - the tag search request. The request can only accept a single search filter and a single search key

fields - the field options for the tag type search response. The valid field options are: displayName, description, parentTagKey, hasChildren

Returns:

TagSearchResponse

Throws:

ApiException

tagGetTags

public TagListResponse tagGetTags(String tagTypeCode,
                                  String tagCode)
                           throws ApiException

getTags Retrieves all associated tags for the specified tag type code. When tagCode is null, return all tags of the tag type code, which has no parent (i.e. root tags). When tagCode is provided, return all tags of the tag type code and whose parent tag code is tagCode.

Parameters:

tagTypeCode - the tag type's code.

tagCode - the parent tag code.

Returns:

TagListResponse

Throws:

ApiException

tagGetTag

public Tag tagGetTag(String tagTypeCode,
                     String tagCode)
              throws ApiException

getTag Gets an existing tag.

Parameters:

tagTypeCode - the tag type code

tagCode - the tag code

Returns:

Tag

Throws:

ApiException

tagUpdateTag

public Tag tagUpdateTag(String tagTypeCode,
                        String tagCode,
                        TagUpdateRequest tagUpdateRequest)
                 throws ApiException

updateTag Updates an existing tag.

Parameters:

tagTypeCode - the tag type code

tagCode - the tag code

tagUpdateRequest - the information needed to update the tag

Returns:

Tag

Throws:

ApiException

tagDeleteTag

public Tag tagDeleteTag(String tagTypeCode,
                        String tagCode)
                 throws ApiException

deleteTag Deletes an existing tag.

Parameters:

tagTypeCode - the tag type code

tagCode - the tag code

Returns:

Tag

Throws:

ApiException