Struct PackageDetails

#[non_exhaustive]
pub struct PackageDetails {

    pub package_id: Option<String>,
    pub package_name: Option<String>,
    pub package_type: Option<PackageType>,
    pub package_description: Option<String>,
    pub package_status: Option<PackageStatus>,
    pub created_at: Option<DateTime>,
    pub last_updated_at: Option<DateTime>,
    pub available_package_version: Option<String>,
    pub error_details: Option<ErrorDetails>,
    pub engine_version: Option<String>,
    pub available_plugin_properties: Option<PluginProperties>,
    pub available_package_configuration: Option<PackageConfiguration>,
    pub allow_listed_user_list: Option<Vec<String>>,
    pub package_owner: Option<String>,
    pub package_vending_options: Option<PackageVendingOptions>,
    pub package_encryption_options: Option<PackageEncryptionOptions>,
}

Basic information about a package.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

package_id: Option<String>

The unique identifier of the package.

package_name: Option<String>

The user-specified name of the package.

package_type: Option<PackageType>

The type of package.

package_description: Option<String>

User-specified description of the package.

package_status: Option<PackageStatus>

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

created_at: Option<DateTime>

The timestamp when the package was created.

last_updated_at: Option<DateTime>

Date and time when the package was last updated.

available_package_version: Option<String>

The package version.

error_details: Option<ErrorDetails>

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

engine_version: Option<String>

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

available_plugin_properties: Option<PluginProperties>

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

available_package_configuration: Option<PackageConfiguration>

This represents the available configuration parameters for the package.

allow_listed_user_list: Option<Vec<String>>

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

package_owner: Option<String>

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

package_vending_options: Option<PackageVendingOptions>

Package Vending Options for a package.

package_encryption_options: Option<PackageEncryptionOptions>

Encryption options for a package.

Implementations

impl PackageDetails

pub fn package_id(&self) -> Option<&str>

The unique identifier of the package.

pub fn package_name(&self) -> Option<&str>

The user-specified name of the package.

pub fn package_type(&self) -> Option<&PackageType>

The type of package.

pub fn package_description(&self) -> Option<&str>

User-specified description of the package.

pub fn package_status(&self) -> Option<&PackageStatus>

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

pub fn created_at(&self) -> Option<&DateTime>

The timestamp when the package was created.

pub fn last_updated_at(&self) -> Option<&DateTime>

Date and time when the package was last updated.

pub fn available_package_version(&self) -> Option<&str>

The package version.

pub fn error_details(&self) -> Option<&ErrorDetails>

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

pub fn engine_version(&self) -> Option<&str>

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

pub fn available_plugin_properties(&self) -> Option<&PluginProperties>

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

pub fn available_package_configuration(&self) -> Option<&PackageConfiguration>

This represents the available configuration parameters for the package.

pub fn allow_listed_user_list(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .allow_listed_user_list.is_none().

pub fn package_owner(&self) -> Option<&str>

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

pub fn package_vending_options(&self) -> Option<&PackageVendingOptions>

Package Vending Options for a package.

pub fn package_encryption_options(&self) -> Option<&PackageEncryptionOptions>

Encryption options for a package.

impl PackageDetails

pub fn builder() -> PackageDetailsBuilder

Creates a new builder-style object to manufacture PackageDetails.

Trait Implementations

impl Clone for PackageDetails

fn clone(&self) -> PackageDetails

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PackageDetails

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PackageDetails

fn eq(&self, other: &PackageDetails) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PackageDetails