apigee.keyvaluemaps package

Submodules

apigee.keyvaluemaps.commands module

apigee.keyvaluemaps.keyvaluemaps module

class apigee.keyvaluemaps.keyvaluemaps.Keyvaluemaps(auth, org_name, map_name)

Bases: object

create_an_entry_in_an_environment_scoped_kvm(environment, entry_name, entry_value)
create_keyvaluemap_in_an_environment(environment, request_body)
create_or_update_entry(environment, entry)
static decrypt_keyvaluemap(kvm_dict, secret)
static decrypt_value(kvm_dict, entry_index, secret)
delete_entries(environment, entries_to_delete)
delete_keyvaluemap_entry_in_an_environment(environment, entry_name)
delete_keyvaluemap_from_an_environment(environment)
static encrypt_keyvaluemap(kvm_dict, secret)
static encrypt_value(kvm_dict, entry_index, secret)
fetch_keys_in_environment_scoped_keyvaluemap(uri)
static find_deleted_keys(kvm_dict1, kvm_dict2)
get_a_keys_value_in_an_environment_scoped_keyvaluemap(environment, entry_name)
get_keyvaluemap_in_an_environment(environment)
list_keys_in_an_environment_scoped_keyvaluemap(environment, startkey, count)
list_keyvaluemaps_in_an_environment(environment, prefix=None, format='json')
push_keyvaluemap(environment, file, secret=None)
send_delete_request(uri)
synchronize_keyvaluemap_with_environment(environment, local_map)

Synchronizes the local Key-Value Map (KVM) with the specified environment.

This method compares the entries in the local_map with the existing Key-Value Map in the given environment. It performs the following actions to synchronize the KVM: - Removes any entries in the environment’s KVM that are not present in the local_map. - Updates the entries in the environment’s KVM with the ones from the local_map that have different values. - Creates new entries in the environment’s KVM for the entries in the local_map that are not already present.

Parameters:
  • environment (str) – The name of the environment where the KVM should be synchronized.

  • local_map (dict) – The local Key-Value Map (KVM) containing the entries to synchronize.

Raises:

Exception – If there is an error during the synchronization process.

Returns:

The method does not return a value directly. It performs the necessary synchronization actions.

Return type:

None

update_an_entry_in_an_environment_scoped_kvm(environment, entry_name, updated_value)
update_keyvaluemap_in_an_environment(environment, request_body)
apigee.keyvaluemaps.keyvaluemaps.get_tqdm_kwargs(desc)

apigee.keyvaluemaps.serializer module

class apigee.keyvaluemaps.serializer.KeyvaluemapsSerializer

Bases: object

serialize_details(maps, format, prefix=None)

Module contents