Class SubscriberName

Resource name for the Subscriber resource.

Inheritance

object

SubscriberName

Implements

IResourceName

IEquatable<SubscriberName>

Inherited Members

object.GetType()

Namespace: Google.DevicesAndServices.Health.V4

Assembly: Google.DevicesAndServices.Health.V4.dll

Syntax

public sealed class SubscriberName : IResourceName, IEquatable<SubscriberName>

Constructors

SubscriberName(string, string)

Constructs a new instance of a SubscriberName class from the component parts of pattern projects/{project}/subscribers/{subscriber}

Declaration

public SubscriberName(string projectId, string subscriberId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	subscriberId	The Subscriber 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

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
string

SubscriberId

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

Declaration

public string SubscriberId { get; }

Property Value

Type	Description
string

Type

The SubscriberName.ResourceNameType of the contained resource name.

Declaration

public SubscriberName.ResourceNameType Type { get; }

Property Value

Type	Description
SubscriberName.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

Methods

Format(string, string)

Formats the IDs into the string representation of this SubscriberName with pattern projects/{project}/subscribers/{subscriber}.

Declaration

public static string Format(string projectId, string subscriberId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	subscriberId	The Subscriber ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this SubscriberName with pattern projects/{project}/subscribers/{subscriber}.

FormatProjectSubscriber(string, string)

Formats the IDs into the string representation of this SubscriberName with pattern projects/{project}/subscribers/{subscriber}.

Declaration

public static string FormatProjectSubscriber(string projectId, string subscriberId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	subscriberId	The Subscriber ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this SubscriberName with pattern projects/{project}/subscribers/{subscriber}.

FromProjectSubscriber(string, string)

Creates a SubscriberName with the pattern projects/{project}/subscribers/{subscriber}.

Declaration

public static SubscriberName FromProjectSubscriber(string projectId, string subscriberId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	subscriberId	The Subscriber ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a SubscriberName containing an unparsed resource name.

Declaration

public static SubscriberName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

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 SubscriberName instance.

Declaration

public static SubscriberName Parse(string subscriberName)

Parameters

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

Returns

Type	Description
SubscriberName	The parsed SubscriberName if successful.

Remarks

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

• projects/{project}/subscribers/{subscriber}

Parse(string, bool)

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

Declaration

public static SubscriberName Parse(string subscriberName, bool allowUnparsed)

Parameters

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

Remarks

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

• projects/{project}/subscribers/{subscriber}

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

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

Declaration

public static bool TryParse(string subscriberName, out SubscriberName result)

Parameters

Type	Name	Description
string	subscriberName	The resource name in string form. Must not be null.
SubscriberName	result	When this method returns, the parsed SubscriberName, 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:

• projects/{project}/subscribers/{subscriber}

TryParse(string, bool, out SubscriberName)

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

Declaration

public static bool TryParse(string subscriberName, bool allowUnparsed, out SubscriberName result)

Parameters

Type	Name	Description
string	subscriberName	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.
SubscriberName	result	When this method returns, the parsed SubscriberName, 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:

• projects/{project}/subscribers/{subscriber}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SubscriberName, SubscriberName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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