public sealed class CryptoKeyName : IResourceName, IEquatable<CryptoKeyName>
Reference documentation and code samples for the Cloud Run Admin v2 API class CryptoKeyName.
Resource name for the CryptoKey
resource.
Namespace
Google.Cloud.Run.V2Assembly
Google.Cloud.Run.V2.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 |
locationId | string The |
keyRingId | string The |
cryptoKeyId | string The |
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 |
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 CryptoKeyName.ResourceNameType Type { get; }
The CryptoKeyName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
CryptoKeyNameResourceNameType |
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 |
locationId | string The |
keyRingId | string The |
cryptoKeyId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this CryptoKeyName with pattern
|
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 |
locationId | string The |
keyRingId | string The |
cryptoKeyId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this CryptoKeyName with pattern
|
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 |
locationId | string The |
keyRingId | string The |
cryptoKeyId | string The |
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 |
Returns | |
---|---|
Type | Description |
CryptoKeyName | A new instance of CryptoKeyName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
CryptoKeyName | The parsed CryptoKeyName if successful. |
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, bool)
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 |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
CryptoKeyName | The parsed CryptoKeyName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
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. |
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 |
result | CryptoKeyName When this method returns, the parsed CryptoKeyName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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, bool, 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 |
allowUnparsed | bool If |
result | CryptoKeyName When this method returns, the parsed CryptoKeyName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
allowUnparsed
is true
.
Operators
operator ==(CryptoKeyName, CryptoKeyName)
public static bool operator ==(CryptoKeyName a, CryptoKeyName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a | CryptoKeyName The first resource name to compare, or null. |
b | CryptoKeyName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool | true if the value of |
operator !=(CryptoKeyName, CryptoKeyName)
public static bool operator !=(CryptoKeyName a, CryptoKeyName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a | CryptoKeyName The first resource name to compare, or null. |
b | CryptoKeyName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool | true if the value of |