Show / Hide Table of Contents

Class FirebaseLinkName

Resource name for the FirebaseLink resource.

Inheritance
System.Object
FirebaseLinkName
Implements
Google.Api.Gax.IResourceName
System.IEquatable<FirebaseLinkName>
Inherited Members
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Analytics.Admin.V1Alpha
Assembly: Google.Analytics.Admin.V1Alpha.dll
Syntax
public sealed class FirebaseLinkName : IResourceName, IEquatable<FirebaseLinkName>

Constructors

FirebaseLinkName(String, String)

Constructs a new instance of a FirebaseLinkName class from the component parts of pattern properties/{property}/firebaseLinks/{firebase_link}

Declaration
public FirebaseLinkName(string propertyId, string firebaseLinkId)
Parameters
Type Name Description
System.String propertyId

The Property ID. Must not be null or empty.

System.String firebaseLinkId

The FirebaseLink ID. Must not be null or empty.

Properties

FirebaseLinkId

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

Declaration
public string FirebaseLinkId { get; }
Property Value
Type Description
System.String

IsKnownPattern

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

Declaration
public bool IsKnownPattern { get; }
Property Value
Type Description
System.Boolean
Implements
Google.Api.Gax.IResourceName.IsKnownPattern

PropertyId

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

Declaration
public string PropertyId { get; }
Property Value
Type Description
System.String

Type

The FirebaseLinkName.ResourceNameType of the contained resource name.

Declaration
public FirebaseLinkName.ResourceNameType Type { get; }
Property Value
Type Description
FirebaseLinkName.ResourceNameType

UnparsedResource

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

Declaration
public UnparsedResourceName UnparsedResource { get; }
Property Value
Type Description
Google.Api.Gax.UnparsedResourceName

Methods

Format(String, String)

Formats the IDs into the string representation of this FirebaseLinkName with pattern properties/{property}/firebaseLinks/{firebase_link}.

Declaration
public static string Format(string propertyId, string firebaseLinkId)
Parameters
Type Name Description
System.String propertyId

The Property ID. Must not be null or empty.

System.String firebaseLinkId

The FirebaseLink ID. Must not be null or empty.

Returns
Type Description
System.String

The string representation of this FirebaseLinkName with pattern properties/{property}/firebaseLinks/{firebase_link}.

FormatPropertyFirebaseLink(String, String)

Formats the IDs into the string representation of this FirebaseLinkName with pattern properties/{property}/firebaseLinks/{firebase_link}.

Declaration
public static string FormatPropertyFirebaseLink(string propertyId, string firebaseLinkId)
Parameters
Type Name Description
System.String propertyId

The Property ID. Must not be null or empty.

System.String firebaseLinkId

The FirebaseLink ID. Must not be null or empty.

Returns
Type Description
System.String

The string representation of this FirebaseLinkName with pattern properties/{property}/firebaseLinks/{firebase_link}.

FromPropertyFirebaseLink(String, String)

Creates a FirebaseLinkName with the pattern properties/{property}/firebaseLinks/{firebase_link}.

Declaration
public static FirebaseLinkName FromPropertyFirebaseLink(string propertyId, string firebaseLinkId)
Parameters
Type Name Description
System.String propertyId

The Property ID. Must not be null or empty.

System.String firebaseLinkId

The FirebaseLink ID. Must not be null or empty.

Returns
Type Description
FirebaseLinkName

A new instance of FirebaseLinkName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a FirebaseLinkName containing an unparsed resource name.

Declaration
public static FirebaseLinkName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
Google.Api.Gax.UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
FirebaseLinkName

A new instance of FirebaseLinkName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

Parse(String)

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

Declaration
public static FirebaseLinkName Parse(string firebaseLinkName)
Parameters
Type Name Description
System.String firebaseLinkName

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

Returns
Type Description
FirebaseLinkName

The parsed FirebaseLinkName if successful.

Remarks

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

  • properties/{property}/firebaseLinks/{firebase_link}

Parse(String, Boolean)

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

Declaration
public static FirebaseLinkName Parse(string firebaseLinkName, bool allowUnparsed)
Parameters
Type Name Description
System.String firebaseLinkName

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

System.Boolean allowUnparsed

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns
Type Description
FirebaseLinkName

The parsed FirebaseLinkName if successful.

Remarks

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

  • properties/{property}/firebaseLinks/{firebase_link}
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
System.String

The string representation of the resource name.

Overrides
System.Object.ToString()
Implements
Google.Api.Gax.IResourceName.ToString()

TryParse(String, out FirebaseLinkName)

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

Declaration
public static bool TryParse(string firebaseLinkName, out FirebaseLinkName result)
Parameters
Type Name Description
System.String firebaseLinkName

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

FirebaseLinkName result

When this method returns, the parsed FirebaseLinkName, or null if parsing failed.

Returns
Type Description
System.Boolean

true if the name was parsed successfully; false otherwise.

Remarks

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

  • properties/{property}/firebaseLinks/{firebase_link}

TryParse(String, Boolean, out FirebaseLinkName)

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

Declaration
public static bool TryParse(string firebaseLinkName, bool allowUnparsed, out FirebaseLinkName result)
Parameters
Type Name Description
System.String firebaseLinkName

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

System.Boolean allowUnparsed

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

FirebaseLinkName result

When this method returns, the parsed FirebaseLinkName, or null if parsing failed.

Returns
Type Description
System.Boolean

true if the name was parsed successfully; false otherwise.

Remarks

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

  • properties/{property}/firebaseLinks/{firebase_link}
Or may be in any format if allowUnparsed is true.

Operators

Equality(FirebaseLinkName, FirebaseLinkName)

Declaration
public static bool operator ==(FirebaseLinkName a, FirebaseLinkName b)
Parameters
Type Name Description
FirebaseLinkName a
FirebaseLinkName b
Returns
Type Description
System.Boolean

Inequality(FirebaseLinkName, FirebaseLinkName)

Declaration
public static bool operator !=(FirebaseLinkName a, FirebaseLinkName b)
Parameters
Type Name Description
FirebaseLinkName a
FirebaseLinkName b
Returns
Type Description
System.Boolean
Back to top