Distributed Cloud Edge Network v1 API - Class SubnetName (1.3.0) 

public sealed class SubnetName : IResourceName, IEquatable<SubnetName>

Reference documentation and code samples for the Distributed Cloud Edge Network v1 API class SubnetName.

Resource name for the Subnet resource.

Inheritance

object > SubnetName

Namespace

Google.Cloud.EdgeNetwork.V1

Assembly

Google.Cloud.EdgeNetwork.V1.dll

Constructors

SubnetName(string, string, string, string)

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

Constructs a new instance of a SubnetName class from the component parts of pattern projects/{project}/locations/{location}/zones/{zone}/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.
zoneId string

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

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
SubnetNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

ZoneId

public string ZoneId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string)

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

Formats the IDs into the string representation of this SubnetName with pattern projects/{project}/locations/{location}/zones/{zone}/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.
zoneId string

The Zone 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}/zones/{zone}/subnets/{subnet}.

FormatProjectLocationZoneSubnet(string, string, string, string)

public static string FormatProjectLocationZoneSubnet(string projectId, string locationId, string zoneId, string subnetId)

Formats the IDs into the string representation of this SubnetName with pattern projects/{project}/locations/{location}/zones/{zone}/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.
zoneId string

The Zone 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}/zones/{zone}/subnets/{subnet}.

FromProjectLocationZoneSubnet(string, string, string, string)

public static SubnetName FromProjectLocationZoneSubnet(string projectId, string locationId, string zoneId, string subnetId)

Creates a SubnetName with the pattern projects/{project}/locations/{location}/zones/{zone}/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.
zoneId string

The Zone 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
int
Overrides

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}/zones/{zone}/subnets/{subnet}

Parse(string, bool)

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 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
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}/zones/{zone}/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

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
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}/zones/{zone}/subnets/{subnet}

TryParse(string, bool, 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 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 SubnetName

When this method returns, the parsed SubnetName, 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}/zones/{zone}/subnets/{subnet}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SubnetName, SubnetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SubnetName

The first resource name to compare, or null.
b SubnetName

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 !=(SubnetName, SubnetName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SubnetName

The first resource name to compare, or null.
b SubnetName

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.