Google Cloud Bigtable Administration v2 API - Class AppProfileName (3.3.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class AppProfileName : IResourceName, IEquatable<AppProfileName>

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

Resource name for the AppProfile resource.

Inheritance

Object > AppProfileName

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

AppProfileName(String, String, String)

public AppProfileName(string projectId, string instanceId, string appProfileId)

Constructs a new instance of a AppProfileName class from the component parts of pattern projects/{project}/instances/{instance}/appProfiles/{app_profile}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

appProfileIdString

The AppProfile ID. Must not be null or empty.

Properties

AppProfileId

public string AppProfileId { get; }

The AppProfile 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
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public AppProfileName.ResourceNameType Type { get; }

The AppProfileName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AppProfileName.ResourceNameType

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)

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

Formats the IDs into the string representation of this AppProfileName with pattern projects/{project}/instances/{instance}/appProfiles/{app_profile}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

appProfileIdString

The AppProfile ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AppProfileName with pattern projects/{project}/instances/{instance}/appProfiles/{app_profile}.

FormatProjectInstanceAppProfile(String, String, String)

public static string FormatProjectInstanceAppProfile(string projectId, string instanceId, string appProfileId)

Formats the IDs into the string representation of this AppProfileName with pattern projects/{project}/instances/{instance}/appProfiles/{app_profile}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

appProfileIdString

The AppProfile ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AppProfileName with pattern projects/{project}/instances/{instance}/appProfiles/{app_profile}.

FromProjectInstanceAppProfile(String, String, String)

public static AppProfileName FromProjectInstanceAppProfile(string projectId, string instanceId, string appProfileId)

Creates a AppProfileName with the pattern projects/{project}/instances/{instance}/appProfiles/{app_profile}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

appProfileIdString

The AppProfile ID. Must not be null or empty.

Returns
TypeDescription
AppProfileName

A new instance of AppProfileName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AppProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AppProfileName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AppProfileName

A new instance of AppProfileName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static AppProfileName Parse(string appProfileName)

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

Parameter
NameDescription
appProfileNameString

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

Returns
TypeDescription
AppProfileName

The parsed AppProfileName if successful.

Remarks

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

  • projects/{project}/instances/{instance}/appProfiles/{app_profile}

Parse(String, Boolean)

public static AppProfileName Parse(string appProfileName, bool allowUnparsed)

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

Parameters
NameDescription
appProfileNameString

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

allowUnparsedBoolean

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
AppProfileName

The parsed AppProfileName if successful.

Remarks

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

  • projects/{project}/instances/{instance}/appProfiles/{app_profile}
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 AppProfileName)

public static bool TryParse(string appProfileName, out AppProfileName result)

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

Parameters
NameDescription
appProfileNameString

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

resultAppProfileName

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

Returns
TypeDescription
Boolean

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}/appProfiles/{app_profile}

TryParse(String, Boolean, out AppProfileName)

public static bool TryParse(string appProfileName, bool allowUnparsed, out AppProfileName result)

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

Parameters
NameDescription
appProfileNameString

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

allowUnparsedBoolean

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.

resultAppProfileName

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

Returns
TypeDescription
Boolean

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}/appProfiles/{app_profile}
Or may be in any format if allowUnparsed is true.

Operators

Equality(AppProfileName, AppProfileName)

public static bool operator ==(AppProfileName a, AppProfileName b)
Parameters
NameDescription
aAppProfileName
bAppProfileName
Returns
TypeDescription
Boolean

Inequality(AppProfileName, AppProfileName)

public static bool operator !=(AppProfileName a, AppProfileName b)
Parameters
NameDescription
aAppProfileName
bAppProfileName
Returns
TypeDescription
Boolean