Class PropertyName

Resource name for the Property resource.

Inheritance

object

PropertyName

Implements

IResourceName

IEquatable<PropertyName>

Inherited Members

object.GetType()

Namespace: Google.Ads.MarketingPlatform.Admin.V1Alpha

Assembly: Google.Ads.MarketingPlatform.Admin.V1Alpha.dll

Syntax

public sealed class PropertyName : IResourceName, IEquatable<PropertyName>

Constructors

PropertyName(string)

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

Declaration

public PropertyName(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 PropertyName.ResourceNameType of the contained resource name.

Declaration

public PropertyName.ResourceNameType Type { get; }

Property Value

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

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 PropertyName with pattern `properties/{property}`.

FormatProperty(string)

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

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 PropertyName with pattern `properties/{property}`.

FromProperty(string)

Creates a PropertyName with the pattern properties/{property}.

Declaration

public static PropertyName FromProperty(string propertyId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a PropertyName containing an unparsed resource name.

Declaration

public static PropertyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static PropertyName Parse(string propertyName)

Parameters

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

Returns

Type	Description
PropertyName	The parsed PropertyName if successful.

Remarks

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

properties/{property}

Parse(string, bool)

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

Declaration

public static PropertyName Parse(string propertyName, bool allowUnparsed)

Parameters

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

Remarks

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

properties/{property}

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

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

Declaration

public static bool TryParse(string propertyName, out PropertyName result)

Parameters

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

TryParse(string, bool, out PropertyName)

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

Declaration

public static bool TryParse(string propertyName, bool allowUnparsed, out PropertyName result)

Parameters

Type	Name	Description
string	propertyName	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.
PropertyName	result	When this method returns, the parsed PropertyName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PropertyName, PropertyName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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