Google Cloud Datastore Admin V1 Client - Class Index (0.6.0)

Reference documentation and code samples for the Google Cloud Datastore Admin V1 Client class Index.

Datastore composite index definition.

Generated from protobuf message google.datastore.admin.v1.Index

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ project_id string

Output only. Project ID.

↳ index_id string

Output only. The resource ID of the index.

↳ kind string

Required. The entity kind to which this index applies.

↳ ancestor int

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

↳ properties array<Google\Cloud\Datastore\Admin\V1\Index\IndexedProperty>

Required. An ordered sequence of property names and their index attributes.

↳ state int

Output only. The state of the index.

getProjectId

Output only. Project ID.

Returns
TypeDescription
string

setProjectId

Output only. Project ID.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIndexId

Output only. The resource ID of the index.

Returns
TypeDescription
string

setIndexId

Output only. The resource ID of the index.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKind

Required. The entity kind to which this index applies.

Returns
TypeDescription
string

setKind

Required. The entity kind to which this index applies.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAncestor

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

Returns
TypeDescription
int

setAncestor

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getProperties

Required. An ordered sequence of property names and their index attributes.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setProperties

Required. An ordered sequence of property names and their index attributes.

Parameter
NameDescription
var array<Google\Cloud\Datastore\Admin\V1\Index\IndexedProperty>
Returns
TypeDescription
$this

getState

Output only. The state of the index.

Returns
TypeDescription
int

setState

Output only. The state of the index.

Parameter
NameDescription
var int
Returns
TypeDescription
$this