Class MetadataName

Resource name for the Metadata resource.

Inheritance

object

MetadataName

Implements

IResourceName

IEquatable<MetadataName>

Inherited Members

object.GetType()

Namespace: Google.Analytics.Data.V1Beta

Assembly: Google.Analytics.Data.V1Beta.dll

Syntax

public sealed class MetadataName : IResourceName, IEquatable<MetadataName>

Constructors

MetadataName(string)

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

Declaration

public MetadataName(string propertyId)

Parameters

Type	Name	Description
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
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 MetadataName.ResourceNameType of the contained resource name.

Declaration

public MetadataName.ResourceNameType Type { get; }

Property Value

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

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

Declaration

public static string Format(string propertyId)

Parameters

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

Returns

Type	Description
string	The string representation of this MetadataName with pattern `properties/{property}/metadata` .

FormatProperty(string)

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

Declaration

public static string FormatProperty(string propertyId)

Parameters

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

Returns

Type	Description
string	The string representation of this MetadataName with pattern `properties/{property}/metadata` .

FromProperty(string)

Creates a MetadataName with the pattern properties/{property}/metadata.

Declaration

public static MetadataName FromProperty(string propertyId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a MetadataName containing an unparsed resource name.

Declaration

public static MetadataName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static MetadataName Parse(string metadataName)

Parameters

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

Returns

Type	Description
MetadataName	The parsed MetadataName if successful.

Remarks

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

properties/{property}/metadata

Parse(string, bool)

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

Declaration

public static MetadataName Parse(string metadataName, bool allowUnparsed)

Parameters

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

Remarks

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

properties/{property}/metadata

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

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

Declaration

public static bool TryParse(string metadataName, out MetadataName result)

Parameters

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

TryParse(string, bool, out MetadataName)

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

Declaration

public static bool TryParse(string metadataName, bool allowUnparsed, out MetadataName result)

Parameters

Type	Name	Description
string	metadataName	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.
MetadataName	result	When this method returns, the parsed MetadataName, 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}/metadata

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MetadataName, MetadataName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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