Contact Center AI Insights v1 API - Class IssueName (2.3.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

Implements

IResourceName, IEquatable<IssueName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`IssueName.ResourceNameType`

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
`Int32`

Overrides

Object.GetHashCode()

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, Boolean)

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`	`Boolean` 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

Object.ToString()

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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(IssueName, IssueName)

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

Parameters
Name	Description
`a`	`IssueName`
`b`	`IssueName`

Returns
Type	Description
`Boolean`

Inequality(IssueName, IssueName)

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

Parameters
Name	Description
`a`	`IssueName`
`b`	`IssueName`

Returns
Type	Description
`Boolean`