Package com.azure.analytics.purview.datamap

Class RelationshipClient

java.lang.Object
com.azure.analytics.purview.datamap.RelationshipClient
public final class RelationshipClient extends Object
Initializes a new instance of the synchronous DataMapClient type.

  • Method Details

    • createWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
      Create a new relationship between entities.

      Request Body Schema

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

      Response Body Schema

       
 {
     attributes (Optional): {
         String: BinaryData (Required)
     }
     typeName: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     end1 (Optional): {
         guid: String (Optional)
         typeName: String (Optional)
         uniqueAttributes (Optional): {
             String: BinaryData (Required)
         }
     }
     end2 (Optional): (recursive schema, see end2 above)
     guid: String (Optional)
     homeId: String (Optional)
     label: String (Optional)
     provenanceType: Integer (Optional)
     status: String(ACTIVE/DELETED) (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     version: Long (Optional)
 }
      Parameters:
      body - Body parameter.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      atlas relationship instance along with Response.
      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 com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> updateWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
      Update an existing relationship between entities.

      Request Body Schema

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

      Response Body Schema

       
 {
     attributes (Optional): {
         String: BinaryData (Required)
     }
     typeName: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     end1 (Optional): {
         guid: String (Optional)
         typeName: String (Optional)
         uniqueAttributes (Optional): {
             String: BinaryData (Required)
         }
     }
     end2 (Optional): (recursive schema, see end2 above)
     guid: String (Optional)
     homeId: String (Optional)
     label: String (Optional)
     provenanceType: Integer (Optional)
     status: String(ACTIVE/DELETED) (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     version: Long (Optional)
 }
      Parameters:
      body - Body parameter.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      atlas relationship instance along with Response.
      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 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
      NameTypeRequiredDescription
      extendedInfoBooleanNoLimits whether includes extended information.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     referredEntities (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             classificationNames (Optional): [
                 String (Optional)
             ]
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             displayText: String (Optional)
             guid: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meaningNames (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             status: String(ACTIVE/DELETED) (Optional)
         }
     }
     relationship (Optional): {
         attributes (Optional): {
             String: BinaryData (Required)
         }
         typeName: String (Optional)
         lastModifiedTS: String (Optional)
         createTime: Long (Optional)
         createdBy: String (Optional)
         end1 (Optional): {
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
         }
         end2 (Optional): (recursive schema, see end2 above)
         guid: String (Optional)
         homeId: String (Optional)
         label: String (Optional)
         provenanceType: Integer (Optional)
         status: String(ACTIVE/DELETED) (Optional)
         updateTime: Long (Optional)
         updatedBy: String (Optional)
         version: Long (Optional)
     }
 }
      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:
      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 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.
      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.

    • create

      public AtlasRelationship create(AtlasRelationship body)
      Create a new relationship between entities.
      Parameters:
      body - Body parameter.
      Returns:
      atlas relationship instance.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      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.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • update

      public AtlasRelationship update(AtlasRelationship body)
      Update an existing relationship between entities.
      Parameters:
      body - Body parameter.
      Returns:
      atlas relationship instance.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      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.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      public AtlasRelationshipWithExtInfo get(String guid, Boolean extendedInfo)
      Get relationship information between entities by its GUID.
      Parameters:
      guid - The globally unique identifier of the relationship.
      extendedInfo - Limits whether includes extended information.
      Returns:
      relationship information between entities by its GUID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      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.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      public AtlasRelationshipWithExtInfo get(String guid)
      Get relationship information between entities by its GUID.
      Parameters:
      guid - The globally unique identifier of the relationship.
      Returns:
      relationship information between entities by its GUID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      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.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      public void delete(String guid)
      Delete a relationship between entities by its GUID.
      Parameters:
      guid - The globally unique identifier of the relationship.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      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.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.