Console
    Contact Us Start free

    Google Cloud Filestore V1 Client - Class Instance (1.0.3)

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

    A Cloud Filestore instance.

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

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

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

    ↳ description
    string

    The description of the instance (2048 characters or less).

    ↳ state
    int

    Output only. The instance state.

    ↳ status_message
    string

    Output only. Additional information about the instance state, if available.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. The time when the instance was created.

    ↳ tier
    int

    The service tier of the instance.

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    Resource labels to represent user provided metadata.

    ↳ file_shares
    array< Google\Cloud\Filestore\V1\FileShareConfig >

    File system shares on the instance. For this version, only a single file share is supported.

    ↳ networks
    array< Google\Cloud\Filestore\V1\NetworkConfig >

    VPC networks to which the instance is connected. For this version, only a single network is supported.

    ↳ etag
    string

    Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

    ↳ satisfies_pzs
    Google\Protobuf\BoolValue

    Output only. Reserved for future use.

    getName

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

    Returns
    Type
    Description
    string

    setName

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    The description of the instance (2048 characters or less).

    Returns
    Type
    Description
    string

    setDescription

    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

    getStatusMessage

    Output only. Additional information about the instance state, if available.

    Returns
    Type
    Description
    string

    setStatusMessage

    Output only. Additional information about the instance state, if available.

    Parameter
    Name
    Description
    var
    string
    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

    getTier

    The service tier of the instance.

    Returns
    Type
    Description
    int

    setTier

    The service tier of the instance.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getLabels

    Resource labels to represent user provided metadata.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    Resource labels to represent user provided metadata.

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

    getFileShares

    File system shares on the instance.

    For this version, only a single file share is supported.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setFileShares

    File system shares on the instance.

    For this version, only a single file share is supported.

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Filestore\V1\FileShareConfig >
    Returns
    Type
    Description
    $this

    getNetworks

    VPC networks to which the instance is connected.

    For this version, only a single network is supported.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setNetworks

    VPC networks to which the instance is connected.

    For this version, only a single network is supported.

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Filestore\V1\NetworkConfig >
    Returns
    Type
    Description
    $this

    getEtag

    Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

    Returns
    Type
    Description
    string

    setEtag

    Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSatisfiesPzs

    Output only. Reserved for future use.

    Returns
    Type
    Description
    Google\Protobuf\BoolValue |null

    hasSatisfiesPzs

    clearSatisfiesPzs

    getSatisfiesPzsValue

    Returns the unboxed value from getSatisfiesPzs()

    Output only. Reserved for future use.

    Returns
    Type
    Description
    bool|null

    setSatisfiesPzs

    Output only. Reserved for future use.

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

    setSatisfiesPzsValue

    Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

    Output only. Reserved for future use.

    Parameter
    Name
    Description
    var
    bool|null
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: