Class CustomMetricName

Resource name for the CustomMetric resource.

Inheritance

object

CustomMetricName

Implements

IResourceName

IEquatable<CustomMetricName>

Inherited Members

object.GetType()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class CustomMetricName : IResourceName, IEquatable<CustomMetricName>

Constructors

CustomMetricName(string, string)

Constructs a new instance of a CustomMetricName class from the component parts of pattern properties/{property}/customMetrics/{custom_metric}

Declaration

public CustomMetricName(string propertyId, string customMetricId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	customMetricId	The CustomMetric ID. Must not be null or empty.

Properties

CustomMetricId

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

Declaration

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

Declaration

public CustomMetricName.ResourceNameType Type { get; }

Property Value

Type	Description
CustomMetricName.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 CustomMetricName with pattern properties/{property}/customMetrics/{custom_metric}.

Declaration

public static string Format(string propertyId, string customMetricId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	customMetricId	The CustomMetric ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CustomMetricName with pattern properties/{property}/customMetrics/{custom_metric}.

FormatPropertyCustomMetric(string, string)

Formats the IDs into the string representation of this CustomMetricName with pattern properties/{property}/customMetrics/{custom_metric}.

Declaration

public static string FormatPropertyCustomMetric(string propertyId, string customMetricId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	customMetricId	The CustomMetric ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CustomMetricName with pattern properties/{property}/customMetrics/{custom_metric}.

FromPropertyCustomMetric(string, string)

Creates a CustomMetricName with the pattern properties/{property}/customMetrics/{custom_metric}.

Declaration

public static CustomMetricName FromPropertyCustomMetric(string propertyId, string customMetricId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	customMetricId	The CustomMetric ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CustomMetricName containing an unparsed resource name.

Declaration

public static CustomMetricName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static CustomMetricName Parse(string customMetricName)

Parameters

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

Returns

Type	Description
CustomMetricName	The parsed CustomMetricName if successful.

Remarks

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

• properties/{property}/customMetrics/{custom_metric}

Parse(string, bool)

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

Declaration

public static CustomMetricName Parse(string customMetricName, bool allowUnparsed)

Parameters

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

Remarks

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

• properties/{property}/customMetrics/{custom_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 CustomMetricName)

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

Declaration

public static bool TryParse(string customMetricName, out CustomMetricName result)

Parameters

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

TryParse(string, bool, out CustomMetricName)

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

Declaration

public static bool TryParse(string customMetricName, bool allowUnparsed, out CustomMetricName result)

Parameters

Type	Name	Description
string	customMetricName	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.
CustomMetricName	result	When this method returns, the parsed CustomMetricName, 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}/customMetrics/{custom_metric}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CustomMetricName, CustomMetricName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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