Google Cloud Bigtable Administration v2 API - Class SchemaBundleName (3.27.0) 

public sealed class SchemaBundleName : IResourceName, IEquatable<SchemaBundleName>

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

Resource name for the SchemaBundle resource.

Inheritance

object > SchemaBundleName

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

SchemaBundleName(string, string, string, string)

public SchemaBundleName(string projectId, string instanceId, string tableId, string schemaBundleId)

Constructs a new instance of a SchemaBundleName class from the component parts of pattern projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}

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

The Table ID. Must not be null or empty.
schemaBundleId string

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

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

SchemaBundleId

public string SchemaBundleId { get; }

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

Property Value
Type Description
string

TableId

public string TableId { get; }

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

Property Value
Type Description
string

Type

public SchemaBundleName.ResourceNameType Type { get; }

The SchemaBundleName.ResourceNameType of the contained resource name.

Property Value
Type Description
SchemaBundleNameResourceNameType

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 instanceId, string tableId, string schemaBundleId)

Formats the IDs into the string representation of this SchemaBundleName with pattern projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}.

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

The Table ID. Must not be null or empty.
schemaBundleId string

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

The string representation of this SchemaBundleName with pattern projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}.

FormatProjectInstanceTableSchemaBundle(string, string, string, string)

public static string FormatProjectInstanceTableSchemaBundle(string projectId, string instanceId, string tableId, string schemaBundleId)

Formats the IDs into the string representation of this SchemaBundleName with pattern projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}.

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

The Table ID. Must not be null or empty.
schemaBundleId string

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

The string representation of this SchemaBundleName with pattern projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}.

FromProjectInstanceTableSchemaBundle(string, string, string, string)

public static SchemaBundleName FromProjectInstanceTableSchemaBundle(string projectId, string instanceId, string tableId, string schemaBundleId)

Creates a SchemaBundleName with the pattern projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}.

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

The Table ID. Must not be null or empty.
schemaBundleId string

The SchemaBundle ID. Must not be null or empty.
Returns
Type Description
SchemaBundleName

A new instance of SchemaBundleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SchemaBundleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SchemaBundleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
schemaBundleName string

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

The parsed SchemaBundleName if successful.
Remarks

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

  • projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}

Parse(string, bool)

public static SchemaBundleName Parse(string schemaBundleName, bool allowUnparsed)

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

Parameters
Name Description
schemaBundleName 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
SchemaBundleName

The parsed SchemaBundleName if successful.
Remarks

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

  • projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}
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 SchemaBundleName)

public static bool TryParse(string schemaBundleName, out SchemaBundleName result)

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

Parameters
Name Description
schemaBundleName string

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

When this method returns, the parsed SchemaBundleName, 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}/tables/{table}/schemaBundles/{schema_bundle}

TryParse(string, bool, out SchemaBundleName)

public static bool TryParse(string schemaBundleName, bool allowUnparsed, out SchemaBundleName result)

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

Parameters
Name Description
schemaBundleName 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 SchemaBundleName

When this method returns, the parsed SchemaBundleName, 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}/tables/{table}/schemaBundles/{schema_bundle}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SchemaBundleName, SchemaBundleName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SchemaBundleName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SchemaBundleName

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

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.