Struct Role 

pub struct Role {

    pub name: String,
    pub access_hostgroups: Option<ConfigRefMap<HostGroupRef>>,
    pub access_keywords: Option<ConfigRefMap<HashtagRef>>,
    pub access_servicegroups: Option<ConfigRefMap<ServiceGroupRef>>,
    pub accesses: Option<HashSet<Access>>,
    pub all_bsm_components: Option<bool>,
    pub all_bsm_edit: Option<bool>,
    pub all_bsm_view: Option<bool>,
    pub all_hostgroups: Option<bool>,
    pub all_keywords: Option<bool>,
    pub all_monitoringservers: Option<bool>,
    pub all_remotely_managed_clusters: Option<bool>,
    pub all_servicegroups: Option<bool>,
    pub contacts: Option<ConfigRefMap<ContactRef>>,
    pub description: Option<String>,
    pub hostgroups: Option<ConfigRefMap<HostGroupRef>>,
    pub monitoringservers: Option<ConfigObjectMap<MonitoringServer>>,
    pub remotely_managed_clusters: Option<ConfigRefMap<MonitoringClusterRef>>,
    pub tenancy: Option<TenancyRef>,
    pub id: Option<u64>,
    pub ref_: Option<String>,
    pub uncommitted: Option<bool>,
}

Represents a Role in Opsview.

Roles are used to define a set of permissions for users within the Opsview system.

This struct defines the structure for a role entity as used in Opsview.

Fields

name: String

The name of the Role.

access_hostgroups: Option<ConfigRefMap<HostGroupRef>>

ConfigRefMap of HostGroupRef objects that the Role has access to.

access_keywords: Option<ConfigRefMap<HashtagRef>>

ConfigRefMap of HashtagRef objects that the Role has access to.

access_servicegroups: Option<ConfigRefMap<ServiceGroupRef>>

ConfigRefMap of ServiceGroupRef objects that the Role has access to.

accesses: Option<HashSet<Access>>

HashSet of Access objects that the Role has access to.

all_bsm_components: Option<bool>

A boolean indicating whether the Role has access to all super::BSMComponents. Default: Some(false).

all_bsm_edit: Option<bool>

A boolean indicating whether the Role has access to all BSM edit operations. Some(false).

all_bsm_view: Option<bool>

A boolean indicating whether the Role has access to all BSM view operations. Some(false).

all_hostgroups: Option<bool>

A boolean indicating whether the Role has access to all HostGroups. Some(false).

all_keywords: Option<bool>

A boolean indicating whether the Role has access to all Hashtags. Some(false).

all_monitoringservers: Option<bool>

A boolean indicating whether the Role has access to all monitoring servers. Some(false).

all_remotely_managed_clusters: Option<bool>

A boolean indicating whether the Role has access to all remotely managed clusters. Some(false).

all_servicegroups: Option<bool>

A boolean indicating whether the Role has access to all ServiceGroups. Some(false).

contacts: Option<ConfigRefMap<ContactRef>>

ConfigRefMap of ContactRef objects associated with this role.

description: Option<String>

A description of the Role.

hostgroups: Option<ConfigRefMap<HostGroupRef>>

ConfigRefMap of HostGroupRef objects associated with this role.

monitoringservers: Option<ConfigObjectMap<MonitoringServer>>

ConfigObjectMap of MonitoringServer objects associated with this role.

remotely_managed_clusters: Option<ConfigRefMap<MonitoringClusterRef>>

ConfigRefMap of remotely managed MonitoringClusterRef objects associated with this role.

tenancy: Option<TenancyRef>

The TenancyRef of the Role.

id: Option<u64>

The unique identifier of the Role.

ref_: Option<String>

A reference string unique to this Role.

uncommitted: Option<bool>

A boolean indicating whether the Role is uncommitted.

Trait Implementations

impl Clone for Role

fn clone(&self) -> Role

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConfigObject for Role

fn builder() -> Self::Builder

Returns a builder for constructing a Role object.

Returns

A RoleBuilder object.

fn config_path() -> Option<String>

Provides the configuration path for a Role object within the Opsview system.

Returns

A string representing the API path where roles are configured.

fn unique_name(&self) -> String

Returns the unique name of the Role object.

This name is used to identify the Role when building the HashMap for an ConfigObjectMap.

Returns

A string representing the unique name of the Role.

type Builder = RoleBuilder

fn minimal(name: &str) -> Result<Self, OpsviewConfigError>

impl CreateFromJson for Role

Enables the creation of a Role instance from a JSON representation. Typically used when parsing JSON data from the Opsview API.

fn from_json(json: &str) -> Result<Self, Error>

Deserializes a JSON string into an instance of the implementing type.

impl Debug for Role

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

Formats the value using the given formatter.

impl Default for Role

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Role

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Role> for RoleRef

fn from(full_object: Role) -> Self

Converts to this type from the input type.

impl PartialEq for Role

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

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

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 Persistent for Role

fn id(&self) -> Option<u64>

Returns the unique identifier.

fn ref_(&self) -> Option<String>

Returns the reference string if it’s not empty.

fn name(&self) -> Option<String>

Returns the name if it’s not empty.

fn name_regex(&self) -> Option<String>

fn validated_name(&self, name: &str) -> Result<String, OpsviewConfigError>

fn set_name(&mut self, new_name: &str) -> Result<String, OpsviewConfigError>

fn clear_readonly(&mut self)

fn clone_new_name( original: &Self, new_name: &str, ) -> Result<Self, OpsviewConfigError>

Clones an existing object, but with a new name and with read-only fields cleared.

async fn exists( &self, client: &OpsviewClient, ) -> Result<bool, OpsviewClientError>

Checks whether the object exists in the Opsview Server.

async fn fetch( &self, client: &OpsviewClient, params: Option<Params>, ) -> Result<Self, OpsviewClientError>

Retrieves the object from the Opsview Server and returns it.

async fn remove( &self, client: &OpsviewClient, ) -> Result<Value, OpsviewClientError>

Removes the object from the Opsview Server.

async fn create( &self, client: &OpsviewClient, ) -> Result<Value, OpsviewClientError>

Creates the object on the Opsview Server if it doesn’t already exist.

async fn update( &self, client: &OpsviewClient, ) -> Result<Value, OpsviewClientError>

Updates the object on the Opsview Server if it exists, creates it if it doesn’t.

impl Serialize for Role

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Role

impl StructuralPartialEq for Role