GDC Hardware Management v1alpha API - Class CommentName (1.0.0-alpha03) 

public sealed class CommentName : IResourceName, IEquatable<CommentName>

Reference documentation and code samples for the GDC Hardware Management v1alpha API class CommentName.

Resource name for the Comment resource.

Inheritance

object > CommentName

Namespace

Google.Cloud.GdcHardwareManagement.V1Alpha

Assembly

Google.Cloud.GdcHardwareManagement.V1Alpha.dll

Constructors

CommentName(string, string, string, string)

public CommentName(string projectId, string locationId, string orderId, string commentId)

Constructs a new instance of a CommentName class from the component parts of pattern projects/{project}/locations/{location}/orders/{order}/comments/{comment}

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.
orderId string

The Order ID. Must not be null or empty.
commentId string

The Comment ID. Must not be null or empty.

Properties

CommentId

public string CommentId { get; }

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

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
bool

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

OrderId

public string OrderId { get; }

The Order 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 CommentName.ResourceNameType Type { get; }

The CommentName.ResourceNameType of the contained resource name.

Property Value
Type Description
CommentNameResourceNameType

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 orderId, string commentId)

Formats the IDs into the string representation of this CommentName with pattern projects/{project}/locations/{location}/orders/{order}/comments/{comment}.

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.
orderId string

The Order ID. Must not be null or empty.
commentId string

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

The string representation of this CommentName with pattern projects/{project}/locations/{location}/orders/{order}/comments/{comment}.

FormatProjectLocationOrderComment(string, string, string, string)

public static string FormatProjectLocationOrderComment(string projectId, string locationId, string orderId, string commentId)

Formats the IDs into the string representation of this CommentName with pattern projects/{project}/locations/{location}/orders/{order}/comments/{comment}.

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.
orderId string

The Order ID. Must not be null or empty.
commentId string

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

The string representation of this CommentName with pattern projects/{project}/locations/{location}/orders/{order}/comments/{comment}.

FromProjectLocationOrderComment(string, string, string, string)

public static CommentName FromProjectLocationOrderComment(string projectId, string locationId, string orderId, string commentId)

Creates a CommentName with the pattern projects/{project}/locations/{location}/orders/{order}/comments/{comment}.

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.
orderId string

The Order ID. Must not be null or empty.
commentId string

The Comment ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of CommentName 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 CommentName Parse(string commentName)

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

Parameter
Name Description
commentName string

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

The parsed CommentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/orders/{order}/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
Name Description
commentName 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
CommentName

The parsed CommentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/orders/{order}/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
Type Description
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
Name Description
commentName string

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

When this method returns, the parsed CommentName, 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}/orders/{order}/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
Name Description
commentName 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 CommentName

When this method returns, the parsed CommentName, 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}/orders/{order}/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
Name Description
a CommentName

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

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 !=(CommentName, CommentName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CommentName

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

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.