Google Cloud Key Management Service v1 API - Class PublicKeyName (3.20.0) 

public sealed class PublicKeyName : IResourceName, IEquatable<PublicKeyName>

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

Resource name for the PublicKey resource.

Inheritance

object > PublicKeyName

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

PublicKeyName(string, string, string, string, string)

public PublicKeyName(string projectId, string locationId, string keyRingId, string cryptoKeyId, string cryptoKeyVersionId)

Constructs a new instance of a PublicKeyName class from the component parts of pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/publicKey

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

The KeyRing ID. Must not be null or empty.
cryptoKeyId string

The CryptoKey ID. Must not be null or empty.
cryptoKeyVersionId string

The CryptoKeyVersion ID. Must not be null or empty.

Properties

CryptoKeyId

public string CryptoKeyId { get; }

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

Property Value
Type Description
string

CryptoKeyVersionId

public string CryptoKeyVersionId { get; }

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

KeyRingId

public string KeyRingId { get; }

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

Property Value
Type Description
string

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

Type

public PublicKeyName.ResourceNameType Type { get; }

The PublicKeyName.ResourceNameType of the contained resource name.

Property Value
Type Description
PublicKeyNameResourceNameType

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

public static string Format(string projectId, string locationId, string keyRingId, string cryptoKeyId, string cryptoKeyVersionId)

Formats the IDs into the string representation of this PublicKeyName with pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/publicKey .

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

The KeyRing ID. Must not be null or empty.
cryptoKeyId string

The CryptoKey ID. Must not be null or empty.
cryptoKeyVersionId string

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

The string representation of this PublicKeyName with pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/publicKey .

FormatProjectLocationKeyRingCryptoKeyCryptoKeyVersion(string, string, string, string, string)

public static string FormatProjectLocationKeyRingCryptoKeyCryptoKeyVersion(string projectId, string locationId, string keyRingId, string cryptoKeyId, string cryptoKeyVersionId)

Formats the IDs into the string representation of this PublicKeyName with pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/publicKey .

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

The KeyRing ID. Must not be null or empty.
cryptoKeyId string

The CryptoKey ID. Must not be null or empty.
cryptoKeyVersionId string

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

The string representation of this PublicKeyName with pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/publicKey .

FromProjectLocationKeyRingCryptoKeyCryptoKeyVersion(string, string, string, string, string)

public static PublicKeyName FromProjectLocationKeyRingCryptoKeyCryptoKeyVersion(string projectId, string locationId, string keyRingId, string cryptoKeyId, string cryptoKeyVersionId)

Creates a PublicKeyName with the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/publicKey .

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

The KeyRing ID. Must not be null or empty.
cryptoKeyId string

The CryptoKey ID. Must not be null or empty.
cryptoKeyVersionId string

The CryptoKeyVersion ID. Must not be null or empty.
Returns
Type Description
PublicKeyName

A new instance of PublicKeyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PublicKeyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PublicKeyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
publicKeyName string

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

The parsed PublicKeyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/publicKey

Parse(string, bool)

public static PublicKeyName Parse(string publicKeyName, bool allowUnparsed)

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

Parameters
Name Description
publicKeyName 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
PublicKeyName

The parsed PublicKeyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/publicKey
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 PublicKeyName)

public static bool TryParse(string publicKeyName, out PublicKeyName result)

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

Parameters
Name Description
publicKeyName string

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

When this method returns, the parsed PublicKeyName, 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}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/publicKey

TryParse(string, bool, out PublicKeyName)

public static bool TryParse(string publicKeyName, bool allowUnparsed, out PublicKeyName result)

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

Parameters
Name Description
publicKeyName 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 PublicKeyName

When this method returns, the parsed PublicKeyName, 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}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/publicKey
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PublicKeyName, PublicKeyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PublicKeyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PublicKeyName

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

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.