TagsResourceApi

All URIs are relative to https://localhost/api/v43

Method HTTP request Description
getTags GET /tags Current CM entities and their tags.
readTagsByName GET /tags/{tagName} Get Entities given the Tag name, grouped by entity type.

getTags

ApiTagToEntitiesList getTags(limit, offset)

Current CM entities and their tags.

Current CM entities and their tags. Tag names beginning with the prefix cldr (case insensitive) are reserved for internal use by Cloudera.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.TagsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

TagsResourceApi apiInstance = new TagsResourceApi();
Integer limit = 10; // Integer | Number of tags to search for. Maximum value for limit is 1000.
Integer offset = 0; // Integer | Starting index of the list
try {
    ApiTagToEntitiesList result = apiInstance.getTags(limit, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TagsResourceApi#getTags");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
limit Integer Number of tags to search for. Maximum value for limit is 1000. [optional] [default to 10]
offset Integer Starting index of the list [optional] [default to 0]

Return type

ApiTagToEntitiesList

Authorization

basic

HTTP request headers

readTagsByName

ApiTagToEntitiesList readTagsByName(tagName, limit, offset)

Get Entities given the Tag name, grouped by entity type.

Get Entities given the Tag name, grouped by entity type.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.TagsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

TagsResourceApi apiInstance = new TagsResourceApi();
String tagName = "tagName_example"; // String | Name of the tag
Integer limit = 10; // Integer | Number of entries to search for. Maximum value for limit is 1000.
Integer offset = 0; // Integer | Starting index of the list
try {
    ApiTagToEntitiesList result = apiInstance.readTagsByName(tagName, limit, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TagsResourceApi#readTagsByName");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
tagName String Name of the tag
limit Integer Number of entries to search for. Maximum value for limit is 1000. [optional] [default to 10]
offset Integer Starting index of the list [optional] [default to 0]

Return type

ApiTagToEntitiesList

Authorization

basic

HTTP request headers