Class ProfileName

Resource name for the Profile resource.

Inheritance

object

ProfileName

Implements

IResourceName

IEquatable<ProfileName>

Inherited Members

object.GetType()

Namespace: Google.DevicesAndServices.Health.V4

Assembly: Google.DevicesAndServices.Health.V4.dll

Syntax

public sealed class ProfileName : IResourceName, IEquatable<ProfileName>

Constructors

ProfileName(string)

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

Declaration

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

Declaration

public ProfileName.ResourceNameType Type { get; }

Property Value

Type	Description
ProfileName.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 ProfileName with pattern users/{user}/profile.

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

FormatUser(string)

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

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

FromUnparsed(UnparsedResourceName)

Creates a ProfileName containing an unparsed resource name.

Declaration

public static ProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

FromUser(string)

Creates a ProfileName with the pattern users/{user}/profile.

Declaration

public static ProfileName FromUser(string userId)

Parameters

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

Returns

Type	Description
ProfileName	A new instance of ProfileName 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 ProfileName instance.

Declaration

public static ProfileName Parse(string profileName)

Parameters

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

Returns

Type	Description
ProfileName	The parsed ProfileName if successful.

Remarks

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

• users/{user}/profile

Parse(string, bool)

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

Declaration

public static ProfileName Parse(string profileName, bool allowUnparsed)

Parameters

Type	Name	Description
string	profileName	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
ProfileName	The parsed ProfileName if successful.

Remarks

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

• users/{user}/profile

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

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

Declaration

public static bool TryParse(string profileName, out ProfileName result)

Parameters

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

TryParse(string, bool, out ProfileName)

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

Declaration

public static bool TryParse(string profileName, bool allowUnparsed, out ProfileName result)

Parameters

Type	Name	Description
string	profileName	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.
ProfileName	result	When this method returns, the parsed ProfileName, 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}/profile

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProfileName, ProfileName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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