Module Values.GetKxDataviewResponseSource

Retrieves details of the dataview.

Sourcetype nonrec t = {
  1. databaseName : DatabaseName.t option;
    (*

    The name of the database where you created the dataview.

    *)
  2. dataviewName : KxDataviewName.t option;
    (*

    A unique identifier for the dataview.

    *)
  3. azMode : KxAzMode.t option;
    (*

    The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

    *)
  4. availabilityZoneId : AvailabilityZoneId.t option;
    (*

    The identifier of the availability zones.

    *)
  5. changesetId : ChangesetId.t option;
    (*

    A unique identifier of the changeset that you want to use to ingest data.

    *)
  6. segmentConfigurations : KxDataviewSegmentConfigurationList.t option;
    (*

    The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

    *)
  7. activeVersions : KxDataviewActiveVersionList.t option;
    (*

    The current active changeset versions of the database on the given dataview.

    *)
  8. description : Description.t option;
    (*

    A description of the dataview.

    *)
  9. autoUpdate : BooleanValue.t option;
    (*

    The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.

    *)
  10. readWrite : BooleanValue.t option;
    (*

    Returns True if the dataview is created as writeable and False otherwise.

    *)
  11. environmentId : EnvironmentId.t option;
    (*

    A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

    *)
  12. createdTimestamp : Timestamp.t option;
    (*

    The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    *)
  13. lastModifiedTimestamp : Timestamp.t option;
    (*

    The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    *)
  14. status : KxDataviewStatus.t option;
    (*

    The status of dataview creation. CREATING – The dataview creation is in progress. UPDATING – The dataview is in the process of being updated. ACTIVE – The dataview is active.

    *)
  15. statusReason : KxDataviewStatusReason.t option;
    (*

    The error message when a failed state occurs.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?databaseName:??? -> ?dataviewName:??? -> ?azMode:??? -> ?availabilityZoneId:??? -> ?changesetId:??? -> ?segmentConfigurations:??? -> ?activeVersions:??? -> ?description:??? -> ?autoUpdate:??? -> ?readWrite:??? -> ?environmentId:??? -> ?createdTimestamp:??? -> ?lastModifiedTimestamp:??? -> ?status:??? -> ?statusReason:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of BooleanValue.t | `Enum of string | `List of [> `Structure of (string * [> `Boolean of BooleanValue.t | `List of [> `String of DbPath.t | `Structure of (string * [> `Boolean of BooleanValue.t | `List of [> `String of DbPath.t ] list | `String of KxVolumeName.t ]) list ] list | `String of KxVolumeName.t | `Timestamp of Timestamp.t ]) list ] list | `String of DatabaseName.t | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t