Reference documentation and code samples for the Compute V1 Client class Host.
Represents a host resource.
Generated from protobuf message google.cloud.compute.v1.Host
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ alias_links |
string[]
Output only. All aliases for this resource. e.g. projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1 |
↳ creation_timestamp |
string
Output only. The creation timestamp, formatted asRFC3339 text. |
↳ description |
string
An optional description of this resource. |
↳ id |
int|string
Output only. The unique identifier for this resource. This identifier is defined by the server. |
↳ kind |
string
Output only. The type of resource. Alwayscompute#host for hosts. |
↳ name |
string
Output only. The name of the host. |
↳ self_link |
string
Output only. The self link of the host. |
↳ self_link_with_id |
string
Output only. The self link with id of the host. |
↳ state |
string
Output only. The state of the host. Check the State enum for the list of possible values. |
↳ status |
HostStatus
Output only. The status of the host |
↳ zone |
string
Output only. The zone in which the host resides. |
getAliasLinks
Output only. All aliases for this resource.
e.g. projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAliasLinks
Output only. All aliases for this resource.
e.g. projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreationTimestamp
Output only. The creation timestamp, formatted asRFC3339 text.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
Output only. The creation timestamp, formatted asRFC3339 text.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
An optional description of this resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
An optional description of this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
Output only. The unique identifier for this resource. This identifier is defined by the server.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasId
clearId
setId
Output only. The unique identifier for this resource. This identifier is defined by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKind
Output only. The type of resource. Alwayscompute#host for hosts.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasKind
clearKind
setKind
Output only. The type of resource. Alwayscompute#host for hosts.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Output only. The name of the host.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasName
clearName
setName
Output only. The name of the host.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLink
Output only. The self link of the host.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSelfLink
clearSelfLink
setSelfLink
Output only. The self link of the host.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLinkWithId
Output only. The self link with id of the host.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSelfLinkWithId
clearSelfLinkWithId
setSelfLinkWithId
Output only. The self link with id of the host.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The state of the host.
Check the State enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasState
clearState
setState
Output only. The state of the host.
Check the State enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. The status of the host
| Returns | |
|---|---|
| Type | Description |
HostStatus|null |
|
hasStatus
clearStatus
setStatus
Output only. The status of the host
| Parameter | |
|---|---|
| Name | Description |
var |
HostStatus
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getZone
Output only. The zone in which the host resides.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasZone
clearZone
setZone
Output only. The zone in which the host resides.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|