Class CreateBackupPlanRequest (0.12.0)

public final class CreateBackupPlanRequest extends GeneratedMessageV3 implements CreateBackupPlanRequestOrBuilder

The request message for creating a BackupPlan.

Protobuf type google.cloud.backupdr.v1.CreateBackupPlanRequest

Static Fields

BACKUP_PLAN_FIELD_NUMBER

public static final int BACKUP_PLAN_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_PLAN_ID_FIELD_NUMBER

public static final int BACKUP_PLAN_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateBackupPlanRequest getDefaultInstance()
Returns
Type Description
CreateBackupPlanRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateBackupPlanRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBackupPlan()

public BackupPlan getBackupPlan()

Required. The BackupPlan resource object to create.

.google.cloud.backupdr.v1.BackupPlan backup_plan = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupPlan

The backupPlan.

getBackupPlanId()

public String getBackupPlanId()

Required. The name of the BackupPlan to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.

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

Returns
Type Description
String

The backupPlanId.

getBackupPlanIdBytes()

public ByteString getBackupPlanIdBytes()

Required. The name of the BackupPlan to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.

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

Returns
Type Description
ByteString

The bytes for backupPlanId.

getBackupPlanOrBuilder()

public BackupPlanOrBuilder getBackupPlanOrBuilder()

Required. The BackupPlan resource object to create.

.google.cloud.backupdr.v1.BackupPlan backup_plan = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupPlanOrBuilder

getDefaultInstanceForType()

public CreateBackupPlanRequest getDefaultInstanceForType()
Returns
Type Description
CreateBackupPlanRequest

getParent()

public String getParent()

Required. The BackupPlan project and location in the format projects/{project}/locations/{location}. In Cloud BackupDR locations map to GCP regions, for example us-central1.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The BackupPlan project and location in the format projects/{project}/locations/{location}. In Cloud BackupDR locations map to GCP regions, for example us-central1.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

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 since the first request.

For example, consider a situation where you make an initial request and t he 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 = 4 [(.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 since the first request.

For example, consider a situation where you make an initial request and t he 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 = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasBackupPlan()

public boolean hasBackupPlan()

Required. The BackupPlan resource object to create.

.google.cloud.backupdr.v1.BackupPlan backup_plan = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the backupPlan 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 CreateBackupPlanRequest.Builder newBuilderForType()
Returns
Type Description
CreateBackupPlanRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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