Show / Hide Table of Contents

Class RowName

Resource name for the Row resource.

Inheritance
object
RowName
Implements
IResourceName
IEquatable<RowName>
Inherited Members
object.GetType()
Namespace: Google.Area120.Tables.V1Alpha1
Assembly: Google.Area120.Tables.V1Alpha1.dll
Syntax
public sealed class RowName : IResourceName, IEquatable<RowName>

Constructors

RowName(string, string)

Constructs a new instance of a RowName class from the component parts of pattern tables/{table}/rows/{row}

Declaration
public RowName(string tableId, string rowId)
Parameters
Type Name Description
string tableId

The Table ID. Must not be null or empty.

string rowId

The Row 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

RowId

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

Declaration
public string RowId { get; }
Property Value
Type Description
string

TableId

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

Declaration
public string TableId { get; }
Property Value
Type Description
string

Type

The RowName.ResourceNameType of the contained resource name.

Declaration
public RowName.ResourceNameType Type { get; }
Property Value
Type Description
RowName.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 RowName with pattern tables/{table}/rows/{row}.

Declaration
public static string Format(string tableId, string rowId)
Parameters
Type Name Description
string tableId

The Table ID. Must not be null or empty.

string rowId

The Row ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this RowName with pattern tables/{table}/rows/{row}.

FormatTableRow(string, string)

Formats the IDs into the string representation of this RowName with pattern tables/{table}/rows/{row}.

Declaration
public static string FormatTableRow(string tableId, string rowId)
Parameters
Type Name Description
string tableId

The Table ID. Must not be null or empty.

string rowId

The Row ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this RowName with pattern tables/{table}/rows/{row}.

FromTableRow(string, string)

Creates a RowName with the pattern tables/{table}/rows/{row}.

Declaration
public static RowName FromTableRow(string tableId, string rowId)
Parameters
Type Name Description
string tableId

The Table ID. Must not be null or empty.

string rowId

The Row ID. Must not be null or empty.

Returns
Type Description
RowName

A new instance of RowName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a RowName containing an unparsed resource name.

Declaration
public static RowName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
RowName

A new instance of RowName 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 RowName instance.

Declaration
public static RowName Parse(string rowName)
Parameters
Type Name Description
string rowName

The resource name in string form. Must not be null.

Returns
Type Description
RowName

The parsed RowName if successful.

Remarks

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

  • tables/{table}/rows/{row}

Parse(string, bool)

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

Declaration
public static RowName Parse(string rowName, bool allowUnparsed)
Parameters
Type Name Description
string rowName

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
RowName

The parsed RowName if successful.

Remarks

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

  • tables/{table}/rows/{row}
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 RowName)

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

Declaration
public static bool TryParse(string rowName, out RowName result)
Parameters
Type Name Description
string rowName

The resource name in string form. Must not be null.

RowName result

When this method returns, the parsed RowName, 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:

  • tables/{table}/rows/{row}

TryParse(string, bool, out RowName)

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

Declaration
public static bool TryParse(string rowName, bool allowUnparsed, out RowName result)
Parameters
Type Name Description
string rowName

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.

RowName result

When this method returns, the parsed RowName, 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:

  • tables/{table}/rows/{row}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RowName, RowName)

Determines whether two specified resource names have the same value.

Declaration
public static bool operator ==(RowName a, RowName b)
Parameters
Type Name Description
RowName a

The first resource name to compare, or null.

RowName 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 !=(RowName, RowName)

Determines whether two specified resource names have different values.

Declaration
public static bool operator !=(RowName a, RowName b)
Parameters
Type Name Description
RowName a

The first resource name to compare, or null.

RowName 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.

In this article
Back to top Generated by DocFX