Class ShippingSettingsName

Resource name for the ShippingSettings resource.

Inheritance

object

ShippingSettingsName

Implements

IResourceName

IEquatable<ShippingSettingsName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public sealed class ShippingSettingsName : IResourceName, IEquatable<ShippingSettingsName>

Constructors

ShippingSettingsName(string)

Constructs a new instance of a ShippingSettingsName class from the component parts of pattern accounts/{account}/shippingSettings

Declaration

public ShippingSettingsName(string accountId)

Parameters

Type	Name	Description
string	accountId	The Account 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

Type

The ShippingSettingsName.ResourceNameType of the contained resource name.

Declaration

public ShippingSettingsName.ResourceNameType Type { get; }

Property Value

Type	Description
ShippingSettingsName.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)

Formats the IDs into the string representation of this ShippingSettingsName with pattern accounts/{account}/shippingSettings.

Declaration

public static string Format(string accountId)

Parameters

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

Returns

Type	Description
string	The string representation of this ShippingSettingsName with pattern accounts/{account}/shippingSettings.

FormatAccount(string)

Formats the IDs into the string representation of this ShippingSettingsName with pattern accounts/{account}/shippingSettings.

Declaration

public static string FormatAccount(string accountId)

Parameters

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

Returns

Type	Description
string	The string representation of this ShippingSettingsName with pattern accounts/{account}/shippingSettings.

FromAccount(string)

Creates a ShippingSettingsName with the pattern accounts/{account}/shippingSettings.

Declaration

public static ShippingSettingsName FromAccount(string accountId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a ShippingSettingsName containing an unparsed resource name.

Declaration

public static ShippingSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static ShippingSettingsName Parse(string shippingSettingsName)

Parameters

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

Returns

Type	Description
ShippingSettingsName	The parsed ShippingSettingsName if successful.

Remarks

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

• accounts/{account}/shippingSettings

Parse(string, bool)

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

Declaration

public static ShippingSettingsName Parse(string shippingSettingsName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/shippingSettings

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

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

Declaration

public static bool TryParse(string shippingSettingsName, out ShippingSettingsName result)

Parameters

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

TryParse(string, bool, out ShippingSettingsName)

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

Declaration

public static bool TryParse(string shippingSettingsName, bool allowUnparsed, out ShippingSettingsName result)

Parameters

Type	Name	Description
string	shippingSettingsName	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.
ShippingSettingsName	result	When this method returns, the parsed ShippingSettingsName, 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}/shippingSettings

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ShippingSettingsName, ShippingSettingsName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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