Package video.api.client.api.clients

Class TagsApi

java.lang.Object

video.api.client.api.clients.TagsApi

public class TagsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TagsApi.APIlistRequest

Constructor Summary

Constructors

Constructor	Description
TagsApi()	Constructor for TagsApi production environment where API key is not required.
TagsApi(String basePath)	Constructor for TagsApi with custom API base path where API key is not required.
TagsApi(String apiKey, String basePath)	Constructor for TagsApi with custom API base path
TagsApi(String apiKey, Environment environment)	Constructor for TagsApi with custom API base path
TagsApi(ApiClient apiClient)
TagsApi(Environment environment)	Constructor for TagsApi with custom API base path where API key is not required.

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
TagsApi.APIlistRequest	list()	List all video tags This endpoint enables you to search for video tags in a project and see how many videos are tagged with them.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

TagsApi

public TagsApi(ApiClient apiClient)

TagsApi

public TagsApi()

Constructor for TagsApi production environment where API key is not required.

TagsApi

public TagsApi(String basePath)

Constructor for TagsApi with custom API base path where API key is not required.

Parameters:

basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.

TagsApi

public TagsApi(Environment environment)

Constructor for TagsApi with custom API base path where API key is not required.

Parameters:

environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

TagsApi

public TagsApi(String apiKey,
               String basePath)

Constructor for TagsApi with custom API base path

Parameters:

apiKey - the api key to use to authenticate to the API

basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.

TagsApi

public TagsApi(String apiKey,
               Environment environment)

Constructor for TagsApi with custom API base path

Parameters:

apiKey - the api key to use to authenticate to the API

environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

list

public TagsApi.APIlistRequest list()

List all video tags This endpoint enables you to search for video tags in a project and see how many videos are tagged with them. If you do not define any query parameters, the endpoint lists all video tags and the numbers of times they are used in a project.

Returns:

APIlistRequest

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.