Bare Metal Solution v2 API - Class VolumeConfigName (1.2.0)

public sealed class VolumeConfigName : IResourceName, IEquatable<VolumeConfigName>

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

Resource name for the VolumeConfig resource.

Inheritance

object > VolumeConfigName

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

VolumeConfigName(string, string, string)

public VolumeConfigName(string projectId, string locationId, string volumeConfigId)

Constructs a new instance of a VolumeConfigName class from the component parts of pattern projects/{project}/locations/{location}/volumeConfigs/{volume_config}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

volumeConfigIdstring

The VolumeConfig 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
TypeDescription
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Type

public VolumeConfigName.ResourceNameType Type { get; }

The VolumeConfigName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
VolumeConfigNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

VolumeConfigId

public string VolumeConfigId { get; }

The VolumeConfig ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this VolumeConfigName with pattern projects/{project}/locations/{location}/volumeConfigs/{volume_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

volumeConfigIdstring

The VolumeConfig ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this VolumeConfigName with pattern projects/{project}/locations/{location}/volumeConfigs/{volume_config}.

FormatProjectLocationVolumeConfig(string, string, string)

public static string FormatProjectLocationVolumeConfig(string projectId, string locationId, string volumeConfigId)

Formats the IDs into the string representation of this VolumeConfigName with pattern projects/{project}/locations/{location}/volumeConfigs/{volume_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

volumeConfigIdstring

The VolumeConfig ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this VolumeConfigName with pattern projects/{project}/locations/{location}/volumeConfigs/{volume_config}.

FromProjectLocationVolumeConfig(string, string, string)

public static VolumeConfigName FromProjectLocationVolumeConfig(string projectId, string locationId, string volumeConfigId)

Creates a VolumeConfigName with the pattern projects/{project}/locations/{location}/volumeConfigs/{volume_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

volumeConfigIdstring

The VolumeConfig ID. Must not be null or empty.

Returns
TypeDescription
VolumeConfigName

A new instance of VolumeConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VolumeConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VolumeConfigName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
VolumeConfigName

A new instance of VolumeConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static VolumeConfigName Parse(string volumeConfigName)

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

Parameter
NameDescription
volumeConfigNamestring

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

Returns
TypeDescription
VolumeConfigName

The parsed VolumeConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/volumeConfigs/{volume_config}

Parse(string, bool)

public static VolumeConfigName Parse(string volumeConfigName, bool allowUnparsed)

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

Parameters
NameDescription
volumeConfigNamestring

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

allowUnparsedbool

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
TypeDescription
VolumeConfigName

The parsed VolumeConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/volumeConfigs/{volume_config}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out VolumeConfigName)

public static bool TryParse(string volumeConfigName, out VolumeConfigName result)

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

Parameters
NameDescription
volumeConfigNamestring

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

resultVolumeConfigName

When this method returns, the parsed VolumeConfigName, or null if parsing failed.

Returns
TypeDescription
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}/volumeConfigs/{volume_config}

TryParse(string, bool, out VolumeConfigName)

public static bool TryParse(string volumeConfigName, bool allowUnparsed, out VolumeConfigName result)

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

Parameters
NameDescription
volumeConfigNamestring

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

allowUnparsedbool

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.

resultVolumeConfigName

When this method returns, the parsed VolumeConfigName, or null if parsing failed.

Returns
TypeDescription
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}/volumeConfigs/{volume_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(VolumeConfigName, VolumeConfigName)

public static bool operator ==(VolumeConfigName a, VolumeConfigName b)
Parameters
NameDescription
aVolumeConfigName
bVolumeConfigName
Returns
TypeDescription
bool

operator !=(VolumeConfigName, VolumeConfigName)

public static bool operator !=(VolumeConfigName a, VolumeConfigName b)
Parameters
NameDescription
aVolumeConfigName
bVolumeConfigName
Returns
TypeDescription
bool