Class Instance (1.9.0)

public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder

A Cloud Filestore instance.

Protobuf type google.cloud.filestore.v1.Instance

Implements

InstanceOrBuilder

Static Fields

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

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

FILE_SHARES_FIELD_NUMBER

public static final int FILE_SHARES_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORKS_FIELD_NUMBER

public static final int NETWORKS_FIELD_NUMBER
Field Value
TypeDescription
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_MESSAGE_FIELD_NUMBER

public static final int STATUS_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

TIER_FIELD_NUMBER

public static final int TIER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()
Returns
TypeDescription
Instance

getDescriptor()

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

newBuilder()

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

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)
Parameter
NameDescription
prototypeInstance
Returns
TypeDescription
Instance.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the instance 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 instance was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
TypeDescription
Instance

getDescription()

public String getDescription()

The description of the instance (2048 characters or less).

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the instance (2048 characters or less).

string description = 2;

Returns
TypeDescription
ByteString

The bytes for description.

getEtag()

public String getEtag()

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

string etag = 12;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

string etag = 12;

Returns
TypeDescription
ByteString

The bytes for etag.

getFileShares(int index)

public FileShareConfig getFileShares(int index)

File system shares on the instance. For this version, only a single file share is supported.

repeated .google.cloud.filestore.v1.FileShareConfig file_shares = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
FileShareConfig

getFileSharesCount()

public int getFileSharesCount()

File system shares on the instance. For this version, only a single file share is supported.

repeated .google.cloud.filestore.v1.FileShareConfig file_shares = 10;

Returns
TypeDescription
int

getFileSharesList()

public List<FileShareConfig> getFileSharesList()

File system shares on the instance. For this version, only a single file share is supported.

repeated .google.cloud.filestore.v1.FileShareConfig file_shares = 10;

Returns
TypeDescription
List<FileShareConfig>

getFileSharesOrBuilder(int index)

public FileShareConfigOrBuilder getFileSharesOrBuilder(int index)

File system shares on the instance. For this version, only a single file share is supported.

repeated .google.cloud.filestore.v1.FileShareConfig file_shares = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
FileShareConfigOrBuilder

getFileSharesOrBuilderList()

public List<? extends FileShareConfigOrBuilder> getFileSharesOrBuilderList()

File system shares on the instance. For this version, only a single file share is supported.

repeated .google.cloud.filestore.v1.FileShareConfig file_shares = 10;

Returns
TypeDescription
List<? extends com.google.cloud.filestore.v1.FileShareConfigOrBuilder>

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 = 9;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

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 = 9;

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 = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

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 instance, in the format projects/{project}/locations/{location}/instances/{instance}.

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

Returns
TypeDescription
ByteString

The bytes for name.

getNetworks(int index)

public NetworkConfig getNetworks(int index)

VPC networks to which the instance is connected. For this version, only a single network is supported.

repeated .google.cloud.filestore.v1.NetworkConfig networks = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
NetworkConfig

getNetworksCount()

public int getNetworksCount()

VPC networks to which the instance is connected. For this version, only a single network is supported.

repeated .google.cloud.filestore.v1.NetworkConfig networks = 11;

Returns
TypeDescription
int

getNetworksList()

public List<NetworkConfig> getNetworksList()

VPC networks to which the instance is connected. For this version, only a single network is supported.

repeated .google.cloud.filestore.v1.NetworkConfig networks = 11;

Returns
TypeDescription
List<NetworkConfig>

getNetworksOrBuilder(int index)

public NetworkConfigOrBuilder getNetworksOrBuilder(int index)

VPC networks to which the instance is connected. For this version, only a single network is supported.

repeated .google.cloud.filestore.v1.NetworkConfig networks = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
NetworkConfigOrBuilder

getNetworksOrBuilderList()

public List<? extends NetworkConfigOrBuilder> getNetworksOrBuilderList()

VPC networks to which the instance is connected. For this version, only a single network is supported.

repeated .google.cloud.filestore.v1.NetworkConfig networks = 11;

Returns
TypeDescription
List<? extends com.google.cloud.filestore.v1.NetworkConfigOrBuilder>

getParserForType()

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

getSatisfiesPzs()

public BoolValue getSatisfiesPzs()

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
BoolValue

The satisfiesPzs.

getSatisfiesPzsOrBuilder()

public BoolValueOrBuilder getSatisfiesPzsOrBuilder()

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
BoolValueOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public Instance.State getState()

Output only. The instance state.

.google.cloud.filestore.v1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.State

The state.

getStateValue()

public int getStateValue()

Output only. The instance state.

.google.cloud.filestore.v1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getStatusMessage()

public String getStatusMessage()

Output only. Additional information about the instance state, if available.

string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The statusMessage.

getStatusMessageBytes()

public ByteString getStatusMessageBytes()

Output only. Additional information about the instance state, if available.

string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for statusMessage.

getTier()

public Instance.Tier getTier()

The service tier of the instance.

.google.cloud.filestore.v1.Instance.Tier tier = 8;

Returns
TypeDescription
Instance.Tier

The tier.

getTierValue()

public int getTierValue()

The service tier of the instance.

.google.cloud.filestore.v1.Instance.Tier tier = 8;

Returns
TypeDescription
int

The enum numeric value on the wire for tier.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the instance was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the satisfiesPzs 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 Instance.Builder newBuilderForType()
Returns
TypeDescription
Instance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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