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 | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setProjectId
Output only. Project ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIndexId
Output only. The resource ID of the index.
| Returns | |
|---|---|
| Type | Description |
string | |
setIndexId
Output only. The resource ID of the index.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
Required. The entity kind to which this index applies.
| Returns | |
|---|---|
| Type | Description |
string | |
setKind
Required. The entity kind to which this index applies.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAncestor
Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
| Returns | |
|---|---|
| Type | Description |
int | |
setAncestor
Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProperties
Required. An ordered sequence of property names and their index attributes.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setProperties
Required. An ordered sequence of property names and their index attributes.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Datastore\Admin\V1\Index\IndexedProperty>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The state of the index.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The state of the index.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |