Google Cloud Key Management Service v1 API - Class PublicKeyName (3.3.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

Implements

IResourceName, IEquatable<PublicKeyName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`PublicKeyName.ResourceNameType`

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)

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
`Int32`

Overrides

Object.GetHashCode()

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

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`	`Boolean` 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

Object.ToString()

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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(PublicKeyName, PublicKeyName)

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

Parameters
Name	Description
`a`	`PublicKeyName`
`b`	`PublicKeyName`

Returns
Type	Description
`Boolean`

Inequality(PublicKeyName, PublicKeyName)

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

Parameters
Name	Description
`a`	`PublicKeyName`
`b`	`PublicKeyName`

Returns
Type	Description
`Boolean`