Interface InstanceOrBuilder (0.31.0) 

public interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsEngineConfigs(String key)

public abstract 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 abstract 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

getAllowFewerZonesDeployment() (deprecated)

public abstract boolean getAllowFewerZonesDeployment()

Deprecated. google.cloud.memorystore.v1.Instance.allow_fewer_zones_deployment is deprecated. See google/cloud/memorystore/v1/memorystore.proto;l=626

Optional. Immutable. Deprecated, do not use.

bool allow_fewer_zones_deployment = 54 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

The allowFewerZonesDeployment.

getAsyncInstanceEndpointsDeletionEnabled()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getAvailableMaintenanceVersions(int index)

public abstract String getAvailableMaintenanceVersions(int index)

Output only. This field is used to determine the available maintenance versions for the self service update.

repeated string available_maintenance_versions = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The availableMaintenanceVersions at the given index.

getAvailableMaintenanceVersionsBytes(int index)

public abstract ByteString getAvailableMaintenanceVersionsBytes(int index)

Output only. This field is used to determine the available maintenance versions for the self service update.

repeated string available_maintenance_versions = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the availableMaintenanceVersions at the given index.

getAvailableMaintenanceVersionsCount()

public abstract int getAvailableMaintenanceVersionsCount()

Output only. This field is used to determine the available maintenance versions for the self service update.

repeated string available_maintenance_versions = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of availableMaintenanceVersions.

getAvailableMaintenanceVersionsList()

public abstract List<String> getAvailableMaintenanceVersionsList()

Output only. This field is used to determine the available maintenance versions for the self service update.

repeated string available_maintenance_versions = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<String>

A list containing the availableMaintenanceVersions.

getBackupCollection()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getDeletionProtectionEnabled()

public abstract 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 abstract DiscoveryEndpoint getDiscoveryEndpoints(int index)

Output only. Deprecated: The discovery_endpoints parameter is deprecated. As a result, it will not be populated if the connections are created using endpoints parameter. Instead of this parameter, for discovery, use endpoints.connections.pscConnection and endpoints.connections.pscAutoConnection with connectionType CONNECTION_TYPE_DISCOVERY.

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 abstract int getDiscoveryEndpointsCount()

Output only. Deprecated: The discovery_endpoints parameter is deprecated. As a result, it will not be populated if the connections are created using endpoints parameter. Instead of this parameter, for discovery, use endpoints.connections.pscConnection and endpoints.connections.pscAutoConnection with connectionType CONNECTION_TYPE_DISCOVERY.

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

Returns
Type Description
int

getDiscoveryEndpointsList() (deprecated)

public abstract List<DiscoveryEndpoint> getDiscoveryEndpointsList()

Output only. Deprecated: The discovery_endpoints parameter is deprecated. As a result, it will not be populated if the connections are created using endpoints parameter. Instead of this parameter, for discovery, use endpoints.connections.pscConnection and endpoints.connections.pscAutoConnection with connectionType CONNECTION_TYPE_DISCOVERY.

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 abstract DiscoveryEndpointOrBuilder getDiscoveryEndpointsOrBuilder(int index)

Output only. Deprecated: The discovery_endpoints parameter is deprecated. As a result, it will not be populated if the connections are created using endpoints parameter. Instead of this parameter, for discovery, use endpoints.connections.pscConnection and endpoints.connections.pscAutoConnection with connectionType CONNECTION_TYPE_DISCOVERY.

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 abstract List<? extends DiscoveryEndpointOrBuilder> getDiscoveryEndpointsOrBuilderList()

Output only. Deprecated: The discovery_endpoints parameter is deprecated. As a result, it will not be populated if the connections are created using endpoints parameter. Instead of this parameter, for discovery, use endpoints.connections.pscConnection and endpoints.connections.pscAutoConnection with connectionType CONNECTION_TYPE_DISCOVERY.

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>

getEffectiveMaintenanceVersion()

public abstract String getEffectiveMaintenanceVersion()

Output only. This field represents the actual maintenance version of the instance.

optional string effective_maintenance_version = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The effectiveMaintenanceVersion.

getEffectiveMaintenanceVersionBytes()

public abstract ByteString getEffectiveMaintenanceVersionBytes()

Output only. This field represents the actual maintenance version of the instance.

optional string effective_maintenance_version = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for effectiveMaintenanceVersion.

getEncryptionInfo()

public abstract EncryptionInfo getEncryptionInfo()

Output only. Encryption information of the data at rest of the cluster.

.google.cloud.memorystore.v1.EncryptionInfo encryption_info = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionInfo

The encryptionInfo.

getEncryptionInfoOrBuilder()

public abstract EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()

Output only. Encryption information of the data at rest of the cluster.

.google.cloud.memorystore.v1.EncryptionInfo encryption_info = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionInfoOrBuilder

getEndpoints(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,String> getEngineConfigs()

Use #getEngineConfigsMap() instead.

Returns
Type Description
Map<String,String>

getEngineConfigsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Instance.ImportSourcesCase getImportSourcesCase()
Returns
Type Description
Instance.ImportSourcesCase

getKmsKey()

public abstract String getKmsKey()

Optional. The KMS key used to encrypt the at-rest data of the cluster.

optional string kms_key = 45 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public abstract ByteString getKmsKeyBytes()

Optional. The KMS key used to encrypt the at-rest data of the cluster.

optional string kms_key = 45 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKey.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getMaintenanceVersion()

public abstract String getMaintenanceVersion()

Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.

optional string maintenance_version = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The maintenanceVersion.

getMaintenanceVersionBytes()

public abstract ByteString getMaintenanceVersionBytes()

Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.

optional string maintenance_version = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for maintenanceVersion.

getManagedBackupSource()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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() (deprecated)

public abstract boolean getOndemandMaintenance()

Deprecated. google.cloud.memorystore.v1.Instance.ondemand_maintenance is deprecated. See google/cloud/memorystore/v1/memorystore.proto;l=545

Optional. Input only. Ondemand maintenance for the instance.

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

Returns
Type Description
boolean

The ondemandMaintenance.

getPersistenceConfig()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getSatisfiesPzi()

public abstract boolean getSatisfiesPzi()

Optional. Output only. Reserved for future use.

optional bool satisfies_pzi = 30 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public abstract boolean getSatisfiesPzs()

Optional. Output only. Reserved for future use.

optional bool satisfies_pzs = 29 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The satisfiesPzs.

getShardCount()

public abstract int getShardCount()

Optional. Number of shards for the instance.

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

Returns
Type Description
int

The shardCount.

getSimulateMaintenanceEvent()

public abstract boolean getSimulateMaintenanceEvent()

Optional. Input only. Simulate a maintenance event.

optional bool simulate_maintenance_event = 27 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

The simulateMaintenanceEvent.

getState()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

hasEffectiveMaintenanceVersion()

public abstract boolean hasEffectiveMaintenanceVersion()

Output only. This field represents the actual maintenance version of the instance.

optional string effective_maintenance_version = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the effectiveMaintenanceVersion field is set.

hasEncryptionInfo()

public abstract boolean hasEncryptionInfo()

Output only. Encryption information of the data at rest of the cluster.

.google.cloud.memorystore.v1.EncryptionInfo encryption_info = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the encryptionInfo field is set.

hasGcsSource()

public abstract 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.

hasKmsKey()

public abstract boolean hasKmsKey()

Optional. The KMS key used to encrypt the at-rest data of the cluster.

optional string kms_key = 45 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the kmsKey field is set.

hasMaintenancePolicy()

public abstract 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 abstract 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.

hasMaintenanceVersion()

public abstract boolean hasMaintenanceVersion()

Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.

optional string maintenance_version = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maintenanceVersion field is set.

hasManagedBackupSource()

public abstract 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 abstract 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() (deprecated)

public abstract boolean hasOndemandMaintenance()

Deprecated. google.cloud.memorystore.v1.Instance.ondemand_maintenance is deprecated. See google/cloud/memorystore/v1/memorystore.proto;l=545

Optional. Input only. Ondemand maintenance for the instance.

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

Returns
Type Description
boolean

Whether the ondemandMaintenance field is set.

hasPersistenceConfig()

public abstract 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 abstract 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.

hasSatisfiesPzi()

public abstract boolean hasSatisfiesPzi()

Optional. Output only. Reserved for future use.

optional bool satisfies_pzi = 30 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public abstract boolean hasSatisfiesPzs()

Optional. Output only. Reserved for future use.

optional bool satisfies_pzs = 29 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasSimulateMaintenanceEvent()

public abstract boolean hasSimulateMaintenanceEvent()

Optional. Input only. Simulate a maintenance event.

optional bool simulate_maintenance_event = 27 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the simulateMaintenanceEvent field is set.

hasStateInfo()

public abstract 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 abstract 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 abstract 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.