Class UserGroupMemberName

Resource name for the UserGroupMember resource.

Inheritance

object

UserGroupMemberName

Implements

IResourceName

IEquatable<UserGroupMemberName>

Inherited Members

object.GetType()

Namespace: Google.Ads.MarketingPlatform.Admin.V1Alpha

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

Syntax

public sealed class UserGroupMemberName : IResourceName, IEquatable<UserGroupMemberName>

Constructors

UserGroupMemberName(string, string, string)

Constructs a new instance of a UserGroupMemberName class from the component parts of pattern organizations/{organization}/userGroups/{user_group}/members/{member}

Declaration

public UserGroupMemberName(string organizationId, string userGroupId, string memberId)

Parameters

Type	Name	Description
string	organizationId	The Organization ID. Must not be null or empty.
string	userGroupId	The UserGroup ID. Must not be null or empty.
string	memberId	The Member 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

MemberId

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

Declaration

public string MemberId { get; }

Property Value

Type	Description
string

OrganizationId

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

Declaration

public string OrganizationId { get; }

Property Value

Type	Description
string

Type

The UserGroupMemberName.ResourceNameType of the contained resource name.

Declaration

public UserGroupMemberName.ResourceNameType Type { get; }

Property Value

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

UserGroupId

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

Declaration

public string UserGroupId { get; }

Property Value

Type	Description
string

Methods

Format(string, string, string)

Formats the IDs into the string representation of this UserGroupMemberName with pattern organizations/{organization}/userGroups/{user_group}/members/{member}.

Declaration

public static string Format(string organizationId, string userGroupId, string memberId)

Parameters

Type	Name	Description
string	organizationId	The Organization ID. Must not be null or empty.
string	userGroupId	The UserGroup ID. Must not be null or empty.
string	memberId	The Member ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this UserGroupMemberName with pattern organizations/{organization}/userGroups/{user_group}/members/{member}.

FormatOrganizationUserGroupMember(string, string, string)

Formats the IDs into the string representation of this UserGroupMemberName with pattern organizations/{organization}/userGroups/{user_group}/members/{member}.

Declaration

public static string FormatOrganizationUserGroupMember(string organizationId, string userGroupId, string memberId)

Parameters

Type	Name	Description
string	organizationId	The Organization ID. Must not be null or empty.
string	userGroupId	The UserGroup ID. Must not be null or empty.
string	memberId	The Member ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this UserGroupMemberName with pattern organizations/{organization}/userGroups/{user_group}/members/{member}.

FromOrganizationUserGroupMember(string, string, string)

Creates a UserGroupMemberName with the pattern organizations/{organization}/userGroups/{user_group}/members/{member}.

Declaration

public static UserGroupMemberName FromOrganizationUserGroupMember(string organizationId, string userGroupId, string memberId)

Parameters

Type	Name	Description
string	organizationId	The Organization ID. Must not be null or empty.
string	userGroupId	The UserGroup ID. Must not be null or empty.
string	memberId	The Member ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a UserGroupMemberName containing an unparsed resource name.

Declaration

public static UserGroupMemberName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static UserGroupMemberName Parse(string userGroupMemberName)

Parameters

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

Returns

Type	Description
UserGroupMemberName	The parsed UserGroupMemberName if successful.

Remarks

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

• organizations/{organization}/userGroups/{user_group}/members/{member}

Parse(string, bool)

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

Declaration

public static UserGroupMemberName Parse(string userGroupMemberName, bool allowUnparsed)

Parameters

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

Remarks

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

• organizations/{organization}/userGroups/{user_group}/members/{member}

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

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

Declaration

public static bool TryParse(string userGroupMemberName, out UserGroupMemberName result)

Parameters

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

• organizations/{organization}/userGroups/{user_group}/members/{member}

TryParse(string, bool, out UserGroupMemberName)

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

Declaration

public static bool TryParse(string userGroupMemberName, bool allowUnparsed, out UserGroupMemberName result)

Parameters

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

• organizations/{organization}/userGroups/{user_group}/members/{member}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(UserGroupMemberName, UserGroupMemberName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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