VMware Engine v1 API - Class NetworkPolicyName (1.0.0)

public sealed class NetworkPolicyName : IResourceName, IEquatable<NetworkPolicyName>

Reference documentation and code samples for the VMware Engine v1 API class NetworkPolicyName.

Resource name for the NetworkPolicy resource.

Inheritance

object > NetworkPolicyName

Implements

IResourceName, IEquatable NetworkPolicyName

Inherited Members

object.GetType()

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

NetworkPolicyName(string, string, string)

public NetworkPolicyName(string projectId, string locationId, string networkPolicyId)

Constructs a new instance of a NetworkPolicyName class from the component parts of pattern projects/{project}/locations/{location}/networkPolicies/{network_policy}

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.
`networkPolicyId`	`string` The `NetworkPolicy` 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`

NetworkPolicyId

public string NetworkPolicyId { get; }

The NetworkPolicy 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 NetworkPolicyName.ResourceNameType Type { get; }

The NetworkPolicyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`NetworkPolicyNameResourceNameType`

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 locationId, string networkPolicyId)

Formats the IDs into the string representation of this NetworkPolicyName with pattern projects/{project}/locations/{location}/networkPolicies/{network_policy}.

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

Returns
Type	Description
`string`	The string representation of this NetworkPolicyName with pattern `projects/{project}/locations/{location}/networkPolicies/{network_policy}`.

FormatProjectLocationNetworkPolicy(string, string, string)

public static string FormatProjectLocationNetworkPolicy(string projectId, string locationId, string networkPolicyId)

Formats the IDs into the string representation of this NetworkPolicyName with pattern projects/{project}/locations/{location}/networkPolicies/{network_policy}.

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

Returns
Type	Description
`string`	The string representation of this NetworkPolicyName with pattern `projects/{project}/locations/{location}/networkPolicies/{network_policy}`.

FromProjectLocationNetworkPolicy(string, string, string)

public static NetworkPolicyName FromProjectLocationNetworkPolicy(string projectId, string locationId, string networkPolicyId)

Creates a NetworkPolicyName with the pattern projects/{project}/locations/{location}/networkPolicies/{network_policy}.

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

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

FromUnparsed(UnparsedResourceName)

public static NetworkPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NetworkPolicyName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/networkPolicies/{network_policy}

Parse(string, bool)

public static NetworkPolicyName Parse(string networkPolicyName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/networkPolicies/{network_policy}

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

public static bool TryParse(string networkPolicyName, out NetworkPolicyName result)

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

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

TryParse(string, bool, out NetworkPolicyName)

public static bool TryParse(string networkPolicyName, bool allowUnparsed, out NetworkPolicyName result)

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

Parameters
Name	Description
`networkPolicyName`	`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`	`NetworkPolicyName` When this method returns, the parsed NetworkPolicyName, 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}/networkPolicies/{network_policy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NetworkPolicyName, NetworkPolicyName)

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

Parameters
Name	Description
`a`	`NetworkPolicyName`
`b`	`NetworkPolicyName`

Returns
Type	Description
`bool`

operator !=(NetworkPolicyName, NetworkPolicyName)

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

Parameters
Name	Description
`a`	`NetworkPolicyName`
`b`	`NetworkPolicyName`

Returns
Type	Description
`bool`