com.google.cloud.redis.v1beta1.InstanceOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-redis-v1beta1 Show documentation
Show all versions of proto-google-cloud-redis-v1beta1 Show documentation
PROTO library for proto-google-cloud-redis-v1beta1
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/redis/v1beta1/cloud_redis.proto
package com.google.cloud.redis.v1beta1;
public interface InstanceOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.redis.v1beta1.Instance)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*/
java.lang.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;
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* An arbitrary and optional user-provided name for the instance.
*
*
* string display_name = 2;
*/
java.lang.String getDisplayName();
/**
*
*
*
* An arbitrary and optional user-provided name for the instance.
*
*
* string display_name = 2;
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Resource labels to represent user provided metadata
*
*
* map<string, string> labels = 3;
*/
int getLabelsCount();
/**
*
*
*
* Resource labels to represent user provided metadata
*
*
* map<string, string> labels = 3;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Resource labels to represent user provided metadata
*
*
* map<string, string> labels = 3;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Resource labels to represent user provided metadata
*
*
* map<string, string> labels = 3;
*/
java.lang.String getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue);
/**
*
*
*
* Resource labels to represent user provided metadata
*
*
* map<string, string> labels = 3;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Optional. The zone where the instance will be provisioned. If not provided,
* the service will choose a zone for the instance. For STANDARD_HA tier,
* instances will be created across two zones for protection against zonal
* failures. If [alternative_location_id] is also provided, it must be
* different from [location_id].
*
*
* string location_id = 4;
*/
java.lang.String getLocationId();
/**
*
*
*
* Optional. The zone where the instance will be provisioned. If not provided,
* the service will choose a zone for the instance. For STANDARD_HA tier,
* instances will be created across two zones for protection against zonal
* failures. If [alternative_location_id] is also provided, it must be
* different from [location_id].
*
*
* string location_id = 4;
*/
com.google.protobuf.ByteString getLocationIdBytes();
/**
*
*
*
* Optional. Only applicable to STANDARD_HA tier which protects the instance
* against zonal failures by provisioning it across two zones. If provided, it
* must be a different zone from the one provided in [location_id].
*
*
* string alternative_location_id = 5;
*/
java.lang.String getAlternativeLocationId();
/**
*
*
*
* Optional. Only applicable to STANDARD_HA tier which protects the instance
* against zonal failures by provisioning it across two zones. If provided, it
* must be a different zone from the one provided in [location_id].
*
*
* string alternative_location_id = 5;
*/
com.google.protobuf.ByteString getAlternativeLocationIdBytes();
/**
*
*
*
* Optional. The version of Redis software.
* If not provided, latest supported version will be used. Updating the
* version will perform an upgrade/downgrade to the new version. Currently,
* the supported values are:
* * `REDIS_4_0` for Redis 4.0 compatibility (default)
* * `REDIS_3_2` for Redis 3.2 compatibility
*
*
* string redis_version = 7;
*/
java.lang.String getRedisVersion();
/**
*
*
*
* Optional. The version of Redis software.
* If not provided, latest supported version will be used. Updating the
* version will perform an upgrade/downgrade to the new version. Currently,
* the supported values are:
* * `REDIS_4_0` for Redis 4.0 compatibility (default)
* * `REDIS_3_2` for Redis 3.2 compatibility
*
*
* string redis_version = 7;
*/
com.google.protobuf.ByteString getRedisVersionBytes();
/**
*
*
*
* Optional. The CIDR range of internal addresses that are reserved for this
* instance. If not provided, the service will choose an unused /29 block,
* for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
* and non-overlapping with existing subnets in an authorized network.
*
*
* string reserved_ip_range = 9;
*/
java.lang.String getReservedIpRange();
/**
*
*
*
* Optional. The CIDR range of internal addresses that are reserved for this
* instance. If not provided, the service will choose an unused /29 block,
* for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
* and non-overlapping with existing subnets in an authorized network.
*
*
* string reserved_ip_range = 9;
*/
com.google.protobuf.ByteString getReservedIpRangeBytes();
/**
*
*
*
* Output only. Hostname or IP address of the exposed Redis endpoint used by
* clients to connect to the service.
*
*
* string host = 10;
*/
java.lang.String getHost();
/**
*
*
*
* Output only. Hostname or IP address of the exposed Redis endpoint used by
* clients to connect to the service.
*
*
* string host = 10;
*/
com.google.protobuf.ByteString getHostBytes();
/**
*
*
*
* Output only. The port number of the exposed Redis endpoint.
*
*
* int32 port = 11;
*/
int getPort();
/**
*
*
*
* Output only. The current zone where the Redis endpoint is placed. For Basic
* Tier instances, this will always be the same as the [location_id]
* provided by the user at creation time. For Standard Tier instances,
* this can be either [location_id] or [alternative_location_id] and can
* change after a failover event.
*
*
* string current_location_id = 12;
*/
java.lang.String getCurrentLocationId();
/**
*
*
*
* Output only. The current zone where the Redis endpoint is placed. For Basic
* Tier instances, this will always be the same as the [location_id]
* provided by the user at creation time. For Standard Tier instances,
* this can be either [location_id] or [alternative_location_id] and can
* change after a failover event.
*
*
* string current_location_id = 12;
*/
com.google.protobuf.ByteString getCurrentLocationIdBytes();
/**
*
*
*
* Output only. The time the instance was created.
*
*
* .google.protobuf.Timestamp create_time = 13;
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time the instance was created.
*
*
* .google.protobuf.Timestamp create_time = 13;
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time the instance was created.
*
*
* .google.protobuf.Timestamp create_time = 13;
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The current state of this instance.
*
*
* .google.cloud.redis.v1beta1.Instance.State state = 14;
*/
int getStateValue();
/**
*
*
*
* Output only. The current state of this instance.
*
*
* .google.cloud.redis.v1beta1.Instance.State state = 14;
*/
com.google.cloud.redis.v1beta1.Instance.State getState();
/**
*
*
*
* Output only. Additional information about the current status of this
* instance, if available.
*
*
* string status_message = 15;
*/
java.lang.String getStatusMessage();
/**
*
*
*
* Output only. Additional information about the current status of this
* instance, if available.
*
*
* string status_message = 15;
*/
com.google.protobuf.ByteString getStatusMessageBytes();
/**
*
*
*
* Optional. Redis configuration parameters, according to
* http://redis.io/topics/config. Currently, the only supported parameters
* are:
* Redis 3.2 and above:
* * maxmemory-policy
* * notify-keyspace-events
* Redis 4.0 and above:
* * activedefrag
* * lfu-log-factor
* * lfu-decay-time
*
*
* map<string, string> redis_configs = 16;
*/
int getRedisConfigsCount();
/**
*
*
*
* Optional. Redis configuration parameters, according to
* http://redis.io/topics/config. Currently, the only supported parameters
* are:
* Redis 3.2 and above:
* * maxmemory-policy
* * notify-keyspace-events
* Redis 4.0 and above:
* * activedefrag
* * lfu-log-factor
* * lfu-decay-time
*
*
* map<string, string> redis_configs = 16;
*/
boolean containsRedisConfigs(java.lang.String key);
/** Use {@link #getRedisConfigsMap()} instead. */
@java.lang.Deprecated
java.util.Map getRedisConfigs();
/**
*
*
*
* Optional. Redis configuration parameters, according to
* http://redis.io/topics/config. Currently, the only supported parameters
* are:
* Redis 3.2 and above:
* * maxmemory-policy
* * notify-keyspace-events
* Redis 4.0 and above:
* * activedefrag
* * lfu-log-factor
* * lfu-decay-time
*
*
* map<string, string> redis_configs = 16;
*/
java.util.Map getRedisConfigsMap();
/**
*
*
*
* Optional. Redis configuration parameters, according to
* http://redis.io/topics/config. Currently, the only supported parameters
* are:
* Redis 3.2 and above:
* * maxmemory-policy
* * notify-keyspace-events
* Redis 4.0 and above:
* * activedefrag
* * lfu-log-factor
* * lfu-decay-time
*
*
* map<string, string> redis_configs = 16;
*/
java.lang.String getRedisConfigsOrDefault(java.lang.String key, java.lang.String defaultValue);
/**
*
*
*
* Optional. Redis configuration parameters, according to
* http://redis.io/topics/config. Currently, the only supported parameters
* are:
* Redis 3.2 and above:
* * maxmemory-policy
* * notify-keyspace-events
* Redis 4.0 and above:
* * activedefrag
* * lfu-log-factor
* * lfu-decay-time
*
*
* map<string, string> redis_configs = 16;
*/
java.lang.String getRedisConfigsOrThrow(java.lang.String key);
/**
*
*
*
* Required. The service tier of the instance.
*
*
* .google.cloud.redis.v1beta1.Instance.Tier tier = 17;
*/
int getTierValue();
/**
*
*
*
* Required. The service tier of the instance.
*
*
* .google.cloud.redis.v1beta1.Instance.Tier tier = 17;
*/
com.google.cloud.redis.v1beta1.Instance.Tier getTier();
/**
*
*
*
* Required. Redis memory size in GiB.
*
*
* int32 memory_size_gb = 18;
*/
int getMemorySizeGb();
/**
*
*
*
* Optional. The full name of the Google Compute Engine
* [network](/compute/docs/networks-and-firewalls#networks) to which the
* instance is connected. If left unspecified, the `default` network
* will be used.
*
*
* string authorized_network = 20;
*/
java.lang.String getAuthorizedNetwork();
/**
*
*
*
* Optional. The full name of the Google Compute Engine
* [network](/compute/docs/networks-and-firewalls#networks) to which the
* instance is connected. If left unspecified, the `default` network
* will be used.
*
*
* string authorized_network = 20;
*/
com.google.protobuf.ByteString getAuthorizedNetworkBytes();
/**
*
*
*
* 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;
*/
java.lang.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;
*/
com.google.protobuf.ByteString getPersistenceIamIdentityBytes();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy