Google.Cloud.OsLogin.Common - Class SshPublicKeyName (3.3.0)

Version latest

• 3.3.0 (latest)
• 3.2.0
• 3.1.0
• 3.0.0
• 2.3.0
• 2.2.0

public sealed class SshPublicKeyName : IResourceName, IEquatable<SshPublicKeyName>

Reference documentation and code samples for the Google.Cloud.OsLogin.Common class SshPublicKeyName.

Resource name for the SshPublicKey resource.

Inheritance

object > SshPublicKeyName

Implements

IResourceName, IEquatableSshPublicKeyName

Inherited Members

object.GetType()

Namespace

Google.Cloud.OsLogin.Common

Assembly

Google.Cloud.OsLogin.Common.dll

Constructors

SshPublicKeyName(string, string)

public SshPublicKeyName(string userId, string fingerprintId)

Constructs a new instance of a SshPublicKeyName class from the component parts of pattern users/{user}/sshPublicKeys/{fingerprint}

Parameters
Name	Description
userId	string The User ID. Must not be null or empty.
fingerprintId	string The Fingerprint ID. Must not be null or empty.

Properties

FingerprintId

public string FingerprintId { get; }

The Fingerprint 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 SshPublicKeyName.ResourceNameType Type { get; }

The SshPublicKeyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
SshPublicKeyNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
UnparsedResourceName

UserId

public string UserId { get; }

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

Property Value
Type	Description
string

Methods

Format(string, string)

public static string Format(string userId, string fingerprintId)

Formats the IDs into the string representation of this SshPublicKeyName with pattern users/{user}/sshPublicKeys/{fingerprint}.

Parameters
Name	Description
userId	string The User ID. Must not be null or empty.
fingerprintId	string The Fingerprint ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SshPublicKeyName with pattern users/{user}/sshPublicKeys/{fingerprint}.

FormatUserFingerprint(string, string)

public static string FormatUserFingerprint(string userId, string fingerprintId)

Formats the IDs into the string representation of this SshPublicKeyName with pattern users/{user}/sshPublicKeys/{fingerprint}.

Parameters
Name	Description
userId	string The User ID. Must not be null or empty.
fingerprintId	string The Fingerprint ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SshPublicKeyName with pattern users/{user}/sshPublicKeys/{fingerprint}.

FromUnparsed(UnparsedResourceName)

public static SshPublicKeyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SshPublicKeyName containing an unparsed resource name.

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

Returns
Type	Description
SshPublicKeyName	A new instance of SshPublicKeyName containing the provided unparsedResourceName.

FromUserFingerprint(string, string)

public static SshPublicKeyName FromUserFingerprint(string userId, string fingerprintId)

Creates a SshPublicKeyName with the pattern users/{user}/sshPublicKeys/{fingerprint}.

Parameters
Name	Description
userId	string The User ID. Must not be null or empty.
fingerprintId	string The Fingerprint ID. Must not be null or empty.

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static SshPublicKeyName Parse(string sshPublicKeyName)

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

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

Returns
Type	Description
SshPublicKeyName	The parsed SshPublicKeyName if successful.

Remarks

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

• users/{user}/sshPublicKeys/{fingerprint}

Parse(string, bool)

public static SshPublicKeyName Parse(string sshPublicKeyName, bool allowUnparsed)

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

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

Remarks

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

• users/{user}/sshPublicKeys/{fingerprint}

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

public static bool TryParse(string sshPublicKeyName, out SshPublicKeyName result)

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

Parameters
Name	Description
sshPublicKeyName	string The resource name in string form. Must not be null.
result	SshPublicKeyName When this method returns, the parsed SshPublicKeyName, 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:

• users/{user}/sshPublicKeys/{fingerprint}

TryParse(string, bool, out SshPublicKeyName)

public static bool TryParse(string sshPublicKeyName, bool allowUnparsed, out SshPublicKeyName result)

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

Parameters
Name	Description
sshPublicKeyName	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	SshPublicKeyName When this method returns, the parsed SshPublicKeyName, 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:

• users/{user}/sshPublicKeys/{fingerprint}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SshPublicKeyName, SshPublicKeyName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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