Cloud Spanner V1 Client - Class AddSplitPointsRequest (1.93.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class AddSplitPointsRequest.

The request for AddSplitPoints.

Generated from protobuf message google.spanner.admin.database.v1.AddSplitPointsRequest

Namespace

Google \ Cloud \ Spanner \ Admin \ Database \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ database string

Required. The database on whose tables/indexes split points are to be added. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

↳ split_points array<SplitPoints>

Required. The split points to add.

↳ initiator string

Optional. A user-supplied tag associated with the split points. For example, "intital_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.

getDatabase

Required. The database on whose tables/indexes split points are to be added. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

Returns
Type Description
string

setDatabase

Required. The database on whose tables/indexes split points are to be added. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

Parameter
Name Description
var string
Returns
Type Description
$this

getSplitPoints

Required. The split points to add.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSplitPoints

Required. The split points to add.

Parameter
Name Description
var array<SplitPoints>
Returns
Type Description
$this

getInitiator

Optional. A user-supplied tag associated with the split points.

For example, "intital_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.

Returns
Type Description
string

setInitiator

Optional. A user-supplied tag associated with the split points.

For example, "intital_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
database string

Required. The database on whose tables/indexes split points are to be added. Values are of the form projects/<project>/instances/<instance>/databases/<database>. Please see DatabaseAdminClient::databaseName() for help formatting this field.

splitPoints array<SplitPoints>

Required. The split points to add.

Returns
Type Description
AddSplitPointsRequest