Reference documentation and code samples for the Cloud Bigtable V2 Client class AppProfile.
A configuration object describing how Cloud Bigtable should treat traffic
from a particular end user application.
Generated from protobuf messagegoogle.bigtable.admin.v2.AppProfile
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique name of the app profile. Values are of the formprojects/{project}/instances/{instance}/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*.
↳ etag
string
Strongly validated etag for optimistic concurrency control. Preserve the value returned fromGetAppProfilewhen callingUpdateAppProfileto fail the request if there has been a modification in the mean time. Theupdate_maskof the request need not includeetagfor this protection to apply. SeeWikipediaandRFC 7232for more details.
↳ description
string
Long form description of the use case for this AppProfile.
This field has been deprecated in favor ofstandard_isolation.priority. If you set this field,standard_isolation.prioritywill be set instead. The priority of requests sent using this app profile.
Specifies that this app profile is intended for read-only usage via the Data Boost feature.
getName
The unique name of the app profile. Values are of the formprojects/{project}/instances/{instance}/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*.
Returns
Type
Description
string
setName
The unique name of the app profile. Values are of the formprojects/{project}/instances/{instance}/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEtag
Strongly validated etag for optimistic concurrency control. Preserve the
value returned fromGetAppProfilewhen callingUpdateAppProfileto
fail the request if there has been a modification in the mean time. Theupdate_maskof the request need not includeetagfor this protection
to apply.
Strongly validated etag for optimistic concurrency control. Preserve the
value returned fromGetAppProfilewhen callingUpdateAppProfileto
fail the request if there has been a modification in the mean time. Theupdate_maskof the request need not includeetagfor this protection
to apply.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class AppProfile (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Admin.V2.AppProfile)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Admin.V2.AppProfile)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Admin.V2.AppProfile)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Admin.V2.AppProfile)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Admin.V2.AppProfile)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Admin.V2.AppProfile)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Admin.V2.AppProfile)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Admin.V2.AppProfile)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Admin.V2.AppProfile)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Admin.V2.AppProfile)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Admin.V2.AppProfile)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Admin.V2.AppProfile)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Admin.V2.AppProfile)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Admin.V2.AppProfile)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Admin.V2.AppProfile)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Admin.V2.AppProfile)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Admin.V2.AppProfile)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Admin.V2.AppProfile)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Admin.V2.AppProfile)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Admin.V2.AppProfile)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Admin.V2.AppProfile)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Admin.V2.AppProfile)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Admin.V2.AppProfile)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Admin.V2.AppProfile)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Admin.V2.AppProfile)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Admin.V2.AppProfile)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Admin.V2.AppProfile)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Admin.V2.AppProfile)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Admin.V2.AppProfile)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Admin.V2.AppProfile)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Admin.V2.AppProfile) \nReference documentation and code samples for the Cloud Bigtable V2 Client class AppProfile.\n\nA configuration object describing how Cloud Bigtable should treat traffic\nfrom a particular end user application.\n\nGenerated from protobuf message `google.bigtable.admin.v2.AppProfile`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Admin \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe unique name of the app profile. Values are of the form\n`projects/{project}/instances/{instance}/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.\n\n### setName\n\nThe unique name of the app profile. Values are of the form\n`projects/{project}/instances/{instance}/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.\n\n### getEtag\n\nStrongly validated etag for optimistic concurrency control. Preserve the\nvalue returned from `GetAppProfile` when calling `UpdateAppProfile` to\nfail the request if there has been a modification in the mean time. The\n`update_mask` of the request need not include `etag` for this protection\nto apply.\n\nSee [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and\n[RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more\ndetails.\n\n### setEtag\n\nStrongly validated etag for optimistic concurrency control. Preserve the\nvalue returned from `GetAppProfile` when calling `UpdateAppProfile` to\nfail the request if there has been a modification in the mean time. The\n`update_mask` of the request need not include `etag` for this protection\nto apply.\n\nSee [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and\n[RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more\ndetails.\n\n### getDescription\n\nLong form description of the use case for this AppProfile.\n\n### setDescription\n\nLong form description of the use case for this AppProfile.\n\n### getMultiClusterRoutingUseAny\n\nUse a multi-cluster routing policy.\n\n### hasMultiClusterRoutingUseAny\n\n### setMultiClusterRoutingUseAny\n\nUse a multi-cluster routing policy.\n\n### getSingleClusterRouting\n\nUse a single-cluster routing policy.\n\n### hasSingleClusterRouting\n\n### setSingleClusterRouting\n\nUse a single-cluster routing policy.\n\n### getPriority\n\nThis field has been deprecated in favor of `standard_isolation.priority`.\n\nIf you set this field, `standard_isolation.priority` will be set instead.\nThe priority of requests sent using this app profile.\n\n### hasPriority\n\n### setPriority\n\nThis field has been deprecated in favor of `standard_isolation.priority`.\n\nIf you set this field, `standard_isolation.priority` will be set instead.\nThe priority of requests sent using this app profile.\n\n### getStandardIsolation\n\nThe standard options used for isolating this app profile's traffic from\nother use cases.\n\n### hasStandardIsolation\n\n### setStandardIsolation\n\nThe standard options used for isolating this app profile's traffic from\nother use cases.\n\n### getDataBoostIsolationReadOnly\n\nSpecifies that this app profile is intended for read-only usage via the\nData Boost feature.\n\n### hasDataBoostIsolationReadOnly\n\n### setDataBoostIsolationReadOnly\n\nSpecifies that this app profile is intended for read-only usage via the\nData Boost feature.\n\n### getRoutingPolicy\n\n### getIsolation"]]
