Google Cloud Support v2 API - Class CommentName (1.1.0)

public sealed class CommentName : IResourceName, IEquatable<CommentName>

Reference documentation and code samples for the Google Cloud Support v2 API class CommentName.

Resource name for the Comment resource.

Inheritance

object > CommentName

Namespace

Google.Cloud.Support.V2

Assembly

Google.Cloud.Support.V2.dll

Constructors

CommentName(string, string, string)

public CommentName(string organizationId, string caseId, string commentId)

Constructs a new instance of a CommentName class from the component parts of pattern organizations/{organization}/cases/{case}/comments/{comment}

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

caseIdstring

The Case ID. Must not be null or empty.

commentIdstring

The Comment ID. Must not be null or empty.

Properties

CaseId

public string CaseId { get; }

The Case ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
string

CommentId

public string CommentId { get; }

The Comment ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
bool

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
string

Type

public CommentName.ResourceNameType Type { get; }

The CommentName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CommentNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string organizationId, string caseId, string commentId)

Formats the IDs into the string representation of this CommentName with pattern organizations/{organization}/cases/{case}/comments/{comment}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

caseIdstring

The Case ID. Must not be null or empty.

commentIdstring

The Comment ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this CommentName with pattern organizations/{organization}/cases/{case}/comments/{comment}.

FormatOrganizationCaseComment(string, string, string)

public static string FormatOrganizationCaseComment(string organizationId, string caseId, string commentId)

Formats the IDs into the string representation of this CommentName with pattern organizations/{organization}/cases/{case}/comments/{comment}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

caseIdstring

The Case ID. Must not be null or empty.

commentIdstring

The Comment ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this CommentName with pattern organizations/{organization}/cases/{case}/comments/{comment}.

FormatProjectCaseComment(string, string, string)

public static string FormatProjectCaseComment(string projectId, string caseId, string commentId)

Formats the IDs into the string representation of this CommentName with pattern projects/{project}/cases/{case}/comments/{comment}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

caseIdstring

The Case ID. Must not be null or empty.

commentIdstring

The Comment ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this CommentName with pattern projects/{project}/cases/{case}/comments/{comment}.

FromOrganizationCaseComment(string, string, string)

public static CommentName FromOrganizationCaseComment(string organizationId, string caseId, string commentId)

Creates a CommentName with the pattern organizations/{organization}/cases/{case}/comments/{comment}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

caseIdstring

The Case ID. Must not be null or empty.

commentIdstring

The Comment ID. Must not be null or empty.

Returns
TypeDescription
CommentName

A new instance of CommentName constructed from the provided ids.

FromProjectCaseComment(string, string, string)

public static CommentName FromProjectCaseComment(string projectId, string caseId, string commentId)

Creates a CommentName with the pattern projects/{project}/cases/{case}/comments/{comment} .

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

caseIdstring

The Case ID. Must not be null or empty.

commentIdstring

The Comment ID. Must not be null or empty.

Returns
TypeDescription
CommentName

A new instance of CommentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CommentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CommentName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CommentName

A new instance of CommentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static CommentName Parse(string commentName)

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

Parameter
NameDescription
commentNamestring

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

Returns
TypeDescription
CommentName

The parsed CommentName if successful.

Remarks

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

  • organizations/{organization}/cases/{case}/comments/{comment}
  • projects/{project}/cases/{case}/comments/{comment}

Parse(string, bool)

public static CommentName Parse(string commentName, bool allowUnparsed)

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

Parameters
NameDescription
commentNamestring

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

allowUnparsedbool

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
TypeDescription
CommentName

The parsed CommentName if successful.

Remarks

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

  • organizations/{organization}/cases/{case}/comments/{comment}
  • projects/{project}/cases/{case}/comments/{comment}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out CommentName)

public static bool TryParse(string commentName, out CommentName result)

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

Parameters
NameDescription
commentNamestring

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

resultCommentName

When this method returns, the parsed CommentName, or null if parsing failed.

Returns
TypeDescription
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:

  • organizations/{organization}/cases/{case}/comments/{comment}
  • projects/{project}/cases/{case}/comments/{comment}

TryParse(string, bool, out CommentName)

public static bool TryParse(string commentName, bool allowUnparsed, out CommentName result)

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

Parameters
NameDescription
commentNamestring

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

allowUnparsedbool

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.

resultCommentName

When this method returns, the parsed CommentName, or null if parsing failed.

Returns
TypeDescription
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:

  • organizations/{organization}/cases/{case}/comments/{comment}
  • projects/{project}/cases/{case}/comments/{comment}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CommentName, CommentName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aCommentName

The first resource name to compare, or null.

bCommentName

The second resource name to compare, or null.

Returns
TypeDescription
bool

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

operator !=(CommentName, CommentName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aCommentName

The first resource name to compare, or null.

bCommentName

The second resource name to compare, or null.

Returns
TypeDescription
bool

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