Network Connectivity v1alpha1 API - Class InterconnectAttachmentName (2.0.0-alpha03)

public sealed class InterconnectAttachmentName : IResourceName, IEquatable<InterconnectAttachmentName>

Reference documentation and code samples for the Network Connectivity v1alpha1 API class InterconnectAttachmentName.

Resource name for the InterconnectAttachment resource.

Inheritance

object > InterconnectAttachmentName

Namespace

Google.Cloud.NetworkConnectivity.V1Alpha1

Assembly

Google.Cloud.NetworkConnectivity.V1Alpha1.dll

Constructors

InterconnectAttachmentName(string, string, string)

public InterconnectAttachmentName(string projectId, string regionId, string resourceId)

Constructs a new instance of a InterconnectAttachmentName class from the component parts of pattern projects/{project}/regions/{region}/interconnectAttachments/{resource_id}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

regionId string

The Region ID. Must not be null or empty.

resourceId string

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

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

RegionId

public string RegionId { get; }

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

Property Value
Type Description
string

ResourceId

public string ResourceId { get; }

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

Property Value
Type Description
string

Type

public InterconnectAttachmentName.ResourceNameType Type { get; }

The InterconnectAttachmentName.ResourceNameType of the contained resource name.

Property Value
Type Description
InterconnectAttachmentNameResourceNameType

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)

public static string Format(string projectId, string regionId, string resourceId)

Formats the IDs into the string representation of this InterconnectAttachmentName with pattern projects/{project}/regions/{region}/interconnectAttachments/{resource_id}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

regionId string

The Region ID. Must not be null or empty.

resourceId string

The Resource ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this InterconnectAttachmentName with pattern projects/{project}/regions/{region}/interconnectAttachments/{resource_id}.

FormatProjectRegionResource(string, string, string)

public static string FormatProjectRegionResource(string projectId, string regionId, string resourceId)

Formats the IDs into the string representation of this InterconnectAttachmentName with pattern projects/{project}/regions/{region}/interconnectAttachments/{resource_id}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

regionId string

The Region ID. Must not be null or empty.

resourceId string

The Resource ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this InterconnectAttachmentName with pattern projects/{project}/regions/{region}/interconnectAttachments/{resource_id}.

FromProjectRegionResource(string, string, string)

public static InterconnectAttachmentName FromProjectRegionResource(string projectId, string regionId, string resourceId)

Creates a InterconnectAttachmentName with the pattern projects/{project}/regions/{region}/interconnectAttachments/{resource_id}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

regionId string

The Region ID. Must not be null or empty.

resourceId string

The Resource ID. Must not be null or empty.

Returns
Type Description
InterconnectAttachmentName

A new instance of InterconnectAttachmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InterconnectAttachmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InterconnectAttachmentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
InterconnectAttachmentName

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

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

Parameter
Name Description
interconnectAttachmentName string

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

Returns
Type Description
InterconnectAttachmentName

The parsed InterconnectAttachmentName if successful.

Remarks

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

  • projects/{project}/regions/{region}/interconnectAttachments/{resource_id}

Parse(string, bool)

public static InterconnectAttachmentName Parse(string interconnectAttachmentName, bool allowUnparsed)

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

Parameters
Name Description
interconnectAttachmentName 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
InterconnectAttachmentName

The parsed InterconnectAttachmentName if successful.

Remarks

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

  • projects/{project}/regions/{region}/interconnectAttachments/{resource_id}
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 InterconnectAttachmentName)

public static bool TryParse(string interconnectAttachmentName, out InterconnectAttachmentName result)

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

Parameters
Name Description
interconnectAttachmentName string

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

result InterconnectAttachmentName

When this method returns, the parsed InterconnectAttachmentName, 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}/regions/{region}/interconnectAttachments/{resource_id}

TryParse(string, bool, out InterconnectAttachmentName)

public static bool TryParse(string interconnectAttachmentName, bool allowUnparsed, out InterconnectAttachmentName result)

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

Parameters
Name Description
interconnectAttachmentName 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 InterconnectAttachmentName

When this method returns, the parsed InterconnectAttachmentName, 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}/regions/{region}/interconnectAttachments/{resource_id}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(InterconnectAttachmentName, InterconnectAttachmentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a InterconnectAttachmentName

The first resource name to compare, or null.

b InterconnectAttachmentName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a InterconnectAttachmentName

The first resource name to compare, or null.

b InterconnectAttachmentName

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.