Class ProgramName

Resource name for the Program resource.

Inheritance

object

ProgramName

Implements

IResourceName

IEquatable<ProgramName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Accounts.V1Beta

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

Syntax

public sealed class ProgramName : IResourceName, IEquatable<ProgramName>

Constructors

ProgramName(string, string)

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

Declaration

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

Declaration

public ProgramName.ResourceNameType Type { get; }

Property Value

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

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 ProgramName with pattern accounts/{account}/programs/{program}.

FormatAccountProgram(string, string)

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

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 ProgramName with pattern accounts/{account}/programs/{program}.

FromAccountProgram(string, string)

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

Declaration

public static ProgramName 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
ProgramName	A new instance of ProgramName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a ProgramName containing an unparsed resource name.

Declaration

public static ProgramName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static ProgramName Parse(string programName)

Parameters

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

Returns

Type	Description
ProgramName	The parsed ProgramName if successful.

Remarks

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

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

Parse(string, bool)

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

Declaration

public static ProgramName Parse(string programName, bool allowUnparsed)

Parameters

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

Remarks

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

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

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

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

Declaration

public static bool TryParse(string programName, out ProgramName result)

Parameters

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

TryParse(string, bool, out ProgramName)

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

Declaration

public static bool TryParse(string programName, bool allowUnparsed, out ProgramName result)

Parameters

Type	Name	Description
string	programName	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.
ProgramName	result	When this method returns, the parsed ProgramName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProgramName, ProgramName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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