GDC Hardware Management v1alpha API - Class HardwareName (1.0.0-alpha02) 

public sealed class HardwareName : IResourceName, IEquatable<HardwareName>

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

Resource name for the Hardware resource.

Inheritance

object > HardwareName

Namespace

Google.Cloud.GdcHardwareManagement.V1Alpha

Assembly

Google.Cloud.GdcHardwareManagement.V1Alpha.dll

Constructors

HardwareName(string, string, string)

public HardwareName(string projectId, string locationId, string hardwareId)

Constructs a new instance of a HardwareName class from the component parts of pattern projects/{project}/locations/{location}/hardware/{hardware}

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

The Hardware ID. Must not be null or empty.

Properties

HardwareId

public string HardwareId { get; }

The Hardware 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

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 HardwareName.ResourceNameType Type { get; }

The HardwareName.ResourceNameType of the contained resource name.

Property Value
Type Description
HardwareNameResourceNameType

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)

public static string Format(string projectId, string locationId, string hardwareId)

Formats the IDs into the string representation of this HardwareName with pattern projects/{project}/locations/{location}/hardware/{hardware}.

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

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

The string representation of this HardwareName with pattern projects/{project}/locations/{location}/hardware/{hardware}.

FormatProjectLocationHardware(string, string, string)

public static string FormatProjectLocationHardware(string projectId, string locationId, string hardwareId)

Formats the IDs into the string representation of this HardwareName with pattern projects/{project}/locations/{location}/hardware/{hardware}.

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

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

The string representation of this HardwareName with pattern projects/{project}/locations/{location}/hardware/{hardware}.

FromProjectLocationHardware(string, string, string)

public static HardwareName FromProjectLocationHardware(string projectId, string locationId, string hardwareId)

Creates a HardwareName with the pattern projects/{project}/locations/{location}/hardware/{hardware}.

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

The Hardware ID. Must not be null or empty.
Returns
Type Description
HardwareName

A new instance of HardwareName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static HardwareName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HardwareName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
hardwareName string

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

The parsed HardwareName if successful.
Remarks

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

  • projects/{project}/locations/{location}/hardware/{hardware}

Parse(string, bool)

public static HardwareName Parse(string hardwareName, bool allowUnparsed)

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

Parameters
Name Description
hardwareName 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
HardwareName

The parsed HardwareName if successful.
Remarks

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

  • projects/{project}/locations/{location}/hardware/{hardware}
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 HardwareName)

public static bool TryParse(string hardwareName, out HardwareName result)

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

Parameters
Name Description
hardwareName string

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

When this method returns, the parsed HardwareName, 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}/hardware/{hardware}

TryParse(string, bool, out HardwareName)

public static bool TryParse(string hardwareName, bool allowUnparsed, out HardwareName result)

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

Parameters
Name Description
hardwareName 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 HardwareName

When this method returns, the parsed HardwareName, 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}/hardware/{hardware}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(HardwareName, HardwareName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a HardwareName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a HardwareName

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

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.