Class Instance (0.10.0) 

public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder

A Memorystore instance.

Protobuf type google.cloud.memorystore.v1.Instance

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Instance

Implements

InstanceOrBuilder

Static Fields

ASYNC_INSTANCE_ENDPOINTS_DELETION_ENABLED_FIELD_NUMBER

public static final int ASYNC_INSTANCE_ENDPOINTS_DELETION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

AUTHORIZATION_MODE_FIELD_NUMBER

public static final int AUTHORIZATION_MODE_FIELD_NUMBER
Field Value
Type Description
int

AUTOMATED_BACKUP_CONFIG_FIELD_NUMBER

public static final int AUTOMATED_BACKUP_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_COLLECTION_FIELD_NUMBER

public static final int BACKUP_COLLECTION_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CROSS_INSTANCE_REPLICATION_CONFIG_FIELD_NUMBER

public static final int CROSS_INSTANCE_REPLICATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DELETION_PROTECTION_ENABLED_FIELD_NUMBER

public static final int DELETION_PROTECTION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

DISCOVERY_ENDPOINTS_FIELD_NUMBER

public static final int DISCOVERY_ENDPOINTS_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINTS_FIELD_NUMBER

public static final int ENDPOINTS_FIELD_NUMBER
Field Value
Type Description
int

ENGINE_CONFIGS_FIELD_NUMBER

public static final int ENGINE_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

ENGINE_VERSION_FIELD_NUMBER

public static final int ENGINE_VERSION_FIELD_NUMBER
Field Value
Type Description
int

GCS_SOURCE_FIELD_NUMBER

public static final int GCS_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_POLICY_FIELD_NUMBER

public static final int MAINTENANCE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_SCHEDULE_FIELD_NUMBER

public static final int MAINTENANCE_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

MANAGED_BACKUP_SOURCE_FIELD_NUMBER

public static final int MANAGED_BACKUP_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NODE_CONFIG_FIELD_NUMBER

public static final int NODE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NODE_TYPE_FIELD_NUMBER

public static final int NODE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

ONDEMAND_MAINTENANCE_FIELD_NUMBER

public static final int ONDEMAND_MAINTENANCE_FIELD_NUMBER
Field Value
Type Description
int

PERSISTENCE_CONFIG_FIELD_NUMBER

public static final int PERSISTENCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PSC_ATTACHMENT_DETAILS_FIELD_NUMBER

public static final int PSC_ATTACHMENT_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

PSC_AUTO_CONNECTIONS_FIELD_NUMBER

public static final int PSC_AUTO_CONNECTIONS_FIELD_NUMBER
Field Value
Type Description
int

REPLICA_COUNT_FIELD_NUMBER

public static final int REPLICA_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SHARD_COUNT_FIELD_NUMBER

public static final int SHARD_COUNT_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATE_INFO_FIELD_NUMBER

public static final int STATE_INFO_FIELD_NUMBER
Field Value
Type Description
int

TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER

public static final int TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ZONE_DISTRIBUTION_CONFIG_FIELD_NUMBER

public static final int ZONE_DISTRIBUTION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()
Returns
Type Description
Instance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Instance.Builder newBuilder()
Returns
Type Description
Instance.Builder

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)
Parameter
Name Description
prototype Instance
Returns
Type Description
Instance.Builder

parseDelimitedFrom(InputStream input)

public static Instance parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Instance parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Instance parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Instance parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Instance parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Instance parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Instance> parser()
Returns
Type Description
Parser<Instance>

Methods

containsEngineConfigs(String key)

public boolean containsEngineConfigs(String key)

Optional. User-provided engine configurations for the instance.

map<string, string> engine_configs = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels to represent user-provided metadata.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAsyncInstanceEndpointsDeletionEnabled()

public boolean getAsyncInstanceEndpointsDeletionEnabled()

Optional. If true, instance endpoints that are created and registered by customers can be deleted asynchronously. That is, such an instance endpoint can be de-registered before the forwarding rules in the instance endpoint are deleted.

optional bool async_instance_endpoints_deletion_enabled = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The asyncInstanceEndpointsDeletionEnabled.

getAuthorizationMode()

public Instance.AuthorizationMode getAuthorizationMode()

Optional. Immutable. Authorization mode of the instance.

.google.cloud.memorystore.v1.Instance.AuthorizationMode authorization_mode = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Instance.AuthorizationMode

The authorizationMode.

getAuthorizationModeValue()

public int getAuthorizationModeValue()

Optional. Immutable. Authorization mode of the instance.

.google.cloud.memorystore.v1.Instance.AuthorizationMode authorization_mode = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for authorizationMode.

getAutomatedBackupConfig()

public AutomatedBackupConfig getAutomatedBackupConfig()

Optional. The automated backup config for the instance.

.google.cloud.memorystore.v1.AutomatedBackupConfig automated_backup_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AutomatedBackupConfig

The automatedBackupConfig.

getAutomatedBackupConfigOrBuilder()

public AutomatedBackupConfigOrBuilder getAutomatedBackupConfigOrBuilder()

Optional. The automated backup config for the instance.

.google.cloud.memorystore.v1.AutomatedBackupConfig automated_backup_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AutomatedBackupConfigOrBuilder

getBackupCollection()

public String getBackupCollection()

Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}

optional string backup_collection = 47 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The backupCollection.

getBackupCollectionBytes()

public ByteString getBackupCollectionBytes()

Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}

optional string backup_collection = 47 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for backupCollection.

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation timestamp of the instance.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation timestamp of the instance.

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

Returns
Type Description
TimestampOrBuilder

getCrossInstanceReplicationConfig()

public CrossInstanceReplicationConfig getCrossInstanceReplicationConfig()

Optional. The config for cross instance replication.

.google.cloud.memorystore.v1.CrossInstanceReplicationConfig cross_instance_replication_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CrossInstanceReplicationConfig

The crossInstanceReplicationConfig.

getCrossInstanceReplicationConfigOrBuilder()

public CrossInstanceReplicationConfigOrBuilder getCrossInstanceReplicationConfigOrBuilder()

Optional. The config for cross instance replication.

.google.cloud.memorystore.v1.CrossInstanceReplicationConfig cross_instance_replication_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CrossInstanceReplicationConfigOrBuilder

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
Type Description
Instance

getDeletionProtectionEnabled()

public boolean getDeletionProtectionEnabled()

Optional. If set to true deletion of the instance will fail.

optional bool deletion_protection_enabled = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The deletionProtectionEnabled.

getDiscoveryEndpoints(int index) (deprecated)

public DiscoveryEndpoint getDiscoveryEndpoints(int index)

Output only. Deprecated: Use the endpoints.connections.psc_auto_connection or endpoints.connections.psc_connection values instead.

repeated .google.cloud.memorystore.v1.DiscoveryEndpoint discovery_endpoints = 12 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DiscoveryEndpoint

getDiscoveryEndpointsCount() (deprecated)

public int getDiscoveryEndpointsCount()

Output only. Deprecated: Use the endpoints.connections.psc_auto_connection or endpoints.connections.psc_connection values instead.

repeated .google.cloud.memorystore.v1.DiscoveryEndpoint discovery_endpoints = 12 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getDiscoveryEndpointsList() (deprecated)

public List<DiscoveryEndpoint> getDiscoveryEndpointsList()

Output only. Deprecated: Use the endpoints.connections.psc_auto_connection or endpoints.connections.psc_connection values instead.

repeated .google.cloud.memorystore.v1.DiscoveryEndpoint discovery_endpoints = 12 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<DiscoveryEndpoint>

getDiscoveryEndpointsOrBuilder(int index) (deprecated)

public DiscoveryEndpointOrBuilder getDiscoveryEndpointsOrBuilder(int index)

Output only. Deprecated: Use the endpoints.connections.psc_auto_connection or endpoints.connections.psc_connection values instead.

repeated .google.cloud.memorystore.v1.DiscoveryEndpoint discovery_endpoints = 12 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DiscoveryEndpointOrBuilder

getDiscoveryEndpointsOrBuilderList() (deprecated)

public List<? extends DiscoveryEndpointOrBuilder> getDiscoveryEndpointsOrBuilderList()

Output only. Deprecated: Use the endpoints.connections.psc_auto_connection or endpoints.connections.psc_connection values instead.

repeated .google.cloud.memorystore.v1.DiscoveryEndpoint discovery_endpoints = 12 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.memorystore.v1.DiscoveryEndpointOrBuilder>

getEndpoints(int index)

public Instance.InstanceEndpoint getEndpoints(int index)

Optional. Endpoints for the instance.

repeated .google.cloud.memorystore.v1.Instance.InstanceEndpoint endpoints = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Instance.InstanceEndpoint

getEndpointsCount()

public int getEndpointsCount()

Optional. Endpoints for the instance.

repeated .google.cloud.memorystore.v1.Instance.InstanceEndpoint endpoints = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getEndpointsList()

public List<Instance.InstanceEndpoint> getEndpointsList()

Optional. Endpoints for the instance.

repeated .google.cloud.memorystore.v1.Instance.InstanceEndpoint endpoints = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<InstanceEndpoint>

getEndpointsOrBuilder(int index)

public Instance.InstanceEndpointOrBuilder getEndpointsOrBuilder(int index)

Optional. Endpoints for the instance.

repeated .google.cloud.memorystore.v1.Instance.InstanceEndpoint endpoints = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Instance.InstanceEndpointOrBuilder

getEndpointsOrBuilderList()

public List<? extends Instance.InstanceEndpointOrBuilder> getEndpointsOrBuilderList()

Optional. Endpoints for the instance.

repeated .google.cloud.memorystore.v1.Instance.InstanceEndpoint endpoints = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.memorystore.v1.Instance.InstanceEndpointOrBuilder>

getEngineConfigs() (deprecated)

public Map<String,String> getEngineConfigs()

Use #getEngineConfigsMap() instead.

Returns
Type Description
Map<String,String>

getEngineConfigsCount()

public int getEngineConfigsCount()

Optional. User-provided engine configurations for the instance.

map<string, string> engine_configs = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getEngineConfigsMap()

public Map<String,String> getEngineConfigsMap()

Optional. User-provided engine configurations for the instance.

map<string, string> engine_configs = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getEngineConfigsOrDefault(String key, String defaultValue)

public String getEngineConfigsOrDefault(String key, String defaultValue)

Optional. User-provided engine configurations for the instance.

map<string, string> engine_configs = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getEngineConfigsOrThrow(String key)

public String getEngineConfigsOrThrow(String key)

Optional. User-provided engine configurations for the instance.

map<string, string> engine_configs = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getEngineVersion()

public String getEngineVersion()

Optional. Engine version of the instance.

string engine_version = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The engineVersion.

getEngineVersionBytes()

public ByteString getEngineVersionBytes()

Optional. Engine version of the instance.

string engine_version = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for engineVersion.

getGcsSource()

public Instance.GcsBackupSource getGcsSource()

Optional. Immutable. Backups that stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the instances. Read permission is required to import from the provided Cloud Storage Objects.

.google.cloud.memorystore.v1.Instance.GcsBackupSource gcs_source = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Instance.GcsBackupSource

The gcsSource.

getGcsSourceOrBuilder()

public Instance.GcsBackupSourceOrBuilder getGcsSourceOrBuilder()

Optional. Immutable. Backups that stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the instances. Read permission is required to import from the provided Cloud Storage Objects.

.google.cloud.memorystore.v1.Instance.GcsBackupSource gcs_source = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Instance.GcsBackupSourceOrBuilder

getImportSourcesCase()

public Instance.ImportSourcesCase getImportSourcesCase()
Returns
Type Description
Instance.ImportSourcesCase

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels to represent user-provided metadata.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels to represent user-provided metadata.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels to represent user-provided metadata.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels to represent user-provided metadata.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMaintenancePolicy()

public MaintenancePolicy getMaintenancePolicy()

Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.

.google.cloud.memorystore.v1.MaintenancePolicy maintenance_policy = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MaintenancePolicy

The maintenancePolicy.

getMaintenancePolicyOrBuilder()

public MaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder()

Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.

.google.cloud.memorystore.v1.MaintenancePolicy maintenance_policy = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MaintenancePolicyOrBuilder

getMaintenanceSchedule()

public MaintenanceSchedule getMaintenanceSchedule()

Output only. Published maintenance schedule.

.google.cloud.memorystore.v1.MaintenanceSchedule maintenance_schedule = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MaintenanceSchedule

The maintenanceSchedule.

getMaintenanceScheduleOrBuilder()

public MaintenanceScheduleOrBuilder getMaintenanceScheduleOrBuilder()

Output only. Published maintenance schedule.

.google.cloud.memorystore.v1.MaintenanceSchedule maintenance_schedule = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MaintenanceScheduleOrBuilder

getManagedBackupSource()

public Instance.ManagedBackupSource getManagedBackupSource()

Optional. Immutable. Backups that generated and managed by memorystore service.

.google.cloud.memorystore.v1.Instance.ManagedBackupSource managed_backup_source = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Instance.ManagedBackupSource

The managedBackupSource.

getManagedBackupSourceOrBuilder()

public Instance.ManagedBackupSourceOrBuilder getManagedBackupSourceOrBuilder()

Optional. Immutable. Backups that generated and managed by memorystore service.

.google.cloud.memorystore.v1.Instance.ManagedBackupSource managed_backup_source = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Instance.ManagedBackupSourceOrBuilder

getMode()

public Instance.Mode getMode()

Optional. The mode config for the instance.

.google.cloud.memorystore.v1.Instance.Mode mode = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Mode

The mode.

getModeValue()

public int getModeValue()

Optional. The mode config for the instance.

.google.cloud.memorystore.v1.Instance.Mode mode = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for mode.

getName()

public String getName()

Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}

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

Returns
Type Description
ByteString

The bytes for name.

getNodeConfig()

public NodeConfig getNodeConfig()

Output only. Configuration of individual nodes of the instance.

.google.cloud.memorystore.v1.NodeConfig node_config = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
NodeConfig

The nodeConfig.

getNodeConfigOrBuilder()

public NodeConfigOrBuilder getNodeConfigOrBuilder()

Output only. Configuration of individual nodes of the instance.

.google.cloud.memorystore.v1.NodeConfig node_config = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
NodeConfigOrBuilder

getNodeType()

public Instance.NodeType getNodeType()

Optional. Machine type for individual nodes of the instance.

.google.cloud.memorystore.v1.Instance.NodeType node_type = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.NodeType

The nodeType.

getNodeTypeValue()

public int getNodeTypeValue()

Optional. Machine type for individual nodes of the instance.

.google.cloud.memorystore.v1.Instance.NodeType node_type = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for nodeType.

getOndemandMaintenance()

public boolean getOndemandMaintenance()

Optional. Input only. Ondemand maintenance for the instance.

optional bool ondemand_maintenance = 28 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

The ondemandMaintenance.

getParserForType()

public Parser<Instance> getParserForType()
Returns
Type Description
Parser<Instance>
Overrides

getPersistenceConfig()

public PersistenceConfig getPersistenceConfig()

Optional. Persistence configuration of the instance.

.google.cloud.memorystore.v1.PersistenceConfig persistence_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PersistenceConfig

The persistenceConfig.

getPersistenceConfigOrBuilder()

public PersistenceConfigOrBuilder getPersistenceConfigOrBuilder()

Optional. Persistence configuration of the instance.

.google.cloud.memorystore.v1.PersistenceConfig persistence_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PersistenceConfigOrBuilder

getPscAttachmentDetails(int index)

public PscAttachmentDetail getPscAttachmentDetails(int index)

Output only. Service attachment details to configure PSC connections.

repeated .google.cloud.memorystore.v1.PscAttachmentDetail psc_attachment_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PscAttachmentDetail

getPscAttachmentDetailsCount()

public int getPscAttachmentDetailsCount()

Output only. Service attachment details to configure PSC connections.

repeated .google.cloud.memorystore.v1.PscAttachmentDetail psc_attachment_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getPscAttachmentDetailsList()

public List<PscAttachmentDetail> getPscAttachmentDetailsList()

Output only. Service attachment details to configure PSC connections.

repeated .google.cloud.memorystore.v1.PscAttachmentDetail psc_attachment_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<PscAttachmentDetail>

