Class BackupPlan (0.10.0)

publicfinalclass BackupPlanextendsGeneratedMessageV3implementsBackupPlanOrBuilder

A BackupPlan specifies some common fields, such as description as well as one or more BackupRule messages. Each BackupRule has a retention policy and defines a schedule by which the system is to perform backup workloads.

Protobuf type google.cloud.backupdr.v1.BackupPlan

Inheritance

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

Implements

BackupPlanOrBuilder

Inherited Members

publicstaticfinalintBACKUP_RULES_FIELD_NUMBER

publicstaticfinalintBACKUP_VAULT_FIELD_NUMBER

publicstaticfinalintBACKUP_VAULT_SERVICE_ACCOUNT_FIELD_NUMBER

publicstaticfinalintCREATE_TIME_FIELD_NUMBER

publicstaticfinalintDESCRIPTION_FIELD_NUMBER

publicstaticfinalintETAG_FIELD_NUMBER

publicstaticfinalintLABELS_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER

publicstaticfinalintRESOURCE_TYPE_FIELD_NUMBER

publicstaticfinalintSTATE_FIELD_NUMBER

publicstaticfinalintUPDATE_TIME_FIELD_NUMBER

publicstaticBackupPlangetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticBackupPlan.BuildernewBuilder()

publicstaticBackupPlan.BuildernewBuilder(BackupPlanprototype)

publicstaticBackupPlanparseDelimitedFrom(InputStreaminput)

publicstaticBackupPlanparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticBackupPlanparseFrom(byte[]data)

publicstaticBackupPlanparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticBackupPlanparseFrom(ByteStringdata)

publicstaticBackupPlanparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticBackupPlanparseFrom(CodedInputStreaminput)

publicstaticBackupPlanparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticBackupPlanparseFrom(InputStreaminput)

publicstaticBackupPlanparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticBackupPlanparseFrom(ByteBufferdata)

publicstaticBackupPlanparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<BackupPlan>parser()

publicbooleancontainsLabels(Stringkey)

Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicBackupRulegetBackupRules(intindex)

Required. The backup rules for this BackupPlan. There must be at least one BackupRule message.

repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED];

publicintgetBackupRulesCount()

Required. The backup rules for this BackupPlan. There must be at least one BackupRule message.

repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED];

publicList<BackupRule>getBackupRulesList()

Required. The backup rules for this BackupPlan. There must be at least one BackupRule message.

repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED];

publicBackupRuleOrBuildergetBackupRulesOrBuilder(intindex)

Required. The backup rules for this BackupPlan. There must be at least one BackupRule message.

repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED];

publicList<?extendsBackupRuleOrBuilder>getBackupRulesOrBuilderList()

Required. The backup rules for this BackupPlan. There must be at least one BackupRule message.

repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED];

publicStringgetBackupVault()

Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}

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

publicByteStringgetBackupVaultBytes()

Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}

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

publicStringgetBackupVaultServiceAccount()

Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.

string backup_vault_service_account = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicByteStringgetBackupVaultServiceAccountBytes()

Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.

string backup_vault_service_account = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicTimestampgetCreateTime()

Output only. When the BackupPlan was created.

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

publicTimestampOrBuildergetCreateTimeOrBuilder()

Output only. When the BackupPlan was created.

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

publicBackupPlangetDefaultInstanceForType()

publicStringgetDescription()

Optional. The description of the BackupPlan resource.

The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

publicByteStringgetDescriptionBytes()

Optional. The description of the BackupPlan resource.

The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

publicStringgetEtag()

Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.

string etag = 9 [(.google.api.field_behavior) = OPTIONAL];

publicByteStringgetEtagBytes()

Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.

string etag = 9 [(.google.api.field_behavior) = OPTIONAL];

publicMap<String,String>getLabels()

Use #getLabelsMap() instead.

publicintgetLabelsCount()

Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];

publicMap<String,String>getLabelsMap()

Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];

publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];

publicStringgetLabelsOrThrow(Stringkey)

Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];

publicStringgetName()

Output only. Identifier. The resource name of the BackupPlan.

Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

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

publicByteStringgetNameBytes()

Output only. Identifier. The resource name of the BackupPlan.

Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

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

publicParser<BackupPlan>getParserForType()

GeneratedMessageV3.getParserForType()

publicStringgetResourceType()

Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".

string resource_type = 8 [(.google.api.field_behavior) = REQUIRED];

publicByteStringgetResourceTypeBytes()

Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".

string resource_type = 8 [(.google.api.field_behavior) = REQUIRED];

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicBackupPlan.StategetState()

Output only. The State for the BackupPlan.

.google.cloud.backupdr.v1.BackupPlan.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicintgetStateValue()

Output only. The State for the BackupPlan.

.google.cloud.backupdr.v1.BackupPlan.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicTimestampgetUpdateTime()

Output only. When the BackupPlan was last updated.

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

publicTimestampOrBuildergetUpdateTimeOrBuilder()

Output only. When the BackupPlan was last updated.

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

publicbooleanhasCreateTime()

Output only. When the BackupPlan was created.

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

publicbooleanhasUpdateTime()

Output only. When the BackupPlan was last updated.

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

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicBackupPlan.BuildernewBuilderForType()

protectedBackupPlan.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicBackupPlan.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)