Class UserGroupName

Resource name for the UserGroup resource.

Inheritance

object

UserGroupName

Implements

IResourceName

IEquatable<UserGroupName>

Inherited Members

object.GetType()

Namespace: Google.Ads.MarketingPlatform.Admin.V1Alpha

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

Syntax

public sealed class UserGroupName : IResourceName, IEquatable<UserGroupName>

Constructors

UserGroupName(string, string)

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

Declaration

public UserGroupName(string organizationId, string userGroupId)

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.

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

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 UserGroupName.ResourceNameType of the contained resource name.

Declaration

public UserGroupName.ResourceNameType Type { get; }

Property Value

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

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

Declaration

public static string Format(string organizationId, string userGroupId)

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.

Returns

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

FormatOrganizationUserGroup(string, string)

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

Declaration

public static string FormatOrganizationUserGroup(string organizationId, string userGroupId)

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.

Returns

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

FromOrganizationUserGroup(string, string)

Creates a UserGroupName with the pattern organizations/{organization}/userGroups/{user_group}.

Declaration

public static UserGroupName FromOrganizationUserGroup(string organizationId, string userGroupId)

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.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a UserGroupName containing an unparsed resource name.

Declaration

public static UserGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static UserGroupName Parse(string userGroupName)

Parameters

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

Returns

Type	Description
UserGroupName	The parsed UserGroupName if successful.

Remarks

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

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

Parse(string, bool)

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

Declaration

public static UserGroupName Parse(string userGroupName, bool allowUnparsed)

Parameters

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

Remarks

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

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

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

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

Declaration

public static bool TryParse(string userGroupName, out UserGroupName result)

Parameters

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

TryParse(string, bool, out UserGroupName)

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

Declaration

public static bool TryParse(string userGroupName, bool allowUnparsed, out UserGroupName result)

Parameters

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(UserGroupName, UserGroupName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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