public static final class TriggerBackupRequest.Builder extends GeneratedMessage.Builder<TriggerBackupRequest.Builder> implements TriggerBackupRequestOrBuilderRequest message for triggering a backup.
Protobuf type google.cloud.backupdr.v1beta.TriggerBackupRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > TriggerBackupRequest.BuilderImplements
TriggerBackupRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public TriggerBackupRequest build()| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest |
|
buildPartial()
public TriggerBackupRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest |
|
clear()
public TriggerBackupRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
|
clearCustomRetentionDays()
public TriggerBackupRequest.Builder clearCustomRetentionDays()Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in "days". It is mutually exclusive with rule_id. This field is required if rule_id is not provided.
int32 custom_retention_days = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |
clearLabels()
public TriggerBackupRequest.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
|
clearName()
public TriggerBackupRequest.Builder clearName() Required. Name of the backup plan association resource, in the format
projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |
clearRequestId()
public TriggerBackupRequest.Builder clearRequestId()Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |
clearRuleId()
public TriggerBackupRequest.Builder clearRuleId()Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.
string rule_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |
containsLabels(String key)
public boolean containsLabels(String key)Optional. Labels to be applied on the backup.
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCustomRetentionDays()
public int getCustomRetentionDays()Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in "days". It is mutually exclusive with rule_id. This field is required if rule_id is not provided.
int32 custom_retention_days = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The customRetentionDays. |
getDefaultInstanceForType()
public TriggerBackupRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public int getLabelsCount()Optional. Labels to be applied on the backup.
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()Optional. Labels to be applied on the backup.
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)Optional. Labels to be applied on the backup.
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)Optional. Labels to be applied on the backup.
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public String getName() Required. Name of the backup plan association resource, in the format
projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Required. Name of the backup plan association resource, in the format
projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getRequestId()
public String getRequestId()Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The requestId. |
getRequestIdBytes()
public ByteString getRequestIdBytes()Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for requestId. |
getRuleId()
public String getRuleId()Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.
string rule_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The ruleId. |
getRuleIdBytes()
public ByteString getRuleIdBytes()Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.
string rule_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for ruleId. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(TriggerBackupRequest other)
public TriggerBackupRequest.Builder mergeFrom(TriggerBackupRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
TriggerBackupRequest |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TriggerBackupRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public TriggerBackupRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
|
putAllLabels(Map<String,String> values)
public TriggerBackupRequest.Builder putAllLabels(Map<String,String> values)Optional. Labels to be applied on the backup.
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
|
putLabels(String key, String value)
public TriggerBackupRequest.Builder putLabels(String key, String value)Optional. Labels to be applied on the backup.
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
|
removeLabels(String key)
public TriggerBackupRequest.Builder removeLabels(String key)Optional. Labels to be applied on the backup.
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
|
setCustomRetentionDays(int value)
public TriggerBackupRequest.Builder setCustomRetentionDays(int value)Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in "days". It is mutually exclusive with rule_id. This field is required if rule_id is not provided.
int32 custom_retention_days = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe customRetentionDays to set. |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |
setName(String value)
public TriggerBackupRequest.Builder setName(String value) Required. Name of the backup plan association resource, in the format
projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public TriggerBackupRequest.Builder setNameBytes(ByteString value) Required. Name of the backup plan association resource, in the format
projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |
setRequestId(String value)
public TriggerBackupRequest.Builder setRequestId(String value)Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe requestId to set. |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |
setRequestIdBytes(ByteString value)
public TriggerBackupRequest.Builder setRequestIdBytes(ByteString value)Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for requestId to set. |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |
setRuleId(String value)
public TriggerBackupRequest.Builder setRuleId(String value)Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.
string rule_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe ruleId to set. |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |
setRuleIdBytes(ByteString value)
public TriggerBackupRequest.Builder setRuleIdBytes(ByteString value)Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.
string rule_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for ruleId to set. |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest.Builder |
This builder for chaining. |