/*
* Copyright (c) Citrix Systems, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1) Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
using System;
using System.Collections;
using System.Collections.Generic;
using System.ComponentModel;
using System.Globalization;
using System.Linq;
using Newtonsoft.Json;
namespace XenAPI
{
///
/// The metrics associated with a virtual network device
/// First published in XenServer 4.0.
///
public partial class VIF_metrics : XenObject
{
#region Constructors
public VIF_metrics()
{
}
public VIF_metrics(string uuid,
double io_read_kbs,
double io_write_kbs,
DateTime last_updated,
Dictionary other_config)
{
this.uuid = uuid;
this.io_read_kbs = io_read_kbs;
this.io_write_kbs = io_write_kbs;
this.last_updated = last_updated;
this.other_config = other_config;
}
///
/// Creates a new VIF_metrics from a Hashtable.
/// Note that the fields not contained in the Hashtable
/// will be created with their default values.
///
///
public VIF_metrics(Hashtable table)
: this()
{
UpdateFrom(table);
}
///
/// Creates a new VIF_metrics from a Proxy_VIF_metrics.
///
///
public VIF_metrics(Proxy_VIF_metrics proxy)
{
UpdateFrom(proxy);
}
#endregion
///
/// Updates each field of this instance with the value of
/// the corresponding field of a given VIF_metrics.
///
public override void UpdateFrom(VIF_metrics record)
{
uuid = record.uuid;
io_read_kbs = record.io_read_kbs;
io_write_kbs = record.io_write_kbs;
last_updated = record.last_updated;
other_config = record.other_config;
}
internal void UpdateFrom(Proxy_VIF_metrics proxy)
{
uuid = proxy.uuid == null ? null : proxy.uuid;
io_read_kbs = Convert.ToDouble(proxy.io_read_kbs);
io_write_kbs = Convert.ToDouble(proxy.io_write_kbs);
last_updated = proxy.last_updated;
other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config);
}
///
/// Given a Hashtable with field-value pairs, it updates the fields of this VIF_metrics
/// with the values listed in the Hashtable. Note that only the fields contained
/// in the Hashtable will be updated and the rest will remain the same.
///
///
public void UpdateFrom(Hashtable table)
{
if (table.ContainsKey("uuid"))
uuid = Marshalling.ParseString(table, "uuid");
if (table.ContainsKey("io_read_kbs"))
io_read_kbs = Marshalling.ParseDouble(table, "io_read_kbs");
if (table.ContainsKey("io_write_kbs"))
io_write_kbs = Marshalling.ParseDouble(table, "io_write_kbs");
if (table.ContainsKey("last_updated"))
last_updated = Marshalling.ParseDateTime(table, "last_updated");
if (table.ContainsKey("other_config"))
other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config"));
}
public Proxy_VIF_metrics ToProxy()
{
Proxy_VIF_metrics result_ = new Proxy_VIF_metrics();
result_.uuid = uuid ?? "";
result_.io_read_kbs = io_read_kbs;
result_.io_write_kbs = io_write_kbs;
result_.last_updated = last_updated;
result_.other_config = Maps.convert_to_proxy_string_string(other_config);
return result_;
}
public bool DeepEquals(VIF_metrics other)
{
if (ReferenceEquals(null, other))
return false;
if (ReferenceEquals(this, other))
return true;
return Helper.AreEqual2(this._uuid, other._uuid) &&
Helper.AreEqual2(this._io_read_kbs, other._io_read_kbs) &&
Helper.AreEqual2(this._io_write_kbs, other._io_write_kbs) &&
Helper.AreEqual2(this._last_updated, other._last_updated) &&
Helper.AreEqual2(this._other_config, other._other_config);
}
public override string SaveChanges(Session session, string opaqueRef, VIF_metrics server)
{
if (opaqueRef == null)
{
System.Diagnostics.Debug.Assert(false, "Cannot create instances of this type on the server");
return "";
}
else
{
if (!Helper.AreEqual2(_other_config, server._other_config))
{
VIF_metrics.set_other_config(session, opaqueRef, _other_config);
}
return null;
}
}
///
/// Get a record containing the current state of the given VIF_metrics.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given vif_metrics
public static VIF_metrics get_record(Session session, string _vif_metrics)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.vif_metrics_get_record(session.opaque_ref, _vif_metrics);
else
return new VIF_metrics(session.XmlRpcProxy.vif_metrics_get_record(session.opaque_ref, _vif_metrics ?? "").parse());
}
///
/// Get a reference to the VIF_metrics instance with the specified UUID.
/// First published in XenServer 4.0.
///
/// The session
/// UUID of object to return
public static XenRef get_by_uuid(Session session, string _uuid)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.vif_metrics_get_by_uuid(session.opaque_ref, _uuid);
else
return XenRef.Create(session.XmlRpcProxy.vif_metrics_get_by_uuid(session.opaque_ref, _uuid ?? "").parse());
}
///
/// Get the uuid field of the given VIF_metrics.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given vif_metrics
public static string get_uuid(Session session, string _vif_metrics)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.vif_metrics_get_uuid(session.opaque_ref, _vif_metrics);
else
return session.XmlRpcProxy.vif_metrics_get_uuid(session.opaque_ref, _vif_metrics ?? "").parse();
}
///
/// Get the io/read_kbs field of the given VIF_metrics.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given vif_metrics
public static double get_io_read_kbs(Session session, string _vif_metrics)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.vif_metrics_get_io_read_kbs(session.opaque_ref, _vif_metrics);
else
return Convert.ToDouble(session.XmlRpcProxy.vif_metrics_get_io_read_kbs(session.opaque_ref, _vif_metrics ?? "").parse());
}
///
/// Get the io/write_kbs field of the given VIF_metrics.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given vif_metrics
public static double get_io_write_kbs(Session session, string _vif_metrics)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.vif_metrics_get_io_write_kbs(session.opaque_ref, _vif_metrics);
else
return Convert.ToDouble(session.XmlRpcProxy.vif_metrics_get_io_write_kbs(session.opaque_ref, _vif_metrics ?? "").parse());
}
///
/// Get the last_updated field of the given VIF_metrics.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given vif_metrics
public static DateTime get_last_updated(Session session, string _vif_metrics)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.vif_metrics_get_last_updated(session.opaque_ref, _vif_metrics);
else
return session.XmlRpcProxy.vif_metrics_get_last_updated(session.opaque_ref, _vif_metrics ?? "").parse();
}
///
/// Get the other_config field of the given VIF_metrics.
/// First published in XenServer 5.0.
///
/// The session
/// The opaque_ref of the given vif_metrics
public static Dictionary get_other_config(Session session, string _vif_metrics)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.vif_metrics_get_other_config(session.opaque_ref, _vif_metrics);
else
return Maps.convert_from_proxy_string_string(session.XmlRpcProxy.vif_metrics_get_other_config(session.opaque_ref, _vif_metrics ?? "").parse());
}
///
/// Set the other_config field of the given VIF_metrics.
/// First published in XenServer 5.0.
///
/// The session
/// The opaque_ref of the given vif_metrics
/// New value to set
public static void set_other_config(Session session, string _vif_metrics, Dictionary _other_config)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.vif_metrics_set_other_config(session.opaque_ref, _vif_metrics, _other_config);
else
session.XmlRpcProxy.vif_metrics_set_other_config(session.opaque_ref, _vif_metrics ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse();
}
///
/// Add the given key-value pair to the other_config field of the given VIF_metrics.
/// First published in XenServer 5.0.
///
/// The session
/// The opaque_ref of the given vif_metrics
/// Key to add
/// Value to add
public static void add_to_other_config(Session session, string _vif_metrics, string _key, string _value)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.vif_metrics_add_to_other_config(session.opaque_ref, _vif_metrics, _key, _value);
else
session.XmlRpcProxy.vif_metrics_add_to_other_config(session.opaque_ref, _vif_metrics ?? "", _key ?? "", _value ?? "").parse();
}
///
/// Remove the given key and its corresponding value from the other_config field of the given VIF_metrics. If the key is not in that Map, then do nothing.
/// First published in XenServer 5.0.
///
/// The session
/// The opaque_ref of the given vif_metrics
/// Key to remove
public static void remove_from_other_config(Session session, string _vif_metrics, string _key)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.vif_metrics_remove_from_other_config(session.opaque_ref, _vif_metrics, _key);
else
session.XmlRpcProxy.vif_metrics_remove_from_other_config(session.opaque_ref, _vif_metrics ?? "", _key ?? "").parse();
}
///
/// Return a list of all the VIF_metrics instances known to the system.
/// First published in XenServer 4.0.
///
/// The session
public static List> get_all(Session session)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.vif_metrics_get_all(session.opaque_ref);
else
return XenRef.Create(session.XmlRpcProxy.vif_metrics_get_all(session.opaque_ref).parse());
}
///
/// Get all the VIF_metrics Records at once, in a single XML RPC call
/// First published in XenServer 4.0.
///
/// The session
public static Dictionary, VIF_metrics> get_all_records(Session session)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.vif_metrics_get_all_records(session.opaque_ref);
else
return XenRef.Create(session.XmlRpcProxy.vif_metrics_get_all_records(session.opaque_ref).parse());
}
///
/// Unique identifier/object reference
///
public virtual string uuid
{
get { return _uuid; }
set
{
if (!Helper.AreEqual(value, _uuid))
{
_uuid = value;
NotifyPropertyChanged("uuid");
}
}
}
private string _uuid = "";
///
/// Read bandwidth (KiB/s)
///
public virtual double io_read_kbs
{
get { return _io_read_kbs; }
set
{
if (!Helper.AreEqual(value, _io_read_kbs))
{
_io_read_kbs = value;
NotifyPropertyChanged("io_read_kbs");
}
}
}
private double _io_read_kbs;
///
/// Write bandwidth (KiB/s)
///
public virtual double io_write_kbs
{
get { return _io_write_kbs; }
set
{
if (!Helper.AreEqual(value, _io_write_kbs))
{
_io_write_kbs = value;
NotifyPropertyChanged("io_write_kbs");
}
}
}
private double _io_write_kbs;
///
/// Time at which this information was last updated
///
[JsonConverter(typeof(XenDateTimeConverter))]
public virtual DateTime last_updated
{
get { return _last_updated; }
set
{
if (!Helper.AreEqual(value, _last_updated))
{
_last_updated = value;
NotifyPropertyChanged("last_updated");
}
}
}
private DateTime _last_updated;
///
/// additional configuration
/// First published in XenServer 5.0.
///
[JsonConverter(typeof(StringStringMapConverter))]
public virtual Dictionary other_config
{
get { return _other_config; }
set
{
if (!Helper.AreEqual(value, _other_config))
{
_other_config = value;
NotifyPropertyChanged("other_config");
}
}
}
private Dictionary _other_config = new Dictionary() {};
}
}