Skip to main content

app_profiles

Creates, updates, deletes, gets or lists an app_profiles resource.

Overview​

Nameapp_profiles
TypeResource
Idgoogle.bigtableadmin.app_profiles

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringThe unique name of the app profile, up to 50 characters long. Values are of the form projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*.
dataBoostIsolationReadOnlyobjectSpecifies that this app profile is intended for read-only usage via the Data Boost feature. (id: DataBoostIsolationReadOnly)
descriptionstringLong form description of the use case for this AppProfile.
etagstringStrongly 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.
multiClusterRoutingUseAnyobjectUse a multi-cluster routing policy. (id: MultiClusterRoutingUseAny)
prioritystringThis 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.
singleClusterRoutingobjectUse a single-cluster routing policy. (id: SingleClusterRouting)
standardIsolationobjectThe standard options used for isolating this app profile's traffic from other use cases. (id: StandardIsolation)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, instancesId, appProfilesIdGets information about an app profile.
listselectprojectsId, instancesIdpageSize, pageTokenLists information about app profiles in an instance.
createinsertprojectsId, instancesIdappProfileId, ignoreWarningsCreates an app profile within an instance.
patchupdateprojectsId, instancesId, appProfilesIdupdateMask, ignoreWarningsUpdates an app profile within an instance.
deletedeleteprojectsId, instancesId, appProfilesIdignoreWarningsDeletes an app profile from an instance.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
appProfilesIdstring
instancesIdstring
projectsIdstring
appProfileIdstring
ignoreWarningsboolean
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)

SELECT examples​

Gets information about an app profile.

SELECT
name,
dataBoostIsolationReadOnly,
description,
etag,
multiClusterRoutingUseAny,
priority,
singleClusterRouting,
standardIsolation
FROM google.bigtableadmin.app_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND appProfilesId = '{{ appProfilesId }}' -- required;

INSERT examples​

Creates an app profile within an instance.

INSERT INTO google.bigtableadmin.app_profiles (
data__name,
data__etag,
data__description,
data__multiClusterRoutingUseAny,
data__singleClusterRouting,
data__priority,
data__standardIsolation,
data__dataBoostIsolationReadOnly,
projectsId,
instancesId,
appProfileId,
ignoreWarnings
)
SELECT 
'{{ name }}',
'{{ etag }}',
'{{ description }}',
'{{ multiClusterRoutingUseAny }}',
'{{ singleClusterRouting }}',
'{{ priority }}',
'{{ standardIsolation }}',
'{{ dataBoostIsolationReadOnly }}',
'{{ projectsId }}',
'{{ instancesId }}',
'{{ appProfileId }}',
'{{ ignoreWarnings }}'
RETURNING
name,
dataBoostIsolationReadOnly,
description,
etag,
multiClusterRoutingUseAny,
priority,
singleClusterRouting,
standardIsolation
;

UPDATE examples​

Updates an app profile within an instance.

UPDATE google.bigtableadmin.app_profiles
SET 
data__name = '{{ name }}',
data__etag = '{{ etag }}',
data__description = '{{ description }}',
data__multiClusterRoutingUseAny = '{{ multiClusterRoutingUseAny }}',
data__singleClusterRouting = '{{ singleClusterRouting }}',
data__priority = '{{ priority }}',
data__standardIsolation = '{{ standardIsolation }}',
data__dataBoostIsolationReadOnly = '{{ dataBoostIsolationReadOnly }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND appProfilesId = '{{ appProfilesId }}' --required
AND updateMask = '{{ updateMask}}'
AND ignoreWarnings = {{ ignoreWarnings}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes an app profile from an instance.

DELETE FROM google.bigtableadmin.app_profiles
WHERE projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND appProfilesId = '{{ appProfilesId }}' --required
AND ignoreWarnings = '{{ ignoreWarnings }}';