Google Cloud Key Management Service v1 API - Class AutokeyConfigName (3.12.0)

public sealed class AutokeyConfigName : IResourceName, IEquatable<AutokeyConfigName>

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

Resource name for the AutokeyConfig resource.

Inheritance

object > AutokeyConfigName

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

AutokeyConfigName(string)

public AutokeyConfigName(string folderId)

Constructs a new instance of a AutokeyConfigName class from the component parts of pattern folders/{folder}/autokeyConfig

Parameter
Name Description
folderId string

The Folder ID. Must not be null or empty.

Properties

FolderId

public string FolderId { get; }

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

Type

public AutokeyConfigName.ResourceNameType Type { get; }

The AutokeyConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
AutokeyConfigNameResourceNameType

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)

public static string Format(string folderId)

Formats the IDs into the string representation of this AutokeyConfigName with pattern folders/{folder}/autokeyConfig.

Parameter
Name Description
folderId string

The Folder ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AutokeyConfigName with pattern folders/{folder}/autokeyConfig.

FormatFolder(string)

public static string FormatFolder(string folderId)

Formats the IDs into the string representation of this AutokeyConfigName with pattern folders/{folder}/autokeyConfig.

Parameter
Name Description
folderId string

The Folder ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AutokeyConfigName with pattern folders/{folder}/autokeyConfig.

FromFolder(string)

public static AutokeyConfigName FromFolder(string folderId)

Creates a AutokeyConfigName with the pattern folders/{folder}/autokeyConfig.

Parameter
Name Description
folderId string

The Folder ID. Must not be null or empty.

Returns
Type Description
AutokeyConfigName

A new instance of AutokeyConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AutokeyConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AutokeyConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
AutokeyConfigName

A new instance of AutokeyConfigName 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 AutokeyConfigName Parse(string autokeyConfigName)

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

Parameter
Name Description
autokeyConfigName string

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

Returns
Type Description
AutokeyConfigName

The parsed AutokeyConfigName if successful.

Remarks

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

  • folders/{folder}/autokeyConfig

Parse(string, bool)

public static AutokeyConfigName Parse(string autokeyConfigName, bool allowUnparsed)

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

Parameters
Name Description
autokeyConfigName 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
AutokeyConfigName

The parsed AutokeyConfigName if successful.

Remarks

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

  • folders/{folder}/autokeyConfig
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 AutokeyConfigName)

public static bool TryParse(string autokeyConfigName, out AutokeyConfigName result)

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

Parameters
Name Description
autokeyConfigName string

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

result AutokeyConfigName

When this method returns, the parsed AutokeyConfigName, 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:

  • folders/{folder}/autokeyConfig

TryParse(string, bool, out AutokeyConfigName)

public static bool TryParse(string autokeyConfigName, bool allowUnparsed, out AutokeyConfigName result)

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

Parameters
Name Description
autokeyConfigName 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 AutokeyConfigName

When this method returns, the parsed AutokeyConfigName, 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:

  • folders/{folder}/autokeyConfig
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AutokeyConfigName, AutokeyConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AutokeyConfigName

The first resource name to compare, or null.

b AutokeyConfigName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AutokeyConfigName

The first resource name to compare, or null.

b AutokeyConfigName

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.