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

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

Implements

IResourceName, IEquatable CryptoKeyVersionName

Inherited Members

object.GetType()

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

The CryptoKeyVersionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CryptoKeyVersionNameResourceNameType`

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

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

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 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
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
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`CryptoKeyVersionName`	A new instance of CryptoKeyVersionName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static CryptoKeyVersionName Parse(string cryptoKeyVersionName)

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

Parameter
Name	Description
`cryptoKeyVersionName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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, bool)

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
Name	Description
`cryptoKeyVersionName`	`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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`cryptoKeyVersionName`	`string` The resource name in string form. Must not be `null`.
`result`	`CryptoKeyVersionName` When this method returns, the parsed CryptoKeyVersionName, 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}

TryParse(string, bool, 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
Name	Description
`cryptoKeyVersionName`	`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`	`CryptoKeyVersionName` When this method returns, the parsed CryptoKeyVersionName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CryptoKeyVersionName, CryptoKeyVersionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`CryptoKeyVersionName` The first resource name to compare, or null.
`b`	`CryptoKeyVersionName` 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 !=(CryptoKeyVersionName, CryptoKeyVersionName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`CryptoKeyVersionName` The first resource name to compare, or null.
`b`	`CryptoKeyVersionName` 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.