Cloud AI Platform v1 API - Class NetworkAttachmentName (3.6.0) 

public sealed class NetworkAttachmentName : IResourceName, IEquatable<NetworkAttachmentName>

Reference documentation and code samples for the Cloud AI Platform v1 API class NetworkAttachmentName.

Resource name for the NetworkAttachment resource.

Inheritance

object > NetworkAttachmentName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

NetworkAttachmentName(string, string, string)

public NetworkAttachmentName(string projectId, string regionId, string networkattachmentId)

Constructs a new instance of a NetworkAttachmentName class from the component parts of pattern projects/{project}/regions/{region}/networkAttachments/{networkattachment}

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.
networkattachmentId string

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

NetworkattachmentId

public string NetworkattachmentId { get; }

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

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

Type

public NetworkAttachmentName.ResourceNameType Type { get; }

The NetworkAttachmentName.ResourceNameType of the contained resource name.

Property Value
Type Description
NetworkAttachmentNameResourceNameType

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

Formats the IDs into the string representation of this NetworkAttachmentName with pattern projects/{project}/regions/{region}/networkAttachments/{networkattachment}.

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.
networkattachmentId string

The Networkattachment ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this NetworkAttachmentName with pattern projects/{project}/regions/{region}/networkAttachments/{networkattachment}.

FormatProjectRegionNetworkattachment(string, string, string)

public static string FormatProjectRegionNetworkattachment(string projectId, string regionId, string networkattachmentId)

Formats the IDs into the string representation of this NetworkAttachmentName with pattern projects/{project}/regions/{region}/networkAttachments/{networkattachment}.

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.
networkattachmentId string

The Networkattachment ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this NetworkAttachmentName with pattern projects/{project}/regions/{region}/networkAttachments/{networkattachment}.

FromProjectRegionNetworkattachment(string, string, string)

public static NetworkAttachmentName FromProjectRegionNetworkattachment(string projectId, string regionId, string networkattachmentId)

Creates a NetworkAttachmentName with the pattern projects/{project}/regions/{region}/networkAttachments/{networkattachment}.

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.
networkattachmentId string

The Networkattachment ID. Must not be null or empty.
Returns
Type Description
NetworkAttachmentName

A new instance of NetworkAttachmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NetworkAttachmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NetworkAttachmentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
NetworkAttachmentName

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

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

Parameter
Name Description
networkAttachmentName string

The resource name in string form. Must not be null.
Returns
Type Description
NetworkAttachmentName

The parsed NetworkAttachmentName if successful.
Remarks

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

  • projects/{project}/regions/{region}/networkAttachments/{networkattachment}

Parse(string, bool)

public static NetworkAttachmentName Parse(string networkAttachmentName, bool allowUnparsed)

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

Parameters
Name Description
networkAttachmentName 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
NetworkAttachmentName

The parsed NetworkAttachmentName if successful.
Remarks

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

  • projects/{project}/regions/{region}/networkAttachments/{networkattachment}
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 NetworkAttachmentName)

public static bool TryParse(string networkAttachmentName, out NetworkAttachmentName result)

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

Parameters
Name Description
networkAttachmentName string

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

When this method returns, the parsed NetworkAttachmentName, 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}/networkAttachments/{networkattachment}

TryParse(string, bool, out NetworkAttachmentName)

public static bool TryParse(string networkAttachmentName, bool allowUnparsed, out NetworkAttachmentName result)

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

Parameters
Name Description
networkAttachmentName 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 NetworkAttachmentName

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

Operators

operator ==(NetworkAttachmentName, NetworkAttachmentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a NetworkAttachmentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a NetworkAttachmentName

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

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.