Class Backup.Builder (0.1.0)

public static final class Backup.Builder extends GeneratedMessageV3.Builder<Backup.Builder> implements BackupOrBuilder

Message describing Backup object

Protobuf type google.cloud.alloydb.v1beta.Backup

Inheritance

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

Implements

BackupOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Backup.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`Backup.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Backup build()

Returns

Type	Description
`Backup`

buildPartial()

public Backup buildPartial()

Returns

Type	Description
`Backup`

clear()

public Backup.Builder clear()

Returns

Type	Description
`Backup.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAnnotations()

public Backup.Builder clearAnnotations()

Returns

Type	Description
`Backup.Builder`

clearClusterName()

public Backup.Builder clearClusterName()

Required. The full resource name of the backup source cluster (e.g., projects/<project>/locations/<location>/clusters/<cluster_id>).

string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearClusterUid()

public Backup.Builder clearClusterUid()

Output only. The system-generated UID of the cluster which was used to create this resource.

string cluster_uid = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearCreateTime()

public Backup.Builder clearCreateTime()

Output only. Create time stamp

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

Returns

Type	Description
`Backup.Builder`

clearDeleteTime()

public Backup.Builder clearDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Backup.Builder`

clearDescription()

public Backup.Builder clearDescription()

User-provided description of the backup.

string description = 9;

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearDisplayName()

public Backup.Builder clearDisplayName()

User-settable and human-readable display name for the Backup.

string display_name = 2;

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearEncryptionConfig()

public Backup.Builder clearEncryptionConfig()

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`Backup.Builder`

clearEncryptionInfo()

public Backup.Builder clearEncryptionInfo()

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Backup.Builder`

clearEtag()

public Backup.Builder clearEtag()

For Resource freshness validation (https://google.aip.dev/154)

string etag = 14;

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearExpiryTime()

public Backup.Builder clearExpiryTime()

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Backup.Builder`

clearField(Descriptors.FieldDescriptor field)

public Backup.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
`field`	`FieldDescriptor`

Returns

Type	Description
`Backup.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLabels()

public Backup.Builder clearLabels()

Returns

Type	Description
`Backup.Builder`

clearName()

public Backup.Builder clearName()

Output only. The name of the backup resource with the format:

projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource:
projects/{project}/locations/{region}

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

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Backup.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
`oneof`	`OneofDescriptor`

Returns

Type	Description
`Backup.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearReconciling()

public Backup.Builder clearReconciling()

Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

bool reconciling = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearSizeBytes()

public Backup.Builder clearSizeBytes()

Output only. The size of the backup in bytes.

int64 size_bytes = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearState()

public Backup.Builder clearState()

Output only. The current state of the backup.

.google.cloud.alloydb.v1beta.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearType()

public Backup.Builder clearType()

The backup type, which suggests the trigger for the backup.

.google.cloud.alloydb.v1beta.Backup.Type type = 8;

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearUid()

public Backup.Builder clearUid()

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

clearUpdateTime()

public Backup.Builder clearUpdateTime()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Backup.Builder`

clone()

public Backup.Builder clone()

Returns

Type	Description
`Backup.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 6;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns

Type	Description
`Map<String,String>`

getAnnotationsCount()

public int getAnnotationsCount()

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Returns

Type	Description
`int`

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Returns

Type	Description
`Map<String,String>`

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`String`

Returns

Type	Description
`String`

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`String`

getClusterName()

public String getClusterName()

Required. The full resource name of the backup source cluster (e.g., projects/<project>/locations/<location>/clusters/<cluster_id>).

string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
`String`	The clusterName.

getClusterNameBytes()

public ByteString getClusterNameBytes()

Required. The full resource name of the backup source cluster (e.g., projects/<project>/locations/<location>/clusters/<cluster_id>).

string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
`ByteString`	The bytes for clusterName.

getClusterUid()

public String getClusterUid()

Output only. The system-generated UID of the cluster which was used to create this resource.

string cluster_uid = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`String`	The clusterUid.

getClusterUidBytes()

public ByteString getClusterUidBytes()

Output only. The system-generated UID of the cluster which was used to create this resource.

string cluster_uid = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`ByteString`	The bytes for clusterUid.

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time stamp

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

Returns

Type	Description
`Timestamp`	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Create time stamp

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

Returns

Type	Description
`Builder`

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time stamp

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

Returns

Type	Description
`TimestampOrBuilder`

getDefaultInstanceForType()

public Backup getDefaultInstanceForType()

Returns

Type	Description
`Backup`

getDeleteTime()

public Timestamp getDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Builder`

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

getDescription()

public String getDescription()

User-provided description of the backup.

string description = 9;

Returns

Type	Description
`String`	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User-provided description of the backup.

string description = 9;

Returns

Type	Description
`ByteString`	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

User-settable and human-readable display name for the Backup.

string display_name = 2;

Returns

Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User-settable and human-readable display name for the Backup.

string display_name = 2;

Returns

Type	Description
`ByteString`	The bytes for displayName.

getEncryptionConfig()

public EncryptionConfig getEncryptionConfig()

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`EncryptionConfig`	The encryptionConfig.

getEncryptionConfigBuilder()

public EncryptionConfig.Builder getEncryptionConfigBuilder()

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`EncryptionConfig.Builder`

getEncryptionConfigOrBuilder()

public EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`EncryptionConfigOrBuilder`

getEncryptionInfo()

public EncryptionInfo getEncryptionInfo()

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`EncryptionInfo`	The encryptionInfo.

getEncryptionInfoBuilder()

public EncryptionInfo.Builder getEncryptionInfoBuilder()

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`EncryptionInfo.Builder`

getEncryptionInfoOrBuilder()

public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`EncryptionInfoOrBuilder`

getEtag()

public String getEtag()

For Resource freshness validation (https://google.aip.dev/154)

string etag = 14;

Returns

Type	Description
`String`	The etag.

getEtagBytes()

public ByteString getEtagBytes()

For Resource freshness validation (https://google.aip.dev/154)

string etag = 14;

Returns

Type	Description
`ByteString`	The bytes for etag.

getExpiryTime()

public Timestamp getExpiryTime()

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The expiryTime.

getExpiryTimeBuilder()

public Timestamp.Builder getExpiryTimeBuilder()

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Builder`

getExpiryTimeOrBuilder()

public TimestampOrBuilder getExpiryTimeOrBuilder()

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
`Map<String,String>`

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 6;

Returns

Type	Description
`int`

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs

map<string, string> labels = 6;

Returns

Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs

map<string, string> labels = 6;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`String`

Returns

Type	Description
`String`

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs

map<string, string> labels = 6;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`String`

getMutableAnnotations()

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns

Type	Description
`Map<String,String>`

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns

Type	Description
`Map<String,String>`

getName()

public String getName()

Output only. The name of the backup resource with the format:

projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource:
projects/{project}/locations/{region}

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

Returns

Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of the backup resource with the format:

projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource:
projects/{project}/locations/{region}

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

Returns

Type	Description
`ByteString`	The bytes for name.

getReconciling()

public boolean getReconciling()

bool reconciling = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	The reconciling.

getSizeBytes()

public long getSizeBytes()

Output only. The size of the backup in bytes.

int64 size_bytes = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`long`	The sizeBytes.

getState()

public Backup.State getState()

Output only. The current state of the backup.

.google.cloud.alloydb.v1beta.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Backup.State`	The state.

getStateValue()

public int getStateValue()

Output only. The current state of the backup.

.google.cloud.alloydb.v1beta.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`int`	The enum numeric value on the wire for state.

getType()

public Backup.Type getType()

The backup type, which suggests the trigger for the backup.

.google.cloud.alloydb.v1beta.Backup.Type type = 8;

Returns

Type	Description
`Backup.Type`	The type.

getTypeValue()

public int getTypeValue()

The backup type, which suggests the trigger for the backup.

.google.cloud.alloydb.v1beta.Backup.Type type = 8;

Returns

Type	Description
`int`	The enum numeric value on the wire for type.

getUid()

public String getUid()

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`String`	The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`ByteString`	The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Builder`

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time stamp

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

Returns

Type	Description
`boolean`	Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the deleteTime field is set.

hasEncryptionConfig()

public boolean hasEncryptionConfig()

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`boolean`	Whether the encryptionConfig field is set.

hasEncryptionInfo()

public boolean hasEncryptionInfo()

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the encryptionInfo field is set.

hasExpiryTime()

public boolean hasExpiryTime()

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the expiryTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
`number`	`int`

Returns

Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
`number`	`int`

Returns

Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public Backup.Builder mergeCreateTime(Timestamp value)

Output only. Create time stamp

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

Parameter

Name	Description
`value`	`Timestamp`

Returns

Type	Description
`Backup.Builder`

mergeDeleteTime(Timestamp value)

public Backup.Builder mergeDeleteTime(Timestamp value)

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`Timestamp`

Returns

Type	Description
`Backup.Builder`

mergeEncryptionConfig(EncryptionConfig value)

public Backup.Builder mergeEncryptionConfig(EncryptionConfig value)

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
`value`	`EncryptionConfig`

Returns

Type	Description
`Backup.Builder`

mergeEncryptionInfo(EncryptionInfo value)

public Backup.Builder mergeEncryptionInfo(EncryptionInfo value)

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`EncryptionInfo`

Returns

Type	Description
`Backup.Builder`

mergeExpiryTime(Timestamp value)

public Backup.Builder mergeExpiryTime(Timestamp value)

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`Timestamp`

Returns

Type	Description
`Backup.Builder`

mergeFrom(Backup other)

public Backup.Builder mergeFrom(Backup other)

Parameter

Name	Description
`other`	`Backup`

Returns

Type	Description
`Backup.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Backup.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Backup.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
`IOException`

mergeFrom(Message other)

public Backup.Builder mergeFrom(Message other)

Parameter

Name	Description
`other`	`Message`

Returns

Type	Description
`Backup.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Backup.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`Backup.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public Backup.Builder mergeUpdateTime(Timestamp value)

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`Timestamp`

Returns

Type	Description
`Backup.Builder`

putAllAnnotations(Map<String,String> values)

public Backup.Builder putAllAnnotations(Map<String,String> values)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameter

Name	Description
`values`	`Map<String,String>`

Returns

Type	Description
`Backup.Builder`

putAllLabels(Map<String,String> values)

public Backup.Builder putAllLabels(Map<String,String> values)

Labels as key value pairs

map<string, string> labels = 6;

Parameter

Name	Description
`values`	`Map<String,String>`

Returns

Type	Description
`Backup.Builder`

putAnnotations(String key, String value)

public Backup.Builder putAnnotations(String key, String value)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameters

Name	Description
`key`	`String`
`value`	`String`

Returns

Type	Description
`Backup.Builder`

putLabels(String key, String value)

public Backup.Builder putLabels(String key, String value)

Labels as key value pairs

map<string, string> labels = 6;

Parameters

Name	Description
`key`	`String`
`value`	`String`

Returns

Type	Description
`Backup.Builder`

removeAnnotations(String key)

public Backup.Builder removeAnnotations(String key)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 16;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`Backup.Builder`

removeLabels(String key)

public Backup.Builder removeLabels(String key)

Labels as key value pairs

map<string, string> labels = 6;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`Backup.Builder`

setClusterName(String value)

public Backup.Builder setClusterName(String value)

Required. The full resource name of the backup source cluster (e.g., projects/<project>/locations/<location>/clusters/<cluster_id>).

string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
`value`	`String` The clusterName to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setClusterNameBytes(ByteString value)

public Backup.Builder setClusterNameBytes(ByteString value)

Required. The full resource name of the backup source cluster (e.g., projects/<project>/locations/<location>/clusters/<cluster_id>).

string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
`value`	`ByteString` The bytes for clusterName to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setClusterUid(String value)

public Backup.Builder setClusterUid(String value)

Output only. The system-generated UID of the cluster which was used to create this resource.

string cluster_uid = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`String` The clusterUid to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setClusterUidBytes(ByteString value)

public Backup.Builder setClusterUidBytes(ByteString value)

Output only. The system-generated UID of the cluster which was used to create this resource.

string cluster_uid = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`ByteString` The bytes for clusterUid to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setCreateTime(Timestamp value)

public Backup.Builder setCreateTime(Timestamp value)

Output only. Create time stamp

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

Parameter

Name	Description
`value`	`Timestamp`

Returns

Type	Description
`Backup.Builder`

setCreateTime(Timestamp.Builder builderForValue)

public Backup.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Create time stamp

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

Parameter

Name	Description
`builderForValue`	`Builder`

Returns

Type	Description
`Backup.Builder`

setDeleteTime(Timestamp value)

public Backup.Builder setDeleteTime(Timestamp value)

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`Timestamp`

Returns

Type	Description
`Backup.Builder`

setDeleteTime(Timestamp.Builder builderForValue)

public Backup.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`builderForValue`	`Builder`

Returns

Type	Description
`Backup.Builder`

setDescription(String value)

public Backup.Builder setDescription(String value)

User-provided description of the backup.

string description = 9;

Parameter

Name	Description
`value`	`String` The description to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setDescriptionBytes(ByteString value)

public Backup.Builder setDescriptionBytes(ByteString value)

User-provided description of the backup.

string description = 9;

Parameter

Name	Description
`value`	`ByteString` The bytes for description to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setDisplayName(String value)

public Backup.Builder setDisplayName(String value)

User-settable and human-readable display name for the Backup.

string display_name = 2;

Parameter

Name	Description
`value`	`String` The displayName to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Backup.Builder setDisplayNameBytes(ByteString value)

User-settable and human-readable display name for the Backup.

string display_name = 2;

Parameter

Name	Description
`value`	`ByteString` The bytes for displayName to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setEncryptionConfig(EncryptionConfig value)

public Backup.Builder setEncryptionConfig(EncryptionConfig value)

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
`value`	`EncryptionConfig`

Returns

Type	Description
`Backup.Builder`

setEncryptionConfig(EncryptionConfig.Builder builderForValue)

public Backup.Builder setEncryptionConfig(EncryptionConfig.Builder builderForValue)

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
`builderForValue`	`EncryptionConfig.Builder`

Returns

Type	Description
`Backup.Builder`

setEncryptionInfo(EncryptionInfo value)

public Backup.Builder setEncryptionInfo(EncryptionInfo value)

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`EncryptionInfo`

Returns

Type	Description
`Backup.Builder`

setEncryptionInfo(EncryptionInfo.Builder builderForValue)

public Backup.Builder setEncryptionInfo(EncryptionInfo.Builder builderForValue)

Output only. The encryption information for the backup.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`builderForValue`	`EncryptionInfo.Builder`

Returns

Type	Description
`Backup.Builder`

setEtag(String value)

public Backup.Builder setEtag(String value)

For Resource freshness validation (https://google.aip.dev/154)

string etag = 14;

Parameter

Name	Description
`value`	`String` The etag to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setEtagBytes(ByteString value)

public Backup.Builder setEtagBytes(ByteString value)

For Resource freshness validation (https://google.aip.dev/154)

string etag = 14;

Parameter

Name	Description
`value`	`ByteString` The bytes for etag to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setExpiryTime(Timestamp value)

public Backup.Builder setExpiryTime(Timestamp value)

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`Timestamp`

Returns

Type	Description
`Backup.Builder`

setExpiryTime(Timestamp.Builder builderForValue)

public Backup.Builder setExpiryTime(Timestamp.Builder builderForValue)

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

.google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`builderForValue`	`Builder`

Returns

Type	Description
`Backup.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public Backup.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`Backup.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public Backup.Builder setName(String value)

Output only. The name of the backup resource with the format:

projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource:
projects/{project}/locations/{region}

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

Parameter

Name	Description
`value`	`String` The name to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public Backup.Builder setNameBytes(ByteString value)

Output only. The name of the backup resource with the format:

projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource:
projects/{project}/locations/{region}

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

Parameter

Name	Description
`value`	`ByteString` The bytes for name to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setReconciling(boolean value)

public Backup.Builder setReconciling(boolean value)

bool reconciling = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`boolean` The reconciling to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Backup.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns

Type	Description
`Backup.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSizeBytes(long value)

public Backup.Builder setSizeBytes(long value)

Output only. The size of the backup in bytes.

int64 size_bytes = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`long` The sizeBytes to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setState(Backup.State value)

public Backup.Builder setState(Backup.State value)

Output only. The current state of the backup.

.google.cloud.alloydb.v1beta.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`Backup.State` The state to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setStateValue(int value)

public Backup.Builder setStateValue(int value)

Output only. The current state of the backup.

.google.cloud.alloydb.v1beta.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`int` The enum numeric value on the wire for state to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setType(Backup.Type value)

public Backup.Builder setType(Backup.Type value)

The backup type, which suggests the trigger for the backup.

.google.cloud.alloydb.v1beta.Backup.Type type = 8;

Parameter

Name	Description
`value`	`Backup.Type` The type to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setTypeValue(int value)

public Backup.Builder setTypeValue(int value)

The backup type, which suggests the trigger for the backup.

.google.cloud.alloydb.v1beta.Backup.Type type = 8;

Parameter

Name	Description
`value`	`int` The enum numeric value on the wire for type to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setUid(String value)

public Backup.Builder setUid(String value)

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`String` The uid to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setUidBytes(ByteString value)

public Backup.Builder setUidBytes(ByteString value)

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`ByteString` The bytes for uid to set.

Returns

Type	Description
`Backup.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Backup.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`Backup.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public Backup.Builder setUpdateTime(Timestamp value)

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`value`	`Timestamp`

Returns

Type	Description
`Backup.Builder`

setUpdateTime(Timestamp.Builder builderForValue)

public Backup.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`builderForValue`	`Builder`

Returns

Type	Description
`Backup.Builder`