VMware Engine v1 API - Class ExternalAccessRuleName (1.6.0) 

public sealed class ExternalAccessRuleName : IResourceName, IEquatable<ExternalAccessRuleName>

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

Resource name for the ExternalAccessRule resource.

Inheritance

object > ExternalAccessRuleName

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

ExternalAccessRuleName(string, string, string, string)

public ExternalAccessRuleName(string projectId, string locationId, string networkPolicyId, string externalAccessRuleId)

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

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

The ExternalAccessRule ID. Must not be null or empty.

Properties

ExternalAccessRuleId

public string ExternalAccessRuleId { get; }

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

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

The ExternalAccessRuleName.ResourceNameType of the contained resource name.

Property Value
Type Description
ExternalAccessRuleNameResourceNameType

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

public static string Format(string projectId, string locationId, string networkPolicyId, string externalAccessRuleId)

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

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

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

The string representation of this ExternalAccessRuleName with pattern projects/{project}/locations/{location}/networkPolicies/{network_policy}/externalAccessRules/{external_access_rule} .

FormatProjectLocationNetworkPolicyExternalAccessRule(string, string, string, string)

public static string FormatProjectLocationNetworkPolicyExternalAccessRule(string projectId, string locationId, string networkPolicyId, string externalAccessRuleId)

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

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

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

The string representation of this ExternalAccessRuleName with pattern projects/{project}/locations/{location}/networkPolicies/{network_policy}/externalAccessRules/{external_access_rule} .

FromProjectLocationNetworkPolicyExternalAccessRule(string, string, string, string)

public static ExternalAccessRuleName FromProjectLocationNetworkPolicyExternalAccessRule(string projectId, string locationId, string networkPolicyId, string externalAccessRuleId)

Creates a ExternalAccessRuleName with the pattern projects/{project}/locations/{location}/networkPolicies/{network_policy}/externalAccessRules/{external_access_rule} .

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

The ExternalAccessRule ID. Must not be null or empty.
Returns
Type Description
ExternalAccessRuleName

A new instance of ExternalAccessRuleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ExternalAccessRuleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ExternalAccessRuleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
externalAccessRuleName string

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

The parsed ExternalAccessRuleName if successful.
Remarks

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

  • projects/{project}/locations/{location}/networkPolicies/{network_policy}/externalAccessRules/{external_access_rule}

Parse(string, bool)

public static ExternalAccessRuleName Parse(string externalAccessRuleName, bool allowUnparsed)

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

Parameters
Name Description
externalAccessRuleName 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
ExternalAccessRuleName

The parsed ExternalAccessRuleName if successful.
Remarks

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

  • projects/{project}/locations/{location}/networkPolicies/{network_policy}/externalAccessRules/{external_access_rule}
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 ExternalAccessRuleName)

public static bool TryParse(string externalAccessRuleName, out ExternalAccessRuleName result)

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

Parameters
Name Description
externalAccessRuleName string

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

When this method returns, the parsed ExternalAccessRuleName, 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}/externalAccessRules/{external_access_rule}

TryParse(string, bool, out ExternalAccessRuleName)

public static bool TryParse(string externalAccessRuleName, bool allowUnparsed, out ExternalAccessRuleName result)

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

Parameters
Name Description
externalAccessRuleName 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 ExternalAccessRuleName

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

Operators

operator ==(ExternalAccessRuleName, ExternalAccessRuleName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ExternalAccessRuleName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ExternalAccessRuleName

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

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.