Contact Center AI Insights v1 API - Class IssueName (2.20.0) 

public sealed class IssueName : IResourceName, IEquatable<IssueName>

Reference documentation and code samples for the Contact Center AI Insights v1 API class IssueName.

Resource name for the Issue resource.

Inheritance

object > IssueName

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

IssueName(string, string, string, string)

public IssueName(string projectId, string locationId, string issueModelId, string issueId)

Constructs a new instance of a IssueName class from the component parts of pattern projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
issueModelId string

The IssueModel ID. Must not be null or empty.
issueId string

The Issue ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

IssueId

public string IssueId { get; }

The Issue ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

IssueModelId

public string IssueModelId { get; }

The IssueModel ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public IssueName.ResourceNameType Type { get; }

The IssueName.ResourceNameType of the contained resource name.

Property Value
Type Description
IssueNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string issueModelId, string issueId)

Formats the IDs into the string representation of this IssueName with pattern projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
issueModelId string

The IssueModel ID. Must not be null or empty.
issueId string

The Issue ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this IssueName with pattern projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}.

FormatProjectLocationIssueModelIssue(string, string, string, string)

public static string FormatProjectLocationIssueModelIssue(string projectId, string locationId, string issueModelId, string issueId)

Formats the IDs into the string representation of this IssueName with pattern projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
issueModelId string

The IssueModel ID. Must not be null or empty.
issueId string

The Issue ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this IssueName with pattern projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}.

FromProjectLocationIssueModelIssue(string, string, string, string)

public static IssueName FromProjectLocationIssueModelIssue(string projectId, string locationId, string issueModelId, string issueId)

Creates a IssueName with the pattern projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
issueModelId string

The IssueModel ID. Must not be null or empty.
issueId string

The Issue ID. Must not be null or empty.
Returns
Type Description
IssueName

A new instance of IssueName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static IssueName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a IssueName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
IssueName

A new instance of IssueName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static IssueName Parse(string issueName)

Parses the given resource name string into a new IssueName instance.

Parameter
Name Description
issueName string

The resource name in string form. Must not be null.
Returns
Type Description
IssueName

The parsed IssueName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}

Parse(string, bool)

public static IssueName Parse(string issueName, bool allowUnparsed)

Parses the given resource name string into a new IssueName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
issueName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
Returns
Type Description
IssueName

The parsed IssueName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out IssueName)

public static bool TryParse(string issueName, out IssueName result)

Tries to parse the given resource name string into a new IssueName instance.

Parameters
Name Description
issueName string

The resource name in string form. Must not be null.
result IssueName

When this method returns, the parsed IssueName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}

TryParse(string, bool, out IssueName)

public static bool TryParse(string issueName, bool allowUnparsed, out IssueName result)

Tries to parse the given resource name string into a new IssueName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
issueName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
result IssueName

When this method returns, the parsed IssueName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(IssueName, IssueName)

public static bool operator ==(IssueName a, IssueName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a IssueName

The first resource name to compare, or null.
b IssueName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(IssueName, IssueName)

public static bool operator !=(IssueName a, IssueName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a IssueName

The first resource name to compare, or null.
b IssueName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.