All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.openmetadata.client.api.ClassificationsApi Maven / Gradle / Ivy

There is a newer version: 1.5.11
Show newest version
package org.openmetadata.client.api;

import org.openmetadata.client.ApiClient;
import org.openmetadata.client.EncodingUtils;
import org.openmetadata.client.model.ApiResponse;

import org.openmetadata.client.model.Classification;
import org.openmetadata.client.model.ClassificationList;
import org.openmetadata.client.model.CreateClassification;
import org.openmetadata.client.model.CreateTag;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.RestoreEntity;
import org.openmetadata.client.model.Tag;
import org.openmetadata.client.model.TagList;
import java.util.UUID;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;

@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-09-13T20:15:57.513387948Z[Etc/UTC]")
public interface ClassificationsApi extends ApiClient.Api {


  /**
   * Create a classification
   * Create a new classification. The request can include the children tags to be created along with the classification.
   * @param createClassification  (optional)
   * @return Classification
   */
  @RequestLine("POST /v1/classifications")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  Classification createClassification(CreateClassification createClassification);

  /**
   * Create a classification
   * Similar to createClassification but it also returns the http response headers .
   * Create a new classification. The request can include the children tags to be created along with the classification.
   * @param createClassification  (optional)
   * @return A ApiResponse that wraps the response boyd and the http headers.
   */
  @RequestLine("POST /v1/classifications")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  ApiResponse createClassificationWithHttpInfo(CreateClassification createClassification);



  /**
   * Update a classification
   * Update an existing category identify by category name
   * @param createClassification  (optional)
   */
  @RequestLine("PUT /v1/classifications")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  void createOrUpdateClassification(CreateClassification createClassification);

  /**
   * Update a classification
   * Similar to createOrUpdateClassification but it also returns the http response headers .
   * Update an existing category identify by category name
   * @param createClassification  (optional)
   */
  @RequestLine("PUT /v1/classifications")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  ApiResponse createOrUpdateClassificationWithHttpInfo(CreateClassification createClassification);



  /**
   * Create or update a tag
   * Create a new tag, if it does not exist or update an existing tag.
   * @param createTag  (optional)
   * @return Tag
   */
  @RequestLine("PUT /v1/tags")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  Tag createOrUpdateTag(CreateTag createTag);

  /**
   * Create or update a tag
   * Similar to createOrUpdateTag but it also returns the http response headers .
   * Create a new tag, if it does not exist or update an existing tag.
   * @param createTag  (optional)
   * @return A ApiResponse that wraps the response boyd and the http headers.
   */
  @RequestLine("PUT /v1/tags")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  ApiResponse createOrUpdateTagWithHttpInfo(CreateTag createTag);



  /**
   * Create a tag
   * Create a new tag.
   * @param createTag  (optional)
   * @return Tag
   */
  @RequestLine("POST /v1/tags")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  Tag createTag(CreateTag createTag);

  /**
   * Create a tag
   * Similar to createTag but it also returns the http response headers .
   * Create a new tag.
   * @param createTag  (optional)
   * @return A ApiResponse that wraps the response boyd and the http headers.
   */
  @RequestLine("POST /v1/tags")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  ApiResponse createTagWithHttpInfo(CreateTag createTag);



  /**
   * Delete classification by id
   * Delete a classification and all the tags under it.
   * @param id Id of the classification (required)
   * @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
   * @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
   */
  @RequestLine("DELETE /v1/classifications/{id}?recursive={recursive}&hardDelete={hardDelete}")
  @Headers({
    "Accept: application/json",
  })
  void deleteClassification(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);

  /**
   * Delete classification by id
   * Similar to deleteClassification but it also returns the http response headers .
   * Delete a classification and all the tags under it.
   * @param id Id of the classification (required)
   * @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
   * @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
   */
  @RequestLine("DELETE /v1/classifications/{id}?recursive={recursive}&hardDelete={hardDelete}")
  @Headers({
    "Accept: application/json",
  })
  ApiResponse deleteClassificationWithHttpInfo(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);


