VMware Engine v1 API - Class ExternalAddressName (1.5.0)

public sealed class ExternalAddressName : IResourceName, IEquatable<ExternalAddressName>

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

Resource name for the ExternalAddress resource.

Inheritance

object > ExternalAddressName

Implements

IResourceName, IEquatable ExternalAddressName

Inherited Members

object.GetType()

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

ExternalAddressName(string, string, string, string)

public ExternalAddressName(string projectId, string locationId, string privateCloudId, string externalAddressId)

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

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

Properties

ExternalAddressId

public string ExternalAddressId { get; }

The ExternalAddress 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`

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

The ExternalAddressName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ExternalAddressNameResourceNameType`

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

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

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

Returns
Type	Description
`string`	The string representation of this ExternalAddressName with pattern `projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}` .

FormatProjectLocationPrivateCloudExternalAddress(string, string, string, string)

public static string FormatProjectLocationPrivateCloudExternalAddress(string projectId, string locationId, string privateCloudId, string externalAddressId)

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

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

Returns
Type	Description
`string`	The string representation of this ExternalAddressName with pattern `projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}` .

FromProjectLocationPrivateCloudExternalAddress(string, string, string, string)

public static ExternalAddressName FromProjectLocationPrivateCloudExternalAddress(string projectId, string locationId, string privateCloudId, string externalAddressId)

Creates a ExternalAddressName with the pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address} .

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

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

FromUnparsed(UnparsedResourceName)

public static ExternalAddressName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ExternalAddressName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}

Parse(string, bool)

public static ExternalAddressName Parse(string externalAddressName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}

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

public static bool TryParse(string externalAddressName, out ExternalAddressName result)

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

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

TryParse(string, bool, out ExternalAddressName)

public static bool TryParse(string externalAddressName, bool allowUnparsed, out ExternalAddressName result)

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

Parameters
Name	Description
`externalAddressName`	`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`	`ExternalAddressName` When this method returns, the parsed ExternalAddressName, 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}/externalAddresses/{external_address}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ExternalAddressName, ExternalAddressName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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