Cloud Bigtable V2 Client - Class CreateAppProfileRequest (1.29.2)

Reference documentation and code samples for the Cloud Bigtable V2 Client class CreateAppProfileRequest.

Request message for BigtableInstanceAdmin.CreateAppProfile.

Generated from protobuf message google.bigtable.admin.v2.CreateAppProfileRequest

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

↳ app_profile_id string

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

↳ app_profile Google\Cloud\Bigtable\Admin\V2\AppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

↳ ignore_warnings bool

If true, ignore safety checks when creating the app profile.

getParent

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

Returns
TypeDescription
string

setParent

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAppProfileId

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

Returns
TypeDescription
string

setAppProfileId

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAppProfile

Required. The app profile to be created.

Fields marked OutputOnly will be ignored.

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

hasAppProfile

clearAppProfile

setAppProfile

Required. The app profile to be created.

Fields marked OutputOnly will be ignored.

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

getIgnoreWarnings

If true, ignore safety checks when creating the app profile.

Returns
TypeDescription
bool

setIgnoreWarnings

If true, ignore safety checks when creating the app profile.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}. Please see Google\Cloud\Bigtable\Admin\V2\BigtableInstanceAdminClient::instanceName() for help formatting this field.

appProfileId string

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

appProfile Google\Cloud\Bigtable\Admin\V2\AppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

Returns
TypeDescription
Google\Cloud\Bigtable\Admin\V2\CreateAppProfileRequest