  /**
   * Delete classification by id
   * Delete a classification and all the tags under it.
   * Note, this is equivalent to the other deleteClassification method,
   * but with the query parameters collected into a single Map parameter. This
   * is convenient for services with optional query parameters, especially when
   * used with the {@link DeleteClassificationQueryParams} class that allows for
   * building up this map in a fluent style.
   * @param id Id of the classification (required)
   * @param queryParams Map of query parameters as name-value pairs
   *   

The following elements may be specified in the query map:

*
    *
  • recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
  • *
  • hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
  • *
*/ @RequestLine("DELETE /v1/classifications/{id}?recursive={recursive}&hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) void deleteClassification(@Param("id") UUID id, @QueryMap(encoded=true) DeleteClassificationQueryParams queryParams); /** * Delete classification by id * Delete a classification and all the tags under it. * Note, this is equivalent to the other deleteClassification that receives the query parameters as a map, * but this one also exposes the Http response headers * @param id Id of the classification (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
  • *
  • hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
  • *
*/ @RequestLine("DELETE /v1/classifications/{id}?recursive={recursive}&hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) ApiResponse deleteClassificationWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteClassificationQueryParams queryParams); /** * A convenience class for generating query parameters for the * deleteClassification method in a fluent style. */ public static class DeleteClassificationQueryParams extends HashMap { public DeleteClassificationQueryParams recursive(final Boolean value) { put("recursive", EncodingUtils.encode(value)); return this; } public DeleteClassificationQueryParams hardDelete(final Boolean value) { put("hardDelete", EncodingUtils.encode(value)); return this; } } /** * Delete classification by name * Delete a classification by `name` and all the tags under it. * @param name Name of the classification (required) * @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false) */ @RequestLine("DELETE /v1/classifications/name/{name}?hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) void deleteClassificationByName(@Param("name") String name, @Param("hardDelete") Boolean hardDelete); /** * Delete classification by name * Similar to deleteClassificationByName but it also returns the http response headers . * Delete a classification by `name` and all the tags under it. * @param name Name of the classification (required) * @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false) */ @RequestLine("DELETE /v1/classifications/name/{name}?hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) ApiResponse deleteClassificationByNameWithHttpInfo(@Param("name") String name, @Param("hardDelete") Boolean hardDelete); /** * Delete classification by name * Delete a classification by `name` and all the tags under it. * Note, this is equivalent to the other deleteClassificationByName method, * but with the query parameters collected into a single Map parameter. This * is convenient for services with optional query parameters, especially when * used with the {@link DeleteClassificationByNameQueryParams} class that allows for * building up this map in a fluent style. * @param name Name of the classification (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
  • *
*/ @RequestLine("DELETE /v1/classifications/name/{name}?hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) void deleteClassificationByName(@Param("name") String name, @QueryMap(encoded=true) DeleteClassificationByNameQueryParams queryParams); /** * Delete classification by name * Delete a classification by `name` and all the tags under it. * Note, this is equivalent to the other deleteClassificationByName that receives the query parameters as a map, * but this one also exposes the Http response headers * @param name Name of the classification (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
  • *
*/ @RequestLine("DELETE /v1/classifications/name/{name}?hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) ApiResponse deleteClassificationByNameWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) DeleteClassificationByNameQueryParams queryParams); /** * A convenience class for generating query parameters for the * deleteClassificationByName method in a fluent style. */ public static class DeleteClassificationByNameQueryParams extends HashMap { public DeleteClassificationByNameQueryParams hardDelete(final Boolean value) { put("hardDelete", EncodingUtils.encode(value)); return this; } } /** * Delete a tag by id * Delete a tag by `id`. * @param id Id of the tag (required) * @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false) * @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false) */ @RequestLine("DELETE /v1/tags/{id}?recursive={recursive}&hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) void deleteTag(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete); /** * Delete a tag by id * Similar to deleteTag but it also returns the http response headers . * Delete a tag by `id`. * @param id Id of the tag (required) * @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false) * @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false) */ @RequestLine("DELETE /v1/tags/{id}?recursive={recursive}&hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) ApiResponse deleteTagWithHttpInfo(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete); /** * Delete a tag by id * Delete a tag by `id`. * Note, this is equivalent to the other deleteTag method, * but with the query parameters collected into a single Map parameter. This * is convenient for services with optional query parameters, especially when * used with the {@link DeleteTagQueryParams} class that allows for * building up this map in a fluent style. * @param id Id of the tag (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
  • *
  • hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
  • *
*/ @RequestLine("DELETE /v1/tags/{id}?recursive={recursive}&hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) void deleteTag(@Param("id") UUID id, @QueryMap(encoded=true) DeleteTagQueryParams queryParams); /** * Delete a tag by id * Delete a tag by `id`. * Note, this is equivalent to the other deleteTag that receives the query parameters as a map, * but this one also exposes the Http response headers * @param id Id of the tag (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
  • *
  • hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
  • *
*/ @RequestLine("DELETE /v1/tags/{id}?recursive={recursive}&hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) ApiResponse deleteTagWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteTagQueryParams queryParams); /** * A convenience class for generating query parameters for the * deleteTag method in a fluent style. */ public static class DeleteTagQueryParams extends HashMap { public DeleteTagQueryParams recursive(final Boolean value) { put("recursive", EncodingUtils.encode(value)); return this; } public DeleteTagQueryParams hardDelete(final Boolean value) { put("hardDelete", EncodingUtils.encode(value)); return this; } } /** * Delete a tag by fully qualified name * Delete a tag by `fullyQualifiedName`. * @param fqn Fully qualified name of the tag (required) * @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false) */ @RequestLine("DELETE /v1/tags/name/{fqn}?hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) void deleteTagByName(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete); /** * Delete a tag by fully qualified name * Similar to deleteTagByName but it also returns the http response headers . * Delete a tag by `fullyQualifiedName`. * @param fqn Fully qualified name of the tag (required) * @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false) */ @RequestLine("DELETE /v1/tags/name/{fqn}?hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) ApiResponse deleteTagByNameWithHttpInfo(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete); /** * Delete a tag by fully qualified name * Delete a tag by `fullyQualifiedName`. * Note, this is equivalent to the other deleteTagByName method, * but with the query parameters collected into a single Map parameter. This * is convenient for services with optional query parameters, especially when * used with the {@link DeleteTagByNameQueryParams} class that allows for * building up this map in a fluent style. * @param fqn Fully qualified name of the tag (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
  • *
*/ @RequestLine("DELETE /v1/tags/name/{fqn}?hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) void deleteTagByName(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteTagByNameQueryParams queryParams); /** * Delete a tag by fully qualified name * Delete a tag by `fullyQualifiedName`. * Note, this is equivalent to the other deleteTagByName that receives the query parameters as a map, * but this one also exposes the Http response headers * @param fqn Fully qualified name of the tag (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
  • *
*/ @RequestLine("DELETE /v1/tags/name/{fqn}?hardDelete={hardDelete}") @Headers({ "Accept: application/json", }) ApiResponse deleteTagByNameWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteTagByNameQueryParams queryParams); /** * A convenience class for generating query parameters for the * deleteTagByName method in a fluent style. */ public static class DeleteTagByNameQueryParams extends HashMap { public DeleteTagByNameQueryParams hardDelete(final Boolean value) { put("hardDelete", EncodingUtils.encode(value)); return this; } } /** * Get a classification by id * Get a classification by `id` * @param id Id of the classification (required) * @param fields Fields requested in the returned resource (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return Classification */ @RequestLine("GET /v1/classifications/{id}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) Classification getClassificationByID(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include); /** * Get a classification by id * Similar to getClassificationByID but it also returns the http response headers . * Get a classification by `id` * @param id Id of the classification (required) * @param fields Fields requested in the returned resource (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("GET /v1/classifications/{id}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse getClassificationByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include); /** * Get a classification by id * Get a classification by `id` * Note, this is equivalent to the other getClassificationByID method, * but with the query parameters collected into a single Map parameter. This * is convenient for services with optional query parameters, especially when * used with the {@link GetClassificationByIDQueryParams} class that allows for * building up this map in a fluent style. * @param id Id of the classification (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • fields - Fields requested in the returned resource (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return Classification */ @RequestLine("GET /v1/classifications/{id}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) Classification getClassificationByID(@Param("id") UUID id, @QueryMap(encoded=true) GetClassificationByIDQueryParams queryParams); /** * Get a classification by id * Get a classification by `id` * Note, this is equivalent to the other getClassificationByID that receives the query parameters as a map, * but this one also exposes the Http response headers * @param id Id of the classification (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • fields - Fields requested in the returned resource (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return Classification */ @RequestLine("GET /v1/classifications/{id}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse getClassificationByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetClassificationByIDQueryParams queryParams); /** * A convenience class for generating query parameters for the * getClassificationByID method in a fluent style. */ public static class GetClassificationByIDQueryParams extends HashMap { public GetClassificationByIDQueryParams fields(final String value) { put("fields", EncodingUtils.encode(value)); return this; } public GetClassificationByIDQueryParams include(final String value) { put("include", EncodingUtils.encode(value)); return this; } } /** * Get a classification by name * Get a classification identified by name. The response includes classification information along with the entire hierarchy of all the children tags. * @param name Name of the classification (required) * @param fields Fields requested in the returned resource (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return Classification */ @RequestLine("GET /v1/classifications/name/{name}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) Classification getClassificationByName(@Param("name") String name, @Param("fields") String fields, @Param("include") String include); /** * Get a classification by name * Similar to getClassificationByName but it also returns the http response headers . * Get a classification identified by name. The response includes classification information along with the entire hierarchy of all the children tags. * @param name Name of the classification (required) * @param fields Fields requested in the returned resource (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("GET /v1/classifications/name/{name}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse getClassificationByNameWithHttpInfo(@Param("name") String name, @Param("fields") String fields, @Param("include") String include); /** * Get a classification by name * Get a classification identified by name. The response includes classification information along with the entire hierarchy of all the children tags. * Note, this is equivalent to the other getClassificationByName method, * but with the query parameters collected into a single Map parameter. This * is convenient for services with optional query parameters, especially when * used with the {@link GetClassificationByNameQueryParams} class that allows for * building up this map in a fluent style. * @param name Name of the classification (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • fields - Fields requested in the returned resource (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return Classification */ @RequestLine("GET /v1/classifications/name/{name}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) Classification getClassificationByName(@Param("name") String name, @QueryMap(encoded=true) GetClassificationByNameQueryParams queryParams); /** * Get a classification by name * Get a classification identified by name. The response includes classification information along with the entire hierarchy of all the children tags. * Note, this is equivalent to the other getClassificationByName that receives the query parameters as a map, * but this one also exposes the Http response headers * @param name Name of the classification (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • fields - Fields requested in the returned resource (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return Classification */ @RequestLine("GET /v1/classifications/name/{name}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse getClassificationByNameWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetClassificationByNameQueryParams queryParams); /** * A convenience class for generating query parameters for the * getClassificationByName method in a fluent style. */ public static class GetClassificationByNameQueryParams extends HashMap { public GetClassificationByNameQueryParams fields(final String value) { put("fields", EncodingUtils.encode(value)); return this; } public GetClassificationByNameQueryParams include(final String value) { put("include", EncodingUtils.encode(value)); return this; } } /** * Get a version of the classification * Get a version of the classification by given `id` * @param id Id of the classification (required) * @param version classification version number in the form `major`.`minor` (required) * @return Classification */ @RequestLine("GET /v1/classifications/{id}/versions/{version}") @Headers({ "Accept: application/json", }) Classification getSpecificClassificationVersion(@Param("id") UUID id, @Param("version") String version); /** * Get a version of the classification * Similar to getSpecificClassificationVersion but it also returns the http response headers . * Get a version of the classification by given `id` * @param id Id of the classification (required) * @param version classification version number in the form `major`.`minor` (required) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("GET /v1/classifications/{id}/versions/{version}") @Headers({ "Accept: application/json", }) ApiResponse getSpecificClassificationVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version); /** * Get a version of the tags * Get a version of the tag by given `id` * @param id Id of the tag (required) * @param version tag version number in the form `major`.`minor` (required) * @return Tag */ @RequestLine("GET /v1/tags/{id}/versions/{version}") @Headers({ "Accept: application/json", }) Tag getSpecificTagVersion(@Param("id") UUID id, @Param("version") String version); /** * Get a version of the tags * Similar to getSpecificTagVersion but it also returns the http response headers . * Get a version of the tag by given `id` * @param id Id of the tag (required) * @param version tag version number in the form `major`.`minor` (required) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("GET /v1/tags/{id}/versions/{version}") @Headers({ "Accept: application/json", }) ApiResponse getSpecificTagVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version); /** * Get a tag by fully qualified name * Get a tag by `fullyQualifiedName`. * @param fqn Fully qualified name of the tag (required) * @param fields Fields requested in the returned resource (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return Tag */ @RequestLine("GET /v1/tags/name/{fqn}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) Tag getTagByFQN(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include); /** * Get a tag by fully qualified name * Similar to getTagByFQN but it also returns the http response headers . * Get a tag by `fullyQualifiedName`. * @param fqn Fully qualified name of the tag (required) * @param fields Fields requested in the returned resource (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("GET /v1/tags/name/{fqn}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse getTagByFQNWithHttpInfo(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include); /** * Get a tag by fully qualified name * Get a tag by `fullyQualifiedName`. * Note, this is equivalent to the other getTagByFQN method, * but with the query parameters collected into a single Map parameter. This * is convenient for services with optional query parameters, especially when * used with the {@link GetTagByFQNQueryParams} class that allows for * building up this map in a fluent style. * @param fqn Fully qualified name of the tag (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • fields - Fields requested in the returned resource (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return Tag */ @RequestLine("GET /v1/tags/name/{fqn}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) Tag getTagByFQN(@Param("fqn") String fqn, @QueryMap(encoded=true) GetTagByFQNQueryParams queryParams); /** * Get a tag by fully qualified name * Get a tag by `fullyQualifiedName`. * Note, this is equivalent to the other getTagByFQN that receives the query parameters as a map, * but this one also exposes the Http response headers * @param fqn Fully qualified name of the tag (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • fields - Fields requested in the returned resource (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return Tag */ @RequestLine("GET /v1/tags/name/{fqn}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse getTagByFQNWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) GetTagByFQNQueryParams queryParams); /** * A convenience class for generating query parameters for the * getTagByFQN method in a fluent style. */ public static class GetTagByFQNQueryParams extends HashMap { public GetTagByFQNQueryParams fields(final String value) { put("fields", EncodingUtils.encode(value)); return this; } public GetTagByFQNQueryParams include(final String value) { put("include", EncodingUtils.encode(value)); return this; } } /** * Get a tag by id * Get a tag by `id`. * @param id Id of the tag (required) * @param fields Fields requested in the returned resource (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return Tag */ @RequestLine("GET /v1/tags/{id}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) Tag getTagByID(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include); /** * Get a tag by id * Similar to getTagByID but it also returns the http response headers . * Get a tag by `id`. * @param id Id of the tag (required) * @param fields Fields requested in the returned resource (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("GET /v1/tags/{id}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse getTagByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include); /** * Get a tag by id * Get a tag by `id`. * Note, this is equivalent to the other getTagByID method, * but with the query parameters collected into a single Map parameter. This * is convenient for services with optional query parameters, especially when * used with the {@link GetTagByIDQueryParams} class that allows for * building up this map in a fluent style. * @param id Id of the tag (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • fields - Fields requested in the returned resource (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return Tag */ @RequestLine("GET /v1/tags/{id}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) Tag getTagByID(@Param("id") UUID id, @QueryMap(encoded=true) GetTagByIDQueryParams queryParams); /** * Get a tag by id * Get a tag by `id`. * Note, this is equivalent to the other getTagByID that receives the query parameters as a map, * but this one also exposes the Http response headers * @param id Id of the tag (required) * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • fields - Fields requested in the returned resource (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return Tag */ @RequestLine("GET /v1/tags/{id}?fields={fields}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse getTagByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetTagByIDQueryParams queryParams); /** * A convenience class for generating query parameters for the * getTagByID method in a fluent style. */ public static class GetTagByIDQueryParams extends HashMap { public GetTagByIDQueryParams fields(final String value) { put("fields", EncodingUtils.encode(value)); return this; } public GetTagByIDQueryParams include(final String value) { put("include", EncodingUtils.encode(value)); return this; } } /** * List classification versions * Get a list of all the versions of a classification identified by `id` * @param id Id of the classification (required) * @return EntityHistory */ @RequestLine("GET /v1/classifications/{id}/versions") @Headers({ "Accept: application/json", }) EntityHistory listAllClassificationVersion(@Param("id") UUID id); /** * List classification versions * Similar to listAllClassificationVersion but it also returns the http response headers . * Get a list of all the versions of a classification identified by `id` * @param id Id of the classification (required) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("GET /v1/classifications/{id}/versions") @Headers({ "Accept: application/json", }) ApiResponse listAllClassificationVersionWithHttpInfo(@Param("id") UUID id); /** * List tag versions * Get a list of all the versions of a tag identified by `id` * @param id Id of the tag (required) * @return EntityHistory */ @RequestLine("GET /v1/tags/{id}/versions") @Headers({ "Accept: application/json", }) EntityHistory listAllTagVersion(@Param("id") UUID id); /** * List tag versions * Similar to listAllTagVersion but it also returns the http response headers . * Get a list of all the versions of a tag identified by `id` * @param id Id of the tag (required) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("GET /v1/tags/{id}/versions") @Headers({ "Accept: application/json", }) ApiResponse listAllTagVersionWithHttpInfo(@Param("id") UUID id); /** * List classifications * Get a list of classifications. * @param fields Fields requested in the returned resource (optional) * @param disabled Filter Disabled Classifications (optional) * @param limit Limit the number classifications returned. (1 to 1000000, default = 10) (optional, default to 10) * @param before Returns list of classifications before this cursor (optional) * @param after Returns list of classifications after this cursor (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return ClassificationList */ @RequestLine("GET /v1/classifications?fields={fields}&disabled={disabled}&limit={limit}&before={before}&after={after}&include={include}") @Headers({ "Accept: application/json", }) ClassificationList listClassifications(@Param("fields") String fields, @Param("disabled") String disabled, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include); /** * List classifications * Similar to listClassifications but it also returns the http response headers . * Get a list of classifications. * @param fields Fields requested in the returned resource (optional) * @param disabled Filter Disabled Classifications (optional) * @param limit Limit the number classifications returned. (1 to 1000000, default = 10) (optional, default to 10) * @param before Returns list of classifications before this cursor (optional) * @param after Returns list of classifications after this cursor (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("GET /v1/classifications?fields={fields}&disabled={disabled}&limit={limit}&before={before}&after={after}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse listClassificationsWithHttpInfo(@Param("fields") String fields, @Param("disabled") String disabled, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include); /** * List classifications * Get a list of classifications. * Note, this is equivalent to the other listClassifications method, * but with the query parameters collected into a single Map parameter. This * is convenient for services with optional query parameters, especially when * used with the {@link ListClassificationsQueryParams} class that allows for * building up this map in a fluent style. * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • fields - Fields requested in the returned resource (optional)
  • *
  • disabled - Filter Disabled Classifications (optional)
  • *
  • limit - Limit the number classifications returned. (1 to 1000000, default = 10) (optional, default to 10)
  • *
  • before - Returns list of classifications before this cursor (optional)
  • *
  • after - Returns list of classifications after this cursor (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return ClassificationList */ @RequestLine("GET /v1/classifications?fields={fields}&disabled={disabled}&limit={limit}&before={before}&after={after}&include={include}") @Headers({ "Accept: application/json", }) ClassificationList listClassifications(@QueryMap(encoded=true) ListClassificationsQueryParams queryParams); /** * List classifications * Get a list of classifications. * Note, this is equivalent to the other listClassifications that receives the query parameters as a map, * but this one also exposes the Http response headers * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • fields - Fields requested in the returned resource (optional)
  • *
  • disabled - Filter Disabled Classifications (optional)
  • *
  • limit - Limit the number classifications returned. (1 to 1000000, default = 10) (optional, default to 10)
  • *
  • before - Returns list of classifications before this cursor (optional)
  • *
  • after - Returns list of classifications after this cursor (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return ClassificationList */ @RequestLine("GET /v1/classifications?fields={fields}&disabled={disabled}&limit={limit}&before={before}&after={after}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse listClassificationsWithHttpInfo(@QueryMap(encoded=true) ListClassificationsQueryParams queryParams); /** * A convenience class for generating query parameters for the * listClassifications method in a fluent style. */ public static class ListClassificationsQueryParams extends HashMap { public ListClassificationsQueryParams fields(final String value) { put("fields", EncodingUtils.encode(value)); return this; } public ListClassificationsQueryParams disabled(final String value) { put("disabled", EncodingUtils.encode(value)); return this; } public ListClassificationsQueryParams limit(final Integer value) { put("limit", EncodingUtils.encode(value)); return this; } public ListClassificationsQueryParams before(final String value) { put("before", EncodingUtils.encode(value)); return this; } public ListClassificationsQueryParams after(final String value) { put("after", EncodingUtils.encode(value)); return this; } public ListClassificationsQueryParams include(final String value) { put("include", EncodingUtils.encode(value)); return this; } } /** * List tags * Get a list of tags. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params. * @param parent List tags filtered by children of tag identified by fqn given in `parent` parameter. The fqn can either be classificationName or fqn of a parent tag (optional) * @param fields Fields requested in the returned resource (optional) * @param disabled Filter Disabled Classifications (optional, default to false) * @param limit Limit the number tags returned. (1 to 1000000, default = 10) (optional, default to 10) * @param before Returns list of tags before this cursor (optional) * @param after Returns list of tags after this cursor (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return TagList */ @RequestLine("GET /v1/tags?parent={parent}&fields={fields}&disabled={disabled}&limit={limit}&before={before}&after={after}&include={include}") @Headers({ "Accept: application/json", }) TagList listTags(@Param("parent") String parent, @Param("fields") String fields, @Param("disabled") String disabled, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include); /** * List tags * Similar to listTags but it also returns the http response headers . * Get a list of tags. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params. * @param parent List tags filtered by children of tag identified by fqn given in `parent` parameter. The fqn can either be classificationName or fqn of a parent tag (optional) * @param fields Fields requested in the returned resource (optional) * @param disabled Filter Disabled Classifications (optional, default to false) * @param limit Limit the number tags returned. (1 to 1000000, default = 10) (optional, default to 10) * @param before Returns list of tags before this cursor (optional) * @param after Returns list of tags after this cursor (optional) * @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("GET /v1/tags?parent={parent}&fields={fields}&disabled={disabled}&limit={limit}&before={before}&after={after}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse listTagsWithHttpInfo(@Param("parent") String parent, @Param("fields") String fields, @Param("disabled") String disabled, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include); /** * List tags * Get a list of tags. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params. * Note, this is equivalent to the other listTags method, * but with the query parameters collected into a single Map parameter. This * is convenient for services with optional query parameters, especially when * used with the {@link ListTagsQueryParams} class that allows for * building up this map in a fluent style. * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • parent - List tags filtered by children of tag identified by fqn given in `parent` parameter. The fqn can either be classificationName or fqn of a parent tag (optional)
  • *
  • fields - Fields requested in the returned resource (optional)
  • *
  • disabled - Filter Disabled Classifications (optional, default to false)
  • *
  • limit - Limit the number tags returned. (1 to 1000000, default = 10) (optional, default to 10)
  • *
  • before - Returns list of tags before this cursor (optional)
  • *
  • after - Returns list of tags after this cursor (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return TagList */ @RequestLine("GET /v1/tags?parent={parent}&fields={fields}&disabled={disabled}&limit={limit}&before={before}&after={after}&include={include}") @Headers({ "Accept: application/json", }) TagList listTags(@QueryMap(encoded=true) ListTagsQueryParams queryParams); /** * List tags * Get a list of tags. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params. * Note, this is equivalent to the other listTags that receives the query parameters as a map, * but this one also exposes the Http response headers * @param queryParams Map of query parameters as name-value pairs *

The following elements may be specified in the query map:

*
    *
  • parent - List tags filtered by children of tag identified by fqn given in `parent` parameter. The fqn can either be classificationName or fqn of a parent tag (optional)
  • *
  • fields - Fields requested in the returned resource (optional)
  • *
  • disabled - Filter Disabled Classifications (optional, default to false)
  • *
  • limit - Limit the number tags returned. (1 to 1000000, default = 10) (optional, default to 10)
  • *
  • before - Returns list of tags before this cursor (optional)
  • *
  • after - Returns list of tags after this cursor (optional)
  • *
  • include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
  • *
* @return TagList */ @RequestLine("GET /v1/tags?parent={parent}&fields={fields}&disabled={disabled}&limit={limit}&before={before}&after={after}&include={include}") @Headers({ "Accept: application/json", }) ApiResponse listTagsWithHttpInfo(@QueryMap(encoded=true) ListTagsQueryParams queryParams); /** * A convenience class for generating query parameters for the * listTags method in a fluent style. */ public static class ListTagsQueryParams extends HashMap { public ListTagsQueryParams parent(final String value) { put("parent", EncodingUtils.encode(value)); return this; } public ListTagsQueryParams fields(final String value) { put("fields", EncodingUtils.encode(value)); return this; } public ListTagsQueryParams disabled(final String value) { put("disabled", EncodingUtils.encode(value)); return this; } public ListTagsQueryParams limit(final Integer value) { put("limit", EncodingUtils.encode(value)); return this; } public ListTagsQueryParams before(final String value) { put("before", EncodingUtils.encode(value)); return this; } public ListTagsQueryParams after(final String value) { put("after", EncodingUtils.encode(value)); return this; } public ListTagsQueryParams include(final String value) { put("include", EncodingUtils.encode(value)); return this; } } /** * Update a classification using name. * Update an existing classification using JsonPatch. * @param fqn Name of the classification (required) * @param body JsonPatch with array of operations (optional) * JsonPatch RFC * @see Update a classification using name. Documentation */ @RequestLine("PATCH /v1/classifications/name/{fqn}") @Headers({ "Content-Type: application/json-patch+json", "Accept: application/json", }) void patchClassification(@Param("fqn") String fqn, Object body); /** * Update a classification using name. * Similar to patchClassification but it also returns the http response headers . * Update an existing classification using JsonPatch. * @param fqn Name of the classification (required) * @param body JsonPatch with array of operations (optional) * JsonPatch RFC * @see Update a classification using name. Documentation */ @RequestLine("PATCH /v1/classifications/name/{fqn}") @Headers({ "Content-Type: application/json-patch+json", "Accept: application/json", }) ApiResponse patchClassificationWithHttpInfo(@Param("fqn") String fqn, Object body); /** * Update a classification * Update an existing classification using JsonPatch. * @param id Id of the classification (required) * @param body JsonPatch with array of operations (optional) * JsonPatch RFC * @see Update a classification Documentation */ @RequestLine("PATCH /v1/classifications/{id}") @Headers({ "Content-Type: application/json-patch+json", "Accept: application/json", }) void patchClassification1(@Param("id") UUID id, Object body); /** * Update a classification * Similar to patchClassification1 but it also returns the http response headers . * Update an existing classification using JsonPatch. * @param id Id of the classification (required) * @param body JsonPatch with array of operations (optional) * JsonPatch RFC * @see Update a classification Documentation */ @RequestLine("PATCH /v1/classifications/{id}") @Headers({ "Content-Type: application/json-patch+json", "Accept: application/json", }) ApiResponse patchClassification1WithHttpInfo(@Param("id") UUID id, Object body); /** * Update a tag using name. * Update an existing tag using JsonPatch. * @param fqn Name of the tag (required) * @param body JsonPatch with array of operations (optional) * JsonPatch RFC * @see Update a tag using name. Documentation */ @RequestLine("PATCH /v1/tags/name/{fqn}") @Headers({ "Content-Type: application/json-patch+json", "Accept: application/json", }) void patchTag(@Param("fqn") String fqn, Object body); /** * Update a tag using name. * Similar to patchTag but it also returns the http response headers . * Update an existing tag using JsonPatch. * @param fqn Name of the tag (required) * @param body JsonPatch with array of operations (optional) * JsonPatch RFC * @see Update a tag using name. Documentation */ @RequestLine("PATCH /v1/tags/name/{fqn}") @Headers({ "Content-Type: application/json-patch+json", "Accept: application/json", }) ApiResponse patchTagWithHttpInfo(@Param("fqn") String fqn, Object body); /** * Update a tag * Update an existing tag using JsonPatch. * @param id Id of the tag (required) * @param body JsonPatch with array of operations (optional) * JsonPatch RFC * @see Update a tag Documentation */ @RequestLine("PATCH /v1/tags/{id}") @Headers({ "Content-Type: application/json-patch+json", "Accept: application/json", }) void patchTag1(@Param("id") UUID id, Object body); /** * Update a tag * Similar to patchTag1 but it also returns the http response headers . * Update an existing tag using JsonPatch. * @param id Id of the tag (required) * @param body JsonPatch with array of operations (optional) * JsonPatch RFC * @see Update a tag Documentation */ @RequestLine("PATCH /v1/tags/{id}") @Headers({ "Content-Type: application/json-patch+json", "Accept: application/json", }) ApiResponse patchTag1WithHttpInfo(@Param("id") UUID id, Object body); /** * Restore a soft deleted classification * Restore a soft deleted classification. * @param restoreEntity (optional) * @return Classification */ @RequestLine("PUT /v1/classifications/restore") @Headers({ "Content-Type: application/json", "Accept: application/json", }) Classification restoreClassification(RestoreEntity restoreEntity); /** * Restore a soft deleted classification * Similar to restoreClassification but it also returns the http response headers . * Restore a soft deleted classification. * @param restoreEntity (optional) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("PUT /v1/classifications/restore") @Headers({ "Content-Type: application/json", "Accept: application/json", }) ApiResponse restoreClassificationWithHttpInfo(RestoreEntity restoreEntity); /** * Restore a soft deleted tag. * Restore a soft deleted tag. * @param restoreEntity (optional) * @return Tag */ @RequestLine("PUT /v1/tags/restore") @Headers({ "Content-Type: application/json", "Accept: application/json", }) Tag restoreTag(RestoreEntity restoreEntity); /** * Restore a soft deleted tag. * Similar to restoreTag but it also returns the http response headers . * Restore a soft deleted tag. * @param restoreEntity (optional) * @return A ApiResponse that wraps the response boyd and the http headers. */ @RequestLine("PUT /v1/tags/restore") @Headers({ "Content-Type: application/json", "Accept: application/json", }) ApiResponse restoreTagWithHttpInfo(RestoreEntity restoreEntity); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy