Interface InstanceOrBuilder (0.4.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

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.

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

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)

public abstract DiscoveryEndpoint getDiscoveryEndpoints(int index)

Output only. Endpoints clients can connect to the instance through. Currently only one discovery endpoint is supported.

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

Parameter
Name Description
index int
Returns
Type Description
DiscoveryEndpoint

getDiscoveryEndpointsCount()

public abstract int getDiscoveryEndpointsCount()

Output only. Endpoints clients can connect to the instance through. Currently only one discovery endpoint is supported.

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

Returns
Type Description
int

getDiscoveryEndpointsList()

public abstract List<DiscoveryEndpoint> getDiscoveryEndpointsList()

Output only. Endpoints clients can connect to the instance through. Currently only one discovery endpoint is supported.

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

Returns
Type Description
List<DiscoveryEndpoint>

getDiscoveryEndpointsOrBuilder(int index)

public abstract DiscoveryEndpointOrBuilder getDiscoveryEndpointsOrBuilder(int index)

Output only. Endpoints clients can connect to the instance through. Currently only one discovery endpoint is supported.

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

Parameter
Name Description
index int
Returns
Type Description
DiscoveryEndpointOrBuilder

getDiscoveryEndpointsOrBuilderList()

public abstract List<? extends DiscoveryEndpointOrBuilder> getDiscoveryEndpointsOrBuilderList()

Output only. Endpoints clients can connect to the instance through. Currently only one discovery endpoint is supported.

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

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

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. Immutable. Engine version of the instance.

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

Returns
Type Description
String

The engineVersion.

getEngineVersionBytes()

public abstract ByteString getEngineVersionBytes()

Optional. Immutable. Engine version of the instance.

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

Returns
Type Description
ByteString

The bytes for engineVersion.

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

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. Immutable. Machine type for individual nodes of the instance.

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

Returns
Type Description
Instance.NodeType

The nodeType.

getNodeTypeValue()

public abstract int getNodeTypeValue()

Optional. Immutable. Machine type for individual nodes of the instance.

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

Returns
Type Description
int

The enum numeric value on the wire for nodeType.

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

getPscAutoConnections(int index)

public abstract PscAutoConnection getPscAutoConnections(int index)

Required. Immutable. User inputs and resource details of the auto-created PSC connections.

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

Parameter
Name Description
index int
Returns
Type Description
PscAutoConnection

getPscAutoConnectionsCount()

public abstract int getPscAutoConnectionsCount()

Required. Immutable. User inputs and resource details of the auto-created PSC connections.

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

Returns
Type Description
int

getPscAutoConnectionsList()

public abstract List<PscAutoConnection> getPscAutoConnectionsList()

Required. Immutable. User inputs and resource details of the auto-created PSC connections.

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

Returns
Type Description
List<PscAutoConnection>

getPscAutoConnectionsOrBuilder(int index)

public abstract PscAutoConnectionOrBuilder getPscAutoConnectionsOrBuilder(int index)

Required. Immutable. User inputs and resource details of the auto-created PSC connections.

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

Parameter
Name Description
index int
Returns
Type Description
PscAutoConnectionOrBuilder

getPscAutoConnectionsOrBuilderList()

public abstract List<? extends PscAutoConnectionOrBuilder> getPscAutoConnectionsOrBuilderList()

Required. Immutable. User inputs and resource details of the auto-created PSC connections.

repeated .google.cloud.memorystore.v1.PscAutoConnection psc_auto_connections = 20 [(.google.api.field_behavior) = REQUIRED, (.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.

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.

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

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.

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.

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.

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.

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.