# Google Cloud Net App V1 Client - Class CacheParameters (1.12.0)

1.12.0 (latest) 1.11.0 1.10.2 1.9.0 1.8.1 1.7.0 1.6.1 1.4.0 1.3.1 1.2.1 1.1.1 1.0.1 0.3.1 0.2.6 0.1.1 Reference documentation and code samples for the Google Cloud Net App V1 Client class CacheParameters.

Cache Parameters for the volume.

Generated from protobuf message `google.cloud.netapp.v1.CacheParameters`

## Namespace

Google \\ Cloud \\ NetApp \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ peer_volume_name` | `string` Required. Name of the origin volume for the cache volume. |
| `↳ peer_cluster_name` | `string` Required. Name of the origin volume's ONTAP cluster. |
| `↳ peer_svm_name` | `string` Required. Name of the origin volume's SVM. |
| `↳ peer_ip_addresses` | `string[]` Required. List of IC LIF addresses of the origin volume's ONTAP cluster. |
| `↳ enable_global_file_lock` | `bool` Optional. Indicates whether the cache volume has global file lock enabled. |
| `↳ cache_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.CacheConfig` Optional. Configuration of the cache volume. |
| `↳ cache_state` | `int` Output only. State of the cache volume indicating the peering status. |
| `↳ command` | `string` Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests. |
| `↳ peering_command_expiry_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Optional. Expiration time for the peering command to be executed on user's ONTAP. |
| `↳ passphrase` | `string` Output only. Temporary passphrase generated to accept cluster peering command. |
| `↳ state_details` | `string` Output only. Detailed description of the current cache state. |

### getPeerVolumeName

Required. Name of the origin volume for the cache volume.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPeerVolumeName

Required. Name of the origin volume for the cache volume.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPeerClusterName

Required. Name of the origin volume's ONTAP cluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPeerClusterName

Required. Name of the origin volume's ONTAP cluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPeerSvmName

Required. Name of the origin volume's SVM.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPeerSvmName

Required. Name of the origin volume's SVM.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPeerIpAddresses

Required. List of IC LIF addresses of the origin volume's ONTAP cluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setPeerIpAddresses

Required. List of IC LIF addresses of the origin volume's ONTAP cluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEnableGlobalFileLock

Optional. Indicates whether the cache volume has global file lock enabled.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### hasEnableGlobalFileLock

### clearEnableGlobalFileLock

### setEnableGlobalFileLock

Optional. Indicates whether the cache volume has global file lock enabled.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCacheConfig

Optional. Configuration of the cache volume.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.CacheConfig|null` |   |

### hasCacheConfig

### clearCacheConfig

### setCacheConfig

Optional. Configuration of the cache volume.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.CacheConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCacheState

Output only. State of the cache volume indicating the peering status.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [CacheState](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.CacheParameters.CacheState). |

### setCacheState

Output only. State of the cache volume indicating the peering status.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [CacheState](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.CacheParameters.CacheState). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCommand

Output only. Copy-paste-able commands to be used on user's ONTAP to accept
peering requests.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setCommand

Output only. Copy-paste-able commands to be used on user's ONTAP to accept
peering requests.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPeeringCommandExpiryTime

Optional. Expiration time for the peering command to be executed on user's
ONTAP.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasPeeringCommandExpiryTime

### clearPeeringCommandExpiryTime

### setPeeringCommandExpiryTime

Optional. Expiration time for the peering command to be executed on user's
ONTAP.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPassphrase

Output only. Temporary passphrase generated to accept cluster peering
command.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPassphrase

Output only. Temporary passphrase generated to accept cluster peering
command.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getStateDetails

Output only. Detailed description of the current cache state.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setStateDetails

Output only. Detailed description of the current cache state.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |