ConfigurationClient.deleteConfigurationSetting Method

Definition

Overloads

deleteConfigurationSetting(ConfigurationSetting setting)

Deletes the ConfigurationSetting with a matching getKey(), and optional getLabel() and optional ETag combination.

Code Samples

Delete the setting with the key "prodDBConnection".

ConfigurationSetting setting = configurationClient.deleteConfigurationSetting(
     new ConfigurationSetting().setKey("prodDBConnection"));
 System.out.printf("Key: %s, Value: %s", setting.getKey(), setting.getValue());
deleteConfigurationSetting(String key, String label)

Deletes the ConfigurationSetting with a matching key and optional label combination.

Code Samples

Delete the setting with the key "prodDBConnection".

ConfigurationSetting result = configurationClient.deleteConfigurationSetting("prodDBConnection", null);
 System.out.printf("Key: %s, Value: %s", result.getKey(), result.getValue());

deleteConfigurationSetting(ConfigurationSetting setting)

Deletes the ConfigurationSetting with a matching getKey(), and optional getLabel() and optional ETag combination.

Code Samples

Delete the setting with the key "prodDBConnection".

ConfigurationSetting setting = configurationClient.deleteConfigurationSetting(
     new ConfigurationSetting().setKey("prodDBConnection"));
 System.out.printf("Key: %s, Value: %s", setting.getKey(), setting.getValue());
public ConfigurationSetting deleteConfigurationSetting(ConfigurationSetting setting)

Parameters

setting
ConfigurationSetting

The setting to delete based on its key, optional label and optional ETag combination.

Returns

The deleted ConfigurationSetting or null if it didn't exist. null is also returned if the key is an invalid value (which will also throw ServiceRequestException described below).

deleteConfigurationSetting(String key, String label)

Deletes the ConfigurationSetting with a matching key and optional label combination.

Code Samples

Delete the setting with the key "prodDBConnection".

ConfigurationSetting result = configurationClient.deleteConfigurationSetting("prodDBConnection", null);
 System.out.printf("Key: %s, Value: %s", result.getKey(), result.getValue());
public ConfigurationSetting deleteConfigurationSetting(String key, String label)

Parameters

key
java.lang.String

The key of configuration setting to delete.

label
java.lang.String

The label of configuration setting to delete. If null no label will be used.

Returns

The deleted ConfigurationSetting or null if it didn't exist. null is also returned if the key is an invalid value (which will also throw ServiceRequestException described below).

Applies to