Class CalculatedMetricName

Resource name for the CalculatedMetric resource.

Inheritance

object

CalculatedMetricName

Implements

IResourceName

IEquatable<CalculatedMetricName>

Inherited Members

object.GetType()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class CalculatedMetricName : IResourceName, IEquatable<CalculatedMetricName>

Constructors

CalculatedMetricName(string, string)

Constructs a new instance of a CalculatedMetricName class from the component parts of pattern properties/{property}/calculatedMetrics/{calculated_metric}

Declaration

public CalculatedMetricName(string propertyId, string calculatedMetricId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	calculatedMetricId	The CalculatedMetric ID. Must not be null or empty.

Properties

CalculatedMetricId

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

Declaration

public string CalculatedMetricId { 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 CalculatedMetricName.ResourceNameType of the contained resource name.

Declaration

public CalculatedMetricName.ResourceNameType Type { get; }

Property Value

Type	Description
CalculatedMetricName.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 CalculatedMetricName with pattern properties/{property}/calculatedMetrics/{calculated_metric}.

Declaration

public static string Format(string propertyId, string calculatedMetricId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	calculatedMetricId	The CalculatedMetric ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CalculatedMetricName with pattern properties/{property}/calculatedMetrics/{calculated_metric}.

FormatPropertyCalculatedMetric(string, string)

Formats the IDs into the string representation of this CalculatedMetricName with pattern properties/{property}/calculatedMetrics/{calculated_metric}.

Declaration

public static string FormatPropertyCalculatedMetric(string propertyId, string calculatedMetricId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	calculatedMetricId	The CalculatedMetric ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CalculatedMetricName with pattern properties/{property}/calculatedMetrics/{calculated_metric}.

FromPropertyCalculatedMetric(string, string)

Creates a CalculatedMetricName with the pattern properties/{property}/calculatedMetrics/{calculated_metric}.

Declaration

public static CalculatedMetricName FromPropertyCalculatedMetric(string propertyId, string calculatedMetricId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	calculatedMetricId	The CalculatedMetric ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CalculatedMetricName containing an unparsed resource name.

Declaration

public static CalculatedMetricName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static CalculatedMetricName Parse(string calculatedMetricName)

Parameters

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

Returns

Type	Description
CalculatedMetricName	The parsed CalculatedMetricName if successful.

Remarks

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

• properties/{property}/calculatedMetrics/{calculated_metric}

Parse(string, bool)

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

Declaration

public static CalculatedMetricName Parse(string calculatedMetricName, bool allowUnparsed)

Parameters

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

Remarks

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

• properties/{property}/calculatedMetrics/{calculated_metric}

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

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

Declaration

public static bool TryParse(string calculatedMetricName, out CalculatedMetricName result)

Parameters

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

TryParse(string, bool, out CalculatedMetricName)

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

Declaration

public static bool TryParse(string calculatedMetricName, bool allowUnparsed, out CalculatedMetricName result)

Parameters

Type	Name	Description
string	calculatedMetricName	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.
CalculatedMetricName	result	When this method returns, the parsed CalculatedMetricName, 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}/calculatedMetrics/{calculated_metric}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CalculatedMetricName, CalculatedMetricName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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