Interface ShareOrBuilder (1.42.0)

Version 1.42.0

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.2.0

public interface ShareOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getBackup()

public abstract String getBackup()

Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup.

string backup = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The backup.

getBackupBytes()

public abstract ByteString getBackupBytes()

Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup.

string backup = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for backup.

getCapacityGb()

public abstract long getCapacityGb()

File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.

int64 capacity_gb = 4;

Returns
Type	Description
long	The capacityGb.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time when the share was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the share was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.

string description = 3;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.

string description = 3;

Returns
Type	Description
ByteString	The bytes for description.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMountName()

public abstract String getMountName()

The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.

string mount_name = 2;

Returns
Type	Description
String	The mountName.

getMountNameBytes()

public abstract ByteString getMountNameBytes()

The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.

string mount_name = 2;

Returns
Type	Description
ByteString	The bytes for mountName.

getName()

public abstract String getName()

Output only. The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.

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

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.

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

Returns
Type	Description
ByteString	The bytes for name.

getNfsExportOptions(int index)

public abstract NfsExportOptions getNfsExportOptions(int index)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
NfsExportOptions

getNfsExportOptionsCount()

public abstract int getNfsExportOptionsCount()

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Returns
Type	Description
int

getNfsExportOptionsList()

public abstract List<NfsExportOptions> getNfsExportOptionsList()

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Returns
Type	Description
List<NfsExportOptions>

getNfsExportOptionsOrBuilder(int index)

public abstract NfsExportOptionsOrBuilder getNfsExportOptionsOrBuilder(int index)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
NfsExportOptionsOrBuilder

getNfsExportOptionsOrBuilderList()

public abstract List<? extends NfsExportOptionsOrBuilder> getNfsExportOptionsOrBuilderList()

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Returns
Type	Description
List<? extends com.google.cloud.filestore.v1beta1.NfsExportOptionsOrBuilder>

getSourceCase()

public abstract Share.SourceCase getSourceCase()

Returns
Type	Description
Share.SourceCase

getState()

public abstract Share.State getState()

Output only. The share state.

.google.cloud.filestore.v1beta1.Share.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Share.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The share state.

.google.cloud.filestore.v1beta1.Share.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

hasBackup()

public abstract boolean hasBackup()

Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup.

string backup = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the backup field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time when the share was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.