Class InventoryName (2.0.0) 

public sealed class InventoryName : IResourceName, IEquatable<InventoryName>

Resource name for the Inventory resource.

Inheritance

Object > InventoryName

Implements

IResourceName, System.IEquatable<InventoryName>

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Constructors

InventoryName(String, String, String)

public InventoryName(string projectId, string locationId, string instanceId)

Constructs a new instance of a InventoryName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/inventory

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.
instanceId String

The Instance ID. Must not be null or empty.

Properties

InstanceId

public string InstanceId { get; }

The Instance 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
Boolean

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

The InventoryName.ResourceNameType of the contained resource name.

Property Value
Type Description
InventoryName.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)

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

Formats the IDs into the string representation of this InventoryName with pattern projects/{project}/locations/{location}/instances/{instance}/inventory.

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.
instanceId String

The Instance ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this InventoryName with pattern projects/{project}/locations/{location}/instances/{instance}/inventory.

FormatProjectLocationInstance(String, String, String)

public static string FormatProjectLocationInstance(string projectId, string locationId, string instanceId)

Formats the IDs into the string representation of this InventoryName with pattern projects/{project}/locations/{location}/instances/{instance}/inventory.

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.
instanceId String

The Instance ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this InventoryName with pattern projects/{project}/locations/{location}/instances/{instance}/inventory.

FromProjectLocationInstance(String, String, String)

public static InventoryName FromProjectLocationInstance(string projectId, string locationId, string instanceId)

Creates a InventoryName with the pattern projects/{project}/locations/{location}/instances/{instance}/inventory.

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.
instanceId String

The Instance ID. Must not be null or empty.
Returns
Type Description
InventoryName

A new instance of InventoryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InventoryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InventoryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of InventoryName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static InventoryName Parse(string inventoryName)

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

Parameter
Name Description
inventoryName String

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

The parsed InventoryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/inventory

Parse(String, Boolean)

public static InventoryName Parse(string inventoryName, bool allowUnparsed)

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

Parameters
Name Description
inventoryName 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
InventoryName

The parsed InventoryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/inventory
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 InventoryName)

public static bool TryParse(string inventoryName, out InventoryName result)

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

Parameters
Name Description
inventoryName String

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

When this method returns, the parsed InventoryName, 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}/instances/{instance}/inventory

TryParse(String, Boolean, out InventoryName)

public static bool TryParse(string inventoryName, bool allowUnparsed, out InventoryName result)

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

Parameters
Name Description
inventoryName 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 InventoryName

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

Operators

Equality(InventoryName, InventoryName)

public static bool operator ==(InventoryName a, InventoryName b)
Parameters
Name Description
a InventoryName
b InventoryName
Returns
Type Description
Boolean

Inequality(InventoryName, InventoryName)

public static bool operator !=(InventoryName a, InventoryName b)
Parameters
Name Description
a InventoryName
b InventoryName
Returns
Type Description
Boolean