- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PersistentResource.
Represents long-lasting resources that are dedicated to users to runs custom workloads.
A PersistentResource can have multiple node pools and each node pool can have its own machine spec.
Generated from protobuf message google.cloud.aiplatform.v1.PersistentResource
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Immutable. Resource name of a PersistentResource.
↳ display_name
string
Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
↳ resource_pools
↳ state
int
Output only. The detailed state of a Study.
↳ error
Google\Rpc\Status
Output only. Only populated when persistent resource's state is STOPPING
or ERROR
.
↳ create_time
↳ start_time
Google\Protobuf\Timestamp
Output only. Time when the PersistentResource for the first time entered the RUNNING
state.
↳ update_time
↳ labels
array| Google\Protobuf\Internal\MapField
Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
↳ network
string
Optional. The full name of the Compute Engine network
to peered with Vertex AI to host the persistent resources. For example, projects/12345/global/networks/myVPC
. Format
is of the form projects/{project}/global/networks/{network}
. Where {project} is a project number, as in 12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI
. If this field is left unspecified, the resources aren't peered with any network.
↳ psc_interface_config
↳ encryption_spec
EncryptionSpec
Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
↳ resource_runtime_spec
ResourceRuntimeSpec
Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
↳ resource_runtime
↳ reserved_ip_ranges
array
Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
getName
Immutable. Resource name of a PersistentResource.
string
setName
Immutable. Resource name of a PersistentResource.
var
string
$this
getDisplayName
Optional. The display name of the PersistentResource.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
string
setDisplayName
Optional. The display name of the PersistentResource.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
var
string
$this
getResourcePools
Required. The spec of the pools of different resources.
setResourcePools
Required. The spec of the pools of different resources.
$this
getState
Output only. The detailed state of a Study.
int
setState
Output only. The detailed state of a Study.
var
int
$this
getError
Output only. Only populated when persistent resource's state is STOPPING
or ERROR
.
hasError
clearError
setError
Output only. Only populated when persistent resource's state is STOPPING
or ERROR
.
$this
getCreateTime
Output only. Time when the PersistentResource was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the PersistentResource was created.
$this
getStartTime
Output only. Time when the PersistentResource for the first time entered
the RUNNING
state.
hasStartTime
clearStartTime
setStartTime
Output only. Time when the PersistentResource for the first time entered
the RUNNING
state.
$this
getUpdateTime
Output only. Time when the PersistentResource was most recently updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the PersistentResource was most recently updated.
$this
getLabels
Optional. The labels with user-defined metadata to organize PersistentResource.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
setLabels
Optional. The labels with user-defined metadata to organize PersistentResource.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
$this
getNetwork
Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources.
For example, projects/12345/global/networks/myVPC
. Format
is of the form projects/{project}/global/networks/{network}
.
Where {project} is a project number, as in 12345
, and {network} is a
network name.
To specify this field, you must have already configured VPC Network
Peering for Vertex
AI
.
If this field is left unspecified, the resources aren't peered with any
network.
string
setNetwork
Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources.
For example, projects/12345/global/networks/myVPC
. Format
is of the form projects/{project}/global/networks/{network}
.
Where {project} is a project number, as in 12345
, and {network} is a
network name.
To specify this field, you must have already configured VPC Network
Peering for Vertex
AI
.
If this field is left unspecified, the resources aren't peered with any
network.
var
string
$this
getPscInterfaceConfig
Optional. Configuration for PSC-I for PersistentResource.
hasPscInterfaceConfig
clearPscInterfaceConfig
setPscInterfaceConfig
Optional. Configuration for PSC-I for PersistentResource.
$this
getEncryptionSpec
Optional. Customer-managed encryption key spec for a PersistentResource.
If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
Optional. Customer-managed encryption key spec for a PersistentResource.
If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
$this
getResourceRuntimeSpec
Optional. Persistent Resource runtime spec.
For example, used for Ray cluster configuration.
hasResourceRuntimeSpec
clearResourceRuntimeSpec
setResourceRuntimeSpec
Optional. Persistent Resource runtime spec.
For example, used for Ray cluster configuration.
$this
getResourceRuntime
Output only. Runtime information of the Persistent Resource.
hasResourceRuntime
clearResourceRuntime
setResourceRuntime
Output only. Runtime information of the Persistent Resource.
$this
getReservedIpRanges
Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource.
If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
setReservedIpRanges
Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource.
If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
var
string[]
$this
