Class BugRepositoryDetails

Details about the bug storage system to use.

Inheritance
object
BugRepositoryDetails
Implements
Inherited Members
Namespace: CrashCABN.BugFiler
Assembly: CrashCABN.BugFiler.Abstractions.dll
Syntax
public sealed record BugRepositoryDetails : IEquatable<BugRepositoryDetails>

Constructors

View Source

BugRepositoryDetails(object, string?, string?, string?, string?, string?, KeyValuePair<string, string>?, KeyValuePair<string, IImmutableList<string>>?)

Details regarding how the service should interact with a configured bug repository. This is primarily used for configuration deserialization.

Declaration
[JsonConstructor]
public BugRepositoryDetails(object repository, string? bugItemType = null, string? crashInstanceItemType = null, string? bucketByFieldName = null, string? bucketByTemplate = null, string? crashIDFieldName = null, KeyValuePair<string, string>? searchFilter = null, KeyValuePair<string, IImmutableList<string>>? parentBugFilter = null)
Parameters
Type Name Description
object repository

The ADORepository or JiraRepository to use.
string bugItemType

The work item type that should be used when creating a bug.
string crashInstanceItemType

The work item type that should be used when creating a crash instance.
string bucketByFieldName

The name of the field whose value should be used for bucketing.
string bucketByTemplate
string crashIDFieldName
KeyValuePair<string, string>? searchFilter

The name and value of a repository field to filter any search on when looking for existing crashes.
KeyValuePair<string, IImmutableList<string>>? parentBugFilter

Fields

View Source

DefaultBugItemTypeText

Declaration
public const string DefaultBugItemTypeText = "Bug"
Field Value
Type Description
string
View Source

DefaultCrashInstanceItemTypeText

Declaration
public const string DefaultCrashInstanceItemTypeText = "Crash Instance"
Field Value
Type Description
string

Properties

View Source

BucketByFieldName

Declaration
[JsonProperty(Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string? BucketByFieldName { get; }
Property Value
Type Description
string
View Source

BucketByFieldOrDefault

Declaration
[JsonIgnore]
public string BucketByFieldOrDefault { get; }
Property Value
Type Description
string
View Source

BucketByTemplate

Declaration
[JsonProperty(Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string? BucketByTemplate { get; }
Property Value
Type Description
string
View Source

BugItemType

Gets the item type that crash bugs should be created as.

Declaration
[JsonProperty(Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string BugItemType { get; }
Property Value
Type Description
string
View Source

CrashIDFieldName

Declaration
[JsonProperty(Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string? CrashIDFieldName { get; }
Property Value
Type Description
string
View Source

CrashIDFieldOrDefault

Declaration
[JsonIgnore]
public string? CrashIDFieldOrDefault { get; }
Property Value
Type Description
string
View Source

CrashInstanceItemType

Gets the item type that each crash instance should be created as.

Declaration
[JsonProperty(Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public string CrashInstanceItemType { get; }
Property Value
Type Description
string
View Source

ParentBugFilter

Declaration
[JsonProperty(Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public KeyValuePair<string, IImmutableList<string>> ParentBugFilter { get; }
Property Value
Type Description
KeyValuePair<string, IImmutableList<string>>
View Source

Repository

Declaration
[JsonProperty(Required = Required.Always)]
[JsonConverter(typeof(BugRepositoryConverter))]
public object Repository { get; }
Property Value
Type Description
object
View Source

SearchFilter

Declaration
[JsonProperty(Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
public KeyValuePair<string, string> SearchFilter { get; }
Property Value
Type Description
KeyValuePair<string, string>

Methods

View Source

Equals(BugRepositoryDetails?)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(BugRepositoryDetails? other)
Parameters
Type Name Description
BugRepositoryDetails other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides
View Source

GetItemTypeName(AppliesToEnum)

Declaration
public string GetItemTypeName(AppliesToEnum crashOrBug)
Parameters
Type Name Description
AppliesToEnum crashOrBug
Returns
Type Description
string
View Source

ShouldSerializeBucketByFieldName()

Declaration
public bool ShouldSerializeBucketByFieldName()
Returns
Type Description
bool
View Source

ShouldSerializeCrashIDFieldName()

Declaration
public bool ShouldSerializeCrashIDFieldName()
Returns
Type Description
bool

Implements