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

public sealed class PosixAccountName : IResourceName, IEquatable<PosixAccountName>

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

Resource name for the PosixAccount resource.

Inheritance

object > PosixAccountName

Namespace

Google.Cloud.OsLogin.Common

Assembly

Google.Cloud.OsLogin.Common.dll

Constructors

PosixAccountName(string, string)

public PosixAccountName(string userId, string projectId)

Constructs a new instance of a PosixAccountName class from the component parts of pattern users/{user}/projects/{project}

Parameters
Name Description
userId string

The User ID. Must not be null or empty.
projectId string

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

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

The PosixAccountName.ResourceNameType of the contained resource name.

Property Value
Type Description
PosixAccountNameResourceNameType

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

Formats the IDs into the string representation of this PosixAccountName with pattern users/{user}/projects/{project}.

Parameters
Name Description
userId string

The User ID. Must not be null or empty.
projectId string

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

The string representation of this PosixAccountName with pattern users/{user}/projects/{project}.

FormatUserProject(string, string)

public static string FormatUserProject(string userId, string projectId)

Formats the IDs into the string representation of this PosixAccountName with pattern users/{user}/projects/{project}.

Parameters
Name Description
userId string

The User ID. Must not be null or empty.
projectId string

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

The string representation of this PosixAccountName with pattern users/{user}/projects/{project}.

FromUnparsed(UnparsedResourceName)

public static PosixAccountName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PosixAccountName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of PosixAccountName containing the provided unparsedResourceName.

FromUserProject(string, string)

public static PosixAccountName FromUserProject(string userId, string projectId)

Creates a PosixAccountName with the pattern users/{user}/projects/{project}.

Parameters
Name Description
userId string

The User ID. Must not be null or empty.
projectId string

The Project ID. Must not be null or empty.
Returns
Type Description
PosixAccountName

A new instance of PosixAccountName constructed from the provided ids.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static PosixAccountName Parse(string posixAccountName)

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

Parameter
Name Description
posixAccountName string

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

The parsed PosixAccountName if successful.
Remarks

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

  • users/{user}/projects/{project}

Parse(string, bool)

public static PosixAccountName Parse(string posixAccountName, bool allowUnparsed)

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

Parameters
Name Description
posixAccountName 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
PosixAccountName

The parsed PosixAccountName if successful.
Remarks

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

  • users/{user}/projects/{project}
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 PosixAccountName)

public static bool TryParse(string posixAccountName, out PosixAccountName result)

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

Parameters
Name Description
posixAccountName string

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

When this method returns, the parsed PosixAccountName, 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}/projects/{project}

TryParse(string, bool, out PosixAccountName)

public static bool TryParse(string posixAccountName, bool allowUnparsed, out PosixAccountName result)

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

Parameters
Name Description
posixAccountName 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 PosixAccountName

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

Operators

operator ==(PosixAccountName, PosixAccountName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PosixAccountName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PosixAccountName

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

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.