Source code for ibm_watson_machine_learning.migration_v4ga_cloud

# (C) Copyright IBM Corp. 2020.
#
# 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.

from __future__ import print_function
import requests
from ibm_watson_machine_learning.utils import STR_TYPE, STR_TYPE_NAME, docstring_parameter
from ibm_watson_machine_learning.metanames import Migrationv4GACloudMetaNames
import os
import json
from ibm_watson_machine_learning.wml_client_error import WMLClientError, UnexpectedType, ApiRequestFailure
from ibm_watson_machine_learning.wml_resource import WMLResource
from ibm_watson_machine_learning.href_definitions import API_VERSION, SPACES
_DEFAULT_LIST_LENGTH = 50


[docs]class Migrationv4GACloud(WMLResource): """ Migration APIs for v4 GA Cloud. This will be applicable only till the migration period Refer to the documentation at 'https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/wml-ai.html' for details on migration """ """MetaNames for python functions creation.""" def __init__(self, client): WMLResource.__init__(self, __name__, client) self._client = client self.ConfigurationMetaNames = Migrationv4GACloudMetaNames() self.skip_msg = False self.notification_msg = "NOTE: This migration API is only available during the migration period for moving "\ "assets to a project or space for use with new machine learning service plans and v4 APIs on Cloud. Refer to "\ "the documentation at 'https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/wml-ai.html' for "\ "details on new plans and features.\n"
[docs] @docstring_parameter({'str_type': STR_TYPE_NAME}) def start(self, meta_props): """ Migration APIs for v4 GA Cloud to migrate assets from v3 or v4 beta. This will be applicable only till the migration period. Refer to the documentation at 'https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/wml-ai.html' for details on migration. You will need to have a space or project created before you start migration of assets to that space or project You should have read access to the instance from which migration is required You should have 'editor' or 'admin' access on the target 'space'/'project' SKIP_MIGRATED_ASSETS meta prop: If this is True (the default) and if the target assets still exist and if there are completed jobs (that were not deleted) then any assets that were already migrated will be skipped and the details will be returned in the skipped collection in the response. If this is False then it is possible that duplicate assets will be created in the target space or project if the asset was already migrated **Parameters** .. important:: #. **meta_props**: meta data. To see available meta names use **client.v4ga_cloud_migration.ConfigurationMetaNames.get()**\n **type**: str or dict\n **Output** .. important:: **returns**: Initial state of migration\n **return type**: dict\n **Example** >>> metadata = { >>> client.v4ga_cloud_migration.MigrationMetaNames.DESCRIPTION: "Migration of assets from v3 to v4ga", >>> client.v4ga_cloud_migration.MigrationMetaNames.OLD_INSTANCE_ID: "df40cf1-252f-424b-b52d-5cdd98143aec", >>> client.v4ga_cloud_migration.MigrationMetaNames.SPACE_ID: "3fc54cf1-252f-424b-b52d-5cdd9814987f", >>> client.v4ga_cloud_migration.MigrationMetaNames.FUNCTION_IDS: ["all"], >>> client.v4ga_cloud_migration.MigrationMetaNames.MODEL_IDS: ["afaecb4-254f-689f-4548-9b4298243291"], >>> client.v4ga_cloud_migration.MigrationMetaNames.MAPPING: {"dfaecf1-252f-424b-b52d-5cdd98143481": "4fbc211-252f-424b-b52d-5cdd98df310a"} >>> client.v4ga_cloud_migration.MigrationMetaNames.SKIP_MIGRATED_ASSETS: True >>> } >>> details = client.v4ga_cloud_migration.start(meta_props=metadata) """ print(self.notification_msg) Migrationv4GACloud._validate_type(meta_props, u'meta_props', dict, True) self._validate_input(meta_props) migration_meta = self.ConfigurationMetaNames._generate_resource_metadata( meta_props, with_validation=True, client=self._client) href = self._href_definitions.v4ga_cloud_migration_href() start_response = requests.post(href, headers=self._client._get_headers(), json=migration_meta) details = self._handle_response(expected_status_code=202, operationName=u'start migration', response=start_response) print("Migration has been started. The initial state information is below. To monitor the migration " "job, you can use client.v4ga_cloud_migration.get_details api where you can provide " "the 'migration_id' and 'space_id'/'project_id' to monitor the status of migration. " "If you see 'skipped' section in the output from get_details() api, its because the assets listed " "in 'skipped' section would already be migrated. Use 'SKIP_MIGRATED_ASSETS' to False in start() " "api( by default, its True ) in case you want the assets to be re-migrated again") return details
def _validate_input(self, meta_props): if 'old_instance_id' not in meta_props: raise WMLClientError("Its mandatory to provide old instance id for migration. Provide it via meta_props " "Eg: 'client.v4ga_cloud_migration.MigrationMetaNames.OLD_INSTANCE_ID' ") if 'space_id' not in meta_props and 'project_id' not in meta_props: raise WMLClientError("Its mandatory to provide space_id or project_id for migration. Provide it " "via meta_props Eg: 'client.v4ga_cloud_migration.MigrationMetaNames.SPACE_ID' ") if 'model_ids' not in meta_props and 'function_ids' not in meta_props and\ 'experiment_ids' not in meta_props and 'pipeline_ids' not in meta_props: raise WMLClientError("Its mandatory to provide at least one of 'model_ids', 'function_ids'," " 'experiment_ids', 'pipeline_ids' ' for migration. Provide it via meta_props. Eg: " "'client.v4ga_cloud_migration.MigrationMetaNames.MODEL_IDS: ['afaecb4-254f-689f-4548-9b4298243291'] ") if 'model_ids' in meta_props and not meta_props[u'model_ids']: raise WMLClientError("MODEL_IDS is provided but empty. Provide model id(s) to be migrated or 'all' to " "migrate all models") if 'function_ids' in meta_props and not meta_props[u'function_ids']: raise WMLClientError("FUNCTION_IDS is provided but empty. Provide function id(s) to be migrated or 'all'" " to migrate all functions") if 'experiment_ids' in meta_props and not meta_props[u'experiment_ids']: raise WMLClientError("EXPERIMENT_IDS is provided but empty. Provide experiment id(s) to be migrated or " "'all' to migrate all experiments") if 'pipeline_ids' in meta_props and not meta_props[u'pipeline_ids']: raise WMLClientError("PIPELINE_IDS is provided but empty. Provide pipeline id(s) to be migrated or " "'all' to migrate all pipelines")
[docs] @docstring_parameter({'str_type': STR_TYPE_NAME}) def cancel(self, migration_id, space_id=None, project_id=None): """ Cancel a migration job. 'migration_id' and 'space_id'( or 'project_id' has to be provided ) Note: To delete a migratin job, use delete() api **Parameters** .. important:: #. **migration_id**: Migration identifier\n **type**: str\n #. **space_id**: Space identifier\n **type**: str\n #. **project_id**: Project identifier\n **type**: str\n **Output** .. important:: **returns**: status ("SUCCESS" or "FAILED")\n **return type**: str\n **Example** >>> client.v4ga_cloud_migration.cancel(migration_id='6213cf1-252f-424b-b52d-5cdd9814956c', >>> space_id='3421cf1-252f-424b-b52d-5cdd981495fe') """ print(self.notification_msg) Migrationv4GACloud._validate_type(migration_id, u'migration_id', STR_TYPE, True) if space_id is None and project_id is None: raise WMLClientError("Its mandatory to provide space_id or project_id") href = self._href_definitions.v4ga_cloud_migration_id_href(migration_id) params = {} if space_id is not None: params.update({'space_id': space_id}) else: params.update({'project_id': project_id}) cancel_response = requests.delete(href, params=params, headers=self._client._get_headers(), verify=False) details = self._handle_response(expected_status_code=204, operationName=u'cancel migration', response=cancel_response) if "SUCCESS" == details: print("Migration job cancelled")
[docs] @docstring_parameter({'str_type': STR_TYPE_NAME}) def delete(self, migration_id, space_id=None, project_id=None): """ Deletes a migration job. 'migration_id' and 'space_id'( or 'project_id' has to be provided ) **Parameters** .. important:: #. **migration_id**: Migration identifier\n **type**: str\n #. **space_id**: Space identifier\n **type**: str\n #. **project_id**: Project identifier\n **type**: str\n **Output** .. important:: **returns**: status ("SUCCESS" or "FAILED")\n **return type**: str\n **Example** >>> client.v4ga_cloud_migration.delete(migration_id='6213cf1-252f-424b-b52d-5cdd9814956c', >>> space_id='3421cf1-252f-424b-b52d-5cdd981495fe') """ print(self.notification_msg) Migrationv4GACloud._validate_type(migration_id, u'migration_id', STR_TYPE, True) if space_id is None and project_id is None: raise WMLClientError("Its mandatory to provide space_id or project_id") href = self._href_definitions.v4ga_cloud_migration_id_href(migration_id) params = {'hard_delete': True} if space_id is not None: params.update({'space_id': space_id}) else: params.update({'project_id': project_id}) delete_response = requests.delete(href, params=params, headers=self._client._get_headers(), verify=False) details = self._handle_response(expected_status_code=204, operationName=u'delete migration', response=delete_response) if "SUCCESS" == details: print("Migration job deleted")
[docs] @docstring_parameter({'str_type': STR_TYPE_NAME}) def get_details(self, migration_id=None, space_id=None, project_id=None, limit=None): """ Get metadata of of the migration job function(s). If no migration_id is specified all migration jobs metadata is returned. **Parameters** .. important:: #. **migration_id**: Migration identifier\n **type**: str\n #. **space_id**: Space identifier\n **type**: str\n #. **project_id**: Project identifier\n **type**: str\n #. **limit**: limit number of fetched records (optional)\n **type**: int\n **Output** .. important:: **returns**: migration(s) metadata\n **return type**: dict\n dict (if migration_id is not None) or {"resources": [dict]} (if migration_id is None)\n **Example** >>> migration_details = client.v4ga_cloud_migration.get_details(migration_id='6213cf1-252f-424b-b52d-5cdd9814956c', >>> space_id='3421cf1-252f-424b-b52d-5cdd981495fe') """ if self.skip_msg is False: print(self.notification_msg) Migrationv4GACloud._validate_type(migration_id, u'migration_id', STR_TYPE, False) query_params = {} if space_id is None and project_id is None: raise WMLClientError("Its mandatory to provide space_id or project_id") if space_id is not None: query_params.update({'space_id': space_id}) else: query_params.update({'project_id': project_id}) href = self._href_definitions.v4ga_cloud_migration_href() return self._get_artifact_details(href, migration_id, limit, 'migration', query_params=query_params)
[docs] def list(self, space_id=None, project_id=None, limit=None): """ List the migration jobs. If limit is set to None there will be only first 50 records shown. **Parameters** .. important:: #. **limit**: limit number of fetched records\n **type**: int\n **Output** .. important:: This method only prints the list of all migration jobs in a table format.\n **return type**: None\n **Example** >>> client.v4ga_cloud_migration.list() """ print(self.notification_msg) if space_id is None and project_id is None: raise WMLClientError("Its mandatory to provide space_id or project_id") self.skip_msg = True migration_resources = self.get_details(space_id=space_id, project_id=project_id, limit=limit)[u'resources'] self.skip_msg = False if space_id is not None: migration_values = [(m[u'migration_id'], m[u'status'], m[u'space_id']) for m in migration_resources] self._list(migration_values, [u'ID', u'STATUS', u'SPACE_ID'], limit, _DEFAULT_LIST_LENGTH) else: migration_values = [(m[u'migration_id'], m[u'status'], m[u'project_id']) for m in migration_resources] self._list(migration_values, [u'MIGRATION_ID', u'STATUS', u'PROJECT_ID'], limit, _DEFAULT_LIST_LENGTH)