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

public sealed class SingleTenantHsmInstanceProposalName : IResourceName, IEquatable<SingleTenantHsmInstanceProposalName>

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

Resource name for the SingleTenantHsmInstanceProposal resource.

Inheritance

object > SingleTenantHsmInstanceProposalName

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

SingleTenantHsmInstanceProposalName(string, string, string, string)

public SingleTenantHsmInstanceProposalName(string projectId, string locationId, string singleTenantHsmInstanceId, string proposalId)

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

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

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

ProposalId

public string ProposalId { get; }

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

The SingleTenantHsmInstanceProposalName.ResourceNameType of the contained resource name.

Property Value
Type Description
SingleTenantHsmInstanceProposalNameResourceNameType

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

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

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

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

The string representation of this SingleTenantHsmInstanceProposalName with pattern projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}/proposals/{proposal} .

FormatProjectLocationSingleTenantHsmInstanceProposal(string, string, string, string)

public static string FormatProjectLocationSingleTenantHsmInstanceProposal(string projectId, string locationId, string singleTenantHsmInstanceId, string proposalId)

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

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

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

The string representation of this SingleTenantHsmInstanceProposalName with pattern projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}/proposals/{proposal} .

FromProjectLocationSingleTenantHsmInstanceProposal(string, string, string, string)

public static SingleTenantHsmInstanceProposalName FromProjectLocationSingleTenantHsmInstanceProposal(string projectId, string locationId, string singleTenantHsmInstanceId, string proposalId)

Creates a SingleTenantHsmInstanceProposalName with the pattern projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}/proposals/{proposal} .

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

The Proposal ID. Must not be null or empty.
Returns
Type Description
SingleTenantHsmInstanceProposalName

A new instance of SingleTenantHsmInstanceProposalName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SingleTenantHsmInstanceProposalName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SingleTenantHsmInstanceProposalName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
singleTenantHsmInstanceProposalName string

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

The parsed SingleTenantHsmInstanceProposalName 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}/proposals/{proposal}

Parse(string, bool)

public static SingleTenantHsmInstanceProposalName Parse(string singleTenantHsmInstanceProposalName, bool allowUnparsed)

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

Parameters
Name Description
singleTenantHsmInstanceProposalName 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
SingleTenantHsmInstanceProposalName

The parsed SingleTenantHsmInstanceProposalName 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}/proposals/{proposal}
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 SingleTenantHsmInstanceProposalName)

public static bool TryParse(string singleTenantHsmInstanceProposalName, out SingleTenantHsmInstanceProposalName result)

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

Parameters
Name Description
singleTenantHsmInstanceProposalName string

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

When this method returns, the parsed SingleTenantHsmInstanceProposalName, 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}/proposals/{proposal}

TryParse(string, bool, out SingleTenantHsmInstanceProposalName)

public static bool TryParse(string singleTenantHsmInstanceProposalName, bool allowUnparsed, out SingleTenantHsmInstanceProposalName result)

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

Parameters
Name Description
singleTenantHsmInstanceProposalName 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 SingleTenantHsmInstanceProposalName

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

Operators

operator ==(SingleTenantHsmInstanceProposalName, SingleTenantHsmInstanceProposalName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SingleTenantHsmInstanceProposalName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SingleTenantHsmInstanceProposalName

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

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.