azure_cognitiveservices_face 0.17.1 → 0.18.0

data/lib/1.0/generated/azure_cognitiveservices_face/models/name_and_user_data_contract.rb

@@ -7,7 +7,7 @@ module Azure::CognitiveServices::Face::V1_0
   module Models
     #
     # A combination of user defined name and user specified data for the
-    # person, personGroup, and faceList
+    # person, largePersonGroup/personGroup, and largeFaceList/faceList.
     #
     class NameAndUserDataContract
 

data/lib/1.0/generated/azure_cognitiveservices_face/models/operation_status.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Operation status object. Operation refers to the asynchronous backend
+    # task including taking a snapshot and applying a snapshot.
+    #
+    class OperationStatus
+
+      include MsRestAzure
+
+      # @return [OperationStatusType] Operation status: notstarted, running,
+      # succeeded, failed. If the operation is requested and waiting to
+      # perform, the status is notstarted. If the operation is ongoing in
+      # backend, the status is running. Status succeeded means the operation is
+      # completed successfully, specifically for snapshot taking operation, it
+      # illustrates the snapshot is well taken and ready to apply, and for
+      # snapshot applying operation, it presents the target object has finished
+      # creating by the snapshot and ready to be used. Status failed is often
+      # caused by editing the source object while taking the snapshot or
+      # editing the target object while applying the snapshot before
+      # completion, see the field "message" to check the failure reason.
+      # Possible values include: 'notstarted', 'running', 'succeeded', 'failed'
+      attr_accessor :status
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # the time when the operation (take or apply a snapshot) is requested.
+      # E.g. 2018-12-25T11:41:02.2331413Z.
+      attr_accessor :created_time
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # the last time the operation (take or apply a snapshot) is actively
+      # migrating data. The lastActionTime will keep increasing until the
+      # operation finishes. E.g. 2018-12-25T11:51:27.8705696Z.
+      attr_accessor :last_action_time
+
+      # @return [String] When the operation succeeds successfully, for snapshot
+      # taking operation the snapshot id will be included in this field, and
+      # for snapshot applying operation, the path to get the target object will
+      # be returned in this field.
+      attr_accessor :resource_location
+
+      # @return [String] Show failure message when operation fails (omitted
+      # when operation succeeds).
+      attr_accessor :message
+
+
+      #
+      # Mapper for OperationStatus class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'OperationStatus',
+          type: {
+            name: 'Composite',
+            class_name: 'OperationStatus',
+            model_properties: {
+              status: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'status',
+                type: {
+                  name: 'Enum',
+                  module: 'OperationStatusType'
+                }
+              },
+              created_time: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'createdTime',
+                type: {
+                  name: 'DateTime'
+                }
+              },
+              last_action_time: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'lastActionTime',
+                type: {
+                  name: 'DateTime'
+                }
+              },
+              resource_location: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'resourceLocation',
+                type: {
+                  name: 'String'
+                }
+              },
+              message: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'message',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/operation_status_type.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Defines values for OperationStatusType
+    #
+    module OperationStatusType
+      Notstarted = "notstarted"
+      Running = "running"
+      Succeeded = "succeeded"
+      Failed = "failed"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/person_group.rb

@@ -8,11 +8,11 @@ module Azure::CognitiveServices::Face::V1_0
     #
     # Person group object.
     #
-    class PersonGroup < NameAndUserDataContract
+    class PersonGroup < MetaDataContract
 
       include MsRestAzure
 
-      # @return [String] PersonGroupId of the existing person groups.
+      # @return [String] PersonGroupId of the target person group.
       attr_accessor :person_group_id
 
 
@@ -51,6 +51,15 @@ module Azure::CognitiveServices::Face::V1_0
                   name: 'String'
                 }
               },
+              recognition_model: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'recognitionModel',
+                default_value: 'recognition_01',
+                type: {
+                  name: 'String'
+                }
+              },
               person_group_id: {
                 client_side_validation: true,
                 required: true,

data/lib/1.0/generated/azure_cognitiveservices_face/models/recognition_model.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Defines values for RecognitionModel
+    #
+    module RecognitionModel
+      Recognition01 = "recognition_01"
+      Recognition02 = "recognition_02"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/snapshot.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Snapshot object.
+    #
+    class Snapshot
+
+      include MsRestAzure
+
+      # @return Snapshot id.
+      attr_accessor :id
+
+      # @return [String] Azure Cognitive Service Face account id of the
+      # subscriber who created the snapshot by Snapshot - Take.
+      attr_accessor :account
+
+      # @return [SnapshotObjectType] Type of the source object in the snapshot,
+      # specified by the subscriber who created the snapshot when calling
+      # Snapshot - Take. Currently FaceList, PersonGroup, LargeFaceList and
+      # LargePersonGroup are supported. Possible values include: 'FaceList',
+      # 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
+      attr_accessor :type
+
+      # @return Array of the target Face subscription ids for the snapshot,
+      # specified by the user who created the snapshot when calling Snapshot -
+      # Take. For each snapshot, only subscriptions included in the applyScope
+      # of Snapshot - Take can apply it.
+      attr_accessor :apply_scope
+
+      # @return [String] User specified data about the snapshot for any
+      # purpose. Length should not exceed 16KB.
+      attr_accessor :user_data
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # the created time of the snapshot. E.g. 2018-12-25T11:41:02.2331413Z.
+      attr_accessor :created_time
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # the last time when the snapshot was created or updated by Snapshot -
+      # Update. E.g. 2018-12-25T11:51:27.8705696Z.
+      attr_accessor :last_update_time
+
+
+      #
+      # Mapper for Snapshot class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Snapshot',
+          type: {
+            name: 'Composite',
+            class_name: 'Snapshot',
+            model_properties: {
+              id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'id',
+                type: {
+                  name: 'String'
+                }
+              },
+              account: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'account',
+                type: {
+                  name: 'String'
+                }
+              },
+              type: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'type',
+                type: {
+                  name: 'Enum',
+                  module: 'SnapshotObjectType'
+                }
+              },
+              apply_scope: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'applyScope',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'UuidElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              },
+              user_data: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'userData',
+                constraints: {
+                  MaxLength: 16384
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              created_time: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'createdTime',
+                type: {
+                  name: 'DateTime'
+                }
+              },
+              last_update_time: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'lastUpdateTime',
+                type: {
+                  name: 'DateTime'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/snapshot_apply_mode.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Defines values for SnapshotApplyMode
+    #
+    module SnapshotApplyMode
+      CreateNew = "CreateNew"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/snapshot_object_type.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Defines values for SnapshotObjectType
+    #
+    module SnapshotObjectType
+      FaceList = "FaceList"
+      LargeFaceList = "LargeFaceList"
+      LargePersonGroup = "LargePersonGroup"
+      PersonGroup = "PersonGroup"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/take_snapshot_request.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Request body for taking snapshot operation.
+    #
+    class TakeSnapshotRequest
+
+      include MsRestAzure
+
+      # @return [SnapshotObjectType] User specified type for the source object
+      # to take snapshot from. Currently FaceList, PersonGroup, LargeFaceList
+      # and LargePersonGroup are supported. Possible values include:
+      # 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
+      attr_accessor :type
+
+      # @return [String] User specified source object id to take snapshot from.
+      attr_accessor :object_id
+
+      # @return User specified array of target Face subscription ids for the
+      # snapshot. For each snapshot, only subscriptions included in the
+      # applyScope of Snapshot - Take can apply it.
+      attr_accessor :apply_scope
+
+      # @return [String] User specified data about the snapshot for any
+      # purpose. Length should not exceed 16KB.
+      attr_accessor :user_data
+
+
+      #
+      # Mapper for TakeSnapshotRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'TakeSnapshotRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'TakeSnapshotRequest',
+            model_properties: {
+              type: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'type',
+                type: {
+                  name: 'Enum',
+                  module: 'SnapshotObjectType'
+                }
+              },
+              object_id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'objectId',
+                constraints: {
+                  MaxLength: 64,
+                  Pattern: '^[a-z0-9-_]+$'
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              apply_scope: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'applyScope',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'UuidElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              },
+              user_data: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'userData',
+                constraints: {
+                  MaxLength: 16384
+                },
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end