Struct ClusterVersion

Represents the Couchbase Server Cluster version.

Implements

IEquatable<ClusterVersion>

IComparable<ClusterVersion>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Couchbase.Core.Version

Assembly: Couchbase.NetClient.dll

Syntax

public readonly struct ClusterVersion : IEquatable<ClusterVersion>, IComparable<ClusterVersion>

Constructors

| Edit this page View Source

ClusterVersion(Version?, int, string?)

Create a new ClusterVersion.

Declaration

public ClusterVersion(Version? version = null, int build = -1, string? suffix = null)

Parameters

Type	Name	Description
Version	version	Version number.
int	build	Build number.
string	suffix	Additional information, such as "community" or "enterprise".

Properties

| Edit this page View Source

Build

Build number.

Declaration

public int Build { get; }

Property Value

Type	Description
int

| Edit this page View Source

Suffix

Additional information, such as "community" or "enterprise".

Declaration

public string? Suffix { get; }

Property Value

Type	Description
string

| Edit this page View Source

Version

Version number.

Declaration

public Version? Version { get; }

Property Value

Type	Description
Version

Methods

| Edit this page View Source

CompareTo(ClusterVersion)

Declaration

public int CompareTo(ClusterVersion other)

Parameters

Type	Name	Description
ClusterVersion	other

Returns

Type	Description
int

| Edit this page View Source

Deconstruct(out Version?, out int)

Deconstruct into a tuple.

Declaration

public void Deconstruct(out Version? version, out int build)

Parameters

Type	Name	Description
Version	version
int	build

| Edit this page View Source

Deconstruct(out Version?, out int, out string?)

Deconstruct into a tuple.

Declaration

public void Deconstruct(out Version? version, out int build, out string? suffix)

Parameters

Type	Name	Description
Version	version
int	build
string	suffix

| Edit this page View Source

Equals(ClusterVersion)

Declaration

public bool Equals(ClusterVersion other)

Parameters

Type	Name	Description
ClusterVersion	other

Returns

Type	Description
bool

| Edit this page View Source

Equals(object?)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

| Edit this page View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

| Edit this page View Source

Parse(string)

Parse a string to a ClusterVersion.

Declaration

public static ClusterVersion Parse(string versionString)

Parameters

Type	Name	Description
string	versionString	String to parse.

Returns

Type	Description
ClusterVersion	The parsed ClusterVersion.

Exceptions

Type	Condition
FormatException	`versionString` is not a valid version string.

| Edit this page View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

ValueType.ToString()

| Edit this page View Source

TryParse(string, out ClusterVersion)

Parse a string to a ClusterVersion.

Declaration

public static bool TryParse(string versionString, out ClusterVersion version)

Parameters

Type	Name	Description
string	versionString	String to parse.
ClusterVersion	version	The parsed ClusterVersion.

Returns

Type	Description
bool	True if parsed successfully.

Operators

| Edit this page View Source

operator ==(ClusterVersion, ClusterVersion)

Declaration

public static bool operator ==(ClusterVersion left, ClusterVersion right)

Parameters

Type	Name	Description
ClusterVersion	left
ClusterVersion	right

Returns

Type	Description
bool

| Edit this page View Source

operator >(ClusterVersion, ClusterVersion)

Declaration

public static bool operator >(ClusterVersion left, ClusterVersion right)

Parameters

Type	Name	Description
ClusterVersion	left
ClusterVersion	right

Returns

Type	Description
bool

| Edit this page View Source

operator >=(ClusterVersion, ClusterVersion)

Declaration

public static bool operator >=(ClusterVersion left, ClusterVersion right)

Parameters

Type	Name	Description
ClusterVersion	left
ClusterVersion	right

Returns

Type	Description
bool

| Edit this page View Source

operator !=(ClusterVersion, ClusterVersion)

Declaration

public static bool operator !=(ClusterVersion left, ClusterVersion right)

Parameters

Type	Name	Description
ClusterVersion	left
ClusterVersion	right

Returns

Type	Description
bool

| Edit this page View Source

operator <(ClusterVersion, ClusterVersion)

Declaration

public static bool operator <(ClusterVersion left, ClusterVersion right)

Parameters

Type	Name	Description
ClusterVersion	left
ClusterVersion	right

Returns

Type	Description
bool

| Edit this page View Source

operator <=(ClusterVersion, ClusterVersion)

Declaration

public static bool operator <=(ClusterVersion left, ClusterVersion right)

Parameters

Type	Name	Description
ClusterVersion	left
ClusterVersion	right

Returns

Type	Description
bool

Implements

IEquatable<T>

IComparable<T>