Class TriggerBackupRequest.Builder (0.42.0)

public static final class TriggerBackupRequest.Builder extends GeneratedMessage.Builder<TriggerBackupRequest.Builder> implements TriggerBackupRequestOrBuilder

Request message for triggering a backup.

Protobuf type google.cloud.backupdr.v1.TriggerBackupRequest

Static 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
Overrides

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()

Required. backup rule_id for which a backup needs to be triggered.

string rule_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TriggerBackupRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public TriggerBackupRequest getDefaultInstanceForType()
Returns
Type Description
TriggerBackupRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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()

Required. backup rule_id for which a backup needs to be triggered.

string rule_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The ruleId.

getRuleIdBytes()

public ByteString getRuleIdBytes()

Required. backup rule_id for which a backup needs to be triggered.

string rule_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for ruleId.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TriggerBackupRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TriggerBackupRequest.Builder
Overrides

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 String

The 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 ByteString

The 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 String

The 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 ByteString

The bytes for requestId to set.

Returns
Type Description
TriggerBackupRequest.Builder

This builder for chaining.

setRuleId(String value)

public TriggerBackupRequest.Builder setRuleId(String value)

Required. backup rule_id for which a backup needs to be triggered.

string rule_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The ruleId to set.

Returns
Type Description
TriggerBackupRequest.Builder

This builder for chaining.

setRuleIdBytes(ByteString value)

public TriggerBackupRequest.Builder setRuleIdBytes(ByteString value)

Required. backup rule_id for which a backup needs to be triggered.

string rule_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for ruleId to set.

Returns
Type Description
TriggerBackupRequest.Builder

This builder for chaining.