Google Cloud Bigtable Administration v2 API - Class LogicalViewName (3.24.0)

public sealed class LogicalViewName : IResourceName, IEquatable<LogicalViewName>

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class LogicalViewName.

Resource name for the LogicalView resource.

Inheritance

object > LogicalViewName

Implements

IResourceName, IEquatable LogicalViewName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

LogicalViewName(string, string, string)

public LogicalViewName(string projectId, string instanceId, string logicalViewId)

Constructs a new instance of a LogicalViewName class from the component parts of pattern projects/{project}/instances/{instance}/logicalViews/{logical_view}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`logicalViewId`	`string` The `LogicalView` ID. Must not be `null` or empty.

Properties

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`

LogicalViewId

public string LogicalViewId { get; }

The LogicalView 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 LogicalViewName.ResourceNameType Type { get; }

The LogicalViewName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`LogicalViewNameResourceNameType`

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)

public static string Format(string projectId, string instanceId, string logicalViewId)

Formats the IDs into the string representation of this LogicalViewName with pattern projects/{project}/instances/{instance}/logicalViews/{logical_view}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`logicalViewId`	`string` The `LogicalView` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogicalViewName with pattern `projects/{project}/instances/{instance}/logicalViews/{logical_view}`.

FormatProjectInstanceLogicalView(string, string, string)

public static string FormatProjectInstanceLogicalView(string projectId, string instanceId, string logicalViewId)

Formats the IDs into the string representation of this LogicalViewName with pattern projects/{project}/instances/{instance}/logicalViews/{logical_view}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`logicalViewId`	`string` The `LogicalView` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogicalViewName with pattern `projects/{project}/instances/{instance}/logicalViews/{logical_view}`.

FromProjectInstanceLogicalView(string, string, string)

public static LogicalViewName FromProjectInstanceLogicalView(string projectId, string instanceId, string logicalViewId)

Creates a LogicalViewName with the pattern projects/{project}/instances/{instance}/logicalViews/{logical_view}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`logicalViewId`	`string` The `LogicalView` ID. Must not be `null` or empty.

Returns
Type	Description
`LogicalViewName`	A new instance of LogicalViewName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LogicalViewName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogicalViewName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static LogicalViewName Parse(string logicalViewName)

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

Parameter
Name	Description
`logicalViewName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`LogicalViewName`	The parsed LogicalViewName if successful.

Remarks

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

projects/{project}/instances/{instance}/logicalViews/{logical_view}

Parse(string, bool)

public static LogicalViewName Parse(string logicalViewName, bool allowUnparsed)

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

Parameters
Name	Description
`logicalViewName`	`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
`LogicalViewName`	The parsed LogicalViewName if successful.

Remarks

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

projects/{project}/instances/{instance}/logicalViews/{logical_view}

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

object.ToString()

TryParse(string, out LogicalViewName)

public static bool TryParse(string logicalViewName, out LogicalViewName result)

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

Parameters
Name	Description
`logicalViewName`	`string` The resource name in string form. Must not be `null`.
`result`	`LogicalViewName` When this method returns, the parsed LogicalViewName, 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}/instances/{instance}/logicalViews/{logical_view}

TryParse(string, bool, out LogicalViewName)

public static bool TryParse(string logicalViewName, bool allowUnparsed, out LogicalViewName result)

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

Parameters
Name	Description
`logicalViewName`	`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`	`LogicalViewName` When this method returns, the parsed LogicalViewName, 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}/instances/{instance}/logicalViews/{logical_view}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogicalViewName, LogicalViewName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`LogicalViewName` The first resource name to compare, or null.
`b`	`LogicalViewName` 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.