/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file 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. */ /* * Do not modify this file. This file is generated from the backup-2018-11-15.normal.json service model. */ using System; using System.Collections.Generic; using System.Xml.Serialization; using System.Text; using System.IO; using System.Net; using Amazon.Runtime; using Amazon.Runtime.Internal; namespace Amazon.Backup.Model { /// /// This is the response object from the DescribeBackupJob operation. /// public partial class DescribeBackupJobResponse : AmazonWebServiceResponse { private string _accountId; private string _backupJobId; private Dictionary _backupOptions = new Dictionary(); private long? _backupSizeInBytes; private string _backupType; private string _backupVaultArn; private string _backupVaultName; private long? _bytesTransferred; private Dictionary _childJobsInState = new Dictionary(); private DateTime? _completionDate; private RecoveryPointCreator _createdBy; private DateTime? _creationDate; private DateTime? _expectedCompletionDate; private string _iamRoleArn; private bool? _isParent; private long? _numberOfChildJobs; private string _parentJobId; private string _percentDone; private string _recoveryPointArn; private string _resourceArn; private string _resourceName; private string _resourceType; private DateTime? _startBy; private BackupJobState _state; private string _statusMessage; /// /// Gets and sets the property AccountId. /// /// Returns the account ID that owns the backup job. /// /// public string AccountId { get { return this._accountId; } set { this._accountId = value; } } // Check to see if AccountId property is set internal bool IsSetAccountId() { return this._accountId != null; } /// /// Gets and sets the property BackupJobId. /// /// Uniquely identifies a request to Backup to back up a resource. /// /// public string BackupJobId { get { return this._backupJobId; } set { this._backupJobId = value; } } // Check to see if BackupJobId property is set internal bool IsSetBackupJobId() { return this._backupJobId != null; } /// /// Gets and sets the property BackupOptions. /// /// Represents the options specified as part of backup plan or on-demand backup job. /// /// public Dictionary BackupOptions { get { return this._backupOptions; } set { this._backupOptions = value; } } // Check to see if BackupOptions property is set internal bool IsSetBackupOptions() { return this._backupOptions != null && this._backupOptions.Count > 0; } /// /// Gets and sets the property BackupSizeInBytes. /// /// The size, in bytes, of a backup. /// /// public long BackupSizeInBytes { get { return this._backupSizeInBytes.GetValueOrDefault(); } set { this._backupSizeInBytes = value; } } // Check to see if BackupSizeInBytes property is set internal bool IsSetBackupSizeInBytes() { return this._backupSizeInBytes.HasValue; } /// /// Gets and sets the property BackupType. /// /// Represents the actual backup type selected for a backup job. For example, if a successful /// Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType /// returns "WindowsVSS". If BackupType is empty, then the backup /// type was a regular backup. /// /// public string BackupType { get { return this._backupType; } set { this._backupType = value; } } // Check to see if BackupType property is set internal bool IsSetBackupType() { return this._backupType != null; } /// /// Gets and sets the property BackupVaultArn. /// /// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, /// arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. /// /// public string BackupVaultArn { get { return this._backupVaultArn; } set { this._backupVaultArn = value; } } // Check to see if BackupVaultArn property is set internal bool IsSetBackupVaultArn() { return this._backupVaultArn != null; } /// /// Gets and sets the property BackupVaultName. /// /// The name of a logical container where backups are stored. Backup vaults are identified /// by names that are unique to the account used to create them and the Amazon Web Services /// Region where they are created. They consist of lowercase letters, numbers, and hyphens. /// /// public string BackupVaultName { get { return this._backupVaultName; } set { this._backupVaultName = value; } } // Check to see if BackupVaultName property is set internal bool IsSetBackupVaultName() { return this._backupVaultName != null; } /// /// Gets and sets the property BytesTransferred. /// /// The size in bytes transferred to a backup vault at the time that the job status was /// queried. /// /// public long BytesTransferred { get { return this._bytesTransferred.GetValueOrDefault(); } set { this._bytesTransferred = value; } } // Check to see if BytesTransferred property is set internal bool IsSetBytesTransferred() { return this._bytesTransferred.HasValue; } /// /// Gets and sets the property ChildJobsInState. /// /// This returns the statistics of the included child (nested) backup jobs. /// /// public Dictionary ChildJobsInState { get { return this._childJobsInState; } set { this._childJobsInState = value; } } // Check to see if ChildJobsInState property is set internal bool IsSetChildJobsInState() { return this._childJobsInState != null && this._childJobsInState.Count > 0; } /// /// Gets and sets the property CompletionDate. /// /// The date and time that a job to create a backup job is completed, in Unix format and /// Coordinated Universal Time (UTC). The value of CompletionDate is accurate /// to milliseconds. For example, the value 1516925490.087 represents Friday, January /// 26, 2018 12:11:30.087 AM. /// /// public DateTime CompletionDate { get { return this._completionDate.GetValueOrDefault(); } set { this._completionDate = value; } } // Check to see if CompletionDate property is set internal bool IsSetCompletionDate() { return this._completionDate.HasValue; } /// /// Gets and sets the property CreatedBy. /// /// Contains identifying information about the creation of a backup job, including the /// BackupPlanArn, BackupPlanId, BackupPlanVersion, /// and BackupRuleId of the backup plan that is used to create it. /// /// public RecoveryPointCreator CreatedBy { get { return this._createdBy; } set { this._createdBy = value; } } // Check to see if CreatedBy property is set internal bool IsSetCreatedBy() { return this._createdBy != null; } /// /// Gets and sets the property CreationDate. /// /// The date and time that a backup job is created, in Unix format and Coordinated Universal /// Time (UTC). The value of CreationDate is accurate to milliseconds. For /// example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 /// AM. /// /// public DateTime CreationDate { get { return this._creationDate.GetValueOrDefault(); } set { this._creationDate = value; } } // Check to see if CreationDate property is set internal bool IsSetCreationDate() { return this._creationDate.HasValue; } /// /// Gets and sets the property ExpectedCompletionDate. /// /// The date and time that a job to back up resources is expected to be completed, in /// Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate /// is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, /// January 26, 2018 12:11:30.087 AM. /// /// public DateTime ExpectedCompletionDate { get { return this._expectedCompletionDate.GetValueOrDefault(); } set { this._expectedCompletionDate = value; } } // Check to see if ExpectedCompletionDate property is set internal bool IsSetExpectedCompletionDate() { return this._expectedCompletionDate.HasValue; } /// /// Gets and sets the property IamRoleArn. /// /// Specifies the IAM role ARN used to create the target recovery point; for example, /// arn:aws:iam::123456789012:role/S3Access. /// /// public string IamRoleArn { get { return this._iamRoleArn; } set { this._iamRoleArn = value; } } // Check to see if IamRoleArn property is set internal bool IsSetIamRoleArn() { return this._iamRoleArn != null; } /// /// Gets and sets the property IsParent. /// /// This returns the boolean value that a backup job is a parent (composite) job. /// /// public bool IsParent { get { return this._isParent.GetValueOrDefault(); } set { this._isParent = value; } } // Check to see if IsParent property is set internal bool IsSetIsParent() { return this._isParent.HasValue; } /// /// Gets and sets the property NumberOfChildJobs. /// /// This returns the number of child (nested) backup jobs. /// /// public long NumberOfChildJobs { get { return this._numberOfChildJobs.GetValueOrDefault(); } set { this._numberOfChildJobs = value; } } // Check to see if NumberOfChildJobs property is set internal bool IsSetNumberOfChildJobs() { return this._numberOfChildJobs.HasValue; } /// /// Gets and sets the property ParentJobId. /// /// This returns the parent (composite) resource backup job ID. /// /// public string ParentJobId { get { return this._parentJobId; } set { this._parentJobId = value; } } // Check to see if ParentJobId property is set internal bool IsSetParentJobId() { return this._parentJobId != null; } /// /// Gets and sets the property PercentDone. /// /// Contains an estimated percentage that is complete of a job at the time the job status /// was queried. /// /// public string PercentDone { get { return this._percentDone; } set { this._percentDone = value; } } // Check to see if PercentDone property is set internal bool IsSetPercentDone() { return this._percentDone != null; } /// /// Gets and sets the property RecoveryPointArn. /// /// An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. /// /// public string RecoveryPointArn { get { return this._recoveryPointArn; } set { this._recoveryPointArn = value; } } // Check to see if RecoveryPointArn property is set internal bool IsSetRecoveryPointArn() { return this._recoveryPointArn != null; } /// /// Gets and sets the property ResourceArn. /// /// An ARN that uniquely identifies a saved resource. The format of the ARN depends on /// the resource type. /// /// public string ResourceArn { get { return this._resourceArn; } set { this._resourceArn = value; } } // Check to see if ResourceArn property is set internal bool IsSetResourceArn() { return this._resourceArn != null; } /// /// Gets and sets the property ResourceName. /// /// This is the non-unique name of the resource that belongs to the specified backup. /// /// public string ResourceName { get { return this._resourceName; } set { this._resourceName = value; } } // Check to see if ResourceName property is set internal bool IsSetResourceName() { return this._resourceName != null; } /// /// Gets and sets the property ResourceType. /// /// The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic /// Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) /// database. /// /// public string ResourceType { get { return this._resourceType; } set { this._resourceType = value; } } // Check to see if ResourceType property is set internal bool IsSetResourceType() { return this._resourceType != null; } /// /// Gets and sets the property StartBy. /// /// Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup /// job must be started before it is canceled. The value is calculated by adding the start /// window to the scheduled time. So if the scheduled time were 6:00 PM and the start /// window is 2 hours, the StartBy time would be 8:00 PM on the date specified. /// The value of StartBy is accurate to milliseconds. For example, the value /// 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. /// /// public DateTime StartBy { get { return this._startBy.GetValueOrDefault(); } set { this._startBy = value; } } // Check to see if StartBy property is set internal bool IsSetStartBy() { return this._startBy.HasValue; } /// /// Gets and sets the property State. /// /// The current state of a resource recovery point. /// /// public BackupJobState State { get { return this._state; } set { this._state = value; } } // Check to see if State property is set internal bool IsSetState() { return this._state != null; } /// /// Gets and sets the property StatusMessage. /// /// A detailed message explaining the status of the job to back up a resource. /// /// public string StatusMessage { get { return this._statusMessage; } set { this._statusMessage = value; } } // Check to see if StatusMessage property is set internal bool IsSetStatusMessage() { return this._statusMessage != null; } } }