NetApp v1 API - Class KmsConfigName (1.3.0)

public sealed class KmsConfigName : IResourceName, IEquatable<KmsConfigName>

Reference documentation and code samples for the NetApp v1 API class KmsConfigName.

Resource name for the KmsConfig resource.

Inheritance

object > KmsConfigName

Namespace

Google.Cloud.NetApp.V1

Assembly

Google.Cloud.NetApp.V1.dll

Constructors

KmsConfigName(string, string, string)

public KmsConfigName(string projectId, string locationId, string kmsConfigId)

Constructs a new instance of a KmsConfigName class from the component parts of pattern projects/{project}/locations/{location}/kmsConfigs/{kms_config}

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.
kmsConfigId string

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

KmsConfigId

public string KmsConfigId { get; }

The KmsConfig ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

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

The KmsConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
KmsConfigNameResourceNameType

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

Formats the IDs into the string representation of this KmsConfigName with pattern projects/{project}/locations/{location}/kmsConfigs/{kms_config}.

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.
kmsConfigId string

The KmsConfig ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this KmsConfigName with pattern projects/{project}/locations/{location}/kmsConfigs/{kms_config}.

FormatProjectLocationKmsConfig(string, string, string)

public static string FormatProjectLocationKmsConfig(string projectId, string locationId, string kmsConfigId)

Formats the IDs into the string representation of this KmsConfigName with pattern projects/{project}/locations/{location}/kmsConfigs/{kms_config}.

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.
kmsConfigId string

The KmsConfig ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this KmsConfigName with pattern projects/{project}/locations/{location}/kmsConfigs/{kms_config}.

FromProjectLocationKmsConfig(string, string, string)

public static KmsConfigName FromProjectLocationKmsConfig(string projectId, string locationId, string kmsConfigId)

Creates a KmsConfigName with the pattern projects/{project}/locations/{location}/kmsConfigs/{kms_config}.

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.
kmsConfigId string

The KmsConfig ID. Must not be null or empty.
Returns
Type Description
KmsConfigName

A new instance of KmsConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static KmsConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a KmsConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
KmsConfigName

A new instance of KmsConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static KmsConfigName Parse(string kmsConfigName)

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

Parameter
Name Description
kmsConfigName string

The resource name in string form. Must not be null.
Returns
Type Description
KmsConfigName

The parsed KmsConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/kmsConfigs/{kms_config}

Parse(string, bool)

public static KmsConfigName Parse(string kmsConfigName, bool allowUnparsed)

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

Parameters
Name Description
kmsConfigName 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
KmsConfigName

The parsed KmsConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/kmsConfigs/{kms_config}
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

TryParse(string, out KmsConfigName)

public static bool TryParse(string kmsConfigName, out KmsConfigName result)

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

Parameters
Name Description
kmsConfigName string

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

When this method returns, the parsed KmsConfigName, 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}/kmsConfigs/{kms_config}

TryParse(string, bool, out KmsConfigName)

public static bool TryParse(string kmsConfigName, bool allowUnparsed, out KmsConfigName result)

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

Parameters
Name Description
kmsConfigName 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 KmsConfigName

When this method returns, the parsed KmsConfigName, 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}/kmsConfigs/{kms_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(KmsConfigName, KmsConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a KmsConfigName

The first resource name to compare, or null.
b KmsConfigName

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 !=(KmsConfigName, KmsConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a KmsConfigName

The first resource name to compare, or null.
b KmsConfigName

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.