org.openmetadata.client.api.DomainsApi Maven / Gradle / Ivy
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.BulkAssets;
import org.openmetadata.client.model.BulkOperationResult;
import org.openmetadata.client.model.ChangeEvent;
import org.openmetadata.client.model.CreateDataProduct;
import org.openmetadata.client.model.CreateDomain;
import org.openmetadata.client.model.DataProduct;
import org.openmetadata.client.model.DataProductList;
import org.openmetadata.client.model.Domain;
import org.openmetadata.client.model.DomainList;
import org.openmetadata.client.model.EntityHistory;
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-07-25T09:42:14.348793228Z[Etc/UTC]")
public interface DomainsApi extends ApiClient.Api {
/**
* Bulk Add Assets
* Bulk Add Assets
* @param name Name of the Data product (required)
* @param bulkAssets (optional)
* @return BulkOperationResult
*/
@RequestLine("PUT /v1/dataProducts/{name}/assets/add")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
BulkOperationResult bulkAddAssets(@Param("name") String name, BulkAssets bulkAssets);
/**
* Bulk Add Assets
* Similar to bulkAddAssets but it also returns the http response headers .
* Bulk Add Assets
* @param name Name of the Data product (required)
* @param bulkAssets (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataProducts/{name}/assets/add")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse bulkAddAssetsWithHttpInfo(@Param("name") String name, BulkAssets bulkAssets);
/**
* Bulk Add Assets
* Bulk Add Assets
* @param name Name of the domain (required)
* @param bulkAssets (optional)
* @return BulkOperationResult
*/
@RequestLine("PUT /v1/domains/{name}/assets/add")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
BulkOperationResult bulkAddAssets1(@Param("name") String name, BulkAssets bulkAssets);
/**
* Bulk Add Assets
* Similar to bulkAddAssets1 but it also returns the http response headers .
* Bulk Add Assets
* @param name Name of the domain (required)
* @param bulkAssets (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/domains/{name}/assets/add")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse bulkAddAssets1WithHttpInfo(@Param("name") String name, BulkAssets bulkAssets);
/**
* Bulk Remove Assets
* Bulk Remove Assets
* @param name Name of the Data Product (required)
* @param bulkAssets (optional)
* @return ChangeEvent
*/
@RequestLine("PUT /v1/dataProducts/{name}/assets/remove")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ChangeEvent bulkRemoveAssets(@Param("name") String name, BulkAssets bulkAssets);
/**
* Bulk Remove Assets
* Similar to bulkRemoveAssets but it also returns the http response headers .
* Bulk Remove Assets
* @param name Name of the Data Product (required)
* @param bulkAssets (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataProducts/{name}/assets/remove")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse bulkRemoveAssetsWithHttpInfo(@Param("name") String name, BulkAssets bulkAssets);
/**
* Bulk Remove Assets
* Bulk Remove Assets
* @param name Name of the domain (required)
* @param bulkAssets (optional)
* @return ChangeEvent
*/
@RequestLine("PUT /v1/domains/{name}/assets/remove")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ChangeEvent bulkRemoveAssets1(@Param("name") String name, BulkAssets bulkAssets);
/**
* Bulk Remove Assets
* Similar to bulkRemoveAssets1 but it also returns the http response headers .
* Bulk Remove Assets
* @param name Name of the domain (required)
* @param bulkAssets (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/domains/{name}/assets/remove")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse bulkRemoveAssets1WithHttpInfo(@Param("name") String name, BulkAssets bulkAssets);
/**
* Create a dataProduct
* Create a new dataProduct.
* @param createDataProduct (optional)
* @return DataProduct
*/
@RequestLine("POST /v1/dataProducts")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
DataProduct createDataProduct(CreateDataProduct createDataProduct);
/**
* Create a dataProduct
* Similar to createDataProduct but it also returns the http response headers .
* Create a new dataProduct.
* @param createDataProduct (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/dataProducts")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createDataProductWithHttpInfo(CreateDataProduct createDataProduct);
/**
* Create a domain
* Create a new domain.
* @param createDomain (optional)
* @return Domain
*/
@RequestLine("POST /v1/domains")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Domain createDomain(CreateDomain createDomain);
/**
* Create a domain
* Similar to createDomain but it also returns the http response headers .
* Create a new domain.
* @param createDomain (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/domains")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createDomainWithHttpInfo(CreateDomain createDomain);
/**
* Create or update a dataProduct
* Create a dataProduct. if it does not exist. If a dataProduct already exists, update the dataProduct.
* @param createDataProduct (optional)
* @return DataProduct
*/
@RequestLine("PUT /v1/dataProducts")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
DataProduct createOrUpdateDataProduct(CreateDataProduct createDataProduct);
/**
* Create or update a dataProduct
* Similar to createOrUpdateDataProduct but it also returns the http response headers .
* Create a dataProduct. if it does not exist. If a dataProduct already exists, update the dataProduct.
* @param createDataProduct (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataProducts")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateDataProductWithHttpInfo(CreateDataProduct createDataProduct);
/**
* Create or update a domain
* Create a domain. if it does not exist. If a domain already exists, update the domain.
* @param createDomain (optional)
* @return Domain
*/
@RequestLine("PUT /v1/domains")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Domain createOrUpdateDomain(CreateDomain createDomain);
/**
* Create or update a domain
* Similar to createOrUpdateDomain but it also returns the http response headers .
* Create a domain. if it does not exist. If a domain already exists, update the domain.
* @param createDomain (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/domains")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateDomainWithHttpInfo(CreateDomain createDomain);
/**
* Delete a dataProduct by Id
* Delete a dataProduct by `Id`.
* @param id Id of the dataProduct (required)
*/
@RequestLine("DELETE /v1/dataProducts/{id}")
@Headers({
"Accept: application/json",
})
void deleteDataProduct(@Param("id") UUID id);
/**
* Delete a dataProduct by Id
* Similar to deleteDataProduct but it also returns the http response headers .
* Delete a dataProduct by `Id`.
* @param id Id of the dataProduct (required)
*/
@RequestLine("DELETE /v1/dataProducts/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDataProductWithHttpInfo(@Param("id") UUID id);
/**
* Delete a dataProduct by name
* Delete a dataProduct by `name`.
* @param name Name of the dataProduct (required)
*/
@RequestLine("DELETE /v1/dataProducts/name/{name}")
@Headers({
"Accept: application/json",
})
void deleteDataProductByFQN(@Param("name") String name);
/**
* Delete a dataProduct by name
* Similar to deleteDataProductByFQN but it also returns the http response headers .
* Delete a dataProduct by `name`.
* @param name Name of the dataProduct (required)
*/
@RequestLine("DELETE /v1/dataProducts/name/{name}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDataProductByFQNWithHttpInfo(@Param("name") String name);
/**
* Delete a domain by Id
* Delete a domain by `Id`.
* @param id Id of the domain (required)
*/
@RequestLine("DELETE /v1/domains/{id}")
@Headers({
"Accept: application/json",
})
void deleteDomain(@Param("id") UUID id);
/**
* Delete a domain by Id
* Similar to deleteDomain but it also returns the http response headers .
* Delete a domain by `Id`.
* @param id Id of the domain (required)
*/
@RequestLine("DELETE /v1/domains/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDomainWithHttpInfo(@Param("id") UUID id);
/**
* Delete a domain by name
* Delete a domain by `name`.
* @param name Name of the domain (required)
*/
@RequestLine("DELETE /v1/domains/name/{name}")
@Headers({
"Accept: application/json",
})
void deleteDomainByFQN(@Param("name") String name);
/**
* Delete a domain by name
* Similar to deleteDomainByFQN but it also returns the http response headers .
* Delete a domain by `name`.
* @param name Name of the domain (required)
*/
@RequestLine("DELETE /v1/domains/name/{name}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDomainByFQNWithHttpInfo(@Param("name") String name);
/**
* Get a dataProduct by name
* Get a dataProduct by `name`.
* @param name Name of the dataProduct (required)
* @param fields Fields requested in the returned resource (optional)
* @return DataProduct
*/
@RequestLine("GET /v1/dataProducts/name/{name}?fields={fields}")
@Headers({
"Accept: application/json",
})
DataProduct getDataProductByFQN(@Param("name") String name, @Param("fields") String fields);
/**
* Get a dataProduct by name
* Similar to getDataProductByFQN but it also returns the http response headers .
* Get a dataProduct by `name`.
* @param name Name of the dataProduct (required)
* @param fields Fields requested in the returned resource (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataProducts/name/{name}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getDataProductByFQNWithHttpInfo(@Param("name") String name, @Param("fields") String fields);
/**
* Get a dataProduct by name
* Get a dataProduct by `name`.
* Note, this is equivalent to the other getDataProductByFQN 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 GetDataProductByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the dataProduct (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)
*
* @return DataProduct
*/
@RequestLine("GET /v1/dataProducts/name/{name}?fields={fields}")
@Headers({
"Accept: application/json",
})
DataProduct getDataProductByFQN(@Param("name") String name, @QueryMap(encoded=true) GetDataProductByFQNQueryParams queryParams);
/**
* Get a dataProduct by name
* Get a dataProduct by `name`.
* Note, this is equivalent to the other getDataProductByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the dataProduct (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)
*
* @return DataProduct
*/
@RequestLine("GET /v1/dataProducts/name/{name}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getDataProductByFQNWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetDataProductByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDataProductByFQN method in a fluent style.
*/
public static class GetDataProductByFQNQueryParams extends HashMap {
public GetDataProductByFQNQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a dataProduct by Id
* Get a dataProduct by `Id`.
* @param id Id of the dataProduct (required)
* @param fields Fields requested in the returned resource (optional)
* @return DataProduct
*/
@RequestLine("GET /v1/dataProducts/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
DataProduct getDataProductByID(@Param("id") UUID id, @Param("fields") String fields);
/**
* Get a dataProduct by Id
* Similar to getDataProductByID but it also returns the http response headers .
* Get a dataProduct by `Id`.
* @param id Id of the dataProduct (required)
* @param fields Fields requested in the returned resource (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataProducts/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getDataProductByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields);
/**
* Get a dataProduct by Id
* Get a dataProduct by `Id`.
* Note, this is equivalent to the other getDataProductByID 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 GetDataProductByIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the dataProduct (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)
*
* @return DataProduct
*/
@RequestLine("GET /v1/dataProducts/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
DataProduct getDataProductByID(@Param("id") UUID id, @QueryMap(encoded=true) GetDataProductByIDQueryParams queryParams);
/**
* Get a dataProduct by Id
* Get a dataProduct by `Id`.
* Note, this is equivalent to the other getDataProductByID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the dataProduct (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)
*
* @return DataProduct
*/
@RequestLine("GET /v1/dataProducts/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getDataProductByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetDataProductByIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDataProductByID method in a fluent style.
*/
public static class GetDataProductByIDQueryParams extends HashMap {
public GetDataProductByIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a domain by name
* Get a domain by `name`.
* @param name Name of the domain (required)
* @param fields Fields requested in the returned resource (optional)
* @return Domain
*/
@RequestLine("GET /v1/domains/name/{name}?fields={fields}")
@Headers({
"Accept: application/json",
})
Domain getDomainByFQN(@Param("name") String name, @Param("fields") String fields);
/**
* Get a domain by name
* Similar to getDomainByFQN but it also returns the http response headers .
* Get a domain by `name`.
* @param name Name of the domain (required)
* @param fields Fields requested in the returned resource (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/domains/name/{name}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getDomainByFQNWithHttpInfo(@Param("name") String name, @Param("fields") String fields);
/**
* Get a domain by name
* Get a domain by `name`.
* Note, this is equivalent to the other getDomainByFQN 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 GetDomainByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the domain (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)
*
* @return Domain
*/
@RequestLine("GET /v1/domains/name/{name}?fields={fields}")
@Headers({
"Accept: application/json",
})
Domain getDomainByFQN(@Param("name") String name, @QueryMap(encoded=true) GetDomainByFQNQueryParams queryParams);
/**
* Get a domain by name
* Get a domain by `name`.
* Note, this is equivalent to the other getDomainByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the domain (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)
*
* @return Domain
*/
@RequestLine("GET /v1/domains/name/{name}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getDomainByFQNWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetDomainByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDomainByFQN method in a fluent style.
*/
public static class GetDomainByFQNQueryParams extends HashMap {
public GetDomainByFQNQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a domain by Id
* Get a domain by `Id`.
* @param id Id of the domain (required)
* @param fields Fields requested in the returned resource (optional)
* @return Domain
*/
@RequestLine("GET /v1/domains/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
Domain getDomainByID(@Param("id") UUID id, @Param("fields") String fields);
/**
* Get a domain by Id
* Similar to getDomainByID but it also returns the http response headers .
* Get a domain by `Id`.
* @param id Id of the domain (required)
* @param fields Fields requested in the returned resource (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/domains/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getDomainByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields);
/**
* Get a domain by Id
* Get a domain by `Id`.
* Note, this is equivalent to the other getDomainByID 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 GetDomainByIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the domain (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)
*
* @return Domain
*/
@RequestLine("GET /v1/domains/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
Domain getDomainByID(@Param("id") UUID id, @QueryMap(encoded=true) GetDomainByIDQueryParams queryParams);
/**
* Get a domain by Id
* Get a domain by `Id`.
* Note, this is equivalent to the other getDomainByID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the domain (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)
*
* @return Domain
*/
@RequestLine("GET /v1/domains/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getDomainByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetDomainByIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDomainByID method in a fluent style.
*/
public static class GetDomainByIDQueryParams extends HashMap {
public GetDomainByIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
}
/**
* List dataProduct versions
* Get a list of all the versions of a dataProduct identified by `Id`
* @param id Id of the dataProduct (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/dataProducts/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllDataProductVersion(@Param("id") UUID id);
/**
* List dataProduct versions
* Similar to listAllDataProductVersion but it also returns the http response headers .
* Get a list of all the versions of a dataProduct identified by `Id`
* @param id Id of the dataProduct (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataProducts/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllDataProductVersionWithHttpInfo(@Param("id") UUID id);
/**
* List domain versions
* Get a list of all the versions of a domain identified by `Id`
* @param id Id of the domain (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/domains/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllDomainVersion(@Param("id") UUID id);
/**
* List domain versions
* Similar to listAllDomainVersion but it also returns the http response headers .
* Get a list of all the versions of a domain identified by `Id`
* @param id Id of the domain (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/domains/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllDomainVersionWithHttpInfo(@Param("id") UUID id);
/**
* List dataProducts
* Get a list of DataProducts.
* @param fields Fields requested in the returned resource (optional)
* @param domain Filter data products by domain name (optional)
* @param limit (optional, default to 10)
* @param before Returns list of DataProduct before this cursor (optional)
* @param after Returns list of DataProduct after this cursor (optional)
* @return DataProductList
*/
@RequestLine("GET /v1/dataProducts?fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
DataProductList listDataProducts(@Param("fields") String fields, @Param("domain") String domain, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after);
/**
* List dataProducts
* Similar to listDataProducts but it also returns the http response headers .
* Get a list of DataProducts.
* @param fields Fields requested in the returned resource (optional)
* @param domain Filter data products by domain name (optional)
* @param limit (optional, default to 10)
* @param before Returns list of DataProduct before this cursor (optional)
* @param after Returns list of DataProduct after this cursor (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataProducts?fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse listDataProductsWithHttpInfo(@Param("fields") String fields, @Param("domain") String domain, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after);
/**
* List dataProducts
* Get a list of DataProducts.
* Note, this is equivalent to the other listDataProducts 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 ListDataProductsQueryParams} 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)
* - domain - Filter data products by domain name (optional)
* - limit - (optional, default to 10)
* - before - Returns list of DataProduct before this cursor (optional)
* - after - Returns list of DataProduct after this cursor (optional)
*
* @return DataProductList
*/
@RequestLine("GET /v1/dataProducts?fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
DataProductList listDataProducts(@QueryMap(encoded=true) ListDataProductsQueryParams queryParams);
/**
* List dataProducts
* Get a list of DataProducts.
* Note, this is equivalent to the other listDataProducts 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)
* - domain - Filter data products by domain name (optional)
* - limit - (optional, default to 10)
* - before - Returns list of DataProduct before this cursor (optional)
* - after - Returns list of DataProduct after this cursor (optional)
*
* @return DataProductList
*/
@RequestLine("GET /v1/dataProducts?fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse listDataProductsWithHttpInfo(@QueryMap(encoded=true) ListDataProductsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listDataProducts method in a fluent style.
*/
public static class ListDataProductsQueryParams extends HashMap {
public ListDataProductsQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListDataProductsQueryParams domain(final String value) {
put("domain", EncodingUtils.encode(value));
return this;
}
public ListDataProductsQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListDataProductsQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListDataProductsQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
}
/**
* List domains
* Get a list of Domains.
* @param fields Fields requested in the returned resource (optional)
* @param limit (optional, default to 10)
* @param before Returns list of Domain before this cursor (optional)
* @param after Returns list of Domain after this cursor (optional)
* @return DomainList
*/
@RequestLine("GET /v1/domains?fields={fields}&limit={limit}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
DomainList listDomains(@Param("fields") String fields, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after);
/**
* List domains
* Similar to listDomains but it also returns the http response headers .
* Get a list of Domains.
* @param fields Fields requested in the returned resource (optional)
* @param limit (optional, default to 10)
* @param before Returns list of Domain before this cursor (optional)
* @param after Returns list of Domain after this cursor (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/domains?fields={fields}&limit={limit}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse listDomainsWithHttpInfo(@Param("fields") String fields, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after);
/**
* List domains
* Get a list of Domains.
* Note, this is equivalent to the other listDomains 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 ListDomainsQueryParams} 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)
* - limit - (optional, default to 10)
* - before - Returns list of Domain before this cursor (optional)
* - after - Returns list of Domain after this cursor (optional)
*
* @return DomainList
*/
@RequestLine("GET /v1/domains?fields={fields}&limit={limit}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
DomainList listDomains(@QueryMap(encoded=true) ListDomainsQueryParams queryParams);
/**
* List domains
* Get a list of Domains.
* Note, this is equivalent to the other listDomains 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)
* - limit - (optional, default to 10)
* - before - Returns list of Domain before this cursor (optional)
* - after - Returns list of Domain after this cursor (optional)
*
* @return DomainList
*/
@RequestLine("GET /v1/domains?fields={fields}&limit={limit}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse listDomainsWithHttpInfo(@QueryMap(encoded=true) ListDomainsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listDomains method in a fluent style.
*/
public static class ListDomainsQueryParams extends HashMap {
public ListDomainsQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListDomainsQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListDomainsQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListDomainsQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the dataProduct
* Get a version of the dataProduct by given `Id`
* @param id Id of the dataProduct (required)
* @param version DataProduct version number in the form `major`.`minor` (required)
* @return DataProduct
*/
@RequestLine("GET /v1/dataProducts/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
DataProduct listSpecificDataProductVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the dataProduct
* Similar to listSpecificDataProductVersion but it also returns the http response headers .
* Get a version of the dataProduct by given `Id`
* @param id Id of the dataProduct (required)
* @param version DataProduct version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataProducts/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse listSpecificDataProductVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the domain
* Get a version of the domain by given `Id`
* @param id Id of the domain (required)
* @param version Domain version number in the form `major`.`minor` (required)
* @return Domain
*/
@RequestLine("GET /v1/domains/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
Domain listSpecificDomainVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the domain
* Similar to listSpecificDomainVersion but it also returns the http response headers .
* Get a version of the domain by given `Id`
* @param id Id of the domain (required)
* @param version Domain version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/domains/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse listSpecificDomainVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Update a dataProduct by name.
* Update an existing dataProduct using JsonPatch.
* @param fqn Name of the dataProduct (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dataProduct by name. Documentation
*/
@RequestLine("PATCH /v1/dataProducts/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDataProduct(@Param("fqn") String fqn, Object body);
/**
* Update a dataProduct by name.
* Similar to patchDataProduct but it also returns the http response headers .
* Update an existing dataProduct using JsonPatch.
* @param fqn Name of the dataProduct (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dataProduct by name. Documentation
*/
@RequestLine("PATCH /v1/dataProducts/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDataProductWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update a dataProduct
* Update an existing dataProduct using JsonPatch.
* @param id Id of the dataProduct (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dataProduct Documentation
*/
@RequestLine("PATCH /v1/dataProducts/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDataProduct1(@Param("id") UUID id, Object body);
/**
* Update a dataProduct
* Similar to patchDataProduct1 but it also returns the http response headers .
* Update an existing dataProduct using JsonPatch.
* @param id Id of the dataProduct (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dataProduct Documentation
*/
@RequestLine("PATCH /v1/dataProducts/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDataProduct1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Update a domain by name.
* Update an existing domain using JsonPatch.
* @param fqn Name of the domain (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a domain by name. Documentation
*/
@RequestLine("PATCH /v1/domains/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDomain(@Param("fqn") String fqn, Object body);
/**
* Update a domain by name.
* Similar to patchDomain but it also returns the http response headers .
* Update an existing domain using JsonPatch.
* @param fqn Name of the domain (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a domain by name. Documentation
*/
@RequestLine("PATCH /v1/domains/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDomainWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update a domain
* Update an existing domain using JsonPatch.
* @param id Id of the domain (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a domain Documentation
*/
@RequestLine("PATCH /v1/domains/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDomain1(@Param("id") UUID id, Object body);
/**
* Update a domain
* Similar to patchDomain1 but it also returns the http response headers .
* Update an existing domain using JsonPatch.
* @param id Id of the domain (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a domain Documentation
*/
@RequestLine("PATCH /v1/domains/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDomain1WithHttpInfo(@Param("id") UUID id, Object body);
}