Class CustomDimensionName

Resource name for the CustomDimension resource.

Inheritance

System.Object

CustomDimensionName

Implements

Google.Api.Gax.IResourceName

System.IEquatable<CustomDimensionName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class CustomDimensionName : IResourceName, IEquatable<CustomDimensionName>

Constructors

CustomDimensionName(String)

Constructs a new instance of a CustomDimensionName class from the component parts of pattern properties/{property}/customDimensions

Declaration

public CustomDimensionName(string propertyId)

Parameters

Type	Name	Description
System.String	propertyId	The `Property` 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
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 CustomDimensionName.ResourceNameType of the contained resource name.

Declaration

public CustomDimensionName.ResourceNameType Type { get; }

Property Value

Type	Description
CustomDimensionName.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)

Formats the IDs into the string representation of this CustomDimensionName with pattern properties/{property}/customDimensions.

Declaration

public static string Format(string propertyId)

Parameters

Type	Name	Description
System.String	propertyId	The `Property` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this CustomDimensionName with pattern `properties/{property}/customDimensions`.

FormatProperty(String)

Formats the IDs into the string representation of this CustomDimensionName with pattern properties/{property}/customDimensions.

Declaration

public static string FormatProperty(string propertyId)

Parameters

Type	Name	Description
System.String	propertyId	The `Property` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this CustomDimensionName with pattern `properties/{property}/customDimensions`.

FromProperty(String)

Creates a CustomDimensionName with the pattern properties/{property}/customDimensions.

Declaration

public static CustomDimensionName FromProperty(string propertyId)

Parameters

Type	Name	Description
System.String	propertyId	The `Property` ID. Must not be `null` or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CustomDimensionName containing an unparsed resource name.

Declaration

public static CustomDimensionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
Google.Api.Gax.UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be `null`.

Returns

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

Declaration

public static CustomDimensionName Parse(string customDimensionName)

Parameters

Type	Name	Description
System.String	customDimensionName	The resource name in string form. Must not be `null`.

Returns

Type	Description
CustomDimensionName	The parsed CustomDimensionName if successful.

Remarks

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

properties/{property}/customDimensions

Parse(String, Boolean)

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

Declaration

public static CustomDimensionName Parse(string customDimensionName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	customDimensionName	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
CustomDimensionName	The parsed CustomDimensionName if successful.

Remarks

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

properties/{property}/customDimensions

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

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

Declaration

public static bool TryParse(string customDimensionName, out CustomDimensionName result)

Parameters

Type	Name	Description
System.String	customDimensionName	The resource name in string form. Must not be `null`.
CustomDimensionName	result	When this method returns, the parsed CustomDimensionName, 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}/customDimensions

TryParse(String, Boolean, out CustomDimensionName)

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

Declaration

public static bool TryParse(string customDimensionName, bool allowUnparsed, out CustomDimensionName result)

Parameters

Type	Name	Description
System.String	customDimensionName	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.
CustomDimensionName	result	When this method returns, the parsed CustomDimensionName, 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}/customDimensions

Or may be in any format if allowUnparsed is true.

Operators

Equality(CustomDimensionName, CustomDimensionName)

Declaration

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

Parameters

Type	Name	Description
CustomDimensionName	a
CustomDimensionName	b

Returns

Type	Description
System.Boolean

Inequality(CustomDimensionName, CustomDimensionName)

Declaration

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

Parameters

Type	Name	Description
CustomDimensionName	a
CustomDimensionName	b

Returns

Type	Description
System.Boolean