# Interface NfsShareOrBuilder (0.91.0)

0.91.0 (latest) 0.88.0 0.87.0 0.85.0 0.83.0 0.82.0 0.81.0 0.80.0 0.78.0 0.76.0 0.75.0 0.74.0 0.73.0 0.72.0 0.70.0 0.68.0 0.67.0 0.64.0 0.63.0 0.62.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.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.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.8 0.2.1 0.1.1

    public interface NfsShareOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### containsLabels(String key)

    public abstract boolean containsLabels(String key)

Labels as key value pairs.

`map<string, string> labels = 6;`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getAllowedClients(int index)

    public abstract NfsShare.AllowedClient getAllowedClients(int index)

List of allowed access points.

`repeated .google.cloud.baremetalsolution.v2.NfsShare.AllowedClient allowed_clients = 5;
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-bare-metal-solution/latest/com.google.cloud.baremetalsolution.v2.NfsShare.AllowedClient` |   |

### getAllowedClientsCount()

    public abstract int getAllowedClientsCount()

List of allowed access points.

`repeated .google.cloud.baremetalsolution.v2.NfsShare.AllowedClient allowed_clients = 5;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getAllowedClientsList()

    public abstract List<NfsShare.AllowedClient> getAllowedClientsList()

List of allowed access points.

`repeated .google.cloud.baremetalsolution.v2.NfsShare.AllowedClient allowed_clients = 5;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-bare-metal-solution/latest/com.google.cloud.baremetalsolution.v2.NfsShare.AllowedClient>` |   |

### getAllowedClientsOrBuilder(int index)

    public abstract NfsShare.AllowedClientOrBuilder getAllowedClientsOrBuilder(int index)

List of allowed access points.

`repeated .google.cloud.baremetalsolution.v2.NfsShare.AllowedClient allowed_clients = 5;
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-bare-metal-solution/latest/com.google.cloud.baremetalsolution.v2.NfsShare.AllowedClientOrBuilder` |   |

### getAllowedClientsOrBuilderList()

    public abstract List<? extends NfsShare.AllowedClientOrBuilder> getAllowedClientsOrBuilderList()

List of allowed access points.

`repeated .google.cloud.baremetalsolution.v2.NfsShare.AllowedClient allowed_clients = 5;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<? extends com.google.cloud.baremetalsolution.v2.NfsShare.AllowedClientOrBuilder>` |   |

### getId()

    public abstract String getId()

Output only. An identifier for the NFS share, generated by the backend.
This is the same value as nfs_share_id and will replace it in the future.

`string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The id. |

### getIdBytes()

    public abstract ByteString getIdBytes()

Output only. An identifier for the NFS share, generated by the backend.
This is the same value as nfs_share_id and will replace it in the future.

`string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for id. |

### getLabels() (deprecated)

    public abstract Map<String,String> getLabels()

Use [#getLabelsMap()](https://docs.cloud.google.com/java/docs/reference/google-cloud-bare-metal-solution/latest/com.google.cloud.baremetalsolution.v2.NfsShareOrBuilder#com_google_cloud_baremetalsolution_v2_NfsShareOrBuilder_getLabelsMap__) instead.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |   |

### getLabelsCount()

    public abstract int getLabelsCount()

Labels as key value pairs.

`map<string, string> labels = 6;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getLabelsMap()

    public abstract Map<String,String> getLabelsMap()

Labels as key value pairs.

`map<string, string> labels = 6;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |   |

### getLabelsOrDefault(String key, String defaultValue)

    public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs.

`map<string, string> labels = 6;`

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |
| `defaultValue` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### getLabelsOrThrow(String key)

    public abstract String getLabelsOrThrow(String key)

Labels as key value pairs.

`map<string, string> labels = 6;`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### getName()

    public abstract String getName()

Immutable. The name of the NFS share.

`string name = 1 [(.google.api.field_behavior) = IMMUTABLE];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The name. |

### getNameBytes()

    public abstract ByteString getNameBytes()

Immutable. The name of the NFS share.

`string name = 1 [(.google.api.field_behavior) = IMMUTABLE];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for name. |

### getNfsShareId()

    public abstract String getNfsShareId()

Output only. An identifier for the NFS share, generated by the backend.
This field will be deprecated in the future, use `id` instead.

`string nfs_share_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The nfsShareId. |

### getNfsShareIdBytes()

    public abstract ByteString getNfsShareIdBytes()

Output only. An identifier for the NFS share, generated by the backend.
This field will be deprecated in the future, use `id` instead.

`string nfs_share_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for nfsShareId. |

### getRequestedSizeGib()

    public abstract long getRequestedSizeGib()

The requested size, in GiB.

`int64 requested_size_gib = 7;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The requestedSizeGib. |

### getState()

    public abstract NfsShare.State getState()

Output only. The state of the NFS share.

`
.google.cloud.baremetalsolution.v2.NfsShare.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-bare-metal-solution/latest/com.google.cloud.baremetalsolution.v2.NfsShare.State` | The state. |

### getStateValue()

    public abstract int getStateValue()

Output only. The state of the NFS share.

`
.google.cloud.baremetalsolution.v2.NfsShare.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for state. |

### getStorageType()

    public abstract NfsShare.StorageType getStorageType()

Immutable. The storage type of the underlying volume.

`
.google.cloud.baremetalsolution.v2.NfsShare.StorageType storage_type = 9 [(.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-bare-metal-solution/latest/com.google.cloud.baremetalsolution.v2.NfsShare.StorageType` | The storageType. |

### getStorageTypeValue()

    public abstract int getStorageTypeValue()

Immutable. The storage type of the underlying volume.

`
.google.cloud.baremetalsolution.v2.NfsShare.StorageType storage_type = 9 [(.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for storageType. |

### getVolume()

    public abstract String getVolume()

Output only. The underlying volume of the share. Created automatically
during provisioning.

`
string volume = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The volume. |

### getVolumeBytes()

    public abstract ByteString getVolumeBytes()

Output only. The underlying volume of the share. Created automatically
during provisioning.

`
string volume = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for volume. |