Class Share (1.29.0)

public final class Share extends GeneratedMessageV3 implements ShareOrBuilder

A Filestore share.

Protobuf type google.cloud.filestore.v1beta1.Share

Implements

ShareOrBuilder

Static Fields

BACKUP_FIELD_NUMBER

public static final int BACKUP_FIELD_NUMBER
Field Value
TypeDescription
int

CAPACITY_GB_FIELD_NUMBER

public static final int CAPACITY_GB_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MOUNT_NAME_FIELD_NUMBER

public static final int MOUNT_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NFS_EXPORT_OPTIONS_FIELD_NUMBER

public static final int NFS_EXPORT_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Share getDefaultInstance()
Returns
TypeDescription
Share

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Share.Builder newBuilder()
Returns
TypeDescription
Share.Builder

newBuilder(Share prototype)

public static Share.Builder newBuilder(Share prototype)
Parameter
NameDescription
prototypeShare
Returns
TypeDescription
Share.Builder

parseDelimitedFrom(InputStream input)

public static Share parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Share
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Share parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Share
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Share parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Share
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Share parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Share
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Share parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Share
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Share parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Share
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Share parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Share
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Share parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Share
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Share parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Share
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Share parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Share
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Share parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Share
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Share parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Share
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Share> parser()
Returns
TypeDescription
Parser<Share>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBackup()

public 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
TypeDescription
String

The backup.

getBackupBytes()

public 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
TypeDescription
ByteString

The bytes for backup.

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
TypeDescription
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
TypeDescription
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];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Share getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for mountName.

getName()

public 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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
NfsExportOptions

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
TypeDescription
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;

Returns
TypeDescription
List<NfsExportOptions>

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
NameDescription
indexint
Returns
TypeDescription
NfsExportOptionsOrBuilder

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
TypeDescription
List<? extends com.google.cloud.filestore.v1beta1.NfsExportOptionsOrBuilder>

getParserForType()

public Parser<Share> getParserForType()
Returns
TypeDescription
Parser<Share>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public Share.SourceCase getSourceCase()
Returns
TypeDescription
Share.SourceCase

getState()

public Share.State getState()

Output only. The share state.

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

Returns
TypeDescription
Share.State

The state.

getStateValue()

public int getStateValue()

Output only. The share state.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

hasBackup()

public 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
TypeDescription
boolean

Whether the backup field is set.

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
TypeDescription
boolean

Whether the createTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Share.Builder newBuilderForType()
Returns
TypeDescription
Share.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Share.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Share.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Share.Builder toBuilder()
Returns
TypeDescription
Share.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException