/**
* Persists an object
*
* @param {string} type
* @param {object} attributes
* @param {object} [options={}]
* @property {string} [options.id] - force id on creation, not recommended
* @property {boolean} [options.overwrite=false]
* @property {string} [options.namespace]
* @returns {promise} - { id, type, version, attributes }
*/
public async create(type: string, attributes = {}, options: CreateOptions = {}) {
throwErrorIfTypeIsSpace(type);
throwErrorIfNamespaceSpecified(options);
return await this.client.create(type, attributes, {
...options,
namespace: getNamespace(this.spaceId),
});
}
/**
* Returns an array of objects by id
*
* @param {array} objects - an array ids, or an array of objects containing id and optionally type
* @param {object} [options={}]
* @property {string} [options.namespace]
* @returns {promise} - { saved_objects: [{ id, type, version, attributes }] }
* @example
*
* bulkGet([
* { id: 'one', type: 'config' },
* { id: 'foo', type: 'index-pattern' }
* ])
*/
public async bulkGet(objects: BulkGetObjects = [], options: BaseOptions = {}) {
throwErrorIfTypesContainsSpace(objects.map(object => object.type));
throwErrorIfNamespaceSpecified(options);
return await this.client.bulkGet(objects, {
...options,
namespace: getNamespace(this.spaceId),
});
}
/**
* Gets a single object
*
* @param {string} type
* @param {string} id
* @param {object} [options={}]
* @property {string} [options.namespace]
* @returns {promise} - { id, type, version, attributes }
*/
public async get(type: string, id: string, options: BaseOptions = {}) {
throwErrorIfTypeIsSpace(type);
throwErrorIfNamespaceSpecified(options);
return await this.client.get(type, id, {
...options,
namespace: getNamespace(this.spaceId),
});
}
/**
* Updates an object
*
* @param {string} type
* @param {string} id
* @param {object} [options={}]
* @property {integer} options.version - ensures version matches that of persisted object
* @property {string} [options.namespace]
* @returns {promise}
*/
public async update(
type: string,
id: string,
attributes: SavedObjectAttributes,
options: UpdateOptions = {}
) {
throwErrorIfTypeIsSpace(type);
throwErrorIfNamespaceSpecified(options);
return await this.client.update(type, id, attributes, {
...options,
namespace: getNamespace(this.spaceId),
});
}
/**
* @param {object} [options={}]
* @property {(string|Array<string>)} [options.type]
* @property {string} [options.search]
* @property {Array<string>} [options.searchFields] - see Elasticsearch Simple Query String
* Query field argument for more information
* @property {integer} [options.page=1]
* @property {integer} [options.perPage=20]
* @property {string} [options.sortField]
* @property {string} [options.sortOrder]
* @property {Array<string>} [options.fields]
* @property {string} [options.namespace]
* @returns {promise} - { saved_objects: [{ id, type, version, attributes }], total, per_page, page }
*/
public async find(options: FindOptions = {}) {
if (options.type) {
throwErrorIfTypesContainsSpace(coerceToArray(options.type));
}
throwErrorIfNamespaceSpecified(options);
return await this.client.find({
...options,
type: (options.type ? coerceToArray(options.type) : this.types).filter(
type => type !== 'space'
),
namespace: getNamespace(this.spaceId),
});
}