| RiakClusterConfiguration Class |
Represents the configuration file section for a Riak Cluster.
Inheritance HierarchySystemObject
System.ConfigurationConfigurationElement
System.ConfigurationConfigurationSection
RiakClient.ConfigRiakClusterConfiguration
System.ConfigurationConfigurationElement
System.ConfigurationConfigurationSection
RiakClient.ConfigRiakClusterConfiguration
Namespace: RiakClient.Config
Assembly: RiakClient (in RiakClient.dll) Version: f9bb17a3f8ff6940b88010a52f202e3d55fe25c5
SyntaxThe RiakClusterConfiguration type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RiakClusterConfiguration | Initializes a new instance of the RiakClusterConfiguration class |
Properties| Name | Description | |
|---|---|---|
 | Authentication |
A IRiakAuthenticationConfiguration configuration that details any authentication information.
|
| CurrentConfiguration | Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.) |
| DefaultRetryCount |
The max number of retry attempts to make when the client encounters
ResultCode.NoConnections or ResultCode.CommunicationError errors.
|
| DefaultRetryWaitTime |
The period of time to wait inbetween operation retries.
|
| ElementInformation | Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.) |
 | ElementProperty | Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.) |
| EvaluationContext | Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.) |
| ItemConfigurationProperty | Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.) |
| ItemString | Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.) |
| LockAllAttributesExcept | Gets the collection of locked attributes. (Inherited from ConfigurationElement.) |
| LockAllElementsExcept | Gets the collection of locked elements. (Inherited from ConfigurationElement.) |
| LockAttributes | Gets the collection of locked attributes (Inherited from ConfigurationElement.) |
| LockElements | Gets the collection of locked elements. (Inherited from ConfigurationElement.) |
| LockItem | Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.) |
| NodePollTime |
The period of time to poll nodes for health/liveness checks.
|
| Nodes |
A collection of IRiakNodeConfiguration configurations detailing the Riak nodes that can be connected to.
|
| Properties | Gets the collection of properties. (Inherited from ConfigurationElement.) |
| SectionInformation | Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object. (Inherited from ConfigurationSection.) |
| UseTtbEncoding |
Use term-to-binary encoding for messages that support it.
|
Methods| Name | Description | |
|---|---|---|
 | DeserializeElement | Reads XML from the configuration file. (Inherited from ConfigurationElement.) |
| DeserializeSection | Reads XML from the configuration file. (Inherited from ConfigurationSection.) |
| Equals | Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.) |
| GetRuntimeObject | Returns a custom object when overridden in a derived class. (Inherited from ConfigurationSection.) |
| GetTransformedAssemblyString | Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.) |
| GetTransformedTypeString | Returns the transformed version of the specified type name. (Inherited from ConfigurationElement.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Init | Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.) |
| InitializeDefault | Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.) |
| IsModified | Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class. (Inherited from ConfigurationSection.) |
| IsReadOnly | (Overrides ConfigurationElementIsReadOnly.) |
| ListErrors | Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement.) |
 | LoadFromConfig(String) |
Load a RiakClusterConfiguration from the local configuration file,
and return a new IRiakClusterConfiguration.
|
| LoadFromConfig(String, String) |
Load a RiakClusterConfiguration from a specified configuration file,
and return a new IRiakClusterConfiguration.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnDeserializeUnrecognizedAttribute | Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement.) |
| OnDeserializeUnrecognizedElement | Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement.) |
| OnRequiredPropertyNotFound | Throws an exception when a required property is not found. (Inherited from ConfigurationElement.) |
| PostDeserialize | Called after deserialization. (Inherited from ConfigurationElement.) |
| PreSerialize | Called before serialization. (Inherited from ConfigurationElement.) |
| Reset | Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.) |
| ResetModified | Resets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationSection.) |
| SerializeElement | Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
| SerializeSection | Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file. (Inherited from ConfigurationSection.) |
| SerializeToXmlElement | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
| SetPropertyValue | Sets a property to the specified value. (Inherited from ConfigurationElement.) |
| SetReadOnly | Sets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.) |
| ShouldSerializeElementInTargetVersion | Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.) |
| ShouldSerializePropertyInTargetVersion | Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.) |
| ShouldSerializeSectionInTargetVersion | Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Unmerge | Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.) |
See Also