Class TermsOfServiceName

Resource name for the TermsOfService resource.

Inheritance

object

TermsOfServiceName

Implements

IResourceName

IEquatable<TermsOfServiceName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public sealed class TermsOfServiceName : IResourceName, IEquatable<TermsOfServiceName>

Constructors

TermsOfServiceName(string)

Constructs a new instance of a TermsOfServiceName class from the component parts of pattern termsOfService/{version}

Declaration

public TermsOfServiceName(string versionId)

Parameters

Type	Name	Description
string	versionId	The `Version` ID. Must not be `null` or empty.

Properties

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 TermsOfServiceName.ResourceNameType of the contained resource name.

Declaration

public TermsOfServiceName.ResourceNameType Type { get; }

Property Value

Type	Description
TermsOfServiceName.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

VersionId

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

Declaration

public string VersionId { get; }

Property Value

Type	Description
string

Methods

Format(string)

Formats the IDs into the string representation of this TermsOfServiceName with pattern termsOfService/{version}.

Declaration

public static string Format(string versionId)

Parameters

Type	Name	Description
string	versionId	The `Version` ID. Must not be `null` or empty.

Returns

Type	Description
string	The string representation of this TermsOfServiceName with pattern `termsOfService/{version}` .

FormatVersion(string)

Formats the IDs into the string representation of this TermsOfServiceName with pattern termsOfService/{version}.

Declaration

public static string FormatVersion(string versionId)

Parameters

Type	Name	Description
string	versionId	The `Version` ID. Must not be `null` or empty.

Returns

Type	Description
string	The string representation of this TermsOfServiceName with pattern `termsOfService/{version}` .

FromUnparsed(UnparsedResourceName)

Creates a TermsOfServiceName containing an unparsed resource name.

Declaration

public static TermsOfServiceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
TermsOfServiceName	A new instance of TermsOfServiceName containing the provided `unparsedResourceName`.

FromVersion(string)

Creates a TermsOfServiceName with the pattern termsOfService/{version}.

Declaration

public static TermsOfServiceName FromVersion(string versionId)

Parameters

Type	Name	Description
string	versionId	The `Version` ID. Must not be `null` or empty.

Returns

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

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 TermsOfServiceName instance.

Declaration

public static TermsOfServiceName Parse(string termsOfServiceName)

Parameters

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

Returns

Type	Description
TermsOfServiceName	The parsed TermsOfServiceName if successful.

Remarks

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

termsOfService/{version}

Parse(string, bool)

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

Declaration

public static TermsOfServiceName Parse(string termsOfServiceName, bool allowUnparsed)

Parameters

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

Remarks

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

termsOfService/{version}

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

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

Declaration

public static bool TryParse(string termsOfServiceName, out TermsOfServiceName result)

Parameters

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

termsOfService/{version}

TryParse(string, bool, out TermsOfServiceName)

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

Declaration

public static bool TryParse(string termsOfServiceName, bool allowUnparsed, out TermsOfServiceName result)

Parameters

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

termsOfService/{version}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TermsOfServiceName, TermsOfServiceName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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