Reference documentation and code samples for the Google Cloud Lustre V1 Client class Instance.
A Managed Lustre instance.
Generated from protobuf message google.cloud.lustre.v1.Instance
Namespace
Google \ Cloud \ Lustre \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The name of the instance. |
↳ filesystem |
string
Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be eight characters or less and can only contain letters and numbers. |
↳ capacity_gib |
int|string
Required. The storage capacity of the instance in gibibytes (GiB). Allowed values depend on the |
↳ network |
string
Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format |
↳ state |
int
Output only. The state of the instance. |
↳ mount_point |
string
Output only. Mount point of the instance in the format |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when the instance was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when the instance was last updated. |
↳ description |
string
Optional. A user-readable description of the instance. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels as key value pairs. |
↳ per_unit_storage_throughput |
int|string
Optional. The throughput of the instance in MBps per TiB. Valid values are 0, 125, 250, 500, 1000. See Performance tiers for more information. If the instance is using the Dynamic tier, this field must not be set or must be set to zero. |
↳ gke_support_enabled |
bool
Optional. Deprecated: No longer required for GKE instance creation. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported. |
↳ kms_key |
string
Optional. Immutable. The Cloud KMS key name to use for data encryption. If not set, the instance will use Google-managed encryption keys. If set, the instance will use customer-managed encryption keys. The key must be in the same region as the instance. The key format is: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} |
↳ state_reason |
string
Output only. The reason why the instance is in a certain state (e.g. SUSPENDED). |
↳ placement_policy |
string
Optional. The placement policy name for the instance in the format of projects/{project}/locations/{location}/resourcePolicies/{resource_policy} |
↳ access_rules_options |
AccessRulesOptions
Optional. The access rules options for the instance. |
↳ uid |
string
Output only. Unique ID of the resource. This is unrelated to the access rules which allow specifying the root squash uid. |
↳ maintenance_policy |
MaintenancePolicy
Optional. The maintenance policy for the instance to determine when to allow or exclude the instance from maintenance updates. |
↳ upcoming_maintenance_schedule |
MaintenanceSchedule
Output only. Date and time of upcoming maintenance for the instance, if a maintenance policy is set. |
↳ dynamic_tier_options |
DynamicTierOptions
Optional. Immutable. Specifies whether the instance is on the Dynamic tier. See Performance tiers for more information. |
↳ available_version |
string
Output only. The available version that this instance can be upgraded to. Format: |
↳ target_version |
string
Optional. The target version of the instance. Setting this field triggers a self-service update to the specified version. Format: |
↳ effective_version |
string
Output only. The effective version of the instance. Format: |
getName
Identifier. The name of the instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The name of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilesystem
Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be eight characters or less and can only contain letters and numbers.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilesystem
Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be eight characters or less and can only contain letters and numbers.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCapacityGib
Required. The storage capacity of the instance in gibibytes (GiB). Allowed
values depend on the perUnitStorageThroughput. See Performance
tiers
for specific minimums, maximums, and step sizes for each performance tier.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setCapacityGib
Required. The storage capacity of the instance in gibibytes (GiB). Allowed
values depend on the perUnitStorageThroughput. See Performance
tiers
for specific minimums, maximums, and step sizes for each performance tier.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetwork
Required. Immutable. The full name of the VPC network to which the instance
is connected. Must be in the format
projects/{project_id}/global/networks/{network_name}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNetwork
Required. Immutable. The full name of the VPC network to which the instance
is connected. Must be in the format
projects/{project_id}/global/networks/{network_name}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The state of the instance.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. The state of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMountPoint
Output only. Mount point of the instance in the format
IP_ADDRESS\@tcp:/FILESYSTEM.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMountPoint
Output only. Mount point of the instance in the format
IP_ADDRESS\@tcp:/FILESYSTEM.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Timestamp when the instance was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when the instance was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Timestamp when the instance was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when the instance was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A user-readable description of the instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A user-readable description of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Labels as key value pairs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Labels as key value pairs.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPerUnitStorageThroughput
Optional. The throughput of the instance in MBps per TiB. Valid values are 0, 125, 250, 500, 1000. See Performance tiers for more information.
If the instance is using the Dynamic tier, this field must not be set or must be set to zero.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setPerUnitStorageThroughput
Optional. The throughput of the instance in MBps per TiB. Valid values are 0, 125, 250, 500, 1000. See Performance tiers for more information.
If the instance is using the Dynamic tier, this field must not be set or must be set to zero.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGkeSupportEnabled
Optional. Deprecated: No longer required for GKE instance creation.
Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setGkeSupportEnabled
Optional. Deprecated: No longer required for GKE instance creation.
Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKmsKey
Optional. Immutable. The Cloud KMS key name to use for data encryption.
If not set, the instance will use Google-managed encryption keys. If set, the instance will use customer-managed encryption keys. The key must be in the same region as the instance. The key format is: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
| Returns | |
|---|---|
| Type | Description |
string |
|
setKmsKey
Optional. Immutable. The Cloud KMS key name to use for data encryption.
If not set, the instance will use Google-managed encryption keys. If set, the instance will use customer-managed encryption keys. The key must be in the same region as the instance. The key format is: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStateReason
Output only. The reason why the instance is in a certain state (e.g.
SUSPENDED).
| Returns | |
|---|---|
| Type | Description |
string |
|
setStateReason
Output only. The reason why the instance is in a certain state (e.g.
SUSPENDED).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlacementPolicy
Optional. The placement policy name for the instance in the format of projects/{project}/locations/{location}/resourcePolicies/{resource_policy}
| Returns | |
|---|---|
| Type | Description |
string |
|
setPlacementPolicy
Optional. The placement policy name for the instance in the format of projects/{project}/locations/{location}/resourcePolicies/{resource_policy}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccessRulesOptions
Optional. The access rules options for the instance.
| Returns | |
|---|---|
| Type | Description |
AccessRulesOptions|null |
|
hasAccessRulesOptions
clearAccessRulesOptions
setAccessRulesOptions
Optional. The access rules options for the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
AccessRulesOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. Unique ID of the resource.
This is unrelated to the access rules which allow specifying the root squash uid.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. Unique ID of the resource.
This is unrelated to the access rules which allow specifying the root squash uid.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaintenancePolicy
Optional. The maintenance policy for the instance to determine when to allow or exclude the instance from maintenance updates.
| Returns | |
|---|---|
| Type | Description |
MaintenancePolicy|null |
|
hasMaintenancePolicy
clearMaintenancePolicy
setMaintenancePolicy
Optional. The maintenance policy for the instance to determine when to allow or exclude the instance from maintenance updates.
| Parameter | |
|---|---|
| Name | Description |
var |
MaintenancePolicy
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpcomingMaintenanceSchedule
Output only. Date and time of upcoming maintenance for the instance, if a maintenance policy is set.
| Returns | |
|---|---|
| Type | Description |
MaintenanceSchedule|null |
|
hasUpcomingMaintenanceSchedule
clearUpcomingMaintenanceSchedule
setUpcomingMaintenanceSchedule
Output only. Date and time of upcoming maintenance for the instance, if a maintenance policy is set.
| Parameter | |
|---|---|
| Name | Description |
var |
MaintenanceSchedule
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDynamicTierOptions
Optional. Immutable. Specifies whether the instance is on the Dynamic tier.
See Performance tiers for more information.
| Returns | |
|---|---|
| Type | Description |
DynamicTierOptions|null |
|
hasDynamicTierOptions
clearDynamicTierOptions
setDynamicTierOptions
Optional. Immutable. Specifies whether the instance is on the Dynamic tier.
See Performance tiers for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
DynamicTierOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAvailableVersion
Output only. The available version that this instance can be upgraded to.
Format: Lustre_YYYYMMDD.NN_pXX
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAvailableVersion
clearAvailableVersion
setAvailableVersion
Output only. The available version that this instance can be upgraded to.
Format: Lustre_YYYYMMDD.NN_pXX
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetVersion
Optional. The target version of the instance. Setting this field triggers a self-service update to the specified version.
Format: Lustre_YYYYMMDD.NN_pXX or latest
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTargetVersion
clearTargetVersion
setTargetVersion
Optional. The target version of the instance. Setting this field triggers a self-service update to the specified version.
Format: Lustre_YYYYMMDD.NN_pXX or latest
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEffectiveVersion
Output only. The effective version of the instance.
Format: Lustre_YYYYMMDD.NN_pXX
| Returns | |
|---|---|
| Type | Description |
string |
|
hasEffectiveVersion
clearEffectiveVersion
setEffectiveVersion
Output only. The effective version of the instance.
Format: Lustre_YYYYMMDD.NN_pXX
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|