Google Cloud Key Management Service v1 API - Class EkmConnectionName (3.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, IEquatable<EkmConnectionName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`EkmConnectionName.ResourceNameType`

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
`Int32`

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, Boolean)

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`	`Boolean` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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
`Boolean`	`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, Boolean, 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`	`Boolean` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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
`Boolean`	`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

Equality(EkmConnectionName, EkmConnectionName)

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

Parameters
Name	Description
`a`	`EkmConnectionName`
`b`	`EkmConnectionName`

Returns
Type	Description
`Boolean`

Inequality(EkmConnectionName, EkmConnectionName)

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

Parameters
Name	Description
`a`	`EkmConnectionName`
`b`	`EkmConnectionName`

Returns
Type	Description
`Boolean`