Class UserListName

Resource name for the UserList resource.

Inheritance

object

UserListName

Implements

IResourceName

IEquatable<UserListName>

Inherited Members

object.GetType()

Namespace: Google.Ads.DataManager.V1

Assembly: Google.Ads.DataManager.V1.dll

Syntax

public sealed class UserListName : IResourceName, IEquatable<UserListName>

Constructors

UserListName(string, string, string)

Constructs a new instance of a UserListName class from the component parts of pattern accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

Declaration

public UserListName(string accountTypeId, string accountId, string userListId)

Parameters

Type	Name	Description
string	accountTypeId	The AccountType ID. Must not be null or empty.
string	accountId	The Account ID. Must not be null or empty.
string	userListId	The UserList ID. Must not be null or empty.

Properties

AccountId

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

Declaration

public string AccountId { get; }

Property Value

Type	Description
string

AccountTypeId

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

Declaration

public string AccountTypeId { 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

Type

The UserListName.ResourceNameType of the contained resource name.

Declaration

public UserListName.ResourceNameType Type { get; }

Property Value

Type	Description
UserListName.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

UserListId

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

Declaration

public string UserListId { get; }

Property Value

Type	Description
string

Methods

Format(string, string, string)

Formats the IDs into the string representation of this UserListName with pattern accountTypes/{account_type}/accounts/{account}/userLists/{user_list}.

Declaration

public static string Format(string accountTypeId, string accountId, string userListId)

Parameters

Type	Name	Description
string	accountTypeId	The AccountType ID. Must not be null or empty.
string	accountId	The Account ID. Must not be null or empty.
string	userListId	The UserList ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this UserListName with pattern accountTypes/{account_type}/accounts/{account}/userLists/{user_list}.

FormatAccountTypeAccountUserList(string, string, string)

Formats the IDs into the string representation of this UserListName with pattern accountTypes/{account_type}/accounts/{account}/userLists/{user_list}.

Declaration

public static string FormatAccountTypeAccountUserList(string accountTypeId, string accountId, string userListId)

Parameters

Type	Name	Description
string	accountTypeId	The AccountType ID. Must not be null or empty.
string	accountId	The Account ID. Must not be null or empty.
string	userListId	The UserList ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this UserListName with pattern accountTypes/{account_type}/accounts/{account}/userLists/{user_list}.

FromAccountTypeAccountUserList(string, string, string)

Creates a UserListName with the pattern accountTypes/{account_type}/accounts/{account}/userLists/{user_list}.

Declaration

public static UserListName FromAccountTypeAccountUserList(string accountTypeId, string accountId, string userListId)

Parameters

Type	Name	Description
string	accountTypeId	The AccountType ID. Must not be null or empty.
string	accountId	The Account ID. Must not be null or empty.
string	userListId	The UserList ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a UserListName containing an unparsed resource name.

Declaration

public static UserListName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static UserListName Parse(string userListName)

Parameters

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

Returns

Type	Description
UserListName	The parsed UserListName if successful.

Remarks

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

• accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

Parse(string, bool)

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

Declaration

public static UserListName Parse(string userListName, bool allowUnparsed)

Parameters

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

Remarks

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

• accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

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

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

Declaration

public static bool TryParse(string userListName, out UserListName result)

Parameters

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

• accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

TryParse(string, bool, out UserListName)

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

Declaration

public static bool TryParse(string userListName, bool allowUnparsed, out UserListName result)

Parameters

Type	Name	Description
string	userListName	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.
UserListName	result	When this method returns, the parsed UserListName, 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:

• accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(UserListName, UserListName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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