Chronicle v1 API - Class DataTableName (1.0.0-beta05) 

public sealed class DataTableName : IResourceName, IEquatable<DataTableName>

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

Resource name for the DataTable resource.

Inheritance

object > DataTableName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

DataTableName(string, string, string, string)

public DataTableName(string projectId, string locationId, string instanceId, string dataTableId)

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

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.

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

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 DataTableName.ResourceNameType Type { get; }

The DataTableName.ResourceNameType of the contained resource name.

Property Value
Type Description
DataTableNameResourceNameType

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)

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

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

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.
Returns
Type Description
string

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

FormatProjectLocationInstanceDataTable(string, string, string, string)

public static string FormatProjectLocationInstanceDataTable(string projectId, string locationId, string instanceId, string dataTableId)

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

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.
Returns
Type Description
string

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

FromProjectLocationInstanceDataTable(string, string, string, string)

public static DataTableName FromProjectLocationInstanceDataTable(string projectId, string locationId, string instanceId, string dataTableId)

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

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.
Returns
Type Description
DataTableName

A new instance of DataTableName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataTableName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataTableName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of DataTableName 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 DataTableName Parse(string dataTableName)

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

Parameter
Name Description
dataTableName string

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

The parsed DataTableName 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}

Parse(string, bool)

public static DataTableName Parse(string dataTableName, bool allowUnparsed)

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

Parameters
Name Description
dataTableName 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
DataTableName

The parsed DataTableName 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}

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

public static bool TryParse(string dataTableName, out DataTableName result)

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

Parameters
Name Description
dataTableName string

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

When this method returns, the parsed DataTableName, 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}

TryParse(string, bool, out DataTableName)

public static bool TryParse(string dataTableName, bool allowUnparsed, out DataTableName result)

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

Parameters
Name Description
dataTableName 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 DataTableName

When this method returns, the parsed DataTableName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataTableName, DataTableName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DataTableName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DataTableName

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

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.