Bare Metal Solution v2 API - Class SshKeyName (1.6.0) 

public sealed class SshKeyName : IResourceName, IEquatable<SshKeyName>

Reference documentation and code samples for the Bare Metal Solution v2 API class SshKeyName.

Resource name for the SshKey resource.

Inheritance

object > SshKeyName

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

SshKeyName(string, string, string)

public SshKeyName(string projectId, string locationId, string sshKeyId)

Constructs a new instance of a SshKeyName class from the component parts of pattern projects/{project}/locations/{location}/sshKeys/{ssh_key}

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

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

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

SshKeyId

public string SshKeyId { get; }

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

Property Value
Type Description
string

Type

public SshKeyName.ResourceNameType Type { get; }

The SshKeyName.ResourceNameType of the contained resource name.

Property Value
Type Description
SshKeyNameResourceNameType

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

Formats the IDs into the string representation of this SshKeyName with pattern projects/{project}/locations/{location}/sshKeys/{ssh_key}.

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

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

The string representation of this SshKeyName with pattern projects/{project}/locations/{location}/sshKeys/{ssh_key}.

FormatProjectLocationSshKey(string, string, string)

public static string FormatProjectLocationSshKey(string projectId, string locationId, string sshKeyId)

Formats the IDs into the string representation of this SshKeyName with pattern projects/{project}/locations/{location}/sshKeys/{ssh_key}.

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

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

The string representation of this SshKeyName with pattern projects/{project}/locations/{location}/sshKeys/{ssh_key}.

FromProjectLocationSshKey(string, string, string)

public static SshKeyName FromProjectLocationSshKey(string projectId, string locationId, string sshKeyId)

Creates a SshKeyName with the pattern projects/{project}/locations/{location}/sshKeys/{ssh_key}.

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

The SshKey ID. Must not be null or empty.
Returns
Type Description
SshKeyName

A new instance of SshKeyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SshKeyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SshKeyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
sshKeyName string

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

The parsed SshKeyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sshKeys/{ssh_key}

Parse(string, bool)

public static SshKeyName Parse(string sshKeyName, bool allowUnparsed)

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

Parameters
Name Description
sshKeyName 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
SshKeyName

The parsed SshKeyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sshKeys/{ssh_key}
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 SshKeyName)

public static bool TryParse(string sshKeyName, out SshKeyName result)

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

Parameters
Name Description
sshKeyName string

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

When this method returns, the parsed SshKeyName, 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}/sshKeys/{ssh_key}

TryParse(string, bool, out SshKeyName)

public static bool TryParse(string sshKeyName, bool allowUnparsed, out SshKeyName result)

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

Parameters
Name Description
sshKeyName 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 SshKeyName

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

Operators

operator ==(SshKeyName, SshKeyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SshKeyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SshKeyName

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

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.