azure-docs-sdk-java/legacy/docs-ref-autogen/com.azure.analytics.purview.catalog.RelationshipClient.yml

### YamlMime:JavaType
uid: "com.azure.analytics.purview.catalog.RelationshipClient"
fullName: "com.azure.analytics.purview.catalog.RelationshipClient"
name: "RelationshipClient"
nameWithType: "RelationshipClient"
summary: "Initializes a new instance of the synchronous Purview<wbr>Catalog<wbr>Client type."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **RelationshipClient**"
methods:
- uid: "com.azure.analytics.purview.catalog.RelationshipClient.createWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
  fullName: "com.azure.analytics.purview.catalog.RelationshipClient.createWithResponse(BinaryData relationship, RequestOptions requestOptions)"
  name: "createWithResponse(BinaryData relationship, RequestOptions requestOptions)"
  nameWithType: "RelationshipClient.createWithResponse(BinaryData relationship, RequestOptions requestOptions)"
  summary: "Create a new relationship between entities."
  parameters:
  - description: "The AtlasRelationship object containing the information for the relationship to be created."
    name: "relationship"
    type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
  - description: "The options to configure the HTTP request before HTTP client sends it."
    name: "requestOptions"
    type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Response<BinaryData> createWithResponse(BinaryData relationship, RequestOptions requestOptions)"
  desc: "Create a new relationship between entities.\n\n**Request Body Schema**\n\n```java\n{\n     attributes: {\n         String: Object\n     }\n     typeName: String\n     lastModifiedTS: String\n     createTime: Float\n     createdBy: String\n     end1: {\n         guid: String\n         typeName: String\n         uniqueAttributes: {\n             String: Object\n         }\n     }\n     end2: (recursive schema, see end2 above)\n     guid: String\n     homeId: String\n     label: String\n     provenanceType: Float\n     status: String(ACTIVE/DELETED)\n     updateTime: Float\n     updatedBy: String\n     version: Float\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n     attributes: {\n         String: Object\n     }\n     typeName: String\n     lastModifiedTS: String\n     createTime: Float\n     createdBy: String\n     end1: {\n         guid: String\n         typeName: String\n         uniqueAttributes: {\n             String: Object\n         }\n     }\n     end2: (recursive schema, see end2 above)\n     guid: String\n     homeId: String\n     label: String\n     provenanceType: Float\n     status: String(ACTIVE/DELETED)\n     updateTime: Float\n     updatedBy: String\n     version: Float\n }\n```"
  returns:
    description: "atlasRelationship along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.analytics.purview.catalog.RelationshipClient.deleteWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
  fullName: "com.azure.analytics.purview.catalog.RelationshipClient.deleteWithResponse(String guid, RequestOptions requestOptions)"
  name: "deleteWithResponse(String guid, RequestOptions requestOptions)"
  nameWithType: "RelationshipClient.deleteWithResponse(String guid, RequestOptions requestOptions)"
  summary: "Delete a relationship between entities by its GUID."
  parameters:
  - description: "The globally unique identifier of the relationship."
    name: "guid"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The options to configure the HTTP request before HTTP client sends it."
    name: "requestOptions"
    type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Response<Void> deleteWithResponse(String guid, RequestOptions requestOptions)"
  desc: "Delete a relationship between entities by its GUID."
  returns:
    description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.analytics.purview.catalog.RelationshipClient.getWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
  fullName: "com.azure.analytics.purview.catalog.RelationshipClient.getWithResponse(String guid, RequestOptions requestOptions)"
  name: "getWithResponse(String guid, RequestOptions requestOptions)"
  nameWithType: "RelationshipClient.getWithResponse(String guid, RequestOptions requestOptions)"
  summary: "Get relationship information between entities by its GUID."
  parameters:
  - description: "The globally unique identifier of the relationship."
    name: "guid"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The options to configure the HTTP request before HTTP client sends it."
    name: "requestOptions"
    type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Response<BinaryData> getWithResponse(String guid, RequestOptions requestOptions)"
  desc: "Get relationship information between entities by its GUID.\n\n**Query Parameters**\n\n    | ------------ | ------- | -------- | --------------------------------------------- |\n    | Name         | Type    | Required | Description                                   |\n    | extendedInfo | Boolean | No       | Limits whether includes extended information. |\n\n**Response Body Schema**\n\n```java\n{\n     referredEntities: {\n         String: {\n             attributes: {\n                 String: Object\n             }\n             typeName: String\n             lastModifiedTS: String\n             classificationNames: [\n                 String\n             ]\n             classifications: [\n                 {\n                     attributes: {\n                         String: Object\n                     }\n                     typeName: String\n                     lastModifiedTS: String\n                     entityGuid: String\n                     entityStatus: String(ACTIVE/DELETED)\n                     removePropagationsOnEntityDelete: Boolean\n                     validityPeriods: [\n                         {\n                             endTime: String\n                             startTime: String\n                             timeZone: String\n                         }\n                     ]\n                     source: String\n                     sourceDetails: {\n                         String: Object\n                     }\n                 }\n             ]\n             displayText: String\n             guid: String\n             isIncomplete: Boolean\n             labels: [\n                 String\n             ]\n             meaningNames: [\n                 String\n             ]\n             meanings: [\n                 {\n                     confidence: Integer\n                     createdBy: String\n                     description: String\n                     displayText: String\n                     expression: String\n                     relationGuid: String\n                     source: String\n                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n                     steward: String\n                     termGuid: String\n                 }\n             ]\n             status: String(ACTIVE/DELETED)\n         }\n     }\n     relationship: {\n         attributes: {\n             String: Object\n         }\n         typeName: String\n         lastModifiedTS: String\n         createTime: Float\n         createdBy: String\n         end1: {\n             guid: String\n             typeName: String\n             uniqueAttributes: {\n                 String: Object\n             }\n         }\n         end2: (recursive schema, see end2 above)\n         guid: String\n         homeId: String\n         label: String\n         provenanceType: Float\n         status: String(ACTIVE/DELETED)\n         updateTime: Float\n         updatedBy: String\n         version: Float\n     }\n }\n```"
  returns:
    description: "relationship information between entities by its GUID along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.analytics.purview.catalog.RelationshipClient.updateWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
  fullName: "com.azure.analytics.purview.catalog.RelationshipClient.updateWithResponse(BinaryData relationship, RequestOptions requestOptions)"
  name: "updateWithResponse(BinaryData relationship, RequestOptions requestOptions)"
  nameWithType: "RelationshipClient.updateWithResponse(BinaryData relationship, RequestOptions requestOptions)"
  summary: "Update an existing relationship between entities."
  parameters:
  - description: "The AtlasRelationship object containing the information for the relationship to be created."
    name: "relationship"
    type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
  - description: "The options to configure the HTTP request before HTTP client sends it."
    name: "requestOptions"
    type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Response<BinaryData> updateWithResponse(BinaryData relationship, RequestOptions requestOptions)"
  desc: "Update an existing relationship between entities.\n\n**Request Body Schema**\n\n```java\n{\n     attributes: {\n         String: Object\n     }\n     typeName: String\n     lastModifiedTS: String\n     createTime: Float\n     createdBy: String\n     end1: {\n         guid: String\n         typeName: String\n         uniqueAttributes: {\n             String: Object\n         }\n     }\n     end2: (recursive schema, see end2 above)\n     guid: String\n     homeId: String\n     label: String\n     provenanceType: Float\n     status: String(ACTIVE/DELETED)\n     updateTime: Float\n     updatedBy: String\n     version: Float\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n     attributes: {\n         String: Object\n     }\n     typeName: String\n     lastModifiedTS: String\n     createTime: Float\n     createdBy: String\n     end1: {\n         guid: String\n         typeName: String\n         uniqueAttributes: {\n             String: Object\n         }\n     }\n     end2: (recursive schema, see end2 above)\n     guid: String\n     homeId: String\n     label: String\n     provenanceType: Float\n     status: String(ACTIVE/DELETED)\n     updateTime: Float\n     updatedBy: String\n     version: Float\n }\n```"
  returns:
    description: "atlasRelationship along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "class"
desc: "Initializes a new instance of the synchronous PurviewCatalogClient type."
metadata: {}
package: "com.azure.analytics.purview.catalog"
artifact: com.azure:azure-analytics-purview-catalog:1.0.0-beta.4