Struct gcp_client::google::cloud::redis::v1beta1::Instance

pub struct Instance {
    pub name: String,
    pub display_name: String,
    pub labels: HashMap<String, String>,
    pub location_id: String,
    pub alternative_location_id: String,
    pub redis_version: String,
    pub reserved_ip_range: String,
    pub host: String,
    pub port: i32,
    pub current_location_id: String,
    pub create_time: Option<Timestamp>,
    pub state: i32,
    pub status_message: String,
    pub redis_configs: HashMap<String, String>,
    pub tier: i32,
    pub memory_size_gb: i32,
    pub authorized_network: String,
    pub persistence_iam_identity: String,
    pub connect_mode: i32,
}

A Google Cloud Redis instance.

Fields

name: String

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][google.cloud.redis.v1beta1.Instance.location_id] and [alternative_location_id][google.cloud.redis.v1beta1.Instance.alternative_location_id] fields for more details.

display_name: String

An arbitrary and optional user-provided name for the instance.

labels: HashMap<String, String>

Resource labels to represent user provided metadata

location_id: String

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][google.cloud.redis.v1beta1.Instance.alternative_location_id] is also provided, it must be different from [location_id][google.cloud.redis.v1beta1.Instance.location_id].

alternative_location_id: String

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][google.cloud.redis.v1beta1.Instance.location_id].

redis_version: String

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 compatibility
• REDIS_4_0 for Redis 4.0 compatibility (default)
• REDIS_5_0 for Redis 5.0 compatibility

reserved_ip_range: String

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.

host: String

Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

port: i32

Output only. The port number of the exposed Redis endpoint.

current_location_id: String

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][google.cloud.redis.v1beta1.Instance.location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id][google.cloud.redis.v1beta1.Instance.location_id] or [alternative_location_id][google.cloud.redis.v1beta1.Instance.alternative_location_id] and can change after a failover event.

create_time: Option<Timestamp>

Output only. The time the instance was created.

state: i32

Output only. The current state of this instance.

status_message: String

Output only. Additional information about the current status of this instance, if available.

redis_configs: HashMap<String, String>

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

tier: i32

Required. The service tier of the instance.

memory_size_gb: i32

Required. Redis memory size in GiB.

authorized_network: String

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.

persistence_iam_identity: String

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.

connect_mode: i32

Optional. The connect mode of Redis instance. If not provided, default one will be used. Current default: DIRECT_PEERING.

Implementations

impl Instance

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn tier(&self) -> Tier

Returns the enum value of tier, or the default if the field is set to an invalid enum value.

pub fn set_tier(&mut self, value: Tier)

Sets tier to the provided enum value.

pub fn connect_mode(&self) -> ConnectMode

Returns the enum value of connect_mode, or the default if the field is set to an invalid enum value.

pub fn set_connect_mode(&mut self, value: ConnectMode)

Sets connect_mode to the provided enum value.

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Instance

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Instance

fn default() -> Instance

Returns the "default value" for a type.

impl Message for Instance

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Instance> for Instance

fn eq(&self, other: &Instance) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Instance) -> bool

This method tests for !=.

impl StructuralPartialEq for Instance