VMware Engine v1 API - Class HcxActivationKeyName (1.7.0) 

public sealed class HcxActivationKeyName : IResourceName, IEquatable<HcxActivationKeyName>

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

Resource name for the HcxActivationKey resource.

Inheritance

object > HcxActivationKeyName

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

HcxActivationKeyName(string, string, string, string)

public HcxActivationKeyName(string projectId, string locationId, string privateCloudId, string hcxActivationKeyId)

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

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

The HcxActivationKey ID. Must not be null or empty.

Properties

HcxActivationKeyId

public string HcxActivationKeyId { get; }

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

The HcxActivationKeyName.ResourceNameType of the contained resource name.

Property Value
Type Description
HcxActivationKeyNameResourceNameType

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

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

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

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

The string representation of this HcxActivationKeyName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/hcxActivationKeys/{hcx_activation_key} .

FormatProjectLocationPrivateCloudHcxActivationKey(string, string, string, string)

public static string FormatProjectLocationPrivateCloudHcxActivationKey(string projectId, string locationId, string privateCloudId, string hcxActivationKeyId)

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

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

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

The string representation of this HcxActivationKeyName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/hcxActivationKeys/{hcx_activation_key} .

FromProjectLocationPrivateCloudHcxActivationKey(string, string, string, string)

public static HcxActivationKeyName FromProjectLocationPrivateCloudHcxActivationKey(string projectId, string locationId, string privateCloudId, string hcxActivationKeyId)

Creates a HcxActivationKeyName with the pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/hcxActivationKeys/{hcx_activation_key} .

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

The HcxActivationKey ID. Must not be null or empty.
Returns
Type Description
HcxActivationKeyName

A new instance of HcxActivationKeyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static HcxActivationKeyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HcxActivationKeyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
hcxActivationKeyName string

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

The parsed HcxActivationKeyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/privateClouds/{private_cloud}/hcxActivationKeys/{hcx_activation_key}

Parse(string, bool)

public static HcxActivationKeyName Parse(string hcxActivationKeyName, bool allowUnparsed)

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

Parameters
Name Description
hcxActivationKeyName 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
HcxActivationKeyName

The parsed HcxActivationKeyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/privateClouds/{private_cloud}/hcxActivationKeys/{hcx_activation_key}
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 HcxActivationKeyName)

public static bool TryParse(string hcxActivationKeyName, out HcxActivationKeyName result)

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

Parameters
Name Description
hcxActivationKeyName string

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

When this method returns, the parsed HcxActivationKeyName, 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}/hcxActivationKeys/{hcx_activation_key}

TryParse(string, bool, out HcxActivationKeyName)

public static bool TryParse(string hcxActivationKeyName, bool allowUnparsed, out HcxActivationKeyName result)

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

Parameters
Name Description
hcxActivationKeyName 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 HcxActivationKeyName

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

Operators

operator ==(HcxActivationKeyName, HcxActivationKeyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a HcxActivationKeyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a HcxActivationKeyName

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

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.