Class RoleName

Resource name for the Role resource.

Inheritance

object

RoleName

Implements

IResourceName

IEquatable<RoleName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class RoleName : IResourceName, IEquatable<RoleName>

Constructors

RoleName(string, string)

Constructs a new instance of a RoleName class from the component parts of pattern networks/{network_code}/roles/{role}

Declaration

public RoleName(string networkCodeId, string roleId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	roleId	The Role 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

NetworkCodeId

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

Declaration

public string NetworkCodeId { get; }

Property Value

Type	Description
string

RoleId

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

Declaration

public string RoleId { get; }

Property Value

Type	Description
string

Type

The RoleName.ResourceNameType of the contained resource name.

Declaration

public RoleName.ResourceNameType Type { get; }

Property Value

Type	Description
RoleName.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 RoleName with pattern networks/{network_code}/roles/{role}.

Declaration

public static string Format(string networkCodeId, string roleId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	roleId	The Role ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this RoleName with pattern networks/{network_code}/roles/{role}.

FormatNetworkCodeRole(string, string)

Formats the IDs into the string representation of this RoleName with pattern networks/{network_code}/roles/{role}.

Declaration

public static string FormatNetworkCodeRole(string networkCodeId, string roleId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	roleId	The Role ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this RoleName with pattern networks/{network_code}/roles/{role}.

FromNetworkCodeRole(string, string)

Creates a RoleName with the pattern networks/{network_code}/roles/{role}.

Declaration

public static RoleName FromNetworkCodeRole(string networkCodeId, string roleId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	roleId	The Role ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a RoleName containing an unparsed resource name.

Declaration

public static RoleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static RoleName Parse(string roleName)

Parameters

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

Returns

Type	Description
RoleName	The parsed RoleName if successful.

Remarks

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

• networks/{network_code}/roles/{role}

Parse(string, bool)

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

Declaration

public static RoleName Parse(string roleName, bool allowUnparsed)

Parameters

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

Remarks

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

• networks/{network_code}/roles/{role}

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

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

Declaration

public static bool TryParse(string roleName, out RoleName result)

Parameters

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

• networks/{network_code}/roles/{role}

TryParse(string, bool, out RoleName)

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

Declaration

public static bool TryParse(string roleName, bool allowUnparsed, out RoleName result)

Parameters

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

• networks/{network_code}/roles/{role}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RoleName, RoleName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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