getPscAttachmentDetailsOrBuilder(int index)

public PscAttachmentDetailOrBuilder getPscAttachmentDetailsOrBuilder(int index)

Output only. Service attachment details to configure PSC connections.

repeated .google.cloud.memorystore.v1.PscAttachmentDetail psc_attachment_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PscAttachmentDetailOrBuilder

getPscAttachmentDetailsOrBuilderList()

public List<? extends PscAttachmentDetailOrBuilder> getPscAttachmentDetailsOrBuilderList()

Output only. Service attachment details to configure PSC connections.

repeated .google.cloud.memorystore.v1.PscAttachmentDetail psc_attachment_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.memorystore.v1.PscAttachmentDetailOrBuilder>

getPscAutoConnections(int index) (deprecated)

public PscAutoConnection getPscAutoConnections(int index)

Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.

repeated .google.cloud.memorystore.v1.PscAutoConnection psc_auto_connections = 20 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int
Returns
Type Description
PscAutoConnection

getPscAutoConnectionsCount() (deprecated)

public int getPscAutoConnectionsCount()

Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.

repeated .google.cloud.memorystore.v1.PscAutoConnection psc_auto_connections = 20 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

getPscAutoConnectionsList() (deprecated)

public List<PscAutoConnection> getPscAutoConnectionsList()

Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.

repeated .google.cloud.memorystore.v1.PscAutoConnection psc_auto_connections = 20 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
List<PscAutoConnection>

getPscAutoConnectionsOrBuilder(int index) (deprecated)

public PscAutoConnectionOrBuilder getPscAutoConnectionsOrBuilder(int index)

Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.

repeated .google.cloud.memorystore.v1.PscAutoConnection psc_auto_connections = 20 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int
Returns
Type Description
PscAutoConnectionOrBuilder

getPscAutoConnectionsOrBuilderList() (deprecated)

public List<? extends PscAutoConnectionOrBuilder> getPscAutoConnectionsOrBuilderList()

Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.

repeated .google.cloud.memorystore.v1.PscAutoConnection psc_auto_connections = 20 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
List<? extends com.google.cloud.memorystore.v1.PscAutoConnectionOrBuilder>

getReplicaCount()

public int getReplicaCount()

Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.

optional int32 replica_count = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The replicaCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShardCount()

public int getShardCount()

Optional. Number of shards for the instance.

int32 shard_count = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The shardCount.

getState()

public Instance.State getState()

Output only. Current state of the instance.

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

Returns
Type Description
Instance.State

The state.

getStateInfo()

public Instance.StateInfo getStateInfo()

Output only. Additional information about the state of the instance.

.google.cloud.memorystore.v1.Instance.StateInfo state_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.StateInfo

The stateInfo.

getStateInfoOrBuilder()

public Instance.StateInfoOrBuilder getStateInfoOrBuilder()

Output only. Additional information about the state of the instance.

.google.cloud.memorystore.v1.Instance.StateInfo state_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.StateInfoOrBuilder

getStateValue()

public int getStateValue()

Output only. Current state of the instance.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getTransitEncryptionMode()

public Instance.TransitEncryptionMode getTransitEncryptionMode()

Optional. Immutable. In-transit encryption mode of the instance.

.google.cloud.memorystore.v1.Instance.TransitEncryptionMode transit_encryption_mode = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Instance.TransitEncryptionMode

The transitEncryptionMode.

getTransitEncryptionModeValue()

public int getTransitEncryptionModeValue()

Optional. Immutable. In-transit encryption mode of the instance.

.google.cloud.memorystore.v1.Instance.TransitEncryptionMode transit_encryption_mode = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for transitEncryptionMode.

getUid()

public String getUid()

Output only. System assigned, unique identifier for the instance.

string uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. System assigned, unique identifier for the instance.

string uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Latest update timestamp of the instance.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Latest update timestamp of the instance.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getZoneDistributionConfig()

public ZoneDistributionConfig getZoneDistributionConfig()

Optional. Immutable. Zone distribution configuration of the instance for node allocation.

.google.cloud.memorystore.v1.ZoneDistributionConfig zone_distribution_config = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ZoneDistributionConfig

The zoneDistributionConfig.

getZoneDistributionConfigOrBuilder()

public ZoneDistributionConfigOrBuilder getZoneDistributionConfigOrBuilder()

Optional. Immutable. Zone distribution configuration of the instance for node allocation.

.google.cloud.memorystore.v1.ZoneDistributionConfig zone_distribution_config = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ZoneDistributionConfigOrBuilder

hasAsyncInstanceEndpointsDeletionEnabled()

public boolean hasAsyncInstanceEndpointsDeletionEnabled()

Optional. If true, instance endpoints that are created and registered by customers can be deleted asynchronously. That is, such an instance endpoint can be de-registered before the forwarding rules in the instance endpoint are deleted.

optional bool async_instance_endpoints_deletion_enabled = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the asyncInstanceEndpointsDeletionEnabled field is set.

hasAutomatedBackupConfig()

public boolean hasAutomatedBackupConfig()

Optional. The automated backup config for the instance.

.google.cloud.memorystore.v1.AutomatedBackupConfig automated_backup_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the automatedBackupConfig field is set.

hasBackupCollection()

public boolean hasBackupCollection()

Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}

optional string backup_collection = 47 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the backupCollection field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation timestamp of the instance.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasCrossInstanceReplicationConfig()

public boolean hasCrossInstanceReplicationConfig()

Optional. The config for cross instance replication.

.google.cloud.memorystore.v1.CrossInstanceReplicationConfig cross_instance_replication_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the crossInstanceReplicationConfig field is set.

hasDeletionProtectionEnabled()

public boolean hasDeletionProtectionEnabled()

Optional. If set to true deletion of the instance will fail.

optional bool deletion_protection_enabled = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the deletionProtectionEnabled field is set.

hasGcsSource()

public boolean hasGcsSource()

Optional. Immutable. Backups that stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the instances. Read permission is required to import from the provided Cloud Storage Objects.

.google.cloud.memorystore.v1.Instance.GcsBackupSource gcs_source = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the gcsSource field is set.

hasMaintenancePolicy()

public boolean hasMaintenancePolicy()

Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.

.google.cloud.memorystore.v1.MaintenancePolicy maintenance_policy = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maintenancePolicy field is set.

hasMaintenanceSchedule()

public boolean hasMaintenanceSchedule()

Output only. Published maintenance schedule.

.google.cloud.memorystore.v1.MaintenanceSchedule maintenance_schedule = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the maintenanceSchedule field is set.

hasManagedBackupSource()

public boolean hasManagedBackupSource()

Optional. Immutable. Backups that generated and managed by memorystore service.

.google.cloud.memorystore.v1.Instance.ManagedBackupSource managed_backup_source = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the managedBackupSource field is set.

hasNodeConfig()

public boolean hasNodeConfig()

Output only. Configuration of individual nodes of the instance.

.google.cloud.memorystore.v1.NodeConfig node_config = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the nodeConfig field is set.

hasOndemandMaintenance()

public boolean hasOndemandMaintenance()

Optional. Input only. Ondemand maintenance for the instance.

optional bool ondemand_maintenance = 28 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the ondemandMaintenance field is set.

hasPersistenceConfig()

public boolean hasPersistenceConfig()

Optional. Persistence configuration of the instance.

.google.cloud.memorystore.v1.PersistenceConfig persistence_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the persistenceConfig field is set.

hasReplicaCount()

public boolean hasReplicaCount()

Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.

optional int32 replica_count = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the replicaCount field is set.

hasStateInfo()

public boolean hasStateInfo()

Output only. Additional information about the state of the instance.

.google.cloud.memorystore.v1.Instance.StateInfo state_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the stateInfo field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Latest update timestamp of the instance.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hasZoneDistributionConfig()

public boolean hasZoneDistributionConfig()

Optional. Immutable. Zone distribution configuration of the instance for node allocation.

.google.cloud.memorystore.v1.ZoneDistributionConfig zone_distribution_config = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the zoneDistributionConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Instance.Builder newBuilderForType()
Returns
Type Description
Instance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Instance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Instance.Builder toBuilder()
Returns
Type Description
Instance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException