Cloud Bigtable V2 Client - Class PingAndWarmRequest (2.1.0)

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

Request message for client connection keep-alive and warming.

Generated from protobuf message google.bigtable.v2.PingAndWarmRequest

Namespace

Google \ Cloud \ Bigtable \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.

↳ app_profile_id string

This value specifies routing for replication. If not specified, the "default" application profile will be used.

getName

Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.

Returns
Type Description
string

setName

Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.

Parameter
Name Description
var string
Returns
Type Description
$this

getAppProfileId

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Returns
Type Description
string

setAppProfileId

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>. Please see Google\Cloud\Bigtable\V2\BigtableClient::instanceName() for help formatting this field.

Returns
Type Description
Google\Cloud\Bigtable\V2\PingAndWarmRequest

static::buildFromNameAppProfileId

Parameters
Name Description
name string

Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>. Please see Google\Cloud\Bigtable\V2\BigtableClient::instanceName() for help formatting this field.

appProfileId string

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Returns
Type Description
Google\Cloud\Bigtable\V2\PingAndWarmRequest