Class ConversionEventName

Resource name for the ConversionEvent resource.

Inheritance

object

ConversionEventName

Implements

IResourceName

IEquatable<ConversionEventName>

Inherited Members

object.GetType()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class ConversionEventName : IResourceName, IEquatable<ConversionEventName>

Constructors

ConversionEventName(string, string)

Constructs a new instance of a ConversionEventName class from the component parts of pattern properties/{property}/conversionEvents/{conversion_event}

Declaration

public ConversionEventName(string propertyId, string conversionEventId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	conversionEventId	The ConversionEvent ID. Must not be null or empty.

Properties

ConversionEventId

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

Declaration

public string ConversionEventId { 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

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
string

Type

The ConversionEventName.ResourceNameType of the contained resource name.

Declaration

public ConversionEventName.ResourceNameType Type { get; }

Property Value

Type	Description
ConversionEventName.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 ConversionEventName with pattern properties/{property}/conversionEvents/{conversion_event}.

Declaration

public static string Format(string propertyId, string conversionEventId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	conversionEventId	The ConversionEvent ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this ConversionEventName with pattern properties/{property}/conversionEvents/{conversion_event}.

FormatPropertyConversionEvent(string, string)

Formats the IDs into the string representation of this ConversionEventName with pattern properties/{property}/conversionEvents/{conversion_event}.

Declaration

public static string FormatPropertyConversionEvent(string propertyId, string conversionEventId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	conversionEventId	The ConversionEvent ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this ConversionEventName with pattern properties/{property}/conversionEvents/{conversion_event}.

FromPropertyConversionEvent(string, string)

Creates a ConversionEventName with the pattern properties/{property}/conversionEvents/{conversion_event}.

Declaration

public static ConversionEventName FromPropertyConversionEvent(string propertyId, string conversionEventId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	conversionEventId	The ConversionEvent ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a ConversionEventName containing an unparsed resource name.

Declaration

public static ConversionEventName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static ConversionEventName Parse(string conversionEventName)

Parameters

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

Returns

Type	Description
ConversionEventName	The parsed ConversionEventName if successful.

Remarks

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

• properties/{property}/conversionEvents/{conversion_event}

Parse(string, bool)

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

Declaration

public static ConversionEventName Parse(string conversionEventName, bool allowUnparsed)

Parameters

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

Remarks

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

• properties/{property}/conversionEvents/{conversion_event}

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

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

Declaration

public static bool TryParse(string conversionEventName, out ConversionEventName result)

Parameters

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

• properties/{property}/conversionEvents/{conversion_event}

TryParse(string, bool, out ConversionEventName)

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

Declaration

public static bool TryParse(string conversionEventName, bool allowUnparsed, out ConversionEventName result)

Parameters

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

• properties/{property}/conversionEvents/{conversion_event}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ConversionEventName, ConversionEventName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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