Class AssetOwner

    • Constructor Summary

      Constructors 
      Constructor Description
      AssetOwner​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      AssetOwner​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      AssetOwner​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      AssetOwner​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AssetOwnerRESTClient restClient, int maxPageSize, AuditLog auditLog)
      Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
      AssetOwner​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addAssetOrigin​(java.lang.String userId, java.lang.String assetGUID, java.lang.String organizationGUID, java.lang.String businessCapabilityGUID, java.util.Map<java.lang.String,​java.lang.String> otherOriginValues)
      Add the asset origin classification to an asset.
      java.lang.String addAssetToCatalog​(java.lang.String userId, java.lang.String typeName, java.lang.String qualifiedName, java.lang.String displayName, java.lang.String description, java.util.Map<java.lang.String,​java.lang.String> additionalProperties, java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
      Add a simple asset description to the catalog.
      java.lang.String addAssetToCatalog​(java.lang.String userId, AssetProperties assetProperties)
      Add a comprehensive asset description to the catalog.
      java.lang.String addAssetToCatalogUsingTemplate​(java.lang.String userId, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent an asset using an existing asset as a template.
      java.lang.String addCombinedSchemaToAsset​(java.lang.String userId, java.lang.String assetGUID, SchemaTypeProperties schemaType, java.util.List<SchemaAttributeProperties> schemaAttributes)
      Stores the supplied schema details in the catalog and attaches it to the asset.
      void addConnectionToAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String assetSummary, Connection connection)
      Deprecated.
      java.lang.String addSchemaAttribute​(java.lang.String serverName, java.lang.String userId, java.lang.String assetGUID, java.lang.String parentGUID, SchemaAttributeProperties schemaAttribute)
      Adds a schema attribute to a complex schema type like a relational table, avro schema or a structured document.
      void addSchemaAttributes​(java.lang.String serverName, java.lang.String userId, java.lang.String assetGUID, java.lang.String parentGUID, java.util.List<SchemaAttributeProperties> schemaAttributes)
      Adds attributes to a complex schema type like a relational table, avro schema or a structured document.
      java.lang.String addSchemaTypeToAsset​(java.lang.String userId, java.lang.String assetGUID, SchemaTypeProperties schemaType)
      Stores the supplied schema type in the catalog and attaches it to the asset.
      void addSecurityTags​(java.lang.String userId, java.lang.String assetGUID, java.lang.String assetElementGUID, java.util.List<java.lang.String> securityLabels, java.util.Map<java.lang.String,​java.lang.Object> securityProperties)
      Add or replace the security tags for an asset or one of its elements.
      void addSemanticAssignment​(java.lang.String userId, java.lang.String assetGUID, java.lang.String glossaryTermGUID, java.lang.String assetElementGUID)
      Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).
      void addTemplateClassification​(java.lang.String userId, java.lang.String assetGUID, java.lang.String name, java.lang.String description, java.util.Map<java.lang.String,​java.lang.String> additionalProperties)
      Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.
      void attachSchemaTypeToAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String schemaTypeGUID)
      Links the supplied schema type directly to the asset.
      void clearAssetConnection​(java.lang.String userId, java.lang.String assetGUID, java.lang.String connectionGUID)
      Remove a relationship between an asset and its connection.
      void clearConnectorType​(java.lang.String userId, java.lang.String connectionGUID, java.lang.String connectorTypeGUID)
      Remove a relationship between a connection and a connector type.
      void clearEmbeddedConnection​(java.lang.String userId, java.lang.String connectionGUID, java.lang.String embeddedConnectionGUID)
      Remove a relationship between a virtual connection and an embedded connection.
      void clearEndpoint​(java.lang.String userId, java.lang.String connectionGUID, java.lang.String endpointGUID)
      Remove a relationship between a connection and an endpoint.
      java.lang.String createConnection​(java.lang.String userId, ConnectionProperties connectionProperties)
      Create a new metadata element to represent a connection.
      java.lang.String createConnectionFromTemplate​(java.lang.String userId, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a connection using an existing metadata element as a template.
      java.lang.String createEndpoint​(java.lang.String userId, EndpointProperties endpointProperties)
      Create a new metadata element to represent an endpoint.
      java.lang.String createEndpointFromTemplate​(java.lang.String userId, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent an endpoint using an existing metadata element as a template.
      void deleteAsset​(java.lang.String userId, java.lang.String assetGUID)
      Deletes an asset and all of its associated elements such as schema, connections (unless they are linked to another asset), discovery reports and associated feedback.
      void deleteAssetSchemaType​(java.lang.String userId, java.lang.String assetGUID)
      Detaches and deletes an asset's schema.
      java.lang.String detachSchemaTypeFromAsset​(java.lang.String userId, java.lang.String assetGUID)
      Unlinks the schema from the asset but does not delete it.
      java.util.List<AssetElement> findAssets​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Return a list of assets with the requested search string in their name, qualified name or description.
      java.util.List<ConnectionElement> findConnections​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of connection metadata elements that contain the search string.
      java.util.List<ConnectorTypeElement> findConnectorTypes​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of connectorType metadata elements that contain the search string.
      java.util.List<EndpointElement> findEndpoints​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements that contain the search string.
      AssetUniverse getAssetProperties​(java.lang.String userId, java.lang.String assetGUID)
      Returns a comprehensive collection of properties about the requested asset.
      java.util.List<AssetElement> getAssetsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Return a list of assets with the requested name.
      AssetElement getAssetSummary​(java.lang.String userId, java.lang.String assetGUID)
      Return the basic attributes of an asset.
      ConnectionElement getConnectionByGUID​(java.lang.String userId, java.lang.String connectionGUID)
      Retrieve the connection metadata element with the supplied unique identifier.
      java.util.List<ConnectionElement> getConnectionsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of connection metadata elements with a matching qualified or display name.
      Connector getConnectorToAsset​(java.lang.String userId, java.lang.String assetGUID)
      Return a connector for the asset to enable the calling user to access the content.
      ConnectorTypeElement getConnectorTypeByGUID​(java.lang.String userId, java.lang.String connectorTypeGUID)
      Retrieve the connectorType metadata element with the supplied unique identifier.
      java.util.List<ConnectorTypeElement> getConnectorTypesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of connectorType metadata elements with a matching qualified or display name.
      java.util.List<DiscoveryAnalysisReport> getDiscoveryAnalysisReports​(java.lang.String userId, java.lang.String assetGUID, int startingFrom, int maximumResults)
      Return the discovery analysis reports about the asset.
      java.util.List<Annotation> getDiscoveryReportAnnotations​(java.lang.String userId, java.lang.String discoveryReportGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults)
      Return the annotations linked directly to the report.
      EndpointElement getEndpointByGUID​(java.lang.String userId, java.lang.String endpointGUID)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      java.util.List<EndpointElement> getEndpointsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements with a matching qualified or display name.
      java.util.List<Annotation> getExtendedAnnotations​(java.lang.String userId, java.lang.String annotationGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults)
      Return any annotations attached to this annotation.
      java.util.List<java.lang.String> getTypesOfAnnotation​(java.lang.String userId)
      Return the annotation subtype names.
      java.util.Map<java.lang.String,​java.lang.String> getTypesOfAnnotationWithDescriptions​(java.lang.String userId)
      Return the annotation subtype names mapped to their descriptions.
      java.util.List<java.lang.String> getTypesOfAsset​(java.lang.String userId)
      Return the asset subtype names.
      java.util.Map<java.lang.String,​java.lang.String> getTypesOfAssetWithDescriptions​(java.lang.String userId)
      Return the asset subtype names.
      void publishAsset​(java.lang.String userId, java.lang.String assetGUID)
      Update the zones for a specific asset to the zone list specified in the publishZones.
      void removeAssetOrigin​(java.lang.String userId, java.lang.String assetGUID)
      Remove the asset origin classification to an asset.
      void removeConnection​(java.lang.String userId, java.lang.String connectionGUID)
      Remove the metadata element representing a connection.
      void removeEndpoint​(java.lang.String userId, java.lang.String endpointGUID)
      Remove the metadata element representing a endpoint.
      void removeSecurityTags​(java.lang.String userId, java.lang.String assetGUID, java.lang.String assetElementGUID)
      Remove the security tags classification to an asset or one of its elements.
      void removeSemanticAssignment​(java.lang.String userId, java.lang.String assetGUID, java.lang.String glossaryTermGUID, java.lang.String assetElementGUID)
      Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
      void removeTemplateClassification​(java.lang.String userId, java.lang.String assetGUID)
      Remove the classification that indicates that this asset can be used as a template.
      java.util.List<ConnectionElement> scanConnections​(java.lang.String userId, int startFrom, int pageSize)
      Step through the connections visible to this caller.
      void setupAssetConnection​(java.lang.String userId, java.lang.String assetGUID, java.lang.String assetSummary, java.lang.String connectionGUID)
      Create a relationship between an asset and its connection.
      void setupConnectorType​(java.lang.String userId, java.lang.String connectionGUID, java.lang.String connectorTypeGUID)
      Create a relationship between a connection and a connector type.
      void setupEmbeddedConnection​(java.lang.String userId, java.lang.String connectionGUID, int position, java.lang.String displayName, java.util.Map<java.lang.String,​java.lang.Object> arguments, java.lang.String embeddedConnectionGUID)
      Create a relationship between a virtual connection and an embedded connection.
      void setupEndpoint​(java.lang.String userId, java.lang.String connectionGUID, java.lang.String endpointGUID)
      Create a relationship between a connection and an endpoint.
      void updateAssetOwner​(java.lang.String userId, java.lang.String assetGUID, java.lang.String ownerId, java.lang.String ownerTypeName, java.lang.String ownerPropertyName)
      Update the owner information for a specific asset.
      void updateAssetOwner​(java.lang.String userId, java.lang.String assetGUID, java.lang.String ownerId, OwnerType ownerType)
      Deprecated.
      void updateAssetZones​(java.lang.String userId, java.lang.String assetGUID, java.util.List<java.lang.String> assetZones)
      Update the zones for a specific asset.
      void updateConnection​(java.lang.String userId, java.lang.String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)
      Update the metadata element representing a connection.
      void updateEndpoint​(java.lang.String userId, boolean isMergeUpdate, java.lang.String endpointGUID, EndpointProperties endpointProperties)
      Update the metadata element representing a endpoint.
      void withdrawAsset​(java.lang.String userId, java.lang.String assetGUID)
      Update the zones for a specific asset to the zone list specified in the defaultZones.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait