Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class Feature.
Feature represents the settings and status of any Hub Feature.
Generated from protobuf message google.cloud.gkehub.v1.Feature
Namespace
Google \ Cloud \ GkeHub \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The full, unique name of this Feature resource in the format |
↳ labels |
array|Google\Protobuf\Internal\MapField
GCP labels for this Feature. |
↳ resource_state |
Google\Cloud\GkeHub\V1\FeatureResourceState
Output only. State of the Feature resource itself. |
↳ spec |
Google\Cloud\GkeHub\V1\CommonFeatureSpec
Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. |
↳ membership_specs |
array|Google\Protobuf\Internal\MapField
Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. |
↳ state |
Google\Cloud\GkeHub\V1\CommonFeatureState
Output only. The Hub-wide Feature state. |
↳ membership_states |
array|Google\Protobuf\Internal\MapField
Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. When the Feature resource was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. When the Feature resource was last updated. |
↳ delete_time |
Google\Protobuf\Timestamp
Output only. When the Feature resource was deleted. |
getName
Output only. The full, unique name of this Feature resource in the format
projects/*/locations/*/features/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The full, unique name of this Feature resource in the format
projects/*/locations/*/features/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
GCP labels for this Feature.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
GCP labels for this Feature.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourceState
Output only. State of the Feature resource itself.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeHub\V1\FeatureResourceState|null | |
hasResourceState
clearResourceState
setResourceState
Output only. State of the Feature resource itself.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeHub\V1\FeatureResourceState
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpec
Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeHub\V1\CommonFeatureSpec|null | |
hasSpec
clearSpec
setSpec
Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeHub\V1\CommonFeatureSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMembershipSpecs
Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused.
The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setMembershipSpecs
Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused.
The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The Hub-wide Feature state.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeHub\V1\CommonFeatureState|null | |
hasState
clearState
setState
Output only. The Hub-wide Feature state.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeHub\V1\CommonFeatureState
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMembershipStates
Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused.
The keys indicate which Membership the state is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setMembershipStates
Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused.
The keys indicate which Membership the state is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. When the Feature resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. When the Feature resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. When the Feature resource was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. When the Feature resource was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeleteTime
Output only. When the Feature resource was deleted.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. When the Feature resource was deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |