Google Cloud Key Management Service v1 API - Class SingleTenantHsmInstanceName (3.21.0)

Version latest

• 3.21.0 (latest)
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0

public sealed class SingleTenantHsmInstanceName : IResourceName, IEquatable<SingleTenantHsmInstanceName>

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class SingleTenantHsmInstanceName.

Resource name for the SingleTenantHsmInstance resource.

Inheritance

object > SingleTenantHsmInstanceName

Implements

IResourceName, IEquatableSingleTenantHsmInstanceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

SingleTenantHsmInstanceName(string, string, string)

public SingleTenantHsmInstanceName(string projectId, string locationId, string singleTenantHsmInstanceId)

Constructs a new instance of a SingleTenantHsmInstanceName class from the component parts of pattern projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}

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.
singleTenantHsmInstanceId	string The SingleTenantHsmInstance 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

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

SingleTenantHsmInstanceId

public string SingleTenantHsmInstanceId { get; }

The SingleTenantHsmInstance ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
string

Type

public SingleTenantHsmInstanceName.ResourceNameType Type { get; }

The SingleTenantHsmInstanceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
SingleTenantHsmInstanceNameResourceNameType

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

Formats the IDs into the string representation of this SingleTenantHsmInstanceName with pattern projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance} .

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.
singleTenantHsmInstanceId	string The SingleTenantHsmInstance ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SingleTenantHsmInstanceName with pattern projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}.

FormatProjectLocationSingleTenantHsmInstance(string, string, string)

public static string FormatProjectLocationSingleTenantHsmInstance(string projectId, string locationId, string singleTenantHsmInstanceId)

Formats the IDs into the string representation of this SingleTenantHsmInstanceName with pattern projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance} .

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.
singleTenantHsmInstanceId	string The SingleTenantHsmInstance ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SingleTenantHsmInstanceName with pattern projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}.

FromProjectLocationSingleTenantHsmInstance(string, string, string)

public static SingleTenantHsmInstanceName FromProjectLocationSingleTenantHsmInstance(string projectId, string locationId, string singleTenantHsmInstanceId)

Creates a SingleTenantHsmInstanceName with the pattern projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}.

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.
singleTenantHsmInstanceId	string The SingleTenantHsmInstance ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static SingleTenantHsmInstanceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SingleTenantHsmInstanceName containing an unparsed resource name.

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

Returns
Type	Description
SingleTenantHsmInstanceName	A new instance of SingleTenantHsmInstanceName 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 SingleTenantHsmInstanceName Parse(string singleTenantHsmInstanceName)

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

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

Returns
Type	Description
SingleTenantHsmInstanceName	The parsed SingleTenantHsmInstanceName if successful.

Remarks

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

• projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}

Parse(string, bool)

public static SingleTenantHsmInstanceName Parse(string singleTenantHsmInstanceName, bool allowUnparsed)

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

Parameters
Name	Description
singleTenantHsmInstanceName	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
SingleTenantHsmInstanceName	The parsed SingleTenantHsmInstanceName if successful.

Remarks

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

• projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}

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

public static bool TryParse(string singleTenantHsmInstanceName, out SingleTenantHsmInstanceName result)

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

Parameters
Name	Description
singleTenantHsmInstanceName	string The resource name in string form. Must not be null.
result	SingleTenantHsmInstanceName When this method returns, the parsed SingleTenantHsmInstanceName, 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}/singleTenantHsmInstances/{single_tenant_hsm_instance}

TryParse(string, bool, out SingleTenantHsmInstanceName)

public static bool TryParse(string singleTenantHsmInstanceName, bool allowUnparsed, out SingleTenantHsmInstanceName result)

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

Parameters
Name	Description
singleTenantHsmInstanceName	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	SingleTenantHsmInstanceName When this method returns, the parsed SingleTenantHsmInstanceName, 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}/singleTenantHsmInstances/{single_tenant_hsm_instance}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SingleTenantHsmInstanceName, SingleTenantHsmInstanceName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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