com.google.api.services.backupdr.v1.model.BackupPlan Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.backupdr.v1.model;
/**
* A `BackupPlan` specifies some common fields, such as `display_name` 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.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Backup and DR Service API. For a detailed explanation
* see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class BackupPlan extends com.google.api.client.json.GenericJson {
/**
* Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule`
* message.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List backupRules;
/**
* Required. Resource name of backup vault which will be used as storage location for backups.
* Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String backupVault;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String backupVaultServiceAccount;
/**
* Output only. When the `BackupPlan` was created.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String createTime;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String description;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String etag;
/**
* Optional. This collection of key/value pairs allows for custom labels to be supplied by the
* user. Example, {"tag": "Weekly"}.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map labels;
/**
* Output only. Identifier. The resource name of the `BackupPlan`. Format:
* `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* Required. The resource type to which the `BackupPlan` will be applied. Examples include,
* "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String resourceType;
/**
* Output only. The `State` for the `BackupPlan`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String state;
/**
* Output only. When the `BackupPlan` was last updated.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String updateTime;
/**
* Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule`
* message.
* @return value or {@code null} for none
*/
public java.util.List getBackupRules() {
return backupRules;
}
/**
* Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule`
* message.
* @param backupRules backupRules or {@code null} for none
*/
public BackupPlan setBackupRules(java.util.List backupRules) {
this.backupRules = backupRules;
return this;
}
/**
* Required. Resource name of backup vault which will be used as storage location for backups.
* Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
* @return value or {@code null} for none
*/
public java.lang.String getBackupVault() {
return backupVault;
}
/**
* Required. Resource name of backup vault which will be used as storage location for backups.
* Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
* @param backupVault backupVault or {@code null} for none
*/
public BackupPlan setBackupVault(java.lang.String backupVault) {
this.backupVault = backupVault;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getBackupVaultServiceAccount() {
return backupVaultServiceAccount;
}
/**
* 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.
* @param backupVaultServiceAccount backupVaultServiceAccount or {@code null} for none
*/
public BackupPlan setBackupVaultServiceAccount(java.lang.String backupVaultServiceAccount) {
this.backupVaultServiceAccount = backupVaultServiceAccount;
return this;
}
/**
* Output only. When the `BackupPlan` was created.
* @return value or {@code null} for none
*/
public String getCreateTime() {
return createTime;
}
/**
* Output only. When the `BackupPlan` was created.
* @param createTime createTime or {@code null} for none
*/
public BackupPlan setCreateTime(String createTime) {
this.createTime = createTime;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getDescription() {
return description;
}
/**
* 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.
* @param description description or {@code null} for none
*/
public BackupPlan setDescription(java.lang.String description) {
this.description = description;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getEtag() {
return etag;
}
/**
* 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.
* @param etag etag or {@code null} for none
*/
public BackupPlan setEtag(java.lang.String etag) {
this.etag = etag;
return this;
}
/**
* Optional. This collection of key/value pairs allows for custom labels to be supplied by the
* user. Example, {"tag": "Weekly"}.
* @return value or {@code null} for none
*/
public java.util.Map getLabels() {
return labels;
}
/**
* Optional. This collection of key/value pairs allows for custom labels to be supplied by the
* user. Example, {"tag": "Weekly"}.
* @param labels labels or {@code null} for none
*/
public BackupPlan setLabels(java.util.Map labels) {
this.labels = labels;
return this;
}
/**
* Output only. Identifier. The resource name of the `BackupPlan`. Format:
* `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* Output only. Identifier. The resource name of the `BackupPlan`. Format:
* `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
* @param name name or {@code null} for none
*/
public BackupPlan setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* Required. The resource type to which the `BackupPlan` will be applied. Examples include,
* "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
* @return value or {@code null} for none
*/
public java.lang.String getResourceType() {
return resourceType;
}
/**
* Required. The resource type to which the `BackupPlan` will be applied. Examples include,
* "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
* @param resourceType resourceType or {@code null} for none
*/
public BackupPlan setResourceType(java.lang.String resourceType) {
this.resourceType = resourceType;
return this;
}
/**
* Output only. The `State` for the `BackupPlan`.
* @return value or {@code null} for none
*/
public java.lang.String getState() {
return state;
}
/**
* Output only. The `State` for the `BackupPlan`.
* @param state state or {@code null} for none
*/
public BackupPlan setState(java.lang.String state) {
this.state = state;
return this;
}
/**
* Output only. When the `BackupPlan` was last updated.
* @return value or {@code null} for none
*/
public String getUpdateTime() {
return updateTime;
}
/**
* Output only. When the `BackupPlan` was last updated.
* @param updateTime updateTime or {@code null} for none
*/
public BackupPlan setUpdateTime(String updateTime) {
this.updateTime = updateTime;
return this;
}
@Override
public BackupPlan set(String fieldName, Object value) {
return (BackupPlan) super.set(fieldName, value);
}
@Override
public BackupPlan clone() {
return (BackupPlan) super.clone();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy