VMware Engine v1 API - Class SubnetName (1.0.0-beta02)

public sealed class SubnetName : IResourceName, IEquatable<SubnetName>

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

Resource name for the Subnet resource.

Inheritance

Object > SubnetName

Implements

IResourceName, IEquatable<SubnetName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

SubnetName(String, String, String, String)

public SubnetName(string projectId, string locationId, string privateCloudId, string subnetId)

Constructs a new instance of a SubnetName class from the component parts of pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/subnets/{subnet}

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.
`privateCloudId`	`String` The `PrivateCloud` ID. Must not be `null` or empty.
`subnetId`	`String` The `Subnet` 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
`Boolean`

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`

PrivateCloudId

public string PrivateCloudId { get; }

The PrivateCloud 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`

SubnetId

public string SubnetId { get; }

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

Property Value
Type	Description
`String`

Type

public SubnetName.ResourceNameType Type { get; }

The SubnetName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SubnetName.ResourceNameType`

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, String)

public static string Format(string projectId, string locationId, string privateCloudId, string subnetId)

Formats the IDs into the string representation of this SubnetName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/subnets/{subnet}.

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.
`privateCloudId`	`String` The `PrivateCloud` ID. Must not be `null` or empty.
`subnetId`	`String` The `Subnet` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SubnetName with pattern `projects/{project}/locations/{location}/privateClouds/{private_cloud}/subnets/{subnet}`.

FormatProjectLocationPrivateCloudSubnet(String, String, String, String)

public static string FormatProjectLocationPrivateCloudSubnet(string projectId, string locationId, string privateCloudId, string subnetId)

Formats the IDs into the string representation of this SubnetName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/subnets/{subnet}.

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.
`privateCloudId`	`String` The `PrivateCloud` ID. Must not be `null` or empty.
`subnetId`	`String` The `Subnet` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SubnetName with pattern `projects/{project}/locations/{location}/privateClouds/{private_cloud}/subnets/{subnet}`.

FromProjectLocationPrivateCloudSubnet(String, String, String, String)

public static SubnetName FromProjectLocationPrivateCloudSubnet(string projectId, string locationId, string privateCloudId, string subnetId)

Creates a SubnetName with the pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/subnets/{subnet}.

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.
`privateCloudId`	`String` The `PrivateCloud` ID. Must not be `null` or empty.
`subnetId`	`String` The `Subnet` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static SubnetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SubnetName containing an unparsed resource name.

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

Returns
Type	Description
`SubnetName`	A new instance of SubnetName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static SubnetName Parse(string subnetName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/privateClouds/{private_cloud}/subnets/{subnet}

Parse(String, Boolean)

public static SubnetName Parse(string subnetName, bool allowUnparsed)

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

Parameters
Name	Description
`subnetName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`SubnetName`	The parsed SubnetName if successful.

Remarks

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

projects/{project}/locations/{location}/privateClouds/{private_cloud}/subnets/{subnet}

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

public static bool TryParse(string subnetName, out SubnetName result)

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

Parameters
Name	Description
`subnetName`	`String` The resource name in string form. Must not be `null`.
`result`	`SubnetName` When this method returns, the parsed SubnetName, or `null` if parsing failed.

Returns
Type	Description
`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}/privateClouds/{private_cloud}/subnets/{subnet}

TryParse(String, Boolean, out SubnetName)

public static bool TryParse(string subnetName, bool allowUnparsed, out SubnetName result)

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

Parameters
Name	Description
`subnetName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`SubnetName` When this method returns, the parsed SubnetName, or `null` if parsing failed.

Returns
Type	Description
`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}/privateClouds/{private_cloud}/subnets/{subnet}

Or may be in any format if allowUnparsed is true.

Operators

Equality(SubnetName, SubnetName)

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

Parameters
Name	Description
`a`	`SubnetName`
`b`	`SubnetName`

Returns
Type	Description
`Boolean`

Inequality(SubnetName, SubnetName)

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

Parameters
Name	Description
`a`	`SubnetName`
`b`	`SubnetName`

Returns
Type	Description
`Boolean`