Google Cloud Bigtable Administration v2 API - Class AuthorizedViewName (3.12.0)

public sealed class AuthorizedViewName : IResourceName, IEquatable<AuthorizedViewName>

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

Resource name for the AuthorizedView resource.

Inheritance

object > AuthorizedViewName

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

AuthorizedViewName(string, string, string, string)

public AuthorizedViewName(string projectId, string instanceId, string tableId, string authorizedViewId)

Constructs a new instance of a AuthorizedViewName class from the component parts of pattern projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

tableIdstring

The Table ID. Must not be null or empty.

authorizedViewIdstring

The AuthorizedView ID. Must not be null or empty.

Properties

AuthorizedViewId

public string AuthorizedViewId { get; }

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

Property Value
TypeDescription
string

InstanceId

public string InstanceId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
bool

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

TableId

public string TableId { get; }

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

Property Value
TypeDescription
string

Type

public AuthorizedViewName.ResourceNameType Type { get; }

The AuthorizedViewName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AuthorizedViewNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string instanceId, string tableId, string authorizedViewId)

Formats the IDs into the string representation of this AuthorizedViewName with pattern projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

tableIdstring

The Table ID. Must not be null or empty.

authorizedViewIdstring

The AuthorizedView ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this AuthorizedViewName with pattern projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}.

FormatProjectInstanceTableAuthorizedView(string, string, string, string)

public static string FormatProjectInstanceTableAuthorizedView(string projectId, string instanceId, string tableId, string authorizedViewId)

Formats the IDs into the string representation of this AuthorizedViewName with pattern projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

tableIdstring

The Table ID. Must not be null or empty.

authorizedViewIdstring

The AuthorizedView ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this AuthorizedViewName with pattern projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}.

FromProjectInstanceTableAuthorizedView(string, string, string, string)

public static AuthorizedViewName FromProjectInstanceTableAuthorizedView(string projectId, string instanceId, string tableId, string authorizedViewId)

Creates a AuthorizedViewName with the pattern projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

tableIdstring

The Table ID. Must not be null or empty.

authorizedViewIdstring

The AuthorizedView ID. Must not be null or empty.

Returns
TypeDescription
AuthorizedViewName

A new instance of AuthorizedViewName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AuthorizedViewName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AuthorizedViewName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AuthorizedViewName

A new instance of AuthorizedViewName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static AuthorizedViewName Parse(string authorizedViewName)

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

Parameter
NameDescription
authorizedViewNamestring

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

Returns
TypeDescription
AuthorizedViewName

The parsed AuthorizedViewName if successful.

Remarks

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

  • projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}

Parse(string, bool)

public static AuthorizedViewName Parse(string authorizedViewName, bool allowUnparsed)

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

Parameters
NameDescription
authorizedViewNamestring

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

allowUnparsedbool

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
TypeDescription
AuthorizedViewName

The parsed AuthorizedViewName if successful.

Remarks

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

  • projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out AuthorizedViewName)

public static bool TryParse(string authorizedViewName, out AuthorizedViewName result)

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

Parameters
NameDescription
authorizedViewNamestring

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

resultAuthorizedViewName

When this method returns, the parsed AuthorizedViewName, or null if parsing failed.

Returns
TypeDescription
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}/authorizedViews/{authorized_view}

TryParse(string, bool, out AuthorizedViewName)

public static bool TryParse(string authorizedViewName, bool allowUnparsed, out AuthorizedViewName result)

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

Parameters
NameDescription
authorizedViewNamestring

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

allowUnparsedbool

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.

resultAuthorizedViewName

When this method returns, the parsed AuthorizedViewName, or null if parsing failed.

Returns
TypeDescription
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}/authorizedViews/{authorized_view}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AuthorizedViewName, AuthorizedViewName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aAuthorizedViewName

The first resource name to compare, or null.

bAuthorizedViewName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(AuthorizedViewName, AuthorizedViewName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aAuthorizedViewName

The first resource name to compare, or null.

bAuthorizedViewName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.