Interface InstanceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Instance, Instance.Builder

@Generated public interface InstanceOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getName

      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];
      Returns:
      The name.
    • getNameBytes

      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];
      Returns:
      The bytes for name.
    • getDisplayName

      String getDisplayName()
       An arbitrary and optional user-provided name for the instance.
       
      string display_name = 2;
      Returns:
      The displayName.
    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       An arbitrary and optional user-provided name for the instance.
       
      string display_name = 2;
      Returns:
      The bytes for displayName.
    • getLabelsCount

      int getLabelsCount()
       Resource labels to represent user provided metadata
       
      map<string, string> labels = 3;
    • containsLabels

      boolean containsLabels(String key)
       Resource labels to represent user provided metadata
       
      map<string, string> labels = 3;
    • getLabels

      Deprecated.
      Use getLabelsMap() instead.
    • getLabelsMap

      Map<String,String> getLabelsMap()
       Resource labels to represent user provided metadata
       
      map<string, string> labels = 3;
    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Resource labels to represent user provided metadata
       
      map<string, string> labels = 3;
    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Resource labels to represent user provided metadata
       
      map<string, string> labels = 3;
    • getLocationId

      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:
      The locationId.
    • getLocationIdBytes

      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];
      Returns:
      The bytes for locationId.
    • getAlternativeLocationId

      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:
      The alternativeLocationId.
    • getAlternativeLocationIdBytes

      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];
      Returns:
      The bytes for alternativeLocationId.
    • getRedisVersion

      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];
      Returns:
      The redisVersion.
    • getRedisVersionBytes

      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];
      Returns:
      The bytes for redisVersion.
    • getReservedIpRange

      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:
      The reservedIpRange.
    • getReservedIpRangeBytes

      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];
      Returns:
      The bytes for reservedIpRange.
    • getSecondaryIpRange

      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:
      The secondaryIpRange.
    • getSecondaryIpRangeBytes

      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];
      Returns:
      The bytes for secondaryIpRange.
    • getHost

      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:
      The host.
    • getHostBytes

      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];
      Returns:
      The bytes for host.
    • getPort

      int getPort()
       Output only. The port number of the exposed Redis endpoint.
       
      int32 port = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The port.
    • getCurrentLocationId

      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:
      The currentLocationId.
    • getCurrentLocationIdBytes

      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];
      Returns:
      The bytes for currentLocationId.
    • hasCreateTime

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

      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];
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      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];
    • getStateValue

      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:
      The enum numeric value on the wire for state.
    • getState

      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:
      The state.
    • getStatusMessage

      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:
      The statusMessage.
    • getStatusMessageBytes

      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];
      Returns:
      The bytes for statusMessage.
    • getRedisConfigsCount

      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];
    • containsRedisConfigs

      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];
    • getRedisConfigs

      @Deprecated Map<String,String> getRedisConfigs()
      Deprecated.
    • getRedisConfigsMap

      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];
    • getRedisConfigsOrDefault

      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];
    • getRedisConfigsOrThrow

      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];
    • getTierValue

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

      Instance.Tier getTier()
       Required. The service tier of the instance.
       
      .google.cloud.redis.v1.Instance.Tier tier = 17 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The tier.
    • getMemorySizeGb

      int getMemorySizeGb()
       Required. Redis memory size in GiB.
       
      int32 memory_size_gb = 18 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The memorySizeGb.
    • getAuthorizedNetwork

      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];
      Returns:
      The authorizedNetwork.
    • getAuthorizedNetworkBytes

      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];
      Returns:
      The bytes for authorizedNetwork.
    • getPersistenceIamIdentity

      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:
      The persistenceIamIdentity.
    • getPersistenceIamIdentityBytes

      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];
      Returns:
      The bytes for persistenceIamIdentity.
    • getConnectModeValue

      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:
      The enum numeric value on the wire for connectMode.
    • getConnectMode

      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:
      The connectMode.
    • getAuthEnabled

      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:
      The authEnabled.
    • getServerCaCertsList

      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];
    • getServerCaCerts

      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];
    • getServerCaCertsCount

      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];
    • getServerCaCertsOrBuilderList

      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];
    • getServerCaCertsOrBuilder

      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];
    • getTransitEncryptionModeValue

      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:
      The enum numeric value on the wire for transitEncryptionMode.
    • getTransitEncryptionMode

      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:
      The transitEncryptionMode.
    • hasMaintenancePolicy

      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:
      Whether the maintenancePolicy field is set.
    • getMaintenancePolicy

      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:
      The maintenancePolicy.
    • getMaintenancePolicyOrBuilder

      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];
    • hasMaintenanceSchedule

      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:
      Whether the maintenanceSchedule field is set.
    • getMaintenanceSchedule

      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:
      The maintenanceSchedule.
    • getMaintenanceScheduleOrBuilder

      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];
    • getReplicaCount

      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:
      The replicaCount.
    • getNodesList

      List<NodeInfo> getNodesList()
       Output only. Info per node.
       
      repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getNodes

      NodeInfo getNodes(int index)
       Output only. Info per node.
       
      repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getNodesCount

      int getNodesCount()
       Output only. Info per node.
       
      repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getNodesOrBuilderList

      List<? extends NodeInfoOrBuilder> getNodesOrBuilderList()
       Output only. Info per node.
       
      repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getNodesOrBuilder

      NodeInfoOrBuilder getNodesOrBuilder(int index)
       Output only. Info per node.
       
      repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getReadEndpoint

      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:
      The readEndpoint.
    • getReadEndpointBytes

      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];
      Returns:
      The bytes for readEndpoint.
    • getReadEndpointPort

      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:
      The readEndpointPort.
    • getReadReplicasModeValue

      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:
      The enum numeric value on the wire for readReplicasMode.
    • getReadReplicasMode

      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:
      The readReplicasMode.
    • getCustomerManagedKey

      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:
      The customerManagedKey.
    • getCustomerManagedKeyBytes

      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];
      Returns:
      The bytes for customerManagedKey.
    • hasPersistenceConfig

      boolean hasPersistenceConfig()
       Optional. Persistence configuration parameters
       
      .google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the persistenceConfig field is set.
    • getPersistenceConfig

      PersistenceConfig getPersistenceConfig()
       Optional. Persistence configuration parameters
       
      .google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The persistenceConfig.
    • getPersistenceConfigOrBuilder

      PersistenceConfigOrBuilder getPersistenceConfigOrBuilder()
       Optional. Persistence configuration parameters
       
      .google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
    • getSuspensionReasonsList

      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:
      A list containing the suspensionReasons.
    • getSuspensionReasonsCount

      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:
      The count of suspensionReasons.
    • getSuspensionReasons

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The suspensionReasons at the given index.
    • getSuspensionReasonsValueList

      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:
      A list containing the enum numeric values on the wire for suspensionReasons.
    • getSuspensionReasonsValue

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of suspensionReasons at the given index.
    • getMaintenanceVersion

      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:
      The maintenanceVersion.
    • getMaintenanceVersionBytes

      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];
      Returns:
      The bytes for maintenanceVersion.
    • getAvailableMaintenanceVersionsList

      List<String> getAvailableMaintenanceVersionsList()
       Optional. The available maintenance versions that an instance could update
       to.
       
      repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the availableMaintenanceVersions.
    • getAvailableMaintenanceVersionsCount

      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:
      The count of availableMaintenanceVersions.
    • getAvailableMaintenanceVersions

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The availableMaintenanceVersions at the given index.
    • getAvailableMaintenanceVersionsBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the availableMaintenanceVersions at the given index.