com.azure.analytics.purview.catalog.RelationshipClient

public final class RelationshipClient extends Object

Initializes a new instance of the synchronous PurviewCatalogClient type.

Method Summary

Modifier and Type

Method

Description

Response<BinaryData>

createWithResponse(BinaryData relationship, RequestOptions requestOptions)

Create a new relationship between entities.

Response<Void>

deleteWithResponse(String guid, RequestOptions requestOptions)

Delete a relationship between entities by its GUID.

Response<BinaryData>

getWithResponse(String guid, RequestOptions requestOptions)

Get relationship information between entities by its GUID.

Response<BinaryData>

updateWithResponse(BinaryData relationship, RequestOptions requestOptions)

Update an existing relationship between entities.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createWithResponse

public Response<BinaryData> createWithResponse(BinaryData relationship, RequestOptions requestOptions)

Create a new relationship between entities.

Request Body Schema


 {
     attributes: {
         String: Object
     }
     typeName: String
     lastModifiedTS: String
     createTime: Float
     createdBy: String
     end1: {
         guid: String
         typeName: String
         uniqueAttributes: {
             String: Object
         }
     }
     end2: (recursive schema, see end2 above)
     guid: String
     homeId: String
     label: String
     provenanceType: Float
     status: String(ACTIVE/DELETED)
     updateTime: Float
     updatedBy: String
     version: Float
 }

Response Body Schema


 {
     attributes: {
         String: Object
     }
     typeName: String
     lastModifiedTS: String
     createTime: Float
     createdBy: String
     end1: {
         guid: String
         typeName: String
         uniqueAttributes: {
             String: Object
         }
     }
     end2: (recursive schema, see end2 above)
     guid: String
     homeId: String
     label: String
     provenanceType: Float
     status: String(ACTIVE/DELETED)
     updateTime: Float
     updatedBy: String
     version: Float
 }

Parameters:: relationship - The AtlasRelationship object containing the information for the relationship to be created.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: atlasRelationship along with Response.
Throws:: HttpResponseException - thrown if the request is rejected by server.; ClientAuthenticationException - thrown if the request is rejected by server on status code 401.; ResourceNotFoundException - thrown if the request is rejected by server on status code 404.; ResourceModifiedException - thrown if the request is rejected by server on status code 409.

updateWithResponse

public Response<BinaryData> updateWithResponse(BinaryData relationship, RequestOptions requestOptions)

Update an existing relationship between entities.

Request Body Schema


 {
     attributes: {
         String: Object
     }
     typeName: String
     lastModifiedTS: String
     createTime: Float
     createdBy: String
     end1: {
         guid: String
         typeName: String
         uniqueAttributes: {
             String: Object
         }
     }
     end2: (recursive schema, see end2 above)
     guid: String
     homeId: String
     label: String
     provenanceType: Float
     status: String(ACTIVE/DELETED)
     updateTime: Float
     updatedBy: String
     version: Float
 }

Response Body Schema


 {
     attributes: {
         String: Object
     }
     typeName: String
     lastModifiedTS: String
     createTime: Float
     createdBy: String
     end1: {
         guid: String
         typeName: String
         uniqueAttributes: {
             String: Object
         }
     }
     end2: (recursive schema, see end2 above)
     guid: String
     homeId: String
     label: String
     provenanceType: Float
     status: String(ACTIVE/DELETED)
     updateTime: Float
     updatedBy: String
     version: Float
 }

Parameters:: relationship - The AtlasRelationship object containing the information for the relationship to be created.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: atlasRelationship along with Response.
Throws:: HttpResponseException - thrown if the request is rejected by server.; ClientAuthenticationException - thrown if the request is rejected by server on status code 401.; ResourceNotFoundException - thrown if the request is rejected by server on status code 404.; ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getWithResponse

public Response<BinaryData> getWithResponse(String guid, RequestOptions requestOptions)

Get relationship information between entities by its GUID.

Query Parameters

Query Parameters
Name	Type	Required	Description
extendedInfo	Boolean	No	Limits whether includes extended information.

Response Body Schema


 {
     referredEntities: {
         String: {
             attributes: {
                 String: Object
             }
             typeName: String
             lastModifiedTS: String
             classificationNames: [
                 String
             ]
             classifications: [
                 {
                     attributes: {
                         String: Object
                     }
                     typeName: String
                     lastModifiedTS: String
                     entityGuid: String
                     entityStatus: String(ACTIVE/DELETED)
                     removePropagationsOnEntityDelete: Boolean
                     validityPeriods: [
                         {
                             endTime: String
                             startTime: String
                             timeZone: String
                         }
                     ]
                     source: String
                     sourceDetails: {
                         String: Object
                     }
                 }
             ]
             displayText: String
             guid: String
             isIncomplete: Boolean
             labels: [
                 String
             ]
             meaningNames: [
                 String
             ]
             meanings: [
                 {
                     confidence: Integer
                     createdBy: String
                     description: String
                     displayText: String
                     expression: String
                     relationGuid: String
                     source: String
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)
                     steward: String
                     termGuid: String
                 }
             ]
             status: String(ACTIVE/DELETED)
         }
     }
     relationship: {
         attributes: {
             String: Object
         }
         typeName: String
         lastModifiedTS: String
         createTime: Float
         createdBy: String
         end1: {
             guid: String
             typeName: String
             uniqueAttributes: {
                 String: Object
             }
         }
         end2: (recursive schema, see end2 above)
         guid: String
         homeId: String
         label: String
         provenanceType: Float
         status: String(ACTIVE/DELETED)
         updateTime: Float
         updatedBy: String
         version: Float
     }
 }

Parameters:: guid - The globally unique identifier of the relationship.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: relationship information between entities by its GUID along with Response.
Throws:: HttpResponseException - thrown if the request is rejected by server.; ClientAuthenticationException - thrown if the request is rejected by server on status code 401.; ResourceNotFoundException - thrown if the request is rejected by server on status code 404.; ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteWithResponse

public Response<Void> deleteWithResponse(String guid, RequestOptions requestOptions)

Delete a relationship between entities by its GUID.

Parameters:

guid - The globally unique identifier of the relationship.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

Class RelationshipClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

createWithResponse

updateWithResponse

getWithResponse

deleteWithResponse