VMware Engine v1 API - Class DnsForwardingName (1.2.0)

public sealed class DnsForwardingName : IResourceName, IEquatable<DnsForwardingName>

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

Resource name for the DnsForwarding resource.

Inheritance

object > DnsForwardingName

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

DnsForwardingName(string, string, string)

public DnsForwardingName(string projectId, string locationId, string privateCloudId)

Constructs a new instance of a DnsForwardingName class from the component parts of pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/dnsForwarding

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.

privateCloudId string

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

PrivateCloudId

public string PrivateCloudId { get; }

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

The DnsForwardingName.ResourceNameType of the contained resource name.

Property Value
Type Description
DnsForwardingNameResourceNameType

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

Formats the IDs into the string representation of this DnsForwardingName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/dnsForwarding.

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.

privateCloudId string

The PrivateCloud ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DnsForwardingName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/dnsForwarding.

FormatProjectLocationPrivateCloud(string, string, string)

public static string FormatProjectLocationPrivateCloud(string projectId, string locationId, string privateCloudId)

Formats the IDs into the string representation of this DnsForwardingName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/dnsForwarding.

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.

privateCloudId string

The PrivateCloud ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DnsForwardingName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/dnsForwarding.

FromProjectLocationPrivateCloud(string, string, string)

public static DnsForwardingName FromProjectLocationPrivateCloud(string projectId, string locationId, string privateCloudId)

Creates a DnsForwardingName with the pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/dnsForwarding.

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.

privateCloudId string

The PrivateCloud ID. Must not be null or empty.

Returns
Type Description
DnsForwardingName

A new instance of DnsForwardingName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DnsForwardingName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DnsForwardingName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
DnsForwardingName

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

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

Parameter
Name Description
dnsForwardingName string

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

Returns
Type Description
DnsForwardingName

The parsed DnsForwardingName if successful.

Remarks

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

  • projects/{project}/locations/{location}/privateClouds/{private_cloud}/dnsForwarding

Parse(string, bool)

public static DnsForwardingName Parse(string dnsForwardingName, bool allowUnparsed)

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

Parameters
Name Description
dnsForwardingName 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
DnsForwardingName

The parsed DnsForwardingName if successful.

Remarks

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

  • projects/{project}/locations/{location}/privateClouds/{private_cloud}/dnsForwarding
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 DnsForwardingName)

public static bool TryParse(string dnsForwardingName, out DnsForwardingName result)

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

Parameters
Name Description
dnsForwardingName string

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

result DnsForwardingName

When this method returns, the parsed DnsForwardingName, 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}/privateClouds/{private_cloud}/dnsForwarding

TryParse(string, bool, out DnsForwardingName)

public static bool TryParse(string dnsForwardingName, bool allowUnparsed, out DnsForwardingName result)

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

Parameters
Name Description
dnsForwardingName 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 DnsForwardingName

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

Operators

operator ==(DnsForwardingName, DnsForwardingName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DnsForwardingName

The first resource name to compare, or null.

b DnsForwardingName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DnsForwardingName

The first resource name to compare, or null.

b DnsForwardingName

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.