Class OrderName

Resource name for the Order resource.

Inheritance

object

OrderName

Implements

IResourceName

IEquatable<OrderName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class OrderName : IResourceName, IEquatable<OrderName>

Constructors

OrderName(string, string)

Constructs a new instance of a OrderName class from the component parts of pattern networks/{network_code}/orders/{order}

Declaration

public OrderName(string networkCodeId, string orderId)

Parameters

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

OrderId

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

Declaration

public string OrderId { get; }

Property Value

Type	Description
string

Type

The OrderName.ResourceNameType of the contained resource name.

Declaration

public OrderName.ResourceNameType Type { get; }

Property Value

Type	Description
OrderName.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 OrderName with pattern networks/{network_code}/orders/{order}.

Declaration

public static string Format(string networkCodeId, string orderId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	orderId	The Order ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this OrderName with pattern networks/{network_code}/orders/{order}.

FormatNetworkCodeOrder(string, string)

Formats the IDs into the string representation of this OrderName with pattern networks/{network_code}/orders/{order}.

Declaration

public static string FormatNetworkCodeOrder(string networkCodeId, string orderId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	orderId	The Order ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this OrderName with pattern networks/{network_code}/orders/{order}.

FromNetworkCodeOrder(string, string)

Creates a OrderName with the pattern networks/{network_code}/orders/{order}.

Declaration

public static OrderName FromNetworkCodeOrder(string networkCodeId, string orderId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	orderId	The Order ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a OrderName containing an unparsed resource name.

Declaration

public static OrderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static OrderName Parse(string orderName)

Parameters

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

Returns

Type	Description
OrderName	The parsed OrderName if successful.

Remarks

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

• networks/{network_code}/orders/{order}

Parse(string, bool)

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

Declaration

public static OrderName Parse(string orderName, bool allowUnparsed)

Parameters

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

Remarks

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

• networks/{network_code}/orders/{order}

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

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

Declaration

public static bool TryParse(string orderName, out OrderName result)

Parameters

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

TryParse(string, bool, out OrderName)

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

Declaration

public static bool TryParse(string orderName, bool allowUnparsed, out OrderName result)

Parameters

Type	Name	Description
string	orderName	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.
OrderName	result	When this method returns, the parsed OrderName, 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}/orders/{order}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(OrderName, OrderName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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