Google Cloud Key Management Service v1 API - Class EkmConnectionName (3.9.0)

Version 3.9.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 EkmConnectionName : IResourceName, IEquatable<EkmConnectionName>

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

Resource name for the EkmConnection resource.

Inheritance

object > EkmConnectionName

Implements

IResourceName, IEquatableEkmConnectionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

EkmConnectionName(string, string, string)

public EkmConnectionName(string projectId, string locationId, string ekmConnectionId)

Constructs a new instance of a EkmConnectionName class from the component parts of pattern projects/{project}/locations/{location}/ekmConnections/{ekm_connection}

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.
ekmConnectionId	string The EkmConnection ID. Must not be null or empty.

Properties

EkmConnectionId

public string EkmConnectionId { get; }

The EkmConnection 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

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

The EkmConnectionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
EkmConnectionNameResourceNameType

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)

public static string Format(string projectId, string locationId, string ekmConnectionId)

Formats the IDs into the string representation of this EkmConnectionName with pattern projects/{project}/locations/{location}/ekmConnections/{ekm_connection}.

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.
ekmConnectionId	string The EkmConnection ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this EkmConnectionName with pattern projects/{project}/locations/{location}/ekmConnections/{ekm_connection}.

FormatProjectLocationEkmConnection(string, string, string)

public static string FormatProjectLocationEkmConnection(string projectId, string locationId, string ekmConnectionId)

Formats the IDs into the string representation of this EkmConnectionName with pattern projects/{project}/locations/{location}/ekmConnections/{ekm_connection}.

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.
ekmConnectionId	string The EkmConnection ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this EkmConnectionName with pattern projects/{project}/locations/{location}/ekmConnections/{ekm_connection}.

FromProjectLocationEkmConnection(string, string, string)

public static EkmConnectionName FromProjectLocationEkmConnection(string projectId, string locationId, string ekmConnectionId)

Creates a EkmConnectionName with the pattern projects/{project}/locations/{location}/ekmConnections/{ekm_connection}.

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.
ekmConnectionId	string The EkmConnection ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static EkmConnectionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EkmConnectionName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
EkmConnectionName	The parsed EkmConnectionName if successful.

Remarks

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

• projects/{project}/locations/{location}/ekmConnections/{ekm_connection}

Parse(string, bool)

public static EkmConnectionName Parse(string ekmConnectionName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/ekmConnections/{ekm_connection}

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

public static bool TryParse(string ekmConnectionName, out EkmConnectionName result)

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

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

TryParse(string, bool, out EkmConnectionName)

public static bool TryParse(string ekmConnectionName, bool allowUnparsed, out EkmConnectionName result)

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

Parameters
Name	Description
ekmConnectionName	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	EkmConnectionName When this method returns, the parsed EkmConnectionName, 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}/ekmConnections/{ekm_connection}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EkmConnectionName, EkmConnectionName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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