Discovery Engine v1 API - Class CryptoKeyVersionsName (1.8.0) 

public sealed class CryptoKeyVersionsName : IResourceName, IEquatable<CryptoKeyVersionsName>

Reference documentation and code samples for the Discovery Engine v1 API class CryptoKeyVersionsName.

Resource name for the CryptoKeyVersions resource.

Inheritance

object > CryptoKeyVersionsName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

CryptoKeyVersionsName(string, string, string, string, string)

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

Constructs a new instance of a CryptoKeyVersionsName 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 CryptoKeyVersionsName.ResourceNameType Type { get; }

The CryptoKeyVersionsName.ResourceNameType of the contained resource name.

Property Value
Type Description
CryptoKeyVersionsNameResourceNameType

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

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

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

Creates a CryptoKeyVersionsName 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
CryptoKeyVersionsName

A new instance of CryptoKeyVersionsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CryptoKeyVersionsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CryptoKeyVersionsName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
cryptoKeyVersionsName string

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

The parsed CryptoKeyVersionsName 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 CryptoKeyVersionsName Parse(string cryptoKeyVersionsName, bool allowUnparsed)

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

Parameters
Name Description
cryptoKeyVersionsName 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
CryptoKeyVersionsName

The parsed CryptoKeyVersionsName 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

TryParse(string, out CryptoKeyVersionsName)

public static bool TryParse(string cryptoKeyVersionsName, out CryptoKeyVersionsName result)

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

Parameters
Name Description
cryptoKeyVersionsName string

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

When this method returns, the parsed CryptoKeyVersionsName, 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 CryptoKeyVersionsName)

public static bool TryParse(string cryptoKeyVersionsName, bool allowUnparsed, out CryptoKeyVersionsName result)

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

Parameters
Name Description
cryptoKeyVersionsName 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 CryptoKeyVersionsName

When this method returns, the parsed CryptoKeyVersionsName, 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 ==(CryptoKeyVersionsName, CryptoKeyVersionsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CryptoKeyVersionsName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CryptoKeyVersionsName

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

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.