Class HomepageName

Resource name for the Homepage resource.

Inheritance

object

HomepageName

Implements

IResourceName

IEquatable<HomepageName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public sealed class HomepageName : IResourceName, IEquatable<HomepageName>

Constructors

HomepageName(string)

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

Declaration

public HomepageName(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 HomepageName.ResourceNameType of the contained resource name.

Declaration

public HomepageName.ResourceNameType Type { get; }

Property Value

Type	Description
HomepageName.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 HomepageName with pattern accounts/{account}/homepage.

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 HomepageName with pattern `accounts/{account}/homepage` .

FormatAccount(string)

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

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 HomepageName with pattern `accounts/{account}/homepage` .

FromAccount(string)

Creates a HomepageName with the pattern accounts/{account}/homepage.

Declaration

public static HomepageName FromAccount(string accountId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a HomepageName containing an unparsed resource name.

Declaration

public static HomepageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static HomepageName Parse(string homepageName)

Parameters

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

Returns

Type	Description
HomepageName	The parsed HomepageName if successful.

Remarks

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

accounts/{account}/homepage

Parse(string, bool)

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

Declaration

public static HomepageName Parse(string homepageName, bool allowUnparsed)

Parameters

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

Remarks

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

accounts/{account}/homepage

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

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

Declaration

public static bool TryParse(string homepageName, out HomepageName result)

Parameters

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

TryParse(string, bool, out HomepageName)

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

Declaration

public static bool TryParse(string homepageName, bool allowUnparsed, out HomepageName result)

Parameters

Type	Name	Description
string	homepageName	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.
HomepageName	result	When this method returns, the parsed HomepageName, 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}/homepage

Or may be in any format if allowUnparsed is true.

Operators

operator ==(HomepageName, HomepageName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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