GDC Hardware Management v1alpha API - Class HardwareGroupName (1.0.0-alpha01)

public sealed class HardwareGroupName : IResourceName, IEquatable<HardwareGroupName>

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

Resource name for the HardwareGroup resource.

Inheritance

object > HardwareGroupName

Implements

IResourceName, IEquatable HardwareGroupName

Inherited Members

object.GetType()

Namespace

Google.Cloud.GdcHardwareManagement.V1Alpha

Assembly

Google.Cloud.GdcHardwareManagement.V1Alpha.dll

Constructors

HardwareGroupName(string, string, string, string)

public HardwareGroupName(string projectId, string locationId, string orderId, string hardwareGroupId)

Constructs a new instance of a HardwareGroupName class from the component parts of pattern projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}

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.
`hardwareGroupId`	`string` The `HardwareGroup` ID. Must not be `null` or empty.

Properties

HardwareGroupId

public string HardwareGroupId { get; }

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

The HardwareGroupName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`HardwareGroupNameResourceNameType`

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 hardwareGroupId)

Formats the IDs into the string representation of this HardwareGroupName with pattern projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}.

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.
`hardwareGroupId`	`string` The `HardwareGroup` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this HardwareGroupName with pattern `projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}`.

FormatProjectLocationOrderHardwareGroup(string, string, string, string)

public static string FormatProjectLocationOrderHardwareGroup(string projectId, string locationId, string orderId, string hardwareGroupId)

Formats the IDs into the string representation of this HardwareGroupName with pattern projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}.

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.
`hardwareGroupId`	`string` The `HardwareGroup` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this HardwareGroupName with pattern `projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}`.

FromProjectLocationOrderHardwareGroup(string, string, string, string)

public static HardwareGroupName FromProjectLocationOrderHardwareGroup(string projectId, string locationId, string orderId, string hardwareGroupId)

Creates a HardwareGroupName with the pattern projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}.

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.
`hardwareGroupId`	`string` The `HardwareGroup` ID. Must not be `null` or empty.

Returns
Type	Description
`HardwareGroupName`	A new instance of HardwareGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static HardwareGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HardwareGroupName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`HardwareGroupName`	A new instance of HardwareGroupName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static HardwareGroupName Parse(string hardwareGroupName)

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

Parameter
Name	Description
`hardwareGroupName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`HardwareGroupName`	The parsed HardwareGroupName if successful.

Remarks

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

projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}

Parse(string, bool)

public static HardwareGroupName Parse(string hardwareGroupName, bool allowUnparsed)

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

Parameters
Name	Description
`hardwareGroupName`	`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
`HardwareGroupName`	The parsed HardwareGroupName if successful.

Remarks

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

projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}

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 HardwareGroupName)

public static bool TryParse(string hardwareGroupName, out HardwareGroupName result)

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

Parameters
Name	Description
`hardwareGroupName`	`string` The resource name in string form. Must not be `null`.
`result`	`HardwareGroupName` When this method returns, the parsed HardwareGroupName, 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}/hardwareGroups/{hardware_group}

TryParse(string, bool, out HardwareGroupName)

public static bool TryParse(string hardwareGroupName, bool allowUnparsed, out HardwareGroupName result)

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

Parameters
Name	Description
`hardwareGroupName`	`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`	`HardwareGroupName` When this method returns, the parsed HardwareGroupName, 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}/hardwareGroups/{hardware_group}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(HardwareGroupName, HardwareGroupName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`HardwareGroupName` The first resource name to compare, or null.
`b`	`HardwareGroupName` 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 !=(HardwareGroupName, HardwareGroupName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`HardwareGroupName` The first resource name to compare, or null.
`b`	`HardwareGroupName` 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.