Chronicle v1 API - Class DataTableRowName (1.0.0-beta05) 

public sealed class DataTableRowName : IResourceName, IEquatable<DataTableRowName>

Reference documentation and code samples for the Chronicle v1 API class DataTableRowName.

Resource name for the DataTableRow resource.

Inheritance

object > DataTableRowName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

DataTableRowName(string, string, string, string, string)

public DataTableRowName(string projectId, string locationId, string instanceId, string dataTableId, string dataTableRowId)

Constructs a new instance of a DataTableRowName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
instanceId string

The Instance ID. Must not be null or empty.
dataTableId string

The DataTable ID. Must not be null or empty.
dataTableRowId string

The DataTableRow ID. Must not be null or empty.

Properties

DataTableId

public string DataTableId { get; }

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

Property Value
Type Description
string

DataTableRowId

public string DataTableRowId { get; }

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

Property Value
Type Description
string

InstanceId

public string InstanceId { get; }

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

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

Type

public DataTableRowName.ResourceNameType Type { get; }

The DataTableRowName.ResourceNameType of the contained resource name.

Property Value
Type Description
DataTableRowNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string locationId, string instanceId, string dataTableId, string dataTableRowId)

Formats the IDs into the string representation of this DataTableRowName with pattern projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
instanceId string

The Instance ID. Must not be null or empty.
dataTableId string

The DataTable ID. Must not be null or empty.
dataTableRowId string

The DataTableRow ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DataTableRowName with pattern projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row} .

FormatProjectLocationInstanceDataTableDataTableRow(string, string, string, string, string)

public static string FormatProjectLocationInstanceDataTableDataTableRow(string projectId, string locationId, string instanceId, string dataTableId, string dataTableRowId)

Formats the IDs into the string representation of this DataTableRowName with pattern projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
instanceId string

The Instance ID. Must not be null or empty.
dataTableId string

The DataTable ID. Must not be null or empty.
dataTableRowId string

The DataTableRow ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DataTableRowName with pattern projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row} .

FromProjectLocationInstanceDataTableDataTableRow(string, string, string, string, string)

public static DataTableRowName FromProjectLocationInstanceDataTableDataTableRow(string projectId, string locationId, string instanceId, string dataTableId, string dataTableRowId)

Creates a DataTableRowName with the pattern projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
instanceId string

The Instance ID. Must not be null or empty.
dataTableId string

The DataTable ID. Must not be null or empty.
dataTableRowId string

The DataTableRow ID. Must not be null or empty.
Returns
Type Description
DataTableRowName

A new instance of DataTableRowName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataTableRowName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataTableRowName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DataTableRowName

A new instance of DataTableRowName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static DataTableRowName Parse(string dataTableRowName)

Parses the given resource name string into a new DataTableRowName instance.

Parameter
Name Description
dataTableRowName string

The resource name in string form. Must not be null.
Returns
Type Description
DataTableRowName

The parsed DataTableRowName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}

Parse(string, bool)

public static DataTableRowName Parse(string dataTableRowName, bool allowUnparsed)

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

Parameters
Name Description
dataTableRowName string

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

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
DataTableRowName

The parsed DataTableRowName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out DataTableRowName)

public static bool TryParse(string dataTableRowName, out DataTableRowName result)

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

Parameters
Name Description
dataTableRowName string

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

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

  • projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}

TryParse(string, bool, out DataTableRowName)

public static bool TryParse(string dataTableRowName, bool allowUnparsed, out DataTableRowName result)

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

Parameters
Name Description
dataTableRowName string

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

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.
result DataTableRowName

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

  • projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataTableRowName, DataTableRowName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DataTableRowName

The first resource name to compare, or null.
b DataTableRowName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DataTableRowName

The first resource name to compare, or null.
b DataTableRowName

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.