Console
    Contact Us Start free

    Google Cloud Parallelstore V1 Client - Class Instance (0.9.0)

    Reference documentation and code samples for the Google Cloud Parallelstore V1 Client class Instance.

    A Parallelstore instance.

    Generated from protobuf message google.cloud.parallelstore.v1.Instance

    Namespace

    Google \ Cloud \ Parallelstore \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance_id} .

    ↳ description
    string

    Optional. The description of the instance. 2048 characters or less.

    ↳ state
    int

    Output only. The instance state.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. The time when the instance was created.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. The time when the instance was updated.

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    Optional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.

    ↳ capacity_gib
    int|string

    Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ...

    ↳ daos_version
    string

    Output only. The version of DAOS software running in the instance.

    ↳ access_points
    array

    Output only. A list of IPv4 addresses used for client side configuration.

    ↳ network
    string

    Optional. Immutable. The name of the Compute Engine VPC network to which the instance is connected.

    ↳ reserved_ip_range
    string

    Optional. Immutable. The ID of the IP address range being used by the instance's VPC network. See Configure a VPC network . If no ID is provided, all ranges are considered.

    ↳ effective_reserved_ip_range
    string

    Output only. Immutable. The ID of the IP address range being used by the instance's VPC network. This field is populated by the service and contains the value currently used by the service.

    ↳ file_stripe_level
    int

    Optional. Stripe level for files. Allowed values are: * * FILE_STRIPE_LEVEL_MIN : offers the best performance for small size files. * * FILE_STRIPE_LEVEL_BALANCED : balances performance for workloads involving a mix of small and large files. * * FILE_STRIPE_LEVEL_MAX : higher throughput performance for larger files.

    ↳ directory_stripe_level
    int

    Optional. Stripe level for directories. Allowed values are: * * DIRECTORY_STRIPE_LEVEL_MIN : recommended when directories contain a small number of files. * * DIRECTORY_STRIPE_LEVEL_BALANCED : balances performance for workloads involving a mix of small and large directories. * * DIRECTORY_STRIPE_LEVEL_MAX : recommended for directories with a large number of files.

    getName

    Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance_id} .

    Returns
    Type
    Description
    string

    setName

    Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance_id} .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Optional. The description of the instance. 2048 characters or less.

    Returns
    Type
    Description
    string

    setDescription

    Optional. The description of the instance. 2048 characters or less.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getState

    Output only. The instance state.

    Returns
    Type
    Description
    int

    setState

    Output only. The instance state.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. The time when the instance was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. The time when the instance was created.

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

    getUpdateTime

    Output only. The time when the instance was updated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. The time when the instance was updated.

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

    getLabels

    Optional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    Optional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getCapacityGib

    Required. Immutable. The instance's storage capacity in Gibibytes (GiB).

    Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ...

    Returns
    Type
    Description
    int|string

    setCapacityGib

    Required. Immutable. The instance's storage capacity in Gibibytes (GiB).

    Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ...

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this

    getDaosVersion

    Output only. The version of DAOS software running in the instance.

    Returns
    Type
    Description
    string

    setDaosVersion

    Output only. The version of DAOS software running in the instance.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getAccessPoints

    Output only. A list of IPv4 addresses used for client side configuration.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setAccessPoints

    Output only. A list of IPv4 addresses used for client side configuration.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getNetwork

    Optional. Immutable. The name of the Compute Engine VPC network to which the instance is connected.

    Returns
    Type
    Description
    string

    setNetwork

    Optional. Immutable. The name of the Compute Engine VPC network to which the instance is connected.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getReservedIpRange

    Optional. Immutable. The ID of the IP address range being used by the instance's VPC network. See Configure a VPC network .

    If no ID is provided, all ranges are considered.

    Returns
    Type
    Description
    string

    setReservedIpRange

    Optional. Immutable. The ID of the IP address range being used by the instance's VPC network. See Configure a VPC network .

    If no ID is provided, all ranges are considered.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getEffectiveReservedIpRange

    Output only. Immutable. The ID of the IP address range being used by the instance's VPC network. This field is populated by the service and contains the value currently used by the service.

    Returns
    Type
    Description
    string

    setEffectiveReservedIpRange

    Output only. Immutable. The ID of the IP address range being used by the instance's VPC network. This field is populated by the service and contains the value currently used by the service.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFileStripeLevel

    Optional. Stripe level for files. Allowed values are:

    • FILE_STRIPE_LEVEL_MIN : offers the best performance for small size files.

    • FILE_STRIPE_LEVEL_BALANCED : balances performance for workloads involving a mix of small and large files.

    • FILE_STRIPE_LEVEL_MAX : higher throughput performance for larger files.
    Returns
    Type
    Description
    int

    setFileStripeLevel

    Optional. Stripe level for files. Allowed values are:

    • FILE_STRIPE_LEVEL_MIN : offers the best performance for small size files.

    • FILE_STRIPE_LEVEL_BALANCED : balances performance for workloads involving a mix of small and large files.

    • FILE_STRIPE_LEVEL_MAX : higher throughput performance for larger files.
    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getDirectoryStripeLevel

    Optional. Stripe level for directories. Allowed values are:

    • DIRECTORY_STRIPE_LEVEL_MIN : recommended when directories contain a small number of files.

    • DIRECTORY_STRIPE_LEVEL_BALANCED : balances performance for workloads involving a mix of small and large directories.

    • DIRECTORY_STRIPE_LEVEL_MAX : recommended for directories with a large number of files.
    Returns
    Type
    Description
    int

    setDirectoryStripeLevel

    Optional. Stripe level for directories. Allowed values are:

    • DIRECTORY_STRIPE_LEVEL_MIN : recommended when directories contain a small number of files.

    • DIRECTORY_STRIPE_LEVEL_BALANCED : balances performance for workloads involving a mix of small and large directories.

    • DIRECTORY_STRIPE_LEVEL_MAX : recommended for directories with a large number of files.
    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: