Bare Metal Solution v2 API - Class ServerNetworkTemplateName (1.0.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

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

serverNetworkTemplateIdString

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

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

ServerNetworkTemplateId

public string ServerNetworkTemplateId { get; }

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

Property Value
TypeDescription
String

Type

public ServerNetworkTemplateName.ResourceNameType Type { get; }

The ServerNetworkTemplateName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ServerNetworkTemplateName.ResourceNameType

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

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

serverNetworkTemplateIdString

The ServerNetworkTemplate ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

serverNetworkTemplateIdString

The ServerNetworkTemplate ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

serverNetworkTemplateIdString

The ServerNetworkTemplate ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ServerNetworkTemplateName

A new instance of ServerNetworkTemplateName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ServerNetworkTemplateName Parse(string serverNetworkTemplateName)

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

Parameter
NameDescription
serverNetworkTemplateNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
serverNetworkTemplateNameString

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

allowUnparsedBoolean

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

The string representation of the resource name.

Overrides

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
NameDescription
serverNetworkTemplateNameString

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

resultServerNetworkTemplateName

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

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
serverNetworkTemplateNameString

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

allowUnparsedBoolean

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.

resultServerNetworkTemplateName

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

Returns
TypeDescription
Boolean

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

Equality(ServerNetworkTemplateName, ServerNetworkTemplateName)

public static bool operator ==(ServerNetworkTemplateName a, ServerNetworkTemplateName b)
Parameters
NameDescription
aServerNetworkTemplateName
bServerNetworkTemplateName
Returns
TypeDescription
Boolean

Inequality(ServerNetworkTemplateName, ServerNetworkTemplateName)

public static bool operator !=(ServerNetworkTemplateName a, ServerNetworkTemplateName b)
Parameters
NameDescription
aServerNetworkTemplateName
bServerNetworkTemplateName
Returns
TypeDescription
Boolean