VMware Engine v1 API - Class VmwareEngineNetworkName (1.0.0)

public sealed class VmwareEngineNetworkName : IResourceName, IEquatable<VmwareEngineNetworkName>

Reference documentation and code samples for the VMware Engine v1 API class VmwareEngineNetworkName.

Resource name for the VmwareEngineNetwork resource.

Inheritance

object > VmwareEngineNetworkName

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

VmwareEngineNetworkName(string, string, string)

public VmwareEngineNetworkName(string projectId, string locationId, string vmwareEngineNetworkId)

Constructs a new instance of a VmwareEngineNetworkName class from the component parts of pattern projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}

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.

vmwareEngineNetworkId string

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

Type

public VmwareEngineNetworkName.ResourceNameType Type { get; }

The VmwareEngineNetworkName.ResourceNameType of the contained resource name.

Property Value
Type Description
VmwareEngineNetworkNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

VmwareEngineNetworkId

public string VmwareEngineNetworkId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this VmwareEngineNetworkName with pattern projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}.

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.

vmwareEngineNetworkId string

The VmwareEngineNetwork ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this VmwareEngineNetworkName with pattern projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}.

FormatProjectLocationVmwareEngineNetwork(string, string, string)

public static string FormatProjectLocationVmwareEngineNetwork(string projectId, string locationId, string vmwareEngineNetworkId)

Formats the IDs into the string representation of this VmwareEngineNetworkName with pattern projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}.

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.

vmwareEngineNetworkId string

The VmwareEngineNetwork ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this VmwareEngineNetworkName with pattern projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}.

FromProjectLocationVmwareEngineNetwork(string, string, string)

public static VmwareEngineNetworkName FromProjectLocationVmwareEngineNetwork(string projectId, string locationId, string vmwareEngineNetworkId)

Creates a VmwareEngineNetworkName with the pattern projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}.

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.

vmwareEngineNetworkId string

The VmwareEngineNetwork ID. Must not be null or empty.

Returns
Type Description
VmwareEngineNetworkName

A new instance of VmwareEngineNetworkName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VmwareEngineNetworkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VmwareEngineNetworkName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
VmwareEngineNetworkName

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

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

Parameter
Name Description
vmwareEngineNetworkName string

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

Returns
Type Description
VmwareEngineNetworkName

The parsed VmwareEngineNetworkName if successful.

Remarks

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

  • projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}

Parse(string, bool)

public static VmwareEngineNetworkName Parse(string vmwareEngineNetworkName, bool allowUnparsed)

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

Parameters
Name Description
vmwareEngineNetworkName 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
VmwareEngineNetworkName

The parsed VmwareEngineNetworkName if successful.

Remarks

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

  • projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}
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 VmwareEngineNetworkName)

public static bool TryParse(string vmwareEngineNetworkName, out VmwareEngineNetworkName result)

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

Parameters
Name Description
vmwareEngineNetworkName string

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

result VmwareEngineNetworkName

When this method returns, the parsed VmwareEngineNetworkName, 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}/vmwareEngineNetworks/{vmware_engine_network}

TryParse(string, bool, out VmwareEngineNetworkName)

public static bool TryParse(string vmwareEngineNetworkName, bool allowUnparsed, out VmwareEngineNetworkName result)

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

Parameters
Name Description
vmwareEngineNetworkName 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 VmwareEngineNetworkName

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

Operators

operator ==(VmwareEngineNetworkName, VmwareEngineNetworkName)

public static bool operator ==(VmwareEngineNetworkName a, VmwareEngineNetworkName b)
Parameters
Name Description
a VmwareEngineNetworkName
b VmwareEngineNetworkName
Returns
Type Description
bool

operator !=(VmwareEngineNetworkName, VmwareEngineNetworkName)

public static bool operator !=(VmwareEngineNetworkName a, VmwareEngineNetworkName b)
Parameters
Name Description
a VmwareEngineNetworkName
b VmwareEngineNetworkName
Returns
Type Description
bool