Class Backup (0.29.0) 

public final class Backup extends GeneratedMessageV3 implements BackupOrBuilder

Backup of a cluster.

Protobuf type google.cloud.redis.cluster.v1.Backup

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Backup

Implements

BackupOrBuilder

Static Fields

BACKUP_FILES_FIELD_NUMBER

public static final int BACKUP_FILES_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_TYPE_FIELD_NUMBER

public static final int BACKUP_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_UID_FIELD_NUMBER

public static final int CLUSTER_UID_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_INFO_FIELD_NUMBER

public static final int ENCRYPTION_INFO_FIELD_NUMBER
Field Value
Type Description
int

ENGINE_VERSION_FIELD_NUMBER

public static final int ENGINE_VERSION_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NODE_TYPE_FIELD_NUMBER

public static final int NODE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

REPLICA_COUNT_FIELD_NUMBER

public static final int REPLICA_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SHARD_COUNT_FIELD_NUMBER

public static final int SHARD_COUNT_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_SIZE_BYTES_FIELD_NUMBER

public static final int TOTAL_SIZE_BYTES_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Backup getDefaultInstance()
Returns
Type Description
Backup

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Backup.Builder newBuilder()
Returns
Type Description
Backup.Builder

newBuilder(Backup prototype)

public static Backup.Builder newBuilder(Backup prototype)
Parameter
Name Description
prototype Backup
Returns
Type Description
Backup.Builder

parseDelimitedFrom(InputStream input)

public static Backup parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Backup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Backup parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Backup parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Backup parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Backup parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Backup parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Backup> parser()
Returns
Type Description
Parser<Backup>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBackupFiles(int index)

public BackupFile getBackupFiles(int index)

Output only. List of backup files of the backup.

repeated .google.cloud.redis.cluster.v1.BackupFile backup_files = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
BackupFile

getBackupFilesCount()

public int getBackupFilesCount()

Output only. List of backup files of the backup.

repeated .google.cloud.redis.cluster.v1.BackupFile backup_files = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getBackupFilesList()

public List<BackupFile> getBackupFilesList()

Output only. List of backup files of the backup.

repeated .google.cloud.redis.cluster.v1.BackupFile backup_files = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<BackupFile>

getBackupFilesOrBuilder(int index)

public BackupFileOrBuilder getBackupFilesOrBuilder(int index)

Output only. List of backup files of the backup.

repeated .google.cloud.redis.cluster.v1.BackupFile backup_files = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
BackupFileOrBuilder

getBackupFilesOrBuilderList()

public List<? extends BackupFileOrBuilder> getBackupFilesOrBuilderList()

Output only. List of backup files of the backup.

repeated .google.cloud.redis.cluster.v1.BackupFile backup_files = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.redis.cluster.v1.BackupFileOrBuilder>

getBackupType()

public Backup.BackupType getBackupType()

Output only. Type of the backup.

.google.cloud.redis.cluster.v1.Backup.BackupType backup_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Backup.BackupType

The backupType.

getBackupTypeValue()

public int getBackupTypeValue()

Output only. Type of the backup.

.google.cloud.redis.cluster.v1.Backup.BackupType backup_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for backupType.

getCluster()

public String getCluster()

Output only. Cluster resource path of this backup.

string cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The cluster.

getClusterBytes()

public ByteString getClusterBytes()

Output only. Cluster resource path of this backup.

string cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for cluster.

getClusterUid()

public String getClusterUid()

Output only. Cluster uid of this backup.

string cluster_uid = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The clusterUid.

getClusterUidBytes()

public ByteString getClusterUidBytes()

Output only. Cluster uid of this backup.

string cluster_uid = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for clusterUid.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the backup was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the backup was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Backup getDefaultInstanceForType()
Returns
Type Description
Backup

getEncryptionInfo()

public EncryptionInfo getEncryptionInfo()

Output only. Encryption information of the backup.

.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionInfo

The encryptionInfo.

getEncryptionInfoOrBuilder()

public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()

Output only. Encryption information of the backup.

.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionInfoOrBuilder

getEngineVersion()

public String getEngineVersion()

Output only. redis-7.2, valkey-7.5

string engine_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The engineVersion.

getEngineVersionBytes()

public ByteString getEngineVersionBytes()

Output only. redis-7.2, valkey-7.5

string engine_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for engineVersion.

getExpireTime()

public Timestamp getExpireTime()

Output only. The time when the backup will expire.

.google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

Output only. The time when the backup will expire.

.google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNodeType()

public NodeType getNodeType()

Output only. Node type of the cluster.

.google.cloud.redis.cluster.v1.NodeType node_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
NodeType

The nodeType.

getNodeTypeValue()

public int getNodeTypeValue()

Output only. Node type of the cluster.

.google.cloud.redis.cluster.v1.NodeType node_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for nodeType.

getParserForType()

public Parser<Backup> getParserForType()
Returns
Type Description
Parser<Backup>
Overrides

getReplicaCount()

public int getReplicaCount()

Output only. Number of replicas for the cluster.

int32 replica_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The replicaCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShardCount()

public int getShardCount()

Output only. Number of shards for the cluster.

int32 shard_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The shardCount.

getState()

public Backup.State getState()

Output only. State of the backup.

.google.cloud.redis.cluster.v1.Backup.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Backup.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the backup.

.google.cloud.redis.cluster.v1.Backup.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTotalSizeBytes()

public long getTotalSizeBytes()

Output only. Total size of the backup in bytes.

int64 total_size_bytes = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The totalSizeBytes.

getUid()

public String getUid()

Output only. System assigned unique identifier of the backup.

string uid = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. System assigned unique identifier of the backup.

string uid = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the backup was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEncryptionInfo()

public boolean hasEncryptionInfo()

Output only. Encryption information of the backup.

.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the encryptionInfo field is set.

hasExpireTime()

public boolean hasExpireTime()

Output only. The time when the backup will expire.

.google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the expireTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Backup.Builder newBuilderForType()
Returns
Type Description
Backup.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Backup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Backup.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Backup.Builder toBuilder()
Returns
Type Description
Backup.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException