KMS Inventory v1 API - Class ProtectedResourcesSummaryName (1.2.0)

Version 1.2.0

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 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

Implements

IResourceName, IEquatableProtectedResourcesSummaryName

Inherited Members

object.GetType()

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
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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
string

CryptoKeyVersionId

public string CryptoKeyVersionId { get; }

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

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
string

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type	Description
string

Type

public ProtectedResourcesSummaryName.ResourceNameType Type { get; }

The ProtectedResourcesSummaryName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ProtectedResourcesSummaryNameResourceNameType

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

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

Returns
Type	Description
ProtectedResourcesSummaryName	A new instance of ProtectedResourcesSummaryName 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 ProtectedResourcesSummaryName Parse(string protectedResourcesSummaryName)

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

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

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

Overrides

object.ToString()

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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