Class ConversionSourceName

Resource name for the ConversionSource resource.

Inheritance

object

ConversionSourceName

Implements

IResourceName

IEquatable<ConversionSourceName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Conversions.V1

Assembly: Google.Shopping.Merchant.Conversions.V1.dll

Syntax

public sealed class ConversionSourceName : IResourceName, IEquatable<ConversionSourceName>

Constructors

ConversionSourceName(string, string)

Constructs a new instance of a ConversionSourceName class from the component parts of pattern accounts/{account}/conversionSources/{conversion_source}

Declaration

public ConversionSourceName(string accountId, string conversionSourceId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	conversionSourceId	The ConversionSource ID. Must not be null or empty.

Properties

AccountId

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

Declaration

public string AccountId { get; }

Property Value

Type	Description
string

ConversionSourceId

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

Declaration

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

Type

The ConversionSourceName.ResourceNameType of the contained resource name.

Declaration

public ConversionSourceName.ResourceNameType Type { get; }

Property Value

Type	Description
ConversionSourceName.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 ConversionSourceName with pattern accounts/{account}/conversionSources/{conversion_source}.

Declaration

public static string Format(string accountId, string conversionSourceId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	conversionSourceId	The ConversionSource ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this ConversionSourceName with pattern accounts/{account}/conversionSources/{conversion_source}.

FormatAccountConversionSource(string, string)

Formats the IDs into the string representation of this ConversionSourceName with pattern accounts/{account}/conversionSources/{conversion_source}.

Declaration

public static string FormatAccountConversionSource(string accountId, string conversionSourceId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	conversionSourceId	The ConversionSource ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this ConversionSourceName with pattern accounts/{account}/conversionSources/{conversion_source}.

FromAccountConversionSource(string, string)

Creates a ConversionSourceName with the pattern accounts/{account}/conversionSources/{conversion_source}.

Declaration

public static ConversionSourceName FromAccountConversionSource(string accountId, string conversionSourceId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	conversionSourceId	The ConversionSource ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a ConversionSourceName containing an unparsed resource name.

Declaration

public static ConversionSourceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static ConversionSourceName Parse(string conversionSourceName)

Parameters

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

Returns

Type	Description
ConversionSourceName	The parsed ConversionSourceName if successful.

Remarks

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

• accounts/{account}/conversionSources/{conversion_source}

Parse(string, bool)

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

Declaration

public static ConversionSourceName Parse(string conversionSourceName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/conversionSources/{conversion_source}

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

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

Declaration

public static bool TryParse(string conversionSourceName, out ConversionSourceName result)

Parameters

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

• accounts/{account}/conversionSources/{conversion_source}

TryParse(string, bool, out ConversionSourceName)

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

Declaration

public static bool TryParse(string conversionSourceName, bool allowUnparsed, out ConversionSourceName result)

Parameters

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

• accounts/{account}/conversionSources/{conversion_source}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ConversionSourceName, ConversionSourceName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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