Bare Metal Solution v2 API - Class ServerNetworkTemplateName (1.7.0)

public sealed class ServerNetworkTemplateName : IResourceName, IEquatable<ServerNetworkTemplateName>

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

Resource name for the ServerNetworkTemplate resource.

Inheritance

object > ServerNetworkTemplateName

Implements

IResourceName, IEquatable ServerNetworkTemplateName

Inherited Members

object.GetType()

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

ServerNetworkTemplateName(string, string, string)

public ServerNetworkTemplateName(string projectId, string locationId, string serverNetworkTemplateId)

Constructs a new instance of a ServerNetworkTemplateName class from the component parts of pattern projects/{project}/locations/{location}/serverNetworkTemplate/{server_network_template}

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.
`serverNetworkTemplateId`	`string` The `ServerNetworkTemplate` 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`

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`

ServerNetworkTemplateId

public string ServerNetworkTemplateId { get; }

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

Property Value
Type	Description
`string`

Type

public ServerNetworkTemplateName.ResourceNameType Type { get; }

The ServerNetworkTemplateName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ServerNetworkTemplateNameResourceNameType`

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

Formats the IDs into the string representation of this ServerNetworkTemplateName with pattern projects/{project}/locations/{location}/serverNetworkTemplate/{server_network_template}.

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.
`serverNetworkTemplateId`	`string` The `ServerNetworkTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ServerNetworkTemplateName with pattern `projects/{project}/locations/{location}/serverNetworkTemplate/{server_network_template}`.

FormatProjectLocationServerNetworkTemplate(string, string, string)

public static string FormatProjectLocationServerNetworkTemplate(string projectId, string locationId, string serverNetworkTemplateId)

Formats the IDs into the string representation of this ServerNetworkTemplateName with pattern projects/{project}/locations/{location}/serverNetworkTemplate/{server_network_template}.

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.
`serverNetworkTemplateId`	`string` The `ServerNetworkTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ServerNetworkTemplateName with pattern `projects/{project}/locations/{location}/serverNetworkTemplate/{server_network_template}`.

FromProjectLocationServerNetworkTemplate(string, string, string)

public static ServerNetworkTemplateName FromProjectLocationServerNetworkTemplate(string projectId, string locationId, string serverNetworkTemplateId)

Creates a ServerNetworkTemplateName with the pattern projects/{project}/locations/{location}/serverNetworkTemplate/{server_network_template}.

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.
`serverNetworkTemplateId`	`string` The `ServerNetworkTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`ServerNetworkTemplateName`	A new instance of ServerNetworkTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServerNetworkTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServerNetworkTemplateName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`ServerNetworkTemplateName`	A new instance of ServerNetworkTemplateName 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 ServerNetworkTemplateName Parse(string serverNetworkTemplateName)

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

Parameter
Name	Description
`serverNetworkTemplateName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`ServerNetworkTemplateName`	The parsed ServerNetworkTemplateName if successful.

Remarks

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

projects/{project}/locations/{location}/serverNetworkTemplate/{server_network_template}

Parse(string, bool)

public static ServerNetworkTemplateName Parse(string serverNetworkTemplateName, bool allowUnparsed)

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

Parameters
Name	Description
`serverNetworkTemplateName`	`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
`ServerNetworkTemplateName`	The parsed ServerNetworkTemplateName if successful.

Remarks

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

projects/{project}/locations/{location}/serverNetworkTemplate/{server_network_template}

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

public static bool TryParse(string serverNetworkTemplateName, out ServerNetworkTemplateName result)

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

Parameters
Name	Description
`serverNetworkTemplateName`	`string` The resource name in string form. Must not be `null`.
`result`	`ServerNetworkTemplateName` When this method returns, the parsed ServerNetworkTemplateName, 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}/serverNetworkTemplate/{server_network_template}

TryParse(string, bool, out ServerNetworkTemplateName)

public static bool TryParse(string serverNetworkTemplateName, bool allowUnparsed, out ServerNetworkTemplateName result)

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

Parameters
Name	Description
`serverNetworkTemplateName`	`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`	`ServerNetworkTemplateName` When this method returns, the parsed ServerNetworkTemplateName, 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}/serverNetworkTemplate/{server_network_template}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ServerNetworkTemplateName, ServerNetworkTemplateName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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