Google Cloud Bigtable Administration v2 API - Class MemoryLayerName (3.35.0) 

public sealed class MemoryLayerName : IResourceName, IEquatable<MemoryLayerName>

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

Resource name for the MemoryLayer resource.

Inheritance

object > MemoryLayerName

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

MemoryLayerName(string, string, string)

public MemoryLayerName(string projectId, string instanceId, string clusterId)

Constructs a new instance of a MemoryLayerName class from the component parts of pattern projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer

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.
clusterId string

The Cluster ID. Must not be null or empty.

Properties

ClusterId

public string ClusterId { get; }

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

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

The MemoryLayerName.ResourceNameType of the contained resource name.

Property Value
Type Description
MemoryLayerNameResourceNameType

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

Formats the IDs into the string representation of this MemoryLayerName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer.

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.
clusterId string

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

The string representation of this MemoryLayerName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer.

FormatProjectInstanceCluster(string, string, string)

public static string FormatProjectInstanceCluster(string projectId, string instanceId, string clusterId)

Formats the IDs into the string representation of this MemoryLayerName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer.

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.
clusterId string

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

The string representation of this MemoryLayerName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer.

FromProjectInstanceCluster(string, string, string)

public static MemoryLayerName FromProjectInstanceCluster(string projectId, string instanceId, string clusterId)

Creates a MemoryLayerName with the pattern projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer.

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.
clusterId string

The Cluster ID. Must not be null or empty.
Returns
Type Description
MemoryLayerName

A new instance of MemoryLayerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MemoryLayerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MemoryLayerName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
memoryLayerName string

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

The parsed MemoryLayerName if successful.
Remarks

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

  • projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer

Parse(string, bool)

public static MemoryLayerName Parse(string memoryLayerName, bool allowUnparsed)

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

Parameters
Name Description
memoryLayerName 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
MemoryLayerName

The parsed MemoryLayerName if successful.
Remarks

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

  • projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer

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

public static bool TryParse(string memoryLayerName, out MemoryLayerName result)

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

Parameters
Name Description
memoryLayerName string

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

When this method returns, the parsed MemoryLayerName, 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}/clusters/{cluster}/memoryLayer

TryParse(string, bool, out MemoryLayerName)

public static bool TryParse(string memoryLayerName, bool allowUnparsed, out MemoryLayerName result)

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

Parameters
Name Description
memoryLayerName 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 MemoryLayerName

When this method returns, the parsed MemoryLayerName, 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}/clusters/{cluster}/memoryLayer

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MemoryLayerName, MemoryLayerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MemoryLayerName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MemoryLayerName

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

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.