Class Share (1.17.0)
1.94.0 (latest)
1.92.0
1.89.0
1.88.0
1.86.0
1.84.0
1.83.0
1.82.0
1.81.0
1.79.0
1.77.0
1.76.0
1.75.0
1.74.0
1.73.0
1.71.0
1.69.0
1.68.0
1.65.0
1.64.0
1.63.0
1.61.0
1.60.0
1.59.0
1.58.0
1.57.0
1.56.0
1.55.0
1.54.0
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 final class Share extends GeneratedMessageV3 implements ShareOrBuilder
A Filestore share.
Protobuf type google.cloud.filestore.v1beta1.Share
Static Fields
CAPACITY_GB_FIELD_NUMBER
public static final int CAPACITY_GB_FIELD_NUMBER
Field Value
Type Description
int
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int
MOUNT_NAME_FIELD_NUMBER
public static final int MOUNT_NAME_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
NFS_EXPORT_OPTIONS_FIELD_NUMBER
public static final int NFS_EXPORT_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Share getDefaultInstance ()
Returns
Type Description
Share
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Share . Builder newBuilder ()
newBuilder(Share prototype)
public static Share . Builder newBuilder ( Share prototype )
Parameter
Name Description
prototypeShare
public static Share parseDelimitedFrom ( InputStream input )
Returns
Type Description
Share
public static Share parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Share
parseFrom(byte[] data)
public static Share parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Share
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Share parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Share
parseFrom(ByteString data)
public static Share parseFrom ( ByteString data )
Returns
Type Description
Share
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Share parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Share
public static Share parseFrom ( CodedInputStream input )
Returns
Type Description
Share
public static Share parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Share
public static Share parseFrom ( InputStream input )
Returns
Type Description
Share
public static Share parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Share
parseFrom(ByteBuffer data)
public static Share parseFrom ( ByteBuffer data )
Returns
Type Description
Share
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Share parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Share
parser()
public static Parser<Share> parser ()
Methods
containsLabels(String key)
public boolean containsLabels ( String key )
Resource labels to represent user provided metadata.
map<string, string> labels = 8;
Parameter
Name Description
keyString
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getCapacityGb()
public 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 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 TimestampOrBuilder getCreateTimeOrBuilder ()
Output only. The time when the share was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Share getDefaultInstanceForType ()
Returns
Type Description
Share
getDescription()
public 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 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()
public Map<String , String > getLabels ()
getLabelsCount()
public int getLabelsCount ()
Resource labels to represent user provided metadata.
map<string, string> labels = 8;
Returns
Type Description
int
getLabelsMap()
public Map<String , String > getLabelsMap ()
Resource labels to represent user provided metadata.
map<string, string> labels = 8;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault ( String key , String defaultValue )
Resource labels to represent user provided metadata.
map<string, string> labels = 8;
Returns
Type Description
String
getLabelsOrThrow(String key)
public String getLabelsOrThrow ( String key )
Resource labels to represent user provided metadata.
map<string, string> labels = 8;
Parameter
Name Description
keyString
Returns
Type Description
String
getMountName()
public 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 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()
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 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 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
indexint
getNfsExportOptionsCount()
public 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 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;
getNfsExportOptionsOrBuilder(int index)
public 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
indexint
getNfsExportOptionsOrBuilderList()
public 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 >
getParserForType()
public Parser<Share> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getState()
public Share . State getState ()
Output only. The share state.
.google.cloud.filestore.v1beta1.Share.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public 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.
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
hasCreateTime()
public 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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField ( int number )
Parameter
Name Description
numberint
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Share . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Share . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Share . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-06-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-06-18 UTC."],[],[]]
