Class AudienceName

Resource name for the Audience resource.

Inheritance

object

AudienceName

Implements

IResourceName

IEquatable<AudienceName>

Inherited Members

object.GetType()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class AudienceName : IResourceName, IEquatable<AudienceName>

Constructors

AudienceName(string, string)

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

Declaration

public AudienceName(string propertyId, string audienceId)

Parameters

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

Properties

AudienceId

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

Declaration

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

Declaration

public AudienceName.ResourceNameType Type { get; }

Property Value

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

Declaration

public static string Format(string propertyId, string audienceId)

Parameters

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

Returns

Type	Description
string	The string representation of this AudienceName with pattern properties/{property}/audiences/{audience}.

FormatPropertyAudience(string, string)

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

Declaration

public static string FormatPropertyAudience(string propertyId, string audienceId)

Parameters

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

Returns

Type	Description
string	The string representation of this AudienceName with pattern properties/{property}/audiences/{audience}.

FromPropertyAudience(string, string)

Creates a AudienceName with the pattern properties/{property}/audiences/{audience}.

Declaration

public static AudienceName FromPropertyAudience(string propertyId, string audienceId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a AudienceName containing an unparsed resource name.

Declaration

public static AudienceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static AudienceName Parse(string audienceName)

Parameters

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

Returns

Type	Description
AudienceName	The parsed AudienceName if successful.

Remarks

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

• properties/{property}/audiences/{audience}

Parse(string, bool)

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

Declaration

public static AudienceName Parse(string audienceName, bool allowUnparsed)

Parameters

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

Remarks

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

• properties/{property}/audiences/{audience}

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

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

Declaration

public static bool TryParse(string audienceName, out AudienceName result)

Parameters

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

TryParse(string, bool, out AudienceName)

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

Declaration

public static bool TryParse(string audienceName, bool allowUnparsed, out AudienceName result)

Parameters

Type	Name	Description
string	audienceName	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.
AudienceName	result	When this method returns, the parsed AudienceName, 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}/audiences/{audience}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AudienceName, AudienceName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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