Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class HcxActivationKey.
HCX activation key. A default key is created during private cloud provisioning, but this behavior is subject to change and you should always verify active keys.
Use VmwareEngine.ListHcxActivationKeys to retrieve existing keys and VmwareEngine.CreateHcxActivationKey to create new ones.
Generated from protobuf message google.cloud.vmwareengine.v1.HcxActivationKey
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name of this HcxActivationKey. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Creation time of HCX activation key. |
↳ state |
int
Output only. State of HCX activation key. |
↳ activation_key |
string
Output only. HCX activation key. |
↳ uid |
string
Output only. System-generated unique identifier for the resource. |
getName
Output only. The resource name of this HcxActivationKey.
Resource names are schemeless URIs that follow the conventions in
https://cloud.google.com/apis/design/resource_names.
For example:
projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name of this HcxActivationKey.
Resource names are schemeless URIs that follow the conventions in
https://cloud.google.com/apis/design/resource_names.
For example:
projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Creation time of HCX activation key.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation time of HCX activation key.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. State of HCX activation key.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. State of HCX activation key.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getActivationKey
Output only. HCX activation key.
| Returns | |
|---|---|
| Type | Description |
string | |
setActivationKey
Output only. HCX activation key.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. System-generated unique identifier for the resource.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. System-generated unique identifier for the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |