Google Cloud OS Config v1 API - Class InventoryName (2.4.0)

public sealed class InventoryName : IResourceName, IEquatable<InventoryName>

Reference documentation and code samples for the Google Cloud OS Config v1 API class InventoryName.

Resource name for the Inventory resource.

Inheritance

object > InventoryName

Implements

IResourceName, IEquatable InventoryName

Inherited Members

object.GetType()

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

The InventoryName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`InventoryNameResourceNameType`

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
`int`

Overrides

object.GetHashCode()

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, bool)

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`	`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
`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

object.ToString()

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
`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}/instances/{instance}/inventory

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(InventoryName, InventoryName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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