Package com.google.cloud.redis.v1

Class Instance

  • All Implemented Interfaces:
    InstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Instance
extends com.google.protobuf.GeneratedMessageV3
implements InstanceOrBuilder
     A Memorystore for Redis instance.
    Protobuf type google.cloud.redis.v1.Instance
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOCATION_ID_FIELD_NUMBER

        public static final int LOCATION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALTERNATIVE_LOCATION_ID_FIELD_NUMBER

        public static final int ALTERNATIVE_LOCATION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REDIS_VERSION_FIELD_NUMBER

        public static final int REDIS_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESERVED_IP_RANGE_FIELD_NUMBER

        public static final int RESERVED_IP_RANGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SECONDARY_IP_RANGE_FIELD_NUMBER

        public static final int SECONDARY_IP_RANGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENT_LOCATION_ID_FIELD_NUMBER

        public static final int CURRENT_LOCATION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STATUS_MESSAGE_FIELD_NUMBER

        public static final int STATUS_MESSAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REDIS_CONFIGS_FIELD_NUMBER

        public static final int REDIS_CONFIGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MEMORY_SIZE_GB_FIELD_NUMBER

        public static final int MEMORY_SIZE_GB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTHORIZED_NETWORK_FIELD_NUMBER

        public static final int AUTHORIZED_NETWORK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PERSISTENCE_IAM_IDENTITY_FIELD_NUMBER

        public static final int PERSISTENCE_IAM_IDENTITY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONNECT_MODE_FIELD_NUMBER

        public static final int CONNECT_MODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTH_ENABLED_FIELD_NUMBER

        public static final int AUTH_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVER_CA_CERTS_FIELD_NUMBER

        public static final int SERVER_CA_CERTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER

        public static final int TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAINTENANCE_POLICY_FIELD_NUMBER

        public static final int MAINTENANCE_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAINTENANCE_SCHEDULE_FIELD_NUMBER

        public static final int MAINTENANCE_SCHEDULE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPLICA_COUNT_FIELD_NUMBER

        public static final int REPLICA_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • READ_ENDPOINT_FIELD_NUMBER

        public static final int READ_ENDPOINT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • READ_ENDPOINT_PORT_FIELD_NUMBER

        public static final int READ_ENDPOINT_PORT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • READ_REPLICAS_MODE_FIELD_NUMBER

        public static final int READ_REPLICAS_MODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOMER_MANAGED_KEY_FIELD_NUMBER

        public static final int CUSTOMER_MANAGED_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PERSISTENCE_CONFIG_FIELD_NUMBER

        public static final int PERSISTENCE_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUSPENSION_REASONS_FIELD_NUMBER

        public static final int SUSPENSION_REASONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAINTENANCE_VERSION_FIELD_NUMBER

        public static final int MAINTENANCE_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AVAILABLE_MAINTENANCE_VERSIONS_FIELD_NUMBER

        public static final int AVAILABLE_MAINTENANCE_VERSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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][google.cloud.redis.v1.Instance.location_id] and
 [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id]
 fields for more details.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getName in interface InstanceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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][google.cloud.redis.v1.Instance.location_id] and
 [alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id]
 fields for more details.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         An arbitrary and optional user-provided name for the instance.
        string display_name = 2;
        Specified by:
        getDisplayName in interface InstanceOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         An arbitrary and optional user-provided name for the instance.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for displayName.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: InstanceOrBuilder
         Resource labels to represent user provided metadata
        map<string, string> labels = 3;
        Specified by:
        getLabelsCount in interface InstanceOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Resource labels to represent user provided metadata
        map<string, string> labels = 3;
        Specified by:
        containsLabels in interface InstanceOrBuilder

      • 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];
        Specified by:
        getLocationId in interface InstanceOrBuilder
        Returns:
        The locationId.

      • getLocationIdBytes

        public com.google.protobuf.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];
        Specified by:
        getLocationIdBytes in interface InstanceOrBuilder
        Returns:
        The bytes for locationId.

      • 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];
        Specified by:
        getAlternativeLocationId in interface InstanceOrBuilder
        Returns:
        The alternativeLocationId.

      • getAlternativeLocationIdBytes

        public com.google.protobuf.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];
        Specified by:
        getAlternativeLocationIdBytes in interface InstanceOrBuilder
        Returns:
        The bytes for alternativeLocationId.

      • 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 compatibility
  *   `REDIS_4_0` for Redis 4.0 compatibility (default)
  *   `REDIS_5_0` for Redis 5.0 compatibility
  *   `REDIS_6_X` for Redis 6.x compatibility
        string redis_version = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRedisVersion in interface InstanceOrBuilder
        Returns:
        The redisVersion.

      • getRedisVersionBytes

        public com.google.protobuf.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 compatibility
  *   `REDIS_4_0` for Redis 4.0 compatibility (default)
  *   `REDIS_5_0` for Redis 5.0 compatibility
  *   `REDIS_6_X` for Redis 6.x compatibility
        string redis_version = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRedisVersionBytes in interface InstanceOrBuilder
        Returns:
        The bytes for redisVersion.

      • 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];
        Specified by:
        getReservedIpRange in interface InstanceOrBuilder
        Returns:
        The reservedIpRange.

      • getReservedIpRangeBytes

        public com.google.protobuf.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];
        Specified by:
        getReservedIpRangeBytes in interface InstanceOrBuilder
        Returns:
        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];
        Specified by:
        getSecondaryIpRange in interface InstanceOrBuilder
        Returns:
        The secondaryIpRange.

      • getSecondaryIpRangeBytes

        public com.google.protobuf.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];
        Specified by:
        getSecondaryIpRangeBytes in interface InstanceOrBuilder
        Returns:
        The bytes for secondaryIpRange.

      • 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];
        Specified by:
        getHost in interface InstanceOrBuilder
        Returns:
        The host.

      • getHostBytes

        public com.google.protobuf.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];
        Specified by:
        getHostBytes in interface InstanceOrBuilder
        Returns:
        The bytes for host.

      • getPort

        public int getPort()
         Output only. The port number of the exposed Redis endpoint.
        int32 port = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPort in interface InstanceOrBuilder
        Returns:
        The port.

      • 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];
        Specified by:
        getCurrentLocationId in interface InstanceOrBuilder
        Returns:
        The currentLocationId.

      • getCurrentLocationIdBytes

        public com.google.protobuf.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];
        Specified by:
        getCurrentLocationIdBytes in interface InstanceOrBuilder
        Returns:
        The bytes for currentLocationId.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time the instance was created.
        .google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface InstanceOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time the instance was created.
        .google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface InstanceOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time the instance was created.
        .google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface InstanceOrBuilder

      • 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];
        Specified by:
        getStateValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • 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];
        Specified by:
        getState in interface InstanceOrBuilder
        Returns:
        The 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];
        Specified by:
        getStatusMessage in interface InstanceOrBuilder
        Returns:
        The statusMessage.

      • getStatusMessageBytes

        public com.google.protobuf.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];
        Specified by:
        getStatusMessageBytes in interface InstanceOrBuilder
        Returns:
        The bytes for statusMessage.

      • getRedisConfigsCount

        public int getRedisConfigsCount()
        Description copied from interface: InstanceOrBuilder
         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];
        Specified by:
        getRedisConfigsCount in interface InstanceOrBuilder

      • containsRedisConfigs

        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];
        Specified by:
        containsRedisConfigs in interface InstanceOrBuilder

      • 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];
        Specified by:
        getRedisConfigsMap in interface InstanceOrBuilder

      • getRedisConfigsOrDefault

        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];
        Specified by:
        getRedisConfigsOrDefault in interface InstanceOrBuilder

      • getRedisConfigsOrThrow

        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];
        Specified by:
        getRedisConfigsOrThrow in interface InstanceOrBuilder

      • getTierValue

        public int getTierValue()
         Required. The service tier of the instance.
        .google.cloud.redis.v1.Instance.Tier tier = 17 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTierValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for tier.

      • 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];
        Specified by:
        getTier in interface InstanceOrBuilder
        Returns:
        The tier.

      • getMemorySizeGb

        public int getMemorySizeGb()
         Required. Redis memory size in GiB.
        int32 memory_size_gb = 18 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMemorySizeGb in interface InstanceOrBuilder
        Returns:
        The memorySizeGb.

      • getAuthorizedNetwork

        public String getAuthorizedNetwork()
         Optional. The full name of the Google Compute Engine
 [network](https://cloud.google.com/vpc/docs/vpc) to which the
 instance is connected. If left unspecified, the `default` network
 will be used.
        string authorized_network = 20 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAuthorizedNetwork in interface InstanceOrBuilder
        Returns:
        The authorizedNetwork.

      • getAuthorizedNetworkBytes

        public com.google.protobuf.ByteString getAuthorizedNetworkBytes()
         Optional. The full name of the Google Compute Engine
 [network](https://cloud.google.com/vpc/docs/vpc) to which the
 instance is connected. If left unspecified, the `default` network
 will be used.
        string authorized_network = 20 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAuthorizedNetworkBytes in interface InstanceOrBuilder
        Returns:
        The bytes for authorizedNetwork.

      • 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];
        Specified by:
        getPersistenceIamIdentity in interface InstanceOrBuilder
        Returns:
        The persistenceIamIdentity.

      • getPersistenceIamIdentityBytes

        public com.google.protobuf.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];
        Specified by:
        getPersistenceIamIdentityBytes in interface InstanceOrBuilder
        Returns:
        The bytes for persistenceIamIdentity.

      • 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];
        Specified by:
        getConnectModeValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for connectMode.

      • 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];
        Specified by:
        getConnectMode in interface InstanceOrBuilder
        Returns:
        The connectMode.

      • 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];
        Specified by:
        getAuthEnabled in interface InstanceOrBuilder
        Returns:
        The authEnabled.

      • 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];
        Specified by:
        getServerCaCertsList in interface InstanceOrBuilder

      • 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];
        Specified by:
        getServerCaCertsOrBuilderList in interface InstanceOrBuilder

      • 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];
        Specified by:
        getServerCaCertsCount in interface InstanceOrBuilder

      • getServerCaCerts

        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];
        Specified by:
        getServerCaCerts in interface InstanceOrBuilder

      • getServerCaCertsOrBuilder

        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];
        Specified by:
        getServerCaCertsOrBuilder in interface InstanceOrBuilder

      • 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];
        Specified by:
        getTransitEncryptionModeValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for transitEncryptionMode.

      • 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];
        Specified by:
        getTransitEncryptionMode in interface InstanceOrBuilder
        Returns:
        The transitEncryptionMode.

      • 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];
        Specified by:
        hasMaintenancePolicy in interface InstanceOrBuilder
        Returns:
        Whether the maintenancePolicy field is set.

      • 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];
        Specified by:
        getMaintenancePolicy in interface InstanceOrBuilder
        Returns:
        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];
        Specified by:
        getMaintenancePolicyOrBuilder in interface InstanceOrBuilder

      • 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];
        Specified by:
        hasMaintenanceSchedule in interface InstanceOrBuilder
        Returns:
        Whether the maintenanceSchedule field is set.

      • 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];
        Specified by:
        getMaintenanceSchedule in interface InstanceOrBuilder
        Returns:
        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];
        Specified by:
        getMaintenanceScheduleOrBuilder in interface InstanceOrBuilder

      • 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];
        Specified by:
        getReplicaCount in interface InstanceOrBuilder
        Returns:
        The replicaCount.

      • getNodesList

        public List<NodeInfo> getNodesList()
         Output only. Info per node.
        repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNodesList in interface InstanceOrBuilder

      • getNodesCount

        public int getNodesCount()
         Output only. Info per node.
        repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNodesCount in interface InstanceOrBuilder

      • getNodes

        public NodeInfo getNodes​(int index)
         Output only. Info per node.
        repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNodes in interface InstanceOrBuilder

      • getNodesOrBuilder

        public NodeInfoOrBuilder getNodesOrBuilder​(int index)
         Output only. Info per node.
        repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNodesOrBuilder in interface InstanceOrBuilder

      • 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];
        Specified by:
        getReadEndpoint in interface InstanceOrBuilder
        Returns:
        The readEndpoint.

      • getReadEndpointBytes

        public com.google.protobuf.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];
        Specified by:
        getReadEndpointBytes in interface InstanceOrBuilder
        Returns:
        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];
        Specified by:
        getReadEndpointPort in interface InstanceOrBuilder
        Returns:
        The readEndpointPort.

      • 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];
        Specified by:
        getReadReplicasModeValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for readReplicasMode.

      • 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];
        Specified by:
        getReadReplicasMode in interface InstanceOrBuilder
        Returns:
        The readReplicasMode.

      • 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];
        Specified by:
        getCustomerManagedKey in interface InstanceOrBuilder
        Returns:
        The customerManagedKey.

      • getCustomerManagedKeyBytes

        public com.google.protobuf.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];
        Specified by:
        getCustomerManagedKeyBytes in interface InstanceOrBuilder
        Returns:
        The bytes for customerManagedKey.

      • hasPersistenceConfig

        public boolean hasPersistenceConfig()
         Optional. Persistence configuration parameters
        .google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasPersistenceConfig in interface InstanceOrBuilder
        Returns:
        Whether the persistenceConfig field is set.

      • getPersistenceConfig

        public PersistenceConfig getPersistenceConfig()
         Optional. Persistence configuration parameters
        .google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPersistenceConfig in interface InstanceOrBuilder
        Returns:
        The persistenceConfig.

      • 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];
        Specified by:
        getSuspensionReasonsList in interface InstanceOrBuilder
        Returns:
        A list containing the suspensionReasons.

      • 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];
        Specified by:
        getSuspensionReasonsCount in interface InstanceOrBuilder
        Returns:
        The count of suspensionReasons.

      • getSuspensionReasons

        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];
        Specified by:
        getSuspensionReasons in interface InstanceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The 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];
        Specified by:
        getSuspensionReasonsValueList in interface InstanceOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for suspensionReasons.

      • getSuspensionReasonsValue

        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];
        Specified by:
        getSuspensionReasonsValue in interface InstanceOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of suspensionReasons at the given index.

      • 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];
        Specified by:
        getMaintenanceVersion in interface InstanceOrBuilder
        Returns:
        The maintenanceVersion.

      • getMaintenanceVersionBytes

        public com.google.protobuf.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];
        Specified by:
        getMaintenanceVersionBytes in interface InstanceOrBuilder
        Returns:
        The bytes for maintenanceVersion.

      • getAvailableMaintenanceVersionsList

        public com.google.protobuf.ProtocolStringList getAvailableMaintenanceVersionsList()
         Optional. The available maintenance versions that an instance could update
 to.
        repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAvailableMaintenanceVersionsList in interface InstanceOrBuilder
        Returns:
        A list containing the availableMaintenanceVersions.

      • 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];
        Specified by:
        getAvailableMaintenanceVersionsCount in interface InstanceOrBuilder
        Returns:
        The count of availableMaintenanceVersions.

      • getAvailableMaintenanceVersions

        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];
        Specified by:
        getAvailableMaintenanceVersions in interface InstanceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The availableMaintenanceVersions at the given index.

      • getAvailableMaintenanceVersionsBytes

        public com.google.protobuf.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];
        Specified by:
        getAvailableMaintenanceVersionsBytes in interface InstanceOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the availableMaintenanceVersions at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Instance parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Instance.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Instance.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Instance.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Instance getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Instance> parser()

      • getParserForType

        public com.google.protobuf.Parser<Instance> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Instance getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder