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 message google.bigtable.admin.v2.AppProfile
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2Methods
__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 form |
↳ etag |
string
Strongly validated etag for optimistic concurrency control. Preserve the value returned from |
↳ description |
string
Long form description of the use case for this AppProfile. |
↳ multi_cluster_routing_use_any |
Google\Cloud\Bigtable\Admin\V2\AppProfile\MultiClusterRoutingUseAny
Use a multi-cluster routing policy. |
↳ single_cluster_routing |
Google\Cloud\Bigtable\Admin\V2\AppProfile\SingleClusterRouting
Use a single-cluster routing policy. |
↳ priority |
int
This field has been deprecated in favor of |
↳ standard_isolation |
Google\Cloud\Bigtable\Admin\V2\AppProfile\StandardIsolation
The standard options used for isolating this app profile's traffic from other use cases. |
↳ data_boost_isolation_read_only |
Google\Cloud\Bigtable\Admin\V2\AppProfile\DataBoostIsolationReadOnly
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 form
projects/{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 form
projects/{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 from GetAppProfile when calling UpdateAppProfile to
fail the request if there has been a modification in the mean time. The
update_mask of the request need not include etag for this protection
to apply.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Strongly validated etag for optimistic concurrency control. Preserve the
value returned from GetAppProfile when calling UpdateAppProfile to
fail the request if there has been a modification in the mean time. The
update_mask of the request need not include etag for this protection
to apply.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Long form description of the use case for this AppProfile.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Long form description of the use case for this AppProfile.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMultiClusterRoutingUseAny
Use a multi-cluster routing policy.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\AppProfile\MultiClusterRoutingUseAny|null |
|
hasMultiClusterRoutingUseAny
setMultiClusterRoutingUseAny
Use a multi-cluster routing policy.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\AppProfile\MultiClusterRoutingUseAny
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSingleClusterRouting
Use a single-cluster routing policy.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\AppProfile\SingleClusterRouting|null |
|
hasSingleClusterRouting
setSingleClusterRouting
Use a single-cluster routing policy.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\AppProfile\SingleClusterRouting
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPriority
This field has been deprecated in favor of standard_isolation.priority.
If you set this field, standard_isolation.priority will be set instead.
The priority of requests sent using this app profile.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasPriority
setPriority
This field has been deprecated in favor of standard_isolation.priority.
If you set this field, standard_isolation.priority will be set instead.
The priority of requests sent using this app profile.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStandardIsolation
The standard options used for isolating this app profile's traffic from other use cases.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\AppProfile\StandardIsolation|null |
|
hasStandardIsolation
setStandardIsolation
The standard options used for isolating this app profile's traffic from other use cases.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\AppProfile\StandardIsolation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataBoostIsolationReadOnly
Specifies that this app profile is intended for read-only usage via the Data Boost feature.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\AppProfile\DataBoostIsolationReadOnly|null |
|
hasDataBoostIsolationReadOnly
setDataBoostIsolationReadOnly
Specifies that this app profile is intended for read-only usage via the Data Boost feature.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\AppProfile\DataBoostIsolationReadOnly
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRoutingPolicy
| Returns | |
|---|---|
| Type | Description |
string |
|
getIsolation
| Returns | |
|---|---|
| Type | Description |
string |
|