Bare Metal Solution v2 API - Class OsImageName (1.5.0) 

public sealed class OsImageName : IResourceName, IEquatable<OsImageName>

Reference documentation and code samples for the Bare Metal Solution v2 API class OsImageName.

Resource name for the OsImage resource.

Inheritance

object > OsImageName

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

OsImageName(string, string, string)

public OsImageName(string projectId, string locationId, string osImageId)

Constructs a new instance of a OsImageName class from the component parts of pattern projects/{project}/locations/{location}/osImages/{os_image}

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

The OsImage ID. Must not be null or empty.

Properties

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

OsImageId

public string OsImageId { get; }

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

The OsImageName.ResourceNameType of the contained resource name.

Property Value
Type Description
OsImageNameResourceNameType

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

Formats the IDs into the string representation of this OsImageName with pattern projects/{project}/locations/{location}/osImages/{os_image}.

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

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

The string representation of this OsImageName with pattern projects/{project}/locations/{location}/osImages/{os_image}.

FormatProjectLocationOsImage(string, string, string)

public static string FormatProjectLocationOsImage(string projectId, string locationId, string osImageId)

Formats the IDs into the string representation of this OsImageName with pattern projects/{project}/locations/{location}/osImages/{os_image}.

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

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

The string representation of this OsImageName with pattern projects/{project}/locations/{location}/osImages/{os_image}.

FromProjectLocationOsImage(string, string, string)

public static OsImageName FromProjectLocationOsImage(string projectId, string locationId, string osImageId)

Creates a OsImageName with the pattern projects/{project}/locations/{location}/osImages/{os_image}.

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

The OsImage ID. Must not be null or empty.
Returns
Type Description
OsImageName

A new instance of OsImageName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OsImageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OsImageName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
osImageName string

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

The parsed OsImageName if successful.
Remarks

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

  • projects/{project}/locations/{location}/osImages/{os_image}

Parse(string, bool)

public static OsImageName Parse(string osImageName, bool allowUnparsed)

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

Parameters
Name Description
osImageName 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
OsImageName

The parsed OsImageName if successful.
Remarks

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

  • projects/{project}/locations/{location}/osImages/{os_image}
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 OsImageName)

public static bool TryParse(string osImageName, out OsImageName result)

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

Parameters
Name Description
osImageName string

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

When this method returns, the parsed OsImageName, 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}/osImages/{os_image}

TryParse(string, bool, out OsImageName)

public static bool TryParse(string osImageName, bool allowUnparsed, out OsImageName result)

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

Parameters
Name Description
osImageName 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 OsImageName

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

Operators

operator ==(OsImageName, OsImageName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OsImageName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OsImageName

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

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.