Google Cloud Key Management Service v1 API - Class EkmConfigName (3.4.0)

Version 3.4.0

• 3.15.0 (latest)
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0

public sealed class EkmConfigName : IResourceName, IEquatable<EkmConfigName>

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class EkmConfigName.

Resource name for the EkmConfig resource.

Inheritance

object > EkmConfigName

Implements

IResourceName, IEquatableEkmConfigName

Inherited Members

object.GetType()

Namespace

GoogleGoogle.CloudGoogle.Cloud.KmsV1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

EkmConfigName(string, string)

public EkmConfigName(string projectId, string locationId)

Constructs a new instance of a EkmConfigName class from the component parts of pattern projects/{project}/locations/{location}/ekmConfig

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.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
bool

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

The EkmConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
EkmConfigNameResourceNameType

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)

public static string Format(string projectId, string locationId)

Formats the IDs into the string representation of this EkmConfigName with pattern projects/{project}/locations/{location}/ekmConfig.

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.

Returns
Type	Description
string	The string representation of this EkmConfigName with pattern projects/{project}/locations/{location}/ekmConfig.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this EkmConfigName with pattern projects/{project}/locations/{location}/ekmConfig.

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.

Returns
Type	Description
string	The string representation of this EkmConfigName with pattern projects/{project}/locations/{location}/ekmConfig.

FromProjectLocation(string, string)

public static EkmConfigName FromProjectLocation(string projectId, string locationId)

Creates a EkmConfigName with the pattern projects/{project}/locations/{location}/ekmConfig .

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.

Returns
Type	Description
EkmConfigName	A new instance of EkmConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EkmConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EkmConfigName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

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

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

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

Returns
Type	Description
EkmConfigName	The parsed EkmConfigName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/ekmConfig

Parse(string, bool)

public static EkmConfigName Parse(string ekmConfigName, bool allowUnparsed)

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

Parameters
Name	Description
ekmConfigName	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
EkmConfigName	The parsed EkmConfigName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/ekmConfig

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

public static bool TryParse(string ekmConfigName, out EkmConfigName result)

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

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

TryParse(string, bool, out EkmConfigName)

public static bool TryParse(string ekmConfigName, bool allowUnparsed, out EkmConfigName result)

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

Parameters
Name	Description
ekmConfigName	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	EkmConfigName When this method returns, the parsed EkmConfigName, 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}/ekmConfig

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EkmConfigName, EkmConfigName)

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

Parameters
Name	Description
a	EkmConfigName
b	EkmConfigName

Returns
Type	Description
bool

operator !=(EkmConfigName, EkmConfigName)

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

Parameters
Name	Description
a	EkmConfigName
b	EkmConfigName

Returns
Type	Description
bool