Transformation:Update Transformation Properties

Search (SHIFT+S)

Update Transformation Properties

PUT /object/transformation/{transformationId}

Allows the transformation properties to be updated.

NOTE: The type of the transformation cannot be changed. Properties cannot be updated once the Pre-Check phase has passed.

transformationId	Transformation ID to update.

Required Roles

SYSTEM_ADMIN

Prerequisites

The following conditions must be met in order to call this operation.

Transformation must exist.
Pre-check process must not have completed.

Request Payload

<update_centera_transformation_object_param>
   <type></type>
   <name></name>
   <description></description>
   <admin></admin>
   <password></password>
   <management_ip></management_ip>
   <access_ip></access_ip>
   <port></port>
   <datagram_port></datagram_port>
   <namespace></namespace>
   <replication_group></replication_group>
</update_centera_transformation_object_param>

{
  "type": "",
  "name": "",
  "description": "",
  "admin": "",
  "password": "",
  "management_ip": "",
  "access_ip": "",
  "port": "",
  "datagram_port": "",
  "namespace": "",
  "replication_group": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
update_centera_transformation_object_param
type	Defines type of transformation, for instance "centera".	String
name	User provided name (not verified or unique)	String
description	User provided description	String
admin	User provided Centera admin name	String
password	User provided Centera admin password	String
management_ip	User provided management IP address	String
access_ip	User provided data IP address	String
port	User provided management port address.	Integer
datagram_port	User provided data port address.	Integer
namespace	Namespace for transformation.	String
replication_group	Replication group for transformation. If bucket not provided by user, this rg will be used by transformation during bucket creation.	URI

Response Body

Transformation info indicating success or failure of the transformation update operation.

Field	Description	Type	Notes
transformation
transformation_id	ID of this transformation	URI
current_phase	Optional. Current phase	String
phases			0-* Elements
phase_id	Optional. Phase id of transformation. Possible values: PreCheck, Enumeration, Indexing, Migration, Reconciliation, Deletion	String
status	Optional. Phase status. Possible values: Pending, InProgress, Succeeded, Failed, Canceled	String
source_ids	Optional. List of sources (profile and bucket mappings) for transformation	String	0-* Elements
namespace	Optional. Namespace for transformation. If namespace not provided by user, this namespace will be used by transformation during bucket creation.	String
replication_group	Optional. Replication group for transformation. If bucket not provided by user, this replication group will be used by transformation during bucket creation.	String
name	Optional. User provided name (not verified or unique)	String
description	Optional. User provided description.	String
storageDeviceInfo	Storage device info.
start_time	Optional. Transformation start time.	String
end_time	Optional. Transformation end time.	String
total_objects_for_migration	Optional. Total objects discovered for migration.	Long
total_objects_migrated	Optional. Total objects migrated.	Long
total_bytes_for_migration	Optional. Total bytes discovered for migration.	Long
total_bytes_migrated	Optional. Total bytes migrated.	Long
total_errors	Optional. Total unrecovered errors occurred during migration.	Long
total_mismatch_objects	Optional. Total mismatches after reconciliation.	Long
encryption_enabled	Optional. Namespace encryption.	Boolean