Class DeviceCapabilityName

Resource name for the DeviceCapability resource.

Inheritance

object

DeviceCapabilityName

Implements

IResourceName

IEquatable<DeviceCapabilityName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class DeviceCapabilityName : IResourceName, IEquatable<DeviceCapabilityName>

Constructors

DeviceCapabilityName(string, string)

Constructs a new instance of a DeviceCapabilityName class from the component parts of pattern networks/{network_code}/deviceCapabilities/{device_capability}

Declaration

public DeviceCapabilityName(string networkCodeId, string deviceCapabilityId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	deviceCapabilityId	The DeviceCapability ID. Must not be null or empty.

Properties

DeviceCapabilityId

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

Declaration

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

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

Type

The DeviceCapabilityName.ResourceNameType of the contained resource name.

Declaration

public DeviceCapabilityName.ResourceNameType Type { get; }

Property Value

Type	Description
DeviceCapabilityName.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 DeviceCapabilityName with pattern networks/{network_code}/deviceCapabilities/{device_capability}.

Declaration

public static string Format(string networkCodeId, string deviceCapabilityId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	deviceCapabilityId	The DeviceCapability ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this DeviceCapabilityName with pattern networks/{network_code}/deviceCapabilities/{device_capability}.

FormatNetworkCodeDeviceCapability(string, string)

Formats the IDs into the string representation of this DeviceCapabilityName with pattern networks/{network_code}/deviceCapabilities/{device_capability}.

Declaration

public static string FormatNetworkCodeDeviceCapability(string networkCodeId, string deviceCapabilityId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	deviceCapabilityId	The DeviceCapability ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this DeviceCapabilityName with pattern networks/{network_code}/deviceCapabilities/{device_capability}.

FromNetworkCodeDeviceCapability(string, string)

Creates a DeviceCapabilityName with the pattern networks/{network_code}/deviceCapabilities/{device_capability}.

Declaration

public static DeviceCapabilityName FromNetworkCodeDeviceCapability(string networkCodeId, string deviceCapabilityId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	deviceCapabilityId	The DeviceCapability ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a DeviceCapabilityName containing an unparsed resource name.

Declaration

public static DeviceCapabilityName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static DeviceCapabilityName Parse(string deviceCapabilityName)

Parameters

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

Returns

Type	Description
DeviceCapabilityName	The parsed DeviceCapabilityName if successful.

Remarks

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

• networks/{network_code}/deviceCapabilities/{device_capability}

Parse(string, bool)

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

Declaration

public static DeviceCapabilityName Parse(string deviceCapabilityName, bool allowUnparsed)

Parameters

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

Remarks

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

• networks/{network_code}/deviceCapabilities/{device_capability}

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

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

Declaration

public static bool TryParse(string deviceCapabilityName, out DeviceCapabilityName result)

Parameters

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

TryParse(string, bool, out DeviceCapabilityName)

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

Declaration

public static bool TryParse(string deviceCapabilityName, bool allowUnparsed, out DeviceCapabilityName result)

Parameters

Type	Name	Description
string	deviceCapabilityName	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.
DeviceCapabilityName	result	When this method returns, the parsed DeviceCapabilityName, 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}/deviceCapabilities/{device_capability}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DeviceCapabilityName, DeviceCapabilityName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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