@piiano/vault-client/dist/generated/models/Property.d.ts

Piiano Vault generated typescript client

import type { DataTypeName } from './DataTypeName';
import type { Description } from './Description';
import type { PropertyName } from './PropertyName';
export type Property = {
    /**
     * The time when the property was created, in RFC3339Nano format.
     * Vault sets this value automatically.
     * Sending a value for this field is ignored.
     *
     */
    creation_time?: string;
    /**
     * The time when the property was last modified, in RFC3339 format.
     * Vault sets this value automatically.
     * Sending a value for this field is ignored.
     *
     */
    modification_time?: string;
    description?: Description;
    /**
     * Whether the property is created by Vault (or by the user).
     * Built-in properties cannot be deleted or modified.
     * Sending a value for this field is ignored.
     *
     */
    is_builtin?: boolean;
    /**
     * Whether the value is stored encrypted.
     */
    is_encrypted?: boolean;
    /**
     * Whether the backend storage is optimized for searches on this property. Cannot be set to `true` for properties with data types `LONG_TEXT`, `JSON`, or `BLOB`, or custom data types based on those types.
     */
    is_index?: boolean;
    /**
     * Whether the backend storage is optimized for substring searches on this property. See <a href="/guides/reference/data-types#indexing">indexing</a> in the data type reference for a list of supported data types.
     */
    is_substring_index?: boolean;
    /**
     * Whether the value of the property can be removed (set to null).
     */
    is_nullable?: boolean;
    /**
     * Whether the user can modify values of this property.
     * Ignored for user define properties.
     * Sending a value for this field is ignored.
     *
     */
    is_readonly?: boolean;
    /**
     * Whether the backend storage enforces unique values for active objects. Cannot be set to `true` for properties with data types `LONG_TEXT`, `JSON`, or `BLOB`, or custom data types based on those types.
     */
    is_unique?: boolean;
    name: PropertyName;
    data_type_name: DataTypeName;
};
//# sourceMappingURL=Property.d.ts.map