Show / Hide Table of Contents

Class IrnProfileName

Resource name for the IrnProfile resource.

Inheritance
object
IrnProfileName
Implements
IResourceName
IEquatable<IrnProfileName>
Inherited Members
object.GetType()
Namespace: Google.DevicesAndServices.Health.V4
Assembly: Google.DevicesAndServices.Health.V4.dll
Syntax
public sealed class IrnProfileName : IResourceName, IEquatable<IrnProfileName>

Constructors

IrnProfileName(string)

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

Declaration
public IrnProfileName(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 IrnProfileName.ResourceNameType of the contained resource name.

Declaration
public IrnProfileName.ResourceNameType Type { get; }
Property Value
Type Description
IrnProfileName.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 IrnProfileName with pattern users/{user}/irnProfile.

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 IrnProfileName with pattern users/{user}/irnProfile.

FormatUser(string)

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

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 IrnProfileName with pattern users/{user}/irnProfile.

FromUnparsed(UnparsedResourceName)

Creates a IrnProfileName containing an unparsed resource name.

Declaration
public static IrnProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
IrnProfileName

A new instance of IrnProfileName containing the provided unparsedResourceName.

FromUser(string)

Creates a IrnProfileName with the pattern users/{user}/irnProfile.

Declaration
public static IrnProfileName FromUser(string userId)
Parameters
Type Name Description
string userId

The User ID. Must not be null or empty.

Returns
Type Description
IrnProfileName

A new instance of IrnProfileName 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 IrnProfileName instance.

Declaration
public static IrnProfileName Parse(string irnProfileName)
Parameters
Type Name Description
string irnProfileName

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

Returns
Type Description
IrnProfileName

The parsed IrnProfileName if successful.

Remarks

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

  • users/{user}/irnProfile

Parse(string, bool)

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

Declaration
public static IrnProfileName Parse(string irnProfileName, bool allowUnparsed)
Parameters
Type Name Description
string irnProfileName

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
IrnProfileName

The parsed IrnProfileName if successful.

Remarks

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

  • users/{user}/irnProfile

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

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

Declaration
public static bool TryParse(string irnProfileName, out IrnProfileName result)
Parameters
Type Name Description
string irnProfileName

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

IrnProfileName result

When this method returns, the parsed IrnProfileName, 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}/irnProfile

TryParse(string, bool, out IrnProfileName)

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

Declaration
public static bool TryParse(string irnProfileName, bool allowUnparsed, out IrnProfileName result)
Parameters
Type Name Description
string irnProfileName

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.

IrnProfileName result

When this method returns, the parsed IrnProfileName, 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}/irnProfile

Or may be in any format if allowUnparsed is true.

Operators

operator ==(IrnProfileName, IrnProfileName)

Determines whether two specified resource names have the same value.

Declaration
public static bool operator ==(IrnProfileName a, IrnProfileName b)
Parameters
Type Name Description
IrnProfileName a

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

Declaration
public static bool operator !=(IrnProfileName a, IrnProfileName b)
Parameters
Type Name Description
IrnProfileName a

The first resource name to compare, or null.

IrnProfileName 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.

In this article
Back to top Generated by DocFX