Google Cloud Spanner Database Administration v1 API - Class CryptoKeyVersionName (4.2.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class CryptoKeyVersionName : IResourceName, IEquatable<CryptoKeyVersionName>

Reference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class CryptoKeyVersionName.

Resource name for the CryptoKeyVersion resource.

Inheritance

Object > CryptoKeyVersionName

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

Google.Cloud.Spanner.Admin.Database.V1.dll

Constructors

CryptoKeyVersionName(String, String, String, String, String)

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

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

keyRingIdString

The KeyRing ID. Must not be null or empty.

cryptoKeyIdString

The CryptoKey ID. Must not be null or empty.

cryptoKeyVersionIdString

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
TypeDescription
String

CryptoKeyVersionId

public string CryptoKeyVersionId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

KeyRingId

public string KeyRingId { get; }

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

Property Value
TypeDescription
String

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public CryptoKeyVersionName.ResourceNameType Type { get; }

The CryptoKeyVersionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CryptoKeyVersionName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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 CryptoKeyVersionName with pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

keyRingIdString

The KeyRing ID. Must not be null or empty.

cryptoKeyIdString

The CryptoKey ID. Must not be null or empty.

cryptoKeyVersionIdString

The CryptoKeyVersion ID. Must not be null or empty.

Returns
TypeDescription
String

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

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 CryptoKeyVersionName with pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

keyRingIdString

The KeyRing ID. Must not be null or empty.

cryptoKeyIdString

The CryptoKey ID. Must not be null or empty.

cryptoKeyVersionIdString

The CryptoKeyVersion ID. Must not be null or empty.

Returns
TypeDescription
String

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

FromProjectLocationKeyRingCryptoKeyCryptoKeyVersion(String, String, String, String, String)

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

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

keyRingIdString

The KeyRing ID. Must not be null or empty.

cryptoKeyIdString

The CryptoKey ID. Must not be null or empty.

cryptoKeyVersionIdString

The CryptoKeyVersion ID. Must not be null or empty.

Returns
TypeDescription
CryptoKeyVersionName

A new instance of CryptoKeyVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CryptoKeyVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CryptoKeyVersionName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CryptoKeyVersionName

A new instance of CryptoKeyVersionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static CryptoKeyVersionName Parse(string cryptoKeyVersionName)

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

Parameter
NameDescription
cryptoKeyVersionNameString

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

Returns
TypeDescription
CryptoKeyVersionName

The parsed CryptoKeyVersionName 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}

Parse(String, Boolean)

public static CryptoKeyVersionName Parse(string cryptoKeyVersionName, bool allowUnparsed)

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

Parameters
NameDescription
cryptoKeyVersionNameString

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

allowUnparsedBoolean

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
TypeDescription
CryptoKeyVersionName

The parsed CryptoKeyVersionName 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}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out CryptoKeyVersionName)

public static bool TryParse(string cryptoKeyVersionName, out CryptoKeyVersionName result)

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

Parameters
NameDescription
cryptoKeyVersionNameString

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

resultCryptoKeyVersionName

When this method returns, the parsed CryptoKeyVersionName, or null if parsing failed.

Returns
TypeDescription
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}

TryParse(String, Boolean, out CryptoKeyVersionName)

public static bool TryParse(string cryptoKeyVersionName, bool allowUnparsed, out CryptoKeyVersionName result)

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

Parameters
NameDescription
cryptoKeyVersionNameString

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

allowUnparsedBoolean

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.

resultCryptoKeyVersionName

When this method returns, the parsed CryptoKeyVersionName, or null if parsing failed.

Returns
TypeDescription
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}
Or may be in any format if allowUnparsed is true.

Operators

Equality(CryptoKeyVersionName, CryptoKeyVersionName)

public static bool operator ==(CryptoKeyVersionName a, CryptoKeyVersionName b)
Parameters
NameDescription
aCryptoKeyVersionName
bCryptoKeyVersionName
Returns
TypeDescription
Boolean

Inequality(CryptoKeyVersionName, CryptoKeyVersionName)

public static bool operator !=(CryptoKeyVersionName a, CryptoKeyVersionName b)
Parameters
NameDescription
aCryptoKeyVersionName
bCryptoKeyVersionName
Returns
TypeDescription
Boolean