Google.Cloud.OsLogin.Common - Class UserName (3.1.0)

public sealed class UserName : IResourceName, IEquatable<UserName>

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

Resource name for the User resource.

Inheritance

object > UserName

Implements

IResourceName, IEquatable UserName

Inherited Members

object.GetType()

object.MemberwiseClone()

Namespace

GoogleGoogle.CloudGoogle.Cloud.OsLoginCommon

Assembly

Google.Cloud.OsLogin.Common.dll

Constructors

UserName(string)

public UserName(string userId)

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

Parameter
Name	Description
`userId`	`string` The `User` 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`

Type

public UserName.ResourceNameType Type { get; }

The UserName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`UserNameResourceNameType`

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)

public static string Format(string userId)

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

Parameter
Name	Description
`userId`	`string` The `User` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this UserName with pattern `users/{user}`.

FormatUser(string)

public static string FormatUser(string userId)

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

Parameter
Name	Description
`userId`	`string` The `User` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this UserName with pattern `users/{user}`.

FromUnparsed(UnparsedResourceName)

public static UserName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UserName containing an unparsed resource name.

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

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

FromUser(string)

public static UserName FromUser(string userId)

Creates a UserName with the pattern users/{user}.

Parameter
Name	Description
`userId`	`string` The `User` ID. Must not be `null` or empty.

Returns
Type	Description
`UserName`	A new instance of UserName 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 UserName Parse(string userName)

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

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

Returns
Type	Description
`UserName`	The parsed UserName if successful.

Remarks

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

users/{user}

Parse(string, bool)

public static UserName Parse(string userName, bool allowUnparsed)

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

Parameters
Name	Description
`userName`	`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
`UserName`	The parsed UserName if successful.

Remarks

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

users/{user}

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

public static bool TryParse(string userName, out UserName result)

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

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

TryParse(string, bool, out UserName)

public static bool TryParse(string userName, bool allowUnparsed, out UserName result)

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

Parameters
Name	Description
`userName`	`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`	`UserName` When this method returns, the parsed UserName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(UserName, UserName)

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

Parameters
Name	Description
`a`	`UserName`
`b`	`UserName`

Returns
Type	Description
`bool`

operator !=(UserName, UserName)

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

Parameters
Name	Description
`a`	`UserName`
`b`	`UserName`

Returns
Type	Description
`bool`