KMS Inventory v1 API - Class ProtectedResourcesSummaryName (1.0.0)

public sealed class ProtectedResourcesSummaryName : IResourceName, IEquatable<ProtectedResourcesSummaryName>

Reference documentation and code samples for the KMS Inventory v1 API class ProtectedResourcesSummaryName.

Resource name for the ProtectedResourcesSummary resource.

Inheritance

object > ProtectedResourcesSummaryName

Namespace

Google.Cloud.Kms.Inventory.V1

Assembly

Google.Cloud.Kms.Inventory.V1.dll

Constructors

ProtectedResourcesSummaryName(string, string, string, string)

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

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

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.

Properties

CryptoKeyId

public string CryptoKeyId { get; }

The CryptoKey ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
string

CryptoKeyVersionId

public string CryptoKeyVersionId { get; }

The CryptoKeyVersion ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
bool

KeyRingId

public string KeyRingId { get; }

The KeyRing ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
string

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
string

Type

public ProtectedResourcesSummaryName.ResourceNameType Type { get; }

The ProtectedResourcesSummaryName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ProtectedResourcesSummaryNameResourceNameType

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)

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

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

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.

Returns
TypeDescription
string

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

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

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.

Returns
TypeDescription
string

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

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

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

FromProjectLocationKeyRingCryptoKey(string, string, string, string)

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

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

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.

Returns
TypeDescription
ProtectedResourcesSummaryName

A new instance of ProtectedResourcesSummaryName constructed from the provided ids.

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

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

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

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
ProtectedResourcesSummaryName

A new instance of ProtectedResourcesSummaryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProtectedResourcesSummaryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProtectedResourcesSummaryName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ProtectedResourcesSummaryName

A new instance of ProtectedResourcesSummaryName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ProtectedResourcesSummaryName Parse(string protectedResourcesSummaryName)

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

Parameter
NameDescription
protectedResourcesSummaryNamestring

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

Returns
TypeDescription
ProtectedResourcesSummaryName

The parsed ProtectedResourcesSummaryName 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}/protectedResourcesSummary
  • projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/protectedResourcesSummary

Parse(string, bool)

public static ProtectedResourcesSummaryName Parse(string protectedResourcesSummaryName, bool allowUnparsed)

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

Parameters
NameDescription
protectedResourcesSummaryNamestring

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

allowUnparsedbool

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
ProtectedResourcesSummaryName

The parsed ProtectedResourcesSummaryName 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}/protectedResourcesSummary
  • projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/protectedResourcesSummary
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 ProtectedResourcesSummaryName)

public static bool TryParse(string protectedResourcesSummaryName, out ProtectedResourcesSummaryName result)

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

Parameters
NameDescription
protectedResourcesSummaryNamestring

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

resultProtectedResourcesSummaryName

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

Returns
TypeDescription
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}/protectedResourcesSummary
  • projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/protectedResourcesSummary

TryParse(string, bool, out ProtectedResourcesSummaryName)

public static bool TryParse(string protectedResourcesSummaryName, bool allowUnparsed, out ProtectedResourcesSummaryName result)

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

Parameters
NameDescription
protectedResourcesSummaryNamestring

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

allowUnparsedbool

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.

resultProtectedResourcesSummaryName

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

Returns
TypeDescription
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}/protectedResourcesSummary
  • projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/protectedResourcesSummary
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProtectedResourcesSummaryName, ProtectedResourcesSummaryName)

public static bool operator ==(ProtectedResourcesSummaryName a, ProtectedResourcesSummaryName b)
Parameters
NameDescription
aProtectedResourcesSummaryName
bProtectedResourcesSummaryName
Returns
TypeDescription
bool

operator !=(ProtectedResourcesSummaryName, ProtectedResourcesSummaryName)

public static bool operator !=(ProtectedResourcesSummaryName a, ProtectedResourcesSummaryName b)
Parameters
NameDescription
aProtectedResourcesSummaryName
bProtectedResourcesSummaryName
Returns
TypeDescription
bool