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

public sealed class InterconnectName : IResourceName, IEquatable<InterconnectName>

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

Resource name for the Interconnect resource.

Inheritance

object > InterconnectName

Implements

IResourceName, IEquatable InterconnectName

Inherited Members

object.GetType()

Namespace

Google.Cloud.EdgeNetwork.V1

Assembly

Google.Cloud.EdgeNetwork.V1.dll

Constructors

InterconnectName(string, string, string, string)

public InterconnectName(string projectId, string locationId, string zoneId, string interconnectId)

Constructs a new instance of a InterconnectName class from the component parts of pattern projects/{project}/locations/{location}/zones/{zone}/interconnects/{interconnect}

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

Properties

InterconnectId

public string InterconnectId { get; }

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

Property Value
Type	Description
`string`

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 InterconnectName.ResourceNameType Type { get; }

The InterconnectName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`InterconnectNameResourceNameType`

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

Formats the IDs into the string representation of this InterconnectName with pattern projects/{project}/locations/{location}/zones/{zone}/interconnects/{interconnect}.

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

Returns
Type	Description
`string`	The string representation of this InterconnectName with pattern `projects/{project}/locations/{location}/zones/{zone}/interconnects/{interconnect}`.

FormatProjectLocationZoneInterconnect(string, string, string, string)

public static string FormatProjectLocationZoneInterconnect(string projectId, string locationId, string zoneId, string interconnectId)

Formats the IDs into the string representation of this InterconnectName with pattern projects/{project}/locations/{location}/zones/{zone}/interconnects/{interconnect}.

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

Returns
Type	Description
`string`	The string representation of this InterconnectName with pattern `projects/{project}/locations/{location}/zones/{zone}/interconnects/{interconnect}`.

FromProjectLocationZoneInterconnect(string, string, string, string)

public static InterconnectName FromProjectLocationZoneInterconnect(string projectId, string locationId, string zoneId, string interconnectId)

Creates a InterconnectName with the pattern projects/{project}/locations/{location}/zones/{zone}/interconnects/{interconnect}.

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

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

FromUnparsed(UnparsedResourceName)

public static InterconnectName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InterconnectName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/zones/{zone}/interconnects/{interconnect}

Parse(string, bool)

public static InterconnectName Parse(string interconnectName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/zones/{zone}/interconnects/{interconnect}

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

public static bool TryParse(string interconnectName, out InterconnectName result)

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

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

TryParse(string, bool, out InterconnectName)

public static bool TryParse(string interconnectName, bool allowUnparsed, out InterconnectName result)

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

Parameters
Name	Description
`interconnectName`	`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`	`InterconnectName` When this method returns, the parsed InterconnectName, 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}/interconnects/{interconnect}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(InterconnectName, InterconnectName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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