Cloud AI Platform v1 API - Class SubnetworkName (3.11.0)

public sealed class SubnetworkName : IResourceName, IEquatable<SubnetworkName>

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

Resource name for the Subnetwork resource.

Inheritance

object > SubnetworkName

Implements

IResourceName, IEquatable SubnetworkName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

SubnetworkName(string, string, string)

public SubnetworkName(string projectId, string regionId, string subnetworkId)

Constructs a new instance of a SubnetworkName class from the component parts of pattern projects/{project}/regions/{region}/subnetworks/{subnetwork}

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.
`subnetworkId`	`string` The `Subnetwork` 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`

SubnetworkId

public string SubnetworkId { get; }

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

Property Value
Type	Description
`string`

Type

public SubnetworkName.ResourceNameType Type { get; }

The SubnetworkName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SubnetworkNameResourceNameType`

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

Formats the IDs into the string representation of this SubnetworkName with pattern projects/{project}/regions/{region}/subnetworks/{subnetwork}.

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

Returns
Type	Description
`string`	The string representation of this SubnetworkName with pattern `projects/{project}/regions/{region}/subnetworks/{subnetwork}`.

FormatProjectRegionSubnetwork(string, string, string)

public static string FormatProjectRegionSubnetwork(string projectId, string regionId, string subnetworkId)

Formats the IDs into the string representation of this SubnetworkName with pattern projects/{project}/regions/{region}/subnetworks/{subnetwork}.

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

Returns
Type	Description
`string`	The string representation of this SubnetworkName with pattern `projects/{project}/regions/{region}/subnetworks/{subnetwork}`.

FromProjectRegionSubnetwork(string, string, string)

public static SubnetworkName FromProjectRegionSubnetwork(string projectId, string regionId, string subnetworkId)

Creates a SubnetworkName with the pattern projects/{project}/regions/{region}/subnetworks/{subnetwork}.

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

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

FromUnparsed(UnparsedResourceName)

public static SubnetworkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SubnetworkName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/regions/{region}/subnetworks/{subnetwork}

Parse(string, bool)

public static SubnetworkName Parse(string subnetworkName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/regions/{region}/subnetworks/{subnetwork}

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

public static bool TryParse(string subnetworkName, out SubnetworkName result)

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

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

TryParse(string, bool, out SubnetworkName)

public static bool TryParse(string subnetworkName, bool allowUnparsed, out SubnetworkName result)

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

Parameters
Name	Description
`subnetworkName`	`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`	`SubnetworkName` When this method returns, the parsed SubnetworkName, 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}/subnetworks/{subnetwork}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SubnetworkName, SubnetworkName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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