Class CheckoutSettingsName

Resource name for the CheckoutSettings resource.

Inheritance

object

CheckoutSettingsName

Implements

IResourceName

IEquatable<CheckoutSettingsName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public sealed class CheckoutSettingsName : IResourceName, IEquatable<CheckoutSettingsName>

Constructors

CheckoutSettingsName(string, string)

Constructs a new instance of a CheckoutSettingsName class from the component parts of pattern accounts/{account}/programs/{program}/checkoutSettings

Declaration

public CheckoutSettingsName(string accountId, string programId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	programId	The Program 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

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

ProgramId

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

Declaration

public string ProgramId { get; }

Property Value

Type	Description
string

Type

The CheckoutSettingsName.ResourceNameType of the contained resource name.

Declaration

public CheckoutSettingsName.ResourceNameType Type { get; }

Property Value

Type	Description
CheckoutSettingsName.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 CheckoutSettingsName with pattern accounts/{account}/programs/{program}/checkoutSettings.

Declaration

public static string Format(string accountId, string programId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	programId	The Program ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CheckoutSettingsName with pattern accounts/{account}/programs/{program}/checkoutSettings.

FormatAccountProgram(string, string)

Formats the IDs into the string representation of this CheckoutSettingsName with pattern accounts/{account}/programs/{program}/checkoutSettings.

Declaration

public static string FormatAccountProgram(string accountId, string programId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	programId	The Program ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CheckoutSettingsName with pattern accounts/{account}/programs/{program}/checkoutSettings.

FromAccountProgram(string, string)

Creates a CheckoutSettingsName with the pattern accounts/{account}/programs/{program}/checkoutSettings.

Declaration

public static CheckoutSettingsName FromAccountProgram(string accountId, string programId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	programId	The Program ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CheckoutSettingsName containing an unparsed resource name.

Declaration

public static CheckoutSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static CheckoutSettingsName Parse(string checkoutSettingsName)

Parameters

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

Returns

Type	Description
CheckoutSettingsName	The parsed CheckoutSettingsName if successful.

Remarks

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

• accounts/{account}/programs/{program}/checkoutSettings

Parse(string, bool)

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

Declaration

public static CheckoutSettingsName Parse(string checkoutSettingsName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/programs/{program}/checkoutSettings

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

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

Declaration

public static bool TryParse(string checkoutSettingsName, out CheckoutSettingsName result)

Parameters

Type	Name	Description
string	checkoutSettingsName	The resource name in string form. Must not be null.
CheckoutSettingsName	result	When this method returns, the parsed CheckoutSettingsName, 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}/programs/{program}/checkoutSettings

TryParse(string, bool, out CheckoutSettingsName)

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

Declaration

public static bool TryParse(string checkoutSettingsName, bool allowUnparsed, out CheckoutSettingsName result)

Parameters

Type	Name	Description
string	checkoutSettingsName	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.
CheckoutSettingsName	result	When this method returns, the parsed CheckoutSettingsName, 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}/programs/{program}/checkoutSettings

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CheckoutSettingsName, CheckoutSettingsName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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