getBackupPlan method

Future<GetBackupPlanOutput> getBackupPlan({ required String backupPlanId, String? versionId, })

Returns BackupPlan details for the specified BackupPlanId. Returns the body of a backup plan in JSON format, in addition to plan metadata.

May throw ResourceNotFoundException. May throw InvalidParameterValueException. May throw MissingParameterValueException. May throw ServiceUnavailableException.

Parameter backupPlanId : Uniquely identifies a backup plan.

Parameter versionId : Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Implementation

Future<GetBackupPlanOutput> getBackupPlan({
  required String backupPlanId,
  String? versionId,
}) async {
  ArgumentError.checkNotNull(backupPlanId, 'backupPlanId');
  final $query = <String, List<String>>{
    if (versionId != null) 'versionId': [versionId],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/backup/plans/${Uri.encodeComponent(backupPlanId)}/',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return GetBackupPlanOutput.fromJson(response);
}