Console
    Contact Us Start free

    Google Cloud Ai Platform V1 Client - Class PersistentResource (1.13.1)

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

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    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
    array< ResourcePool >

    Required. The spec of the pools of different resources.

    ↳ 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
    Google\Protobuf\Timestamp

    Output only. Time when the PersistentResource was created.

    ↳ start_time
    Google\Protobuf\Timestamp

    Output only. Time when the PersistentResource for the first time entered the RUNNING state.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. Time when the PersistentResource was most recently updated.

    ↳ 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.

    ↳ 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
    ResourceRuntime

    Output only. Runtime information of the Persistent Resource.

    ↳ 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.

    Returns
    Type
    Description
    string

    setName

    Immutable. Resource name of a PersistentResource.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $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.

    Returns
    Type
    Description
    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getResourcePools

    Required. The spec of the pools of different resources.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setResourcePools

    Required. The spec of the pools of different resources.

    Parameter
    Name
    Description
    var
    array< ResourcePool >
    Returns
    Type
    Description
    $this

    getState

    Output only. The detailed state of a Study.

    Returns
    Type
    Description
    int

    setState

    Output only. The detailed state of a Study.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getError

    Output only. Only populated when persistent resource's state is STOPPING or ERROR .

    Returns
    Type
    Description
    Google\Rpc\Status |null

    hasError

    clearError

    setError

    Output only. Only populated when persistent resource's state is STOPPING or ERROR .

    Parameter
    Name
    Description
    var
    Google\Rpc\Status
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Time when the PersistentResource was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Time when the PersistentResource was created.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getStartTime

    Output only. Time when the PersistentResource for the first time entered the RUNNING state.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasStartTime

    clearStartTime

    setStartTime

    Output only. Time when the PersistentResource for the first time entered the RUNNING state.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. Time when the PersistentResource was most recently updated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. Time when the PersistentResource was most recently updated.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    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.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $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.

    Returns
    Type
    Description
    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $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.

    Returns
    Type
    Description
    EncryptionSpec |null

    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.

    Parameter
    Name
    Description
    var
    EncryptionSpec
    Returns
    Type
    Description
    $this

    getResourceRuntimeSpec

    Optional. Persistent Resource runtime spec.

    For example, used for Ray cluster configuration.

    Returns
    Type
    Description
    ResourceRuntimeSpec |null

    hasResourceRuntimeSpec

    clearResourceRuntimeSpec

    setResourceRuntimeSpec

    Optional. Persistent Resource runtime spec.

    For example, used for Ray cluster configuration.

    Parameter
    Name
    Description
    var
    ResourceRuntimeSpec
    Returns
    Type
    Description
    $this

    getResourceRuntime

    Output only. Runtime information of the Persistent Resource.

    Returns
    Type
    Description
    ResourceRuntime |null

    hasResourceRuntime

    clearResourceRuntime

    setResourceRuntime

    Output only. Runtime information of the Persistent Resource.

    Parameter
    Name
    Description
    var
    ResourceRuntime
    Returns
    Type
    Description
    $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'].

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    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'].

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: