Class CryptoKeyName (3.15.1) 

public sealed class CryptoKeyName : IResourceName, IEquatable<CryptoKeyName>

Resource name for the CryptoKey resource.

Inheritance

Object > CryptoKeyName

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

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

Constructors

CryptoKeyName(String, String, String, String)

public CryptoKeyName(string projectId, string locationId, string keyRingId, string cryptoKeyId)

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

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.

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

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 CryptoKeyName.ResourceNameType Type { get; }

The CryptoKeyName.ResourceNameType of the contained resource name.

Property Value
Type Description
CryptoKeyName.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)

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

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

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.
Returns
Type Description
String

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

FormatProjectLocationKeyRingCryptoKey(String, String, String, String)

public static string FormatProjectLocationKeyRingCryptoKey(string projectId, string locationId, string keyRingId, string cryptoKeyId)

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

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.
Returns
Type Description
String

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

FromProjectLocationKeyRingCryptoKey(String, String, String, String)

public static CryptoKeyName FromProjectLocationKeyRingCryptoKey(string projectId, string locationId, string keyRingId, string cryptoKeyId)

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

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.
Returns
Type Description
CryptoKeyName

A new instance of CryptoKeyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CryptoKeyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CryptoKeyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of CryptoKeyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static CryptoKeyName Parse(string cryptoKeyName)

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

Parameter
Name Description
cryptoKeyName String

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

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

Parse(String, Boolean)

public static CryptoKeyName Parse(string cryptoKeyName, bool allowUnparsed)

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

Parameters
Name Description
cryptoKeyName 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
CryptoKeyName

The parsed CryptoKeyName 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}
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 CryptoKeyName)

public static bool TryParse(string cryptoKeyName, out CryptoKeyName result)

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

Parameters
Name Description
cryptoKeyName String

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

When this method returns, the parsed CryptoKeyName, 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}

TryParse(String, Boolean, out CryptoKeyName)

public static bool TryParse(string cryptoKeyName, bool allowUnparsed, out CryptoKeyName result)

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

Parameters
Name Description
cryptoKeyName 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 CryptoKeyName

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

Operators

Equality(CryptoKeyName, CryptoKeyName)

public static bool operator ==(CryptoKeyName a, CryptoKeyName b)
Parameters
Name Description
a CryptoKeyName
b CryptoKeyName
Returns
Type Description
Boolean

Inequality(CryptoKeyName, CryptoKeyName)

public static bool operator !=(CryptoKeyName a, CryptoKeyName b)
Parameters
Name Description
a CryptoKeyName
b CryptoKeyName
Returns
Type Description
Boolean