Class IdentityName

Resource name for the Identity resource.

Inheritance

object

IdentityName

Implements

IResourceName

IEquatable<IdentityName>

Inherited Members

object.GetType()

Namespace: Google.DevicesAndServices.Health.V4

Assembly: Google.DevicesAndServices.Health.V4.dll

Syntax

public sealed class IdentityName : IResourceName, IEquatable<IdentityName>

Constructors

IdentityName(string)

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

Declaration

public IdentityName(string userId)

Parameters

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

Properties

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

Type

The IdentityName.ResourceNameType of the contained resource name.

Declaration

public IdentityName.ResourceNameType Type { get; }

Property Value

Type	Description
IdentityName.ResourceNameType

UnparsedResource

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

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

UserId

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

Declaration

public string UserId { get; }

Property Value

Type	Description
string

Methods

Format(string)

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

Declaration

public static string Format(string userId)

Parameters

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

Returns

Type	Description
string	The string representation of this IdentityName with pattern users/{user}/identity.

FormatUser(string)

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

Declaration

public static string FormatUser(string userId)

Parameters

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

Returns

Type	Description
string	The string representation of this IdentityName with pattern users/{user}/identity.

FromUnparsed(UnparsedResourceName)

Creates a IdentityName containing an unparsed resource name.

Declaration

public static IdentityName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
IdentityName	A new instance of IdentityName containing the provided unparsedResourceName .

FromUser(string)

Creates a IdentityName with the pattern users/{user}/identity.

Declaration

public static IdentityName FromUser(string userId)

Parameters

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

Returns

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

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

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

Declaration

public static IdentityName Parse(string identityName)

Parameters

Type	Name	Description
string	identityName	The resource name in string form. Must not be null.

Returns

Type	Description
IdentityName	The parsed IdentityName if successful.

Remarks

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

• users/{user}/identity

Parse(string, bool)

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

Declaration

public static IdentityName Parse(string identityName, bool allowUnparsed)

Parameters

Type	Name	Description
string	identityName	The resource name in string form. Must not be null.
bool	allowUnparsed	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
IdentityName	The parsed IdentityName if successful.

Remarks

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

• users/{user}/identity

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out IdentityName)

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

Declaration

public static bool TryParse(string identityName, out IdentityName result)

Parameters

Type	Name	Description
string	identityName	The resource name in string form. Must not be null.
IdentityName	result	When this method returns, the parsed IdentityName, 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}/identity

TryParse(string, bool, out IdentityName)

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

Declaration

public static bool TryParse(string identityName, bool allowUnparsed, out IdentityName result)

Parameters

Type	Name	Description
string	identityName	The resource name in string form. Must not be null.
bool	allowUnparsed	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.
IdentityName	result	When this method returns, the parsed IdentityName, 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}/identity

Or may be in any format if allowUnparsed is true.

Operators

operator ==(IdentityName, IdentityName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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