- 2.50.0 (latest)
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.5
- 2.5.0
- 2.4.1
- 2.3.0
- 2.2.0
- 2.1.1
public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder
A Memorystore for Redis instance.
Protobuf type google.cloud.redis.v1.Instance
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InstanceImplements
InstanceOrBuilderStatic Fields
ALTERNATIVE_LOCATION_ID_FIELD_NUMBER
public static final int ALTERNATIVE_LOCATION_ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
AUTHORIZED_NETWORK_FIELD_NUMBER
public static final int AUTHORIZED_NETWORK_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
AUTH_ENABLED_FIELD_NUMBER
public static final int AUTH_ENABLED_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
AVAILABLE_MAINTENANCE_VERSIONS_FIELD_NUMBER
public static final int AVAILABLE_MAINTENANCE_VERSIONS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CONNECT_MODE_FIELD_NUMBER
public static final int CONNECT_MODE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CURRENT_LOCATION_ID_FIELD_NUMBER
public static final int CURRENT_LOCATION_ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CUSTOMER_MANAGED_KEY_FIELD_NUMBER
public static final int CUSTOMER_MANAGED_KEY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
HOST_FIELD_NUMBER
public static final int HOST_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LOCATION_ID_FIELD_NUMBER
public static final int LOCATION_ID_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 |
MAINTENANCE_VERSION_FIELD_NUMBER
public static final int MAINTENANCE_VERSION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
MEMORY_SIZE_GB_FIELD_NUMBER
public static final int MEMORY_SIZE_GB_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NODES_FIELD_NUMBER
public static final int NODES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PERSISTENCE_CONFIG_FIELD_NUMBER
public static final int PERSISTENCE_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PERSISTENCE_IAM_IDENTITY_FIELD_NUMBER
public static final int PERSISTENCE_IAM_IDENTITY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PORT_FIELD_NUMBER
public static final int PORT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
READ_ENDPOINT_FIELD_NUMBER
public static final int READ_ENDPOINT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
READ_ENDPOINT_PORT_FIELD_NUMBER
public static final int READ_ENDPOINT_PORT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
READ_REPLICAS_MODE_FIELD_NUMBER
public static final int READ_REPLICAS_MODE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
REDIS_CONFIGS_FIELD_NUMBER
public static final int REDIS_CONFIGS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
REDIS_VERSION_FIELD_NUMBER
public static final int REDIS_VERSION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
REPLICA_COUNT_FIELD_NUMBER
public static final int REPLICA_COUNT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RESERVED_IP_RANGE_FIELD_NUMBER
public static final int RESERVED_IP_RANGE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SECONDARY_IP_RANGE_FIELD_NUMBER
public static final int SECONDARY_IP_RANGE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SERVER_CA_CERTS_FIELD_NUMBER
public static final int SERVER_CA_CERTS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
STATUS_MESSAGE_FIELD_NUMBER
public static final int STATUS_MESSAGE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SUSPENSION_REASONS_FIELD_NUMBER
public static final int SUSPENSION_REASONS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TIER_FIELD_NUMBER
public static final int TIER_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 |
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
containsLabels(String key)
public boolean containsLabels(String key)
Resource labels to represent user provided metadata
map<string, string> labels = 3;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
boolean |
containsRedisConfigs(String key)
public boolean containsRedisConfigs(String key)
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are:
Redis version 3.2 and newer:
- maxmemory-policy
notify-keyspace-events
Redis version 4.0 and newer:
activedefrag
- lfu-decay-time
- lfu-log-factor
maxmemory-gb
Redis version 5.0 and newer:
stream-node-max-bytes
- stream-node-max-entries
map<string, string> redis_configs = 16 [(.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 |
getAlternativeLocationId()
public String getAlternativeLocationId()
Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.
string alternative_location_id = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The alternativeLocationId. |
getAlternativeLocationIdBytes()
public ByteString getAlternativeLocationIdBytes()
Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.
string alternative_location_id = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for alternativeLocationId. |
getAuthEnabled()
public boolean getAuthEnabled()
Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
bool auth_enabled = 23 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | The authEnabled. |
getAuthorizedNetwork()
public String getAuthorizedNetwork()
Optional. The full name of the Google Compute Engine
network to which the
instance is connected. If left unspecified, the default
network
will be used.
string authorized_network = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The authorizedNetwork. |
getAuthorizedNetworkBytes()
public ByteString getAuthorizedNetworkBytes()
Optional. The full name of the Google Compute Engine
network to which the
instance is connected. If left unspecified, the default
network
will be used.
string authorized_network = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for authorizedNetwork. |
getAvailableMaintenanceVersions(int index)
public String getAvailableMaintenanceVersions(int index)
Optional. The available maintenance versions that an instance could update to.
repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];
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 ByteString getAvailableMaintenanceVersionsBytes(int index)
Optional. The available maintenance versions that an instance could update to.
repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];
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 int getAvailableMaintenanceVersionsCount()
Optional. The available maintenance versions that an instance could update to.
repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The count of availableMaintenanceVersions. |
getAvailableMaintenanceVersionsList()
public ProtocolStringList getAvailableMaintenanceVersionsList()
Optional. The available maintenance versions that an instance could update to.
repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProtocolStringList | A list containing the availableMaintenanceVersions. |
getConnectMode()
public Instance.ConnectMode getConnectMode()
Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
.google.cloud.redis.v1.Instance.ConnectMode connect_mode = 22 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Instance.ConnectMode | The connectMode. |
getConnectModeValue()
public int getConnectModeValue()
Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
.google.cloud.redis.v1.Instance.ConnectMode connect_mode = 22 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for connectMode. |
getCreateTime()
public Timestamp getCreateTime()
Output only. The time the instance was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp | The createTime. |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time the instance was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getCurrentLocationId()
public String getCurrentLocationId()
Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.
string current_location_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The currentLocationId. |
getCurrentLocationIdBytes()
public ByteString getCurrentLocationIdBytes()
Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.
string current_location_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for currentLocationId. |
getCustomerManagedKey()
public String getCustomerManagedKey()
Optional. The KMS key reference that the customer provides when trying to create the instance.
string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The customerManagedKey. |
getCustomerManagedKeyBytes()
public ByteString getCustomerManagedKeyBytes()
Optional. The KMS key reference that the customer provides when trying to create the instance.
string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for customerManagedKey. |
getDefaultInstanceForType()
public Instance getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Instance |
getDisplayName()
public String getDisplayName()
An arbitrary and optional user-provided name for the instance.
string display_name = 2;
Returns | |
---|---|
Type | Description |
String | The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
An arbitrary and optional user-provided name for the instance.
string display_name = 2;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for displayName. |
getHost()
public String getHost()
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
string host = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The host. |
getHostBytes()
public ByteString getHostBytes()
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
string host = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for host. |
getLabels()
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsCount()
public int getLabelsCount()
Resource labels to represent user provided metadata
map<string, string> labels = 3;
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public Map<String,String> getLabelsMap()
Resource labels to represent user provided metadata
map<string, string> labels = 3;
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Resource labels to represent user provided metadata
map<string, string> labels = 3;
Parameters | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
String |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Resource labels to represent user provided metadata
map<string, string> labels = 3;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
String |
getLocationId()
public String getLocationId()
Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.
string location_id = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The locationId. |
getLocationIdBytes()
public ByteString getLocationIdBytes()
Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.
string location_id = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for locationId. |
getMaintenancePolicy()
public MaintenancePolicy getMaintenancePolicy()
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
.google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.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, maintenance events can be performed at any time.
.google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
MaintenancePolicyOrBuilder |
getMaintenanceSchedule()
public MaintenanceSchedule getMaintenanceSchedule()
Output only. Date and time of upcoming maintenance events which have been scheduled.
.google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
MaintenanceSchedule | The maintenanceSchedule. |
getMaintenanceScheduleOrBuilder()
public MaintenanceScheduleOrBuilder getMaintenanceScheduleOrBuilder()
Output only. Date and time of upcoming maintenance events which have been scheduled.
.google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
MaintenanceScheduleOrBuilder |
getMaintenanceVersion()
public String getMaintenanceVersion()
Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The maintenanceVersion. |
getMaintenanceVersionBytes()
public ByteString getMaintenanceVersionBytes()
Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for maintenanceVersion. |
getMemorySizeGb()
public int getMemorySizeGb()
Required. Redis memory size in GiB.
int32 memory_size_gb = 18 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int | The memorySizeGb. |
getName()
public String getName()
Required. Unique name of the resource in this scope including project and
location using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()
Required. Unique name of the resource in this scope including project and
location using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for name. |
getNodes(int index)
public NodeInfo getNodes(int index)
Output only. Info per node.
repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
NodeInfo |
getNodesCount()
public int getNodesCount()
Output only. Info per node.
repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
getNodesList()
public List<NodeInfo> getNodesList()
Output only. Info per node.
repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<NodeInfo> |
getNodesOrBuilder(int index)
public NodeInfoOrBuilder getNodesOrBuilder(int index)
Output only. Info per node.
repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
NodeInfoOrBuilder |
getNodesOrBuilderList()
public List<? extends NodeInfoOrBuilder> getNodesOrBuilderList()
Output only. Info per node.
repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.redis.v1.NodeInfoOrBuilder> |
getParserForType()
public Parser<Instance> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Instance> |
getPersistenceConfig()
public PersistenceConfig getPersistenceConfig()
Optional. Persistence configuration parameters
.google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PersistenceConfig | The persistenceConfig. |
getPersistenceConfigOrBuilder()
public PersistenceConfigOrBuilder getPersistenceConfigOrBuilder()
Optional. Persistence configuration parameters
.google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PersistenceConfigOrBuilder |
getPersistenceIamIdentity()
public String getPersistenceIamIdentity()
Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation.
string persistence_iam_identity = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The persistenceIamIdentity. |
getPersistenceIamIdentityBytes()
public ByteString getPersistenceIamIdentityBytes()
Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation.
string persistence_iam_identity = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for persistenceIamIdentity. |
getPort()
public int getPort()
Output only. The port number of the exposed Redis endpoint.
int32 port = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int | The port. |
getReadEndpoint()
public String getReadEndpoint()
Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.
string read_endpoint = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The readEndpoint. |
getReadEndpointBytes()
public ByteString getReadEndpointBytes()
Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.
string read_endpoint = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for readEndpoint. |
getReadEndpointPort()
public int getReadEndpointPort()
Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
int32 read_endpoint_port = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int | The readEndpointPort. |
getReadReplicasMode()
public Instance.ReadReplicasMode getReadReplicasMode()
Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
.google.cloud.redis.v1.Instance.ReadReplicasMode read_replicas_mode = 35 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Instance.ReadReplicasMode | The readReplicasMode. |
getReadReplicasModeValue()
public int getReadReplicasModeValue()
Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
.google.cloud.redis.v1.Instance.ReadReplicasMode read_replicas_mode = 35 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for readReplicasMode. |
getRedisConfigs()
public Map<String,String> getRedisConfigs()
Use #getRedisConfigsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getRedisConfigsCount()
public int getRedisConfigsCount()
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are:
Redis version 3.2 and newer:
- maxmemory-policy
notify-keyspace-events
Redis version 4.0 and newer:
activedefrag
- lfu-decay-time
- lfu-log-factor
maxmemory-gb
Redis version 5.0 and newer:
stream-node-max-bytes
- stream-node-max-entries
map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getRedisConfigsMap()
public Map<String,String> getRedisConfigsMap()
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are:
Redis version 3.2 and newer:
- maxmemory-policy
notify-keyspace-events
Redis version 4.0 and newer:
activedefrag
- lfu-decay-time
- lfu-log-factor
maxmemory-gb
Redis version 5.0 and newer:
stream-node-max-bytes
- stream-node-max-entries
map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Map<String,String> |
getRedisConfigsOrDefault(String key, String defaultValue)
public String getRedisConfigsOrDefault(String key, String defaultValue)
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are:
Redis version 3.2 and newer:
- maxmemory-policy
notify-keyspace-events
Redis version 4.0 and newer:
activedefrag
- lfu-decay-time
- lfu-log-factor
maxmemory-gb
Redis version 5.0 and newer:
stream-node-max-bytes
- stream-node-max-entries
map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
String |
getRedisConfigsOrThrow(String key)
public String getRedisConfigsOrThrow(String key)
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are:
Redis version 3.2 and newer:
- maxmemory-policy
notify-keyspace-events
Redis version 4.0 and newer:
activedefrag
- lfu-decay-time
- lfu-log-factor
maxmemory-gb
Redis version 5.0 and newer:
stream-node-max-bytes
- stream-node-max-entries
map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
String |
getRedisVersion()
public String getRedisVersion()
Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are:
REDIS_3_2
for Redis 3.2 compatibilityREDIS_4_0
for Redis 4.0 compatibility (default)REDIS_5_0
for Redis 5.0 compatibilityREDIS_6_X
for Redis 6.x compatibility
string redis_version = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The redisVersion. |
getRedisVersionBytes()
public ByteString getRedisVersionBytes()
Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are:
REDIS_3_2
for Redis 3.2 compatibilityREDIS_4_0
for Redis 4.0 compatibility (default)REDIS_5_0
for Redis 5.0 compatibilityREDIS_6_X
for Redis 6.x compatibility
string redis_version = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for redisVersion. |
getReplicaCount()
public int getReplicaCount()
Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.
int32 replica_count = 31 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The replicaCount. |
getReservedIpRange()
public String getReservedIpRange()
Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.
string reserved_ip_range = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The reservedIpRange. |
getReservedIpRangeBytes()
public ByteString getReservedIpRangeBytes()
Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.
string reserved_ip_range = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for reservedIpRange. |
getSecondaryIpRange()
public String getSecondaryIpRange()
Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".
string secondary_ip_range = 30 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The secondaryIpRange. |
getSecondaryIpRangeBytes()
public ByteString getSecondaryIpRangeBytes()
Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".
string secondary_ip_range = 30 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for secondaryIpRange. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getServerCaCerts(int index)
public TlsCertificate getServerCaCerts(int index)
Output only. List of server CA certificates for the instance.
repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
TlsCertificate |
getServerCaCertsCount()
public int getServerCaCertsCount()
Output only. List of server CA certificates for the instance.
repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
getServerCaCertsList()
public List<TlsCertificate> getServerCaCertsList()
Output only. List of server CA certificates for the instance.
repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<TlsCertificate> |
getServerCaCertsOrBuilder(int index)
public TlsCertificateOrBuilder getServerCaCertsOrBuilder(int index)
Output only. List of server CA certificates for the instance.
repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
TlsCertificateOrBuilder |
getServerCaCertsOrBuilderList()
public List<? extends TlsCertificateOrBuilder> getServerCaCertsOrBuilderList()
Output only. List of server CA certificates for the instance.
repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.redis.v1.TlsCertificateOrBuilder> |
getState()
public Instance.State getState()
Output only. The current state of this instance.
.google.cloud.redis.v1.Instance.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Instance.State | The state. |
getStateValue()
public int getStateValue()
Output only. The current state of this instance.
.google.cloud.redis.v1.Instance.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for state. |
getStatusMessage()
public String getStatusMessage()
Output only. Additional information about the current status of this instance, if available.
string status_message = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The statusMessage. |
getStatusMessageBytes()
public ByteString getStatusMessageBytes()
Output only. Additional information about the current status of this instance, if available.
string status_message = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for statusMessage. |
getSuspensionReasons(int index)
public Instance.SuspensionReason getSuspensionReasons(int index)
Optional. reasons that causes instance in "SUSPENDED" state.
repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
Instance.SuspensionReason | The suspensionReasons at the given index. |
getSuspensionReasonsCount()
public int getSuspensionReasonsCount()
Optional. reasons that causes instance in "SUSPENDED" state.
repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The count of suspensionReasons. |
getSuspensionReasonsList()
public List<Instance.SuspensionReason> getSuspensionReasonsList()
Optional. reasons that causes instance in "SUSPENDED" state.
repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<SuspensionReason> | A list containing the suspensionReasons. |
getSuspensionReasonsValue(int index)
public int getSuspensionReasonsValue(int index)
Optional. reasons that causes instance in "SUSPENDED" state.
repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire of suspensionReasons at the given index. |
getSuspensionReasonsValueList()
public List<Integer> getSuspensionReasonsValueList()
Optional. reasons that causes instance in "SUSPENDED" state.
repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Integer> | A list containing the enum numeric values on the wire for suspensionReasons. |
getTier()
public Instance.Tier getTier()
Required. The service tier of the instance.
.google.cloud.redis.v1.Instance.Tier tier = 17 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Instance.Tier | The tier. |
getTierValue()
public int getTierValue()
Required. The service tier of the instance.
.google.cloud.redis.v1.Instance.Tier tier = 17 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for tier. |
getTransitEncryptionMode()
public Instance.TransitEncryptionMode getTransitEncryptionMode()
Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
.google.cloud.redis.v1.Instance.TransitEncryptionMode transit_encryption_mode = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Instance.TransitEncryptionMode | The transitEncryptionMode. |
getTransitEncryptionModeValue()
public int getTransitEncryptionModeValue()
Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
.google.cloud.redis.v1.Instance.TransitEncryptionMode transit_encryption_mode = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for transitEncryptionMode. |
hasCreateTime()
public boolean hasCreateTime()
Output only. The time the instance was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean | Whether the createTime field is set. |
hasMaintenancePolicy()
public boolean hasMaintenancePolicy()
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
.google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | Whether the maintenancePolicy field is set. |
hasMaintenanceSchedule()
public boolean hasMaintenanceSchedule()
Output only. Date and time of upcoming maintenance events which have been scheduled.
.google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean | Whether the maintenanceSchedule field is set. |
hasPersistenceConfig()
public boolean hasPersistenceConfig()
Optional. Persistence configuration parameters
.google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | Whether the persistenceConfig field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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 |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public Instance.Builder toBuilder()
Returns | |
---|---|
Type | Description |
Instance.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |