direct-io.hg

changeset 12747:0dfe894e37a4

Tidy up the get_record and get_by_uuid descriptions.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Wed Dec 06 15:01:08 2006 +0000 (2006-12-06)
parents e8f5cd2b7253
children c4b91cbed51a
files docs/xen-api/xenapi-datamodel.tex
line diff
     1.1 --- a/docs/xen-api/xenapi-datamodel.tex	Wed Dec 06 13:28:37 2006 +0000
     1.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Wed Dec 06 15:01:08 2006 +0000
     1.3 @@ -464,7 +464,7 @@ void
     1.4  \subsubsection{RPC name:~get\_by\_uuid}
     1.5  
     1.6  {\bf Overview:} 
     1.7 -returns the session instance with a particular uuid
     1.8 +Get a reference to the session instance with the specified UUID.
     1.9  
    1.10   \noindent {\bf Signature:} 
    1.11  \begin{verbatim} (session ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
    1.12 @@ -496,7 +496,7 @@ reference to the object
    1.13  \subsubsection{RPC name:~get\_record}
    1.14  
    1.15  {\bf Overview:} 
    1.16 -returns a record containing the state of an instance of class session
    1.17 +Get a record containing the current state of the given session.
    1.18  
    1.19   \noindent {\bf Signature:} 
    1.20  \begin{verbatim} (session record) get_record (session_id s, session ref self)\end{verbatim}
    1.21 @@ -830,7 +830,7 @@ void
    1.22  \subsubsection{RPC name:~get\_by\_uuid}
    1.23  
    1.24  {\bf Overview:} 
    1.25 -returns the task instance with a particular uuid
    1.26 +Get a reference to the task instance with the specified UUID.
    1.27  
    1.28   \noindent {\bf Signature:} 
    1.29  \begin{verbatim} (task ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
    1.30 @@ -862,7 +862,7 @@ reference to the object
    1.31  \subsubsection{RPC name:~get\_record}
    1.32  
    1.33  {\bf Overview:} 
    1.34 -returns a record containing the state of an instance of class task
    1.35 +Get a record containing the current state of the given task.
    1.36  
    1.37   \noindent {\bf Signature:} 
    1.38  \begin{verbatim} (task record) get_record (session_id s, task ref self)\end{verbatim}
    1.39 @@ -3797,7 +3797,7 @@ void
    1.40  \subsubsection{RPC name:~get\_by\_uuid}
    1.41  
    1.42  {\bf Overview:} 
    1.43 -returns the VM instance with a particular uuid
    1.44 +Get a reference to the VM instance with the specified UUID.
    1.45  
    1.46   \noindent {\bf Signature:} 
    1.47  \begin{verbatim} (VM ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
    1.48 @@ -3829,7 +3829,7 @@ reference to the object
    1.49  \subsubsection{RPC name:~get\_record}
    1.50  
    1.51  {\bf Overview:} 
    1.52 -returns a record containing the state of an instance of class VM
    1.53 +Get a record containing the current state of the given VM.
    1.54  
    1.55   \noindent {\bf Signature:} 
    1.56  \begin{verbatim} (VM record) get_record (session_id s, VM ref self)\end{verbatim}
    1.57 @@ -4420,7 +4420,7 @@ void
    1.58  \subsubsection{RPC name:~get\_by\_uuid}
    1.59  
    1.60  {\bf Overview:} 
    1.61 -returns the host instance with a particular uuid
    1.62 +Get a reference to the host instance with the specified UUID.
    1.63  
    1.64   \noindent {\bf Signature:} 
    1.65  \begin{verbatim} (host ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
    1.66 @@ -4452,7 +4452,7 @@ reference to the object
    1.67  \subsubsection{RPC name:~get\_record}
    1.68  
    1.69  {\bf Overview:} 
    1.70 -returns a record containing the state of an instance of class host
    1.71 +Get a record containing the current state of the given host.
    1.72  
    1.73   \noindent {\bf Signature:} 
    1.74  \begin{verbatim} (host record) get_record (session_id s, host ref self)\end{verbatim}
    1.75 @@ -4859,7 +4859,7 @@ void
    1.76  \subsubsection{RPC name:~get\_by\_uuid}
    1.77  
    1.78  {\bf Overview:} 
    1.79 -returns the host\_cpu instance with a particular uuid
    1.80 +Get a reference to the host\_cpu instance with the specified UUID.
    1.81  
    1.82   \noindent {\bf Signature:} 
    1.83  \begin{verbatim} (host_cpu ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
    1.84 @@ -4891,7 +4891,7 @@ reference to the object
    1.85  \subsubsection{RPC name:~get\_record}
    1.86  
    1.87  {\bf Overview:} 
    1.88 -returns a record containing the state of an instance of class host\_cpu
    1.89 +Get a record containing the current state of the given host\_cpu.
    1.90  
    1.91   \noindent {\bf Signature:} 
    1.92  \begin{verbatim} (host_cpu record) get_record (session_id s, host_cpu ref self)\end{verbatim}
    1.93 @@ -5390,7 +5390,7 @@ void
    1.94  \subsubsection{RPC name:~get\_by\_uuid}
    1.95  
    1.96  {\bf Overview:} 
    1.97 -returns the network instance with a particular uuid
    1.98 +Get a reference to the network instance with the specified UUID.
    1.99  
   1.100   \noindent {\bf Signature:} 
   1.101  \begin{verbatim} (network ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   1.102 @@ -5422,7 +5422,7 @@ reference to the object
   1.103  \subsubsection{RPC name:~get\_record}
   1.104  
   1.105  {\bf Overview:} 
   1.106 -returns a record containing the state of an instance of class network
   1.107 +Get a record containing the current state of the given network.
   1.108  
   1.109   \noindent {\bf Signature:} 
   1.110  \begin{verbatim} (network record) get_record (session_id s, network ref self)\end{verbatim}
   1.111 @@ -6133,7 +6133,7 @@ void
   1.112  \subsubsection{RPC name:~get\_by\_uuid}
   1.113  
   1.114  {\bf Overview:} 
   1.115 -returns the VIF instance with a particular uuid
   1.116 +Get a reference to the VIF instance with the specified UUID.
   1.117  
   1.118   \noindent {\bf Signature:} 
   1.119  \begin{verbatim} (VIF ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   1.120 @@ -6165,7 +6165,7 @@ reference to the object
   1.121  \subsubsection{RPC name:~get\_record}
   1.122  
   1.123  {\bf Overview:} 
   1.124 -returns a record containing the state of an instance of class VIF
   1.125 +Get a record containing the current state of the given VIF.
   1.126  
   1.127   \noindent {\bf Signature:} 
   1.128  \begin{verbatim} (VIF record) get_record (session_id s, VIF ref self)\end{verbatim}
   1.129 @@ -6777,7 +6777,7 @@ void
   1.130  \subsubsection{RPC name:~get\_by\_uuid}
   1.131  
   1.132  {\bf Overview:} 
   1.133 -returns the PIF instance with a particular uuid
   1.134 +Get a reference to the PIF instance with the specified UUID.
   1.135  
   1.136   \noindent {\bf Signature:} 
   1.137  \begin{verbatim} (PIF ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   1.138 @@ -6809,7 +6809,7 @@ reference to the object
   1.139  \subsubsection{RPC name:~get\_record}
   1.140  
   1.141  {\bf Overview:} 
   1.142 -returns a record containing the state of an instance of class PIF
   1.143 +Get a record containing the current state of the given PIF.
   1.144  
   1.145   \noindent {\bf Signature:} 
   1.146  \begin{verbatim} (PIF record) get_record (session_id s, PIF ref self)\end{verbatim}
   1.147 @@ -7343,7 +7343,7 @@ void
   1.148  \subsubsection{RPC name:~get\_by\_uuid}
   1.149  
   1.150  {\bf Overview:} 
   1.151 -returns the SR instance with a particular uuid
   1.152 +Get a reference to the SR instance with the specified UUID.
   1.153  
   1.154   \noindent {\bf Signature:} 
   1.155  \begin{verbatim} (SR ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   1.156 @@ -7375,7 +7375,7 @@ reference to the object
   1.157  \subsubsection{RPC name:~get\_record}
   1.158  
   1.159  {\bf Overview:} 
   1.160 -returns a record containing the state of an instance of class SR
   1.161 +Get a record containing the current state of the given SR.
   1.162  
   1.163   \noindent {\bf Signature:} 
   1.164  \begin{verbatim} (SR record) get_record (session_id s, SR ref self)\end{verbatim}
   1.165 @@ -8217,7 +8217,7 @@ void
   1.166  \subsubsection{RPC name:~get\_by\_uuid}
   1.167  
   1.168  {\bf Overview:} 
   1.169 -returns the VDI instance with a particular uuid
   1.170 +Get a reference to the VDI instance with the specified UUID.
   1.171  
   1.172   \noindent {\bf Signature:} 
   1.173  \begin{verbatim} (VDI ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   1.174 @@ -8249,7 +8249,7 @@ reference to the object
   1.175  \subsubsection{RPC name:~get\_record}
   1.176  
   1.177  {\bf Overview:} 
   1.178 -returns a record containing the state of an instance of class VDI
   1.179 +Get a record containing the current state of the given VDI.
   1.180  
   1.181   \noindent {\bf Signature:} 
   1.182  \begin{verbatim} (VDI record) get_record (session_id s, VDI ref self)\end{verbatim}
   1.183 @@ -8860,7 +8860,7 @@ void
   1.184  \subsubsection{RPC name:~get\_by\_uuid}
   1.185  
   1.186  {\bf Overview:} 
   1.187 -returns the VBD instance with a particular uuid
   1.188 +Get a reference to the VBD instance with the specified UUID.
   1.189  
   1.190   \noindent {\bf Signature:} 
   1.191  \begin{verbatim} (VBD ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   1.192 @@ -8892,7 +8892,7 @@ reference to the object
   1.193  \subsubsection{RPC name:~get\_record}
   1.194  
   1.195  {\bf Overview:} 
   1.196 -returns a record containing the state of an instance of class VBD
   1.197 +Get a record containing the current state of the given VBD.
   1.198  
   1.199   \noindent {\bf Signature:} 
   1.200  \begin{verbatim} (VBD record) get_record (session_id s, VBD ref self)\end{verbatim}
   1.201 @@ -9168,7 +9168,7 @@ void
   1.202  \subsubsection{RPC name:~get\_by\_uuid}
   1.203  
   1.204  {\bf Overview:} 
   1.205 -returns the VTPM instance with a particular uuid
   1.206 +Get a reference to the VTPM instance with the specified UUID.
   1.207  
   1.208   \noindent {\bf Signature:} 
   1.209  \begin{verbatim} (VTPM ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   1.210 @@ -9200,7 +9200,7 @@ reference to the object
   1.211  \subsubsection{RPC name:~get\_record}
   1.212  
   1.213  {\bf Overview:} 
   1.214 -returns a record containing the state of an instance of class VTPM
   1.215 +Get a record containing the current state of the given VTPM.
   1.216  
   1.217   \noindent {\bf Signature:} 
   1.218  \begin{verbatim} (VTPM record) get_record (session_id s, VTPM ref self)\end{verbatim}
   1.219 @@ -9719,7 +9719,7 @@ void
   1.220  \subsubsection{RPC name:~get\_by\_uuid}
   1.221  
   1.222  {\bf Overview:} 
   1.223 -returns the user instance with a particular uuid
   1.224 +Get a reference to the user instance with the specified UUID.
   1.225  
   1.226   \noindent {\bf Signature:} 
   1.227  \begin{verbatim} (user ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   1.228 @@ -9751,7 +9751,7 @@ reference to the object
   1.229  \subsubsection{RPC name:~get\_record}
   1.230  
   1.231  {\bf Overview:} 
   1.232 -returns a record containing the state of an instance of class user
   1.233 +Get a record containing the current state of the given user.
   1.234  
   1.235   \noindent {\bf Signature:} 
   1.236  \begin{verbatim} (user record) get_record (session_id s, user ref self)\end{verbatim}
   1.237 @@ -9896,7 +9896,7 @@ void
   1.238  \subsubsection{RPC name:~get\_by\_uuid}
   1.239  
   1.240  {\bf Overview:} 
   1.241 -returns the debug instance with a particular uuid
   1.242 +Get a reference to the debug instance with the specified UUID.
   1.243  
   1.244   \noindent {\bf Signature:} 
   1.245  \begin{verbatim} (debug ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   1.246 @@ -9928,7 +9928,7 @@ reference to the object
   1.247  \subsubsection{RPC name:~get\_record}
   1.248  
   1.249  {\bf Overview:} 
   1.250 -returns a record containing the state of an instance of class debug
   1.251 +Get a record containing the current state of the given debug.
   1.252  
   1.253   \noindent {\bf Signature:} 
   1.254  \begin{verbatim} (debug record) get_record (session_id s, debug ref self)\end{verbatim}