Module Values.PackageDetailsSource

Basic information about a package.

Sourcetype nonrec t = {
  1. packageID : PackageID.t option;
    (*

    The unique identifier of the package.

    *)
  2. packageName : PackageName.t option;
    (*

    The user-specified name of the package.

    *)
  3. packageType : PackageType.t option;
    (*

    The type of package.

    *)
  4. packageDescription : PackageDescription.t option;
    (*

    User-specified description of the package.

    *)
  5. packageStatus : PackageStatus.t option;
    (*

    The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

    *)
  6. createdAt : CreatedAt.t option;
    (*

    The timestamp when the package was created.

    *)
  7. lastUpdatedAt : LastUpdated.t option;
    (*

    Date and time when the package was last updated.

    *)
  8. availablePackageVersion : PackageVersion.t option;
    (*

    The package version.

    *)
  9. errorDetails : ErrorDetails.t option;
    (*

    Additional information if the package is in an error state. Null otherwise.

    *)
  10. engineVersion : EngineVersion.t option;
    (*

    Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

    *)
  11. availablePluginProperties : PluginProperties.t option;
    (*

    If the package is a ZIP-PLUGIN package, additional information about plugin properties.

    *)
  12. availablePackageConfiguration : PackageConfiguration.t option;
    (*

    This represents the available configuration parameters for the package.

    *)
  13. allowListedUserList : PackageUserList.t option;
    (*

    A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

    *)
  14. packageOwner : PackageOwner.t option;
    (*

    The owner of the package who is allowed to create and update a package and add users to the package scope.

    *)
  15. packageVendingOptions : PackageVendingOptions.t option;
    (*

    Package Vending Options for a package.

    *)
  16. packageEncryptionOptions : PackageEncryptionOptions.t option;
    (*

    Encryption options for a package.

    *)
}
Sourceval make : ?packageID:??? -> ?packageName:??? -> ?packageType:??? -> ?packageDescription:??? -> ?packageStatus:??? -> ?createdAt:??? -> ?lastUpdatedAt:??? -> ?availablePackageVersion:??? -> ?errorDetails:??? -> ?engineVersion:??? -> ?availablePluginProperties:??? -> ?availablePackageConfiguration:??? -> ?allowListedUserList:??? -> ?packageOwner:??? -> ?packageVendingOptions:??? -> ?packageEncryptionOptions:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `String of PackageUser.t ] list | `String of PackageID.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Long of UncompressedPluginSizeInBytes.t | `String of ErrorType.t ]) list | `Timestamp of CreatedAt.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