com.google.cloud.redis.v1.cloud_redis
Members list
Type members
Classlikes
Configures and manages Cloud Memorystore for Redis instances
Configures and manages Cloud Memorystore for Redis instances
Google Cloud Memorystore for Redis v1
The redis.googleapis.com
service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances:
- The service works with a collection of cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
- Each location has a collection of Redis instances, named:
/instances/*
- As such, Redis instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be referring to a GCP region
; for example:
projects/redpepper-1290/locations/us-central1/instances/my-redis
Attributes
- Companion
- object
- Source
- CloudRedis.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- trait
- Source
- CloudRedis.scala
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
CloudRedis.type
Attributes
- Source
- CloudRedisProto.scala
- Supertypes
-
class GeneratedFileObjectclass Objecttrait Matchableclass Any
- Self type
-
CloudRedisProto.type
Request for [CreateInstance][google.cloud.redis.v1.CloudRedis.CreateInstance].
Request for [CreateInstance][google.cloud.redis.v1.CloudRedis.CreateInstance].
Value parameters
- instance
-
Required. A Redis [Instance] resource
- instanceId
-
Required. The logical name of the Redis instance in the customer project with the following restrictions:
- Must contain only lowercase letters, numbers, and hyphens.
- Must start with a letter.
- Must be between 1-40 characters.
- Must end with a number or a letter.
- Must be unique within the customer project / location
- parent
-
Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
wherelocation_id
refers to a GCP region.
Attributes
- Companion
- object
- Source
- CreateInstanceRequest.scala
- Supertypes
-
trait Updatable[CreateInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- CreateInstanceRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[CreateInstanceRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Request for [DeleteInstance][google.cloud.redis.v1.CloudRedis.DeleteInstance].
Request for [DeleteInstance][google.cloud.redis.v1.CloudRedis.DeleteInstance].
Value parameters
- name
-
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.
Attributes
- Companion
- object
- Source
- DeleteInstanceRequest.scala
- Supertypes
-
trait Updatable[DeleteInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- DeleteInstanceRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[DeleteInstanceRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Request for [Export][google.cloud.redis.v1.CloudRedis.ExportInstance].
Request for [Export][google.cloud.redis.v1.CloudRedis.ExportInstance].
Value parameters
- name
-
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region. - outputConfig
-
Required. Specify data to be exported.
Attributes
- Companion
- object
- Source
- ExportInstanceRequest.scala
- Supertypes
-
trait Updatable[ExportInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ExportInstanceRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ExportInstanceRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Request for [Failover][google.cloud.redis.v1.CloudRedis.FailoverInstance].
Request for [Failover][google.cloud.redis.v1.CloudRedis.FailoverInstance].
Value parameters
- dataProtectionMode
-
Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.
- name
-
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.
Attributes
- Companion
- object
- Source
- FailoverInstanceRequest.scala
- Supertypes
-
trait Updatable[FailoverInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- FailoverInstanceRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[FailoverInstanceRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
The Cloud Storage location for the output content
The Cloud Storage location for the output content
Value parameters
- uri
-
Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten.
Attributes
- Companion
- object
- Source
- GcsDestination.scala
- Supertypes
-
trait Updatable[GcsDestination]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- GcsDestination.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[GcsDestination]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
GcsDestination.type
The Cloud Storage location for the input content
The Cloud Storage location for the input content
Value parameters
- uri
-
Required. Source data URI. (e.g. 'gs://my_bucket/my_object').
Attributes
- Companion
- object
- Source
- GcsSource.scala
- Supertypes
Attributes
- Companion
- class
- Source
- GcsSource.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[GcsSource]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
GcsSource.type
Request for [GetInstanceAuthString][google.cloud.redis.v1.CloudRedis.GetInstanceAuthString].
Request for [GetInstanceAuthString][google.cloud.redis.v1.CloudRedis.GetInstanceAuthString].
Value parameters
- name
-
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.
Attributes
- Companion
- object
- Source
- GetInstanceAuthStringRequest.scala
- Supertypes
-
trait Updatable[GetInstanceAuthStringRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- GetInstanceAuthStringRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[GetInstanceAuthStringRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Request for [GetInstance][google.cloud.redis.v1.CloudRedis.GetInstance].
Request for [GetInstance][google.cloud.redis.v1.CloudRedis.GetInstance].
Value parameters
- name
-
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.
Attributes
- Companion
- object
- Source
- GetInstanceRequest.scala
- Supertypes
-
trait Updatable[GetInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- GetInstanceRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[GetInstanceRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
GetInstanceRequest.type
Request for [Import][google.cloud.redis.v1.CloudRedis.ImportInstance].
Request for [Import][google.cloud.redis.v1.CloudRedis.ImportInstance].
Value parameters
- inputConfig
-
Required. Specify data to be imported.
- name
-
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.
Attributes
- Companion
- object
- Source
- ImportInstanceRequest.scala
- Supertypes
-
trait Updatable[ImportInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ImportInstanceRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ImportInstanceRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
The input content
The input content
Attributes
- Companion
- object
- Source
- InputConfig.scala
- Supertypes
-
trait Updatable[InputConfig]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- InputConfig.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[InputConfig]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
InputConfig.type
A Memorystore for Redis instance.
A Memorystore for Redis instance.
Value parameters
- alternativeLocationId
-
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.
- authEnabled
-
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.
- authorizedNetwork
-
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. - availableMaintenanceVersions
-
Optional. The available maintenance versions that an instance could update to.
- connectMode
-
Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
- createTime
-
Output only. The time the instance was created.
- currentLocationId
-
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.
- customerManagedKey
-
Optional. The KMS key reference that the customer provides when trying to create the instance.
- displayName
-
An arbitrary and optional user-provided name for the instance.
- host
-
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
- labels
-
Resource labels to represent user provided metadata
- locationId
-
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.
- maintenancePolicy
-
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
- maintenanceSchedule
-
Output only. Date and time of upcoming maintenance events which have been scheduled.
- maintenanceVersion
-
Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
- memorySizeGb
-
Required. Redis memory size in GiB.
- name
-
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. - nodes
-
Output only. Info per node.
- persistenceConfig
-
Optional. Persistence configuration parameters
- persistenceIamIdentity
-
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.
- port
-
Output only. The port number of the exposed Redis endpoint.
- readEndpoint
-
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'.
- readEndpointPort
-
Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
- readReplicasMode
-
Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
- redisConfigs
-
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
- redisVersion
-
Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are:
REDIS_3_2
for Redis 3.2 compatibilityREDIS_4_0
for Redis 4.0 compatibility (default)REDIS_5_0
for Redis 5.0 compatibilityREDIS_6_X
for Redis 6.x compatibility
- replicaCount
-
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.
- reservedIpRange
-
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.
- secondaryIpRange
-
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".
- serverCaCerts
-
Output only. List of server CA certificates for the instance.
- state
-
Output only. The current state of this instance.
- statusMessage
-
Output only. Additional information about the current status of this instance, if available.
- suspensionReasons
-
Optional. reasons that causes instance in "SUSPENDED" state.
- tier
-
Required. The service tier of the instance.
- transitEncryptionMode
-
Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
Attributes
- Companion
- object
- Source
- Instance.scala
- Supertypes
Attributes
- Companion
- class
- Source
- Instance.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[Instance]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
Instance.type
Instance AUTH string details.
Instance AUTH string details.
Value parameters
- authString
-
AUTH string set on the instance.
Attributes
- Companion
- object
- Source
- InstanceAuthString.scala
- Supertypes
-
trait Updatable[InstanceAuthString]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- InstanceAuthString.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[InstanceAuthString]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
InstanceAuthString.type
Request for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
Request for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
Value parameters
- pageSize
-
The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's [
next_page_token
][google.cloud.redis.v1.ListInstancesResponse.next_page_token] to determine if there are more instances left to be queried. - pageToken
-
The
next_page_token
value returned from a previous [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances] request, if any. - parent
-
Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
wherelocation_id
refers to a GCP region.
Attributes
- Companion
- object
- Source
- ListInstancesRequest.scala
- Supertypes
-
trait Updatable[ListInstancesRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListInstancesRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListInstancesRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
ListInstancesRequest.type
Response for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
Response for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
Value parameters
- instances
-
A list of Redis instances in the project in the specified location, or across all locations. If the
location_id
in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with thename
field set to a value of the formprojects/{project_id}/locations/{location_id}/instances/
- and thestatus
field set to ERROR andstatus_message
field set to "location not available for ListInstances". - nextPageToken
-
Token to retrieve the next page of results, or empty if there are no more results in the list.
- unreachable
-
Locations that could not be reached.
Attributes
- Companion
- object
- Source
- ListInstancesResponse.scala
- Supertypes
-
trait Updatable[ListInstancesResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListInstancesResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListInstancesResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the google.cloud.location.Location.metadata
field.
This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the google.cloud.location.Location.metadata
field.
Value parameters
- availableZones
-
Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in
location_id
oralternative_location_id
fields when creating a Redis instance.
Attributes
- Companion
- object
- Source
- LocationMetadata.scala
- Supertypes
-
trait Updatable[LocationMetadata]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- LocationMetadata.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[LocationMetadata]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
LocationMetadata.type
Maintenance policy for an instance.
Maintenance policy for an instance.
Value parameters
- createTime
-
Output only. The time when the policy was created.
- description
-
Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
- updateTime
-
Output only. The time when the policy was last updated.
- weeklyMaintenanceWindow
-
Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one.
Attributes
- Companion
- object
- Source
- MaintenancePolicy.scala
- Supertypes
-
trait Updatable[MaintenancePolicy]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- MaintenancePolicy.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[MaintenancePolicy]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
MaintenancePolicy.type
Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated.
Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated.
Value parameters
- canReschedule
-
If the scheduled maintenance can be rescheduled, default is true.
- endTime
-
Output only. The end time of any upcoming scheduled maintenance for this instance.
- scheduleDeadlineTime
-
Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
- startTime
-
Output only. The start time of any upcoming scheduled maintenance for this instance.
Attributes
- Companion
- object
- Source
- MaintenanceSchedule.scala
- Supertypes
-
trait Updatable[MaintenanceSchedule]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- MaintenanceSchedule.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[MaintenanceSchedule]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
MaintenanceSchedule.type
Node specific properties.
Node specific properties.
Value parameters
- id
-
Output only. Node identifying string. e.g. 'node-0', 'node-1'
- zone
-
Output only. Location of the node.
Attributes
- Companion
- object
- Source
- NodeInfo.scala
- Supertypes
Attributes
- Companion
- class
- Source
- NodeInfo.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[NodeInfo]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
NodeInfo.type
Represents the v1 metadata of the long-running operation.
Represents the v1 metadata of the long-running operation.
Value parameters
- apiVersion
-
API version.
- cancelRequested
-
Specifies if cancellation was requested for the operation.
- createTime
-
Creation timestamp.
- endTime
-
End timestamp.
- statusDetail
-
Operation status details.
- target
-
Operation target.
- verb
-
Operation verb.
Attributes
- Companion
- object
- Source
- OperationMetadata.scala
- Supertypes
-
trait Updatable[OperationMetadata]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- OperationMetadata.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[OperationMetadata]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
OperationMetadata.type
The output content
The output content
Attributes
- Companion
- object
- Source
- OutputConfig.scala
- Supertypes
-
trait Updatable[OutputConfig]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- OutputConfig.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[OutputConfig]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
OutputConfig.type
Configuration of the persistence functionality.
Configuration of the persistence functionality.
Value parameters
- persistenceMode
-
Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.
- rdbNextSnapshotTime
-
Output only. The next time that a snapshot attempt is scheduled to occur.
- rdbSnapshotPeriod
-
Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.
- rdbSnapshotStartTime
-
Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.
Attributes
- Companion
- object
- Source
- PersistenceConfig.scala
- Supertypes
-
trait Updatable[PersistenceConfig]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- PersistenceConfig.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[PersistenceConfig]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
PersistenceConfig.type
Request for [RescheduleMaintenance][google.cloud.redis.v1.CloudRedis.RescheduleMaintenance].
Request for [RescheduleMaintenance][google.cloud.redis.v1.CloudRedis.RescheduleMaintenance].
Value parameters
- name
-
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region. - rescheduleType
-
Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
- scheduleTime
-
Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.
Attributes
- Companion
- object
- Source
- RescheduleMaintenanceRequest.scala
- Supertypes
-
trait Updatable[RescheduleMaintenanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- RescheduleMaintenanceRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[RescheduleMaintenanceRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
TlsCertificate Resource
TlsCertificate Resource
Value parameters
- cert
-
PEM representation.
- createTime
-
Output only. The time when the certificate was created in RFC 3339 format, for example
2020-05-18T00:00:00.094Z
. - expireTime
-
Output only. The time when the certificate expires in RFC 3339 format, for example
2020-05-18T00:00:00.094Z
. - serialNumber
-
Serial number, as extracted from the certificate.
- sha1Fingerprint
-
Sha1 Fingerprint of the certificate.
Attributes
- Companion
- object
- Source
- TlsCertificate.scala
- Supertypes
-
trait Updatable[TlsCertificate]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- TlsCertificate.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[TlsCertificate]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
TlsCertificate.type
Request for [UpdateInstance][google.cloud.redis.v1.CloudRedis.UpdateInstance].
Request for [UpdateInstance][google.cloud.redis.v1.CloudRedis.UpdateInstance].
Value parameters
- instance
-
Required. Update description. Only fields specified in update_mask are updated.
- updateMask
-
Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [Instance][google.cloud.redis.v1.Instance]:
displayName
labels
memorySizeGb
redisConfig
replica_count
Attributes
- Companion
- object
- Source
- UpdateInstanceRequest.scala
- Supertypes
-
trait Updatable[UpdateInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- UpdateInstanceRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[UpdateInstanceRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Request for [UpgradeInstance][google.cloud.redis.v1.CloudRedis.UpgradeInstance].
Request for [UpgradeInstance][google.cloud.redis.v1.CloudRedis.UpgradeInstance].
Value parameters
- name
-
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region. - redisVersion
-
Required. Specifies the target version of Redis software to upgrade to.
Attributes
- Companion
- object
- Source
- UpgradeInstanceRequest.scala
- Supertypes
-
trait Updatable[UpgradeInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- UpgradeInstanceRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[UpgradeInstanceRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window.
Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window.
Value parameters
- day
-
Required. The day of week that maintenance updates occur.
- duration
-
Output only. Duration of the maintenance window. The current window is fixed at 1 hour.
- startTime
-
Required. Start time of the window in UTC time.
Attributes
- Companion
- object
- Source
- WeeklyMaintenanceWindow.scala
- Supertypes
-
trait Updatable[WeeklyMaintenanceWindow]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- WeeklyMaintenanceWindow.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[WeeklyMaintenanceWindow]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Defines specific information for a particular zone. Currently empty and reserved for future use only.
Defines specific information for a particular zone. Currently empty and reserved for future use only.
Attributes
- Companion
- object
- Source
- ZoneMetadata.scala
- Supertypes
-
trait Updatable[ZoneMetadata]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ZoneMetadata.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ZoneMetadata]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
ZoneMetadata.type