Class RelationshipAsyncClient
java.lang.Object
com.azure.analytics.purview.catalog.RelationshipAsyncClient
Initializes a new instance of the asynchronous PurviewCatalogClient type.
-
Method Summary
Modifier and TypeMethodDescriptionMono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
createWithResponse
(com.azure.core.util.BinaryData relationship, com.azure.core.http.rest.RequestOptions requestOptions) Create a new relationship between entities.deleteWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Delete a relationship between entities by its GUID.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get relationship information between entities by its GUID.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
updateWithResponse
(com.azure.core.util.BinaryData relationship, com.azure.core.http.rest.RequestOptions requestOptions) Update an existing relationship between entities.
-
Method Details
-
createWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> createWithResponse(com.azure.core.util.BinaryData relationship, com.azure.core.http.rest.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
on successful completion ofMono
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
updateWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> updateWithResponse(com.azure.core.util.BinaryData relationship, com.azure.core.http.rest.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
on successful completion ofMono
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
getWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getWithResponse(String guid, com.azure.core.http.rest.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
on successful completion ofMono
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
deleteWithResponse
public Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponse(String guid, com.azure.core.http.rest.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
on successful completion ofMono
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-