Google Cloud Bare Metal Solution V2 Client - Class ProvisioningConfig (0.5.2)

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 \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setName

Output only. The system-generated name of the provisioning config. This follows the UUID format.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInstances

Instances to be created.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setInstances

Instances to be created.

Parameter
NameDescription
var array<Google\Cloud\BareMetalSolution\V2\InstanceConfig>
Returns
TypeDescription
$this

getNetworks

Networks to be created.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNetworks

Networks to be created.

Parameter
NameDescription
var array<Google\Cloud\BareMetalSolution\V2\NetworkConfig>
Returns
TypeDescription
$this

getVolumes

Volumes to be created.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setVolumes

Volumes to be created.

Parameter
NameDescription
var array<Google\Cloud\BareMetalSolution\V2\VolumeConfig>
Returns
TypeDescription
$this

getTicketId

A generated ticket id to track provisioning request.

Returns
TypeDescription
string

setTicketId

A generated ticket id to track provisioning request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHandoverServiceAccount

A service account to enable customers to access instance credentials upon handover.

Returns
TypeDescription
string

setHandoverServiceAccount

A service account to enable customers to access instance credentials upon handover.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEmail

Email provided to send a confirmation with provisioning config to.

Deprecated in favour of email field in request messages.

Returns
TypeDescription
string

setEmail

Email provided to send a confirmation with provisioning config to.

Deprecated in favour of email field in request messages.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. State of ProvisioningConfig.

Returns
TypeDescription
int

setState

Output only. State of ProvisioningConfig.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getLocation

Optional. Location name of this ProvisioningConfig.

It is optional only for Intake UI transition period.

Returns
TypeDescription
string

setLocation

Optional. Location name of this ProvisioningConfig.

It is optional only for Intake UI transition period.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUpdateTime

Output only. Last update timestamp.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last update timestamp.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getCloudConsoleUri

Output only. URI to Cloud Console UI view of this provisioning config.

Returns
TypeDescription
string

setCloudConsoleUri

Output only. URI to Cloud Console UI view of this provisioning config.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVpcScEnabled

If true, VPC SC is enabled for the cluster.

Returns
TypeDescription
bool

setVpcScEnabled

If true, VPC SC is enabled for the cluster.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getStatusMessage

Optional status messages associated with the FAILED state.

Returns
TypeDescription
string

setStatusMessage

Optional status messages associated with the FAILED state.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCustomId

Optional. The user-defined identifier of the provisioning config.

Returns
TypeDescription
string

setCustomId

Optional. The user-defined identifier of the provisioning config.

Parameter
NameDescription
var string
Returns
TypeDescription
$this