Class DataPointName

Resource name for the DataPoint resource.

Inheritance

object

DataPointName

Implements

IResourceName

IEquatable<DataPointName>

Inherited Members

object.GetType()

Namespace: Google.DevicesAndServices.Health.V4

Assembly: Google.DevicesAndServices.Health.V4.dll

Syntax

public sealed class DataPointName : IResourceName, IEquatable<DataPointName>

Constructors

DataPointName(string, string, string)

Constructs a new instance of a DataPointName class from the component parts of pattern users/{user}/dataTypes/{data_type}/dataPoints/{data_point}

Declaration

public DataPointName(string userId, string dataTypeId, string dataPointId)

Parameters

Type	Name	Description
string	userId	The User ID. Must not be null or empty.
string	dataTypeId	The DataType ID. Must not be null or empty.
string	dataPointId	The DataPoint ID. Must not be null or empty.

Properties

DataPointId

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

Declaration

public string DataPointId { get; }

Property Value

Type	Description
string

DataTypeId

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

Declaration

public string DataTypeId { get; }

Property Value

Type	Description
string

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 DataPointName.ResourceNameType of the contained resource name.

Declaration

public DataPointName.ResourceNameType Type { get; }

Property Value

Type	Description
DataPointName.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, string, string)

Formats the IDs into the string representation of this DataPointName with pattern users/{user}/dataTypes/{data_type}/dataPoints/{data_point}.

Declaration

public static string Format(string userId, string dataTypeId, string dataPointId)

Parameters

Type	Name	Description
string	userId	The User ID. Must not be null or empty.
string	dataTypeId	The DataType ID. Must not be null or empty.
string	dataPointId	The DataPoint ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this DataPointName with pattern users/{user}/dataTypes/{data_type}/dataPoints/{data_point}.

FormatUserDataTypeDataPoint(string, string, string)

Formats the IDs into the string representation of this DataPointName with pattern users/{user}/dataTypes/{data_type}/dataPoints/{data_point}.

Declaration

public static string FormatUserDataTypeDataPoint(string userId, string dataTypeId, string dataPointId)

Parameters

Type	Name	Description
string	userId	The User ID. Must not be null or empty.
string	dataTypeId	The DataType ID. Must not be null or empty.
string	dataPointId	The DataPoint ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this DataPointName with pattern users/{user}/dataTypes/{data_type}/dataPoints/{data_point}.

FromUnparsed(UnparsedResourceName)

Creates a DataPointName containing an unparsed resource name.

Declaration

public static DataPointName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

FromUserDataTypeDataPoint(string, string, string)

Creates a DataPointName with the pattern users/{user}/dataTypes/{data_type}/dataPoints/{data_point}.

Declaration

public static DataPointName FromUserDataTypeDataPoint(string userId, string dataTypeId, string dataPointId)

Parameters

Type	Name	Description
string	userId	The User ID. Must not be null or empty.
string	dataTypeId	The DataType ID. Must not be null or empty.
string	dataPointId	The DataPoint ID. Must not be null or empty.

Returns

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

Declaration

public static DataPointName Parse(string dataPointName)

Parameters

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

Returns

Type	Description
DataPointName	The parsed DataPointName if successful.

Remarks

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

• users/{user}/dataTypes/{data_type}/dataPoints/{data_point}

Parse(string, bool)

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

Declaration

public static DataPointName Parse(string dataPointName, bool allowUnparsed)

Parameters

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

Remarks

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

• users/{user}/dataTypes/{data_type}/dataPoints/{data_point}

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

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

Declaration

public static bool TryParse(string dataPointName, out DataPointName result)

Parameters

Type	Name	Description
string	dataPointName	The resource name in string form. Must not be null.
DataPointName	result	When this method returns, the parsed DataPointName, 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}/dataTypes/{data_type}/dataPoints/{data_point}

TryParse(string, bool, out DataPointName)

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

Declaration

public static bool TryParse(string dataPointName, bool allowUnparsed, out DataPointName result)

Parameters

Type	Name	Description
string	dataPointName	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.
DataPointName	result	When this method returns, the parsed DataPointName, 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}/dataTypes/{data_type}/dataPoints/{data_point}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataPointName, DataPointName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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