Class: secret
A secret
Fields for class: secret
| Field | Type | Qualifier | Description |
|---|---|---|---|
other_config |
(string -> string) map |
RW | other_config |
uuid |
string |
RO/runtime | Unique identifier/object reference |
value |
string |
RW | the secret |
RPCs associated with class: secret
RPC name: add_to_other_config
Overview:
Add the given key-value pair to the other_config field of the given secret.
Signature:
void add_to_other_config (session ref session_ref, secret ref self, string key, string value)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
secret ref |
self |
reference to the object |
string |
key |
Key to add |
string |
value |
Value to add |
Minimum Role: pool-operator
Return Type: void
RPC name: create
Overview:
Create a new secret instance, and return its handle.
Signature:
secret ref create (session ref session_ref, secret record args)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
secret record |
args |
All constructor arguments |
Minimum Role: pool-operator
Return Type: secret ref
reference to the newly created object
RPC name: destroy
Overview:
Destroy the specified secret instance.
Signature:
void destroy (session ref session_ref, secret ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
secret ref |
self |
reference to the object |
Minimum Role: pool-operator
Return Type: void
RPC name: get_all
Overview:
Return a list of all the secrets known to the system.
Signature:
secret ref set get_all (session ref session_ref)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Minimum Role: pool-operator
Return Type: secret ref set
references to all objects
RPC name: get_all_records
Overview:
Return a map of secret references to secret records for all secrets known to the system.
Signature:
(secret ref -> secret record) map get_all_records (session ref session_ref)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Minimum Role: pool-operator
Return Type: (secret ref -> secret record) map
records of all objects
RPC name: get_by_uuid
Overview:
Get a reference to the secret instance with the specified UUID.
Signature:
secret ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
string |
uuid |
UUID of object to return |
Minimum Role: pool-operator
Return Type: secret ref
reference to the object
RPC name: get_other_config
Overview:
Get the other_config field of the given secret.
Signature:
(string -> string) map get_other_config (session ref session_ref, secret ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
secret ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: (string -> string) map
value of the field
RPC name: get_record
Overview:
Get a record containing the current state of the given secret.
Signature:
secret record get_record (session ref session_ref, secret ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
secret ref |
self |
reference to the object |
Minimum Role: pool-operator
Return Type: secret record
all fields from the object
RPC name: get_uuid
Overview:
Get the uuid field of the given secret.
Signature:
string get_uuid (session ref session_ref, secret ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
secret ref |
self |
reference to the object |
Minimum Role: pool-operator
Return Type: string
value of the field
RPC name: get_value
Overview:
Get the value field of the given secret.
Signature:
string get_value (session ref session_ref, secret ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
secret ref |
self |
reference to the object |
Minimum Role: pool-operator
Return Type: string
value of the field
RPC name: remove_from_other_config
Overview:
Remove the given key and its corresponding value from the other_config field of the given secret. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, secret ref self, string key)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
secret ref |
self |
reference to the object |
string |
key |
Key to remove |
Minimum Role: pool-operator
Return Type: void
RPC name: set_other_config
Overview:
Set the other_config field of the given secret.
Signature:
void set_other_config (session ref session_ref, secret ref self, (string -> string) map value)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
secret ref |
self |
reference to the object |
(string -> string) map |
value |
New value to set |
Minimum Role: pool-operator
Return Type: void
RPC name: set_value
Overview:
Set the value field of the given secret.
Signature:
void set_value (session ref session_ref, secret ref self, string value)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
secret ref |
self |
reference to the object |
string |
value |
New value to set |
Minimum Role: pool-operator
Return Type: void