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

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

Implements

IResourceName, IEquatable AppProfileName

Inherited Members

object.GetType()

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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`appProfileId`	`string` 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
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 AppProfileName.ResourceNameType Type { get; }

The AppProfileName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AppProfileNameResourceNameType`

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

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

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.
`appProfileId`	`string` The `AppProfile` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`appProfileId`	`string` The `AppProfile` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`appProfileId`	`string` The `AppProfile` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`AppProfileName`	A new instance of AppProfileName 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 AppProfileName Parse(string appProfileName)

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

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

Returns
Type	Description
`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, bool)

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
Name	Description
`appProfileName`	`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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`appProfileName`	`string` The resource name in string form. Must not be `null`.
`result`	`AppProfileName` When this method returns, the parsed AppProfileName, 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}/appProfiles/{app_profile}

TryParse(string, bool, 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
Name	Description
`appProfileName`	`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`	`AppProfileName` When this method returns, the parsed AppProfileName, 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}/appProfiles/{app_profile}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AppProfileName, AppProfileName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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