Cloud Bigtable V2 Client - Class AppProfile (1.22.2)

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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]*.

↳ etag string

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. See Wikipedia and RFC 7232 for more details.

↳ 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.

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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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.

See Wikipedia and RFC 7232 for more details.

Returns
TypeDescription
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.

See Wikipedia and RFC 7232 for more details.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Long form description of the use case for this AppProfile.

Returns
TypeDescription
string

setDescription

Long form description of the use case for this AppProfile.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMultiClusterRoutingUseAny

Use a multi-cluster routing policy.

Returns
TypeDescription
Google\Cloud\Bigtable\Admin\V2\AppProfile\MultiClusterRoutingUseAny|null

hasMultiClusterRoutingUseAny

setMultiClusterRoutingUseAny

Use a multi-cluster routing policy.

Parameter
NameDescription
var Google\Cloud\Bigtable\Admin\V2\AppProfile\MultiClusterRoutingUseAny
Returns
TypeDescription
$this

getSingleClusterRouting

Use a single-cluster routing policy.

Returns
TypeDescription
Google\Cloud\Bigtable\Admin\V2\AppProfile\SingleClusterRouting|null

hasSingleClusterRouting

setSingleClusterRouting

Use a single-cluster routing policy.

Parameter
NameDescription
var Google\Cloud\Bigtable\Admin\V2\AppProfile\SingleClusterRouting
Returns
TypeDescription
$this

getRoutingPolicy

Returns
TypeDescription
string