Bare Metal Solution v2 API - Class ProvisioningConfigName (1.4.0)

public sealed class ProvisioningConfigName : IResourceName, IEquatable<ProvisioningConfigName>

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

Resource name for the ProvisioningConfig resource.

Inheritance

object > ProvisioningConfigName

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

ProvisioningConfigName(string, string, string)

public ProvisioningConfigName(string projectId, string locationId, string provisioningConfigId)

Constructs a new instance of a ProvisioningConfigName class from the component parts of pattern projects/{project}/locations/{location}/provisioningConfigs/{provisioning_config}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

provisioningConfigIdstring

The ProvisioningConfig 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

ProvisioningConfigId

public string ProvisioningConfigId { get; }

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

Property Value
TypeDescription
string

Type

public ProvisioningConfigName.ResourceNameType Type { get; }

The ProvisioningConfigName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ProvisioningConfigNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this ProvisioningConfigName with pattern projects/{project}/locations/{location}/provisioningConfigs/{provisioning_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

provisioningConfigIdstring

The ProvisioningConfig ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ProvisioningConfigName with pattern projects/{project}/locations/{location}/provisioningConfigs/{provisioning_config}.

FormatProjectLocationProvisioningConfig(string, string, string)

public static string FormatProjectLocationProvisioningConfig(string projectId, string locationId, string provisioningConfigId)

Formats the IDs into the string representation of this ProvisioningConfigName with pattern projects/{project}/locations/{location}/provisioningConfigs/{provisioning_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

provisioningConfigIdstring

The ProvisioningConfig ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ProvisioningConfigName with pattern projects/{project}/locations/{location}/provisioningConfigs/{provisioning_config}.

FromProjectLocationProvisioningConfig(string, string, string)

public static ProvisioningConfigName FromProjectLocationProvisioningConfig(string projectId, string locationId, string provisioningConfigId)

Creates a ProvisioningConfigName with the pattern projects/{project}/locations/{location}/provisioningConfigs/{provisioning_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

provisioningConfigIdstring

The ProvisioningConfig ID. Must not be null or empty.

Returns
TypeDescription
ProvisioningConfigName

A new instance of ProvisioningConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProvisioningConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProvisioningConfigName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ProvisioningConfigName

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

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

Parameter
NameDescription
provisioningConfigNamestring

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

Returns
TypeDescription
ProvisioningConfigName

The parsed ProvisioningConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/provisioningConfigs/{provisioning_config}

Parse(string, bool)

public static ProvisioningConfigName Parse(string provisioningConfigName, bool allowUnparsed)

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

Parameters
NameDescription
provisioningConfigNamestring

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
ProvisioningConfigName

The parsed ProvisioningConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/provisioningConfigs/{provisioning_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 ProvisioningConfigName)

public static bool TryParse(string provisioningConfigName, out ProvisioningConfigName result)

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

Parameters
NameDescription
provisioningConfigNamestring

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

resultProvisioningConfigName

When this method returns, the parsed ProvisioningConfigName, 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}/provisioningConfigs/{provisioning_config}

TryParse(string, bool, out ProvisioningConfigName)

public static bool TryParse(string provisioningConfigName, bool allowUnparsed, out ProvisioningConfigName result)

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

Parameters
NameDescription
provisioningConfigNamestring

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.

resultProvisioningConfigName

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

Operators

operator ==(ProvisioningConfigName, ProvisioningConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aProvisioningConfigName

The first resource name to compare, or null.

bProvisioningConfigName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ProvisioningConfigName, ProvisioningConfigName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aProvisioningConfigName

The first resource name to compare, or null.

bProvisioningConfigName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.