Reference documentation and code samples for the Google Cloud Bare Metal Solution V2 Client class ProvisioningConfig.
A provisioning configuration.
Generated from protobuf message google.cloud.baremetalsolution.v2.ProvisioningConfig
Namespace
Google \ Cloud \ BareMetalSolution \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The system-generated name of the provisioning config. This follows the UUID format. |
↳ instances |
array<Google\Cloud\BareMetalSolution\V2\InstanceConfig>
Instances to be created. |
↳ networks |
array<Google\Cloud\BareMetalSolution\V2\NetworkConfig>
Networks to be created. |
↳ volumes |
array<Google\Cloud\BareMetalSolution\V2\VolumeConfig>
Volumes to be created. |
↳ ticket_id |
string
A generated ticket id to track provisioning request. |
↳ handover_service_account |
string
A service account to enable customers to access instance credentials upon handover. |
↳ email |
string
Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. |
↳ state |
int
Output only. State of ProvisioningConfig. |
↳ location |
string
Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Last update timestamp. |
↳ cloud_console_uri |
string
Output only. URI to Cloud Console UI view of this provisioning config. |
↳ vpc_sc_enabled |
bool
If true, VPC SC is enabled for the cluster. |
↳ status_message |
string
Optional status messages associated with the FAILED state. |
↳ custom_id |
string
Optional. The user-defined identifier of the provisioning config. |
getName
Output only. The system-generated name of the provisioning config. This follows the UUID format.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The system-generated name of the provisioning config. This follows the UUID format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstances
Instances to be created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setInstances
Instances to be created.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BareMetalSolution\V2\InstanceConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetworks
Networks to be created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setNetworks
Networks to be created.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BareMetalSolution\V2\NetworkConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVolumes
Volumes to be created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setVolumes
Volumes to be created.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BareMetalSolution\V2\VolumeConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTicketId
A generated ticket id to track provisioning request.
| Returns | |
|---|---|
| Type | Description |
string | |
setTicketId
A generated ticket id to track provisioning request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHandoverServiceAccount
A service account to enable customers to access instance credentials upon handover.
| Returns | |
|---|---|
| Type | Description |
string | |
setHandoverServiceAccount
A service account to enable customers to access instance credentials upon handover.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEmail
Email provided to send a confirmation with provisioning config to.
Deprecated in favour of email field in request messages.
| Returns | |
|---|---|
| Type | Description |
string | |
setEmail
Email provided to send a confirmation with provisioning config to.
Deprecated in favour of email field in request messages.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. State of ProvisioningConfig.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. State of ProvisioningConfig.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLocation
Optional. Location name of this ProvisioningConfig.
It is optional only for Intake UI transition period.
| Returns | |
|---|---|
| Type | Description |
string | |
setLocation
Optional. Location name of this ProvisioningConfig.
It is optional only for Intake UI transition period.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Last update timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last update timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCloudConsoleUri
Output only. URI to Cloud Console UI view of this provisioning config.
| Returns | |
|---|---|
| Type | Description |
string | |
setCloudConsoleUri
Output only. URI to Cloud Console UI view of this provisioning config.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVpcScEnabled
If true, VPC SC is enabled for the cluster.
| Returns | |
|---|---|
| Type | Description |
bool | |
setVpcScEnabled
If true, VPC SC is enabled for the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatusMessage
Optional status messages associated with the FAILED state.
| Returns | |
|---|---|
| Type | Description |
string | |
setStatusMessage
Optional status messages associated with the FAILED state.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCustomId
Optional. The user-defined identifier of the provisioning config.
| Returns | |
|---|---|
| Type | Description |
string | |
setCustomId
Optional. The user-defined identifier of the provisioning config.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |