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.
Namespace
Google.Cloud.OsConfig.V1Assembly
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 |
locationId | String The |
instanceId | String The |
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 |
locationId | String The |
instanceId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this InventoryName with pattern
|
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 |
locationId | String The |
instanceId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this InventoryName with pattern
|
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 |
locationId | String The |
instanceId | String The |
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 |
Returns | |
---|---|
Type | Description |
InventoryName | A new instance of InventoryName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
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 |
Returns | |
---|---|
Type | Description |
InventoryName | The parsed InventoryName if successful. |
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 |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
InventoryName | The parsed InventoryName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/instances/{instance}/inventory
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. |
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 |
result | InventoryName When this method returns, the parsed InventoryName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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 |
allowUnparsed | Boolean If |
result | InventoryName When this method returns, the parsed InventoryName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/instances/{instance}/inventory
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 |