Class TypesAsyncClient
java.lang.Object
com.azure.analytics.purview.catalog.TypesAsyncClient
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>>
createTypeDefinitionsWithResponse
(com.azure.core.util.BinaryData typesDef, com.azure.core.http.rest.RequestOptions requestOptions) Create all atlas type definitions in bulk, only new definitions will be created.deleteTypeByNameWithResponse
(String name, com.azure.core.http.rest.RequestOptions requestOptions) Delete API for type identified by its name.deleteTypeDefinitionsWithResponse
(com.azure.core.util.BinaryData typesDef, com.azure.core.http.rest.RequestOptions requestOptions) Delete API for all types in bulk.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getAllTypeDefinitionsWithResponse
(com.azure.core.http.rest.RequestOptions requestOptions) Get all type definitions in Atlas in bulk.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getBusinessMetadataDefByGuidWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the businessMetadata definition for the given guid.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getBusinessMetadataDefByNameWithResponse
(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the businessMetadata definition by it's name (unique).Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getClassificationDefByGuidWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the classification definition for the given GUID.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getClassificationDefByNameWithResponse
(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the classification definition by its name (unique).Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getEntityDefinitionByGuidWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the Entity definition for the given GUID.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getEntityDefinitionByNameWithResponse
(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the entity definition by its name (unique).Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getEnumDefByGuidWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the enum definition for the given GUID.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getEnumDefByNameWithResponse
(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the enum definition by its name (unique).Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getRelationshipDefByGuidWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the relationship definition for the given GUID.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getRelationshipDefByNameWithResponse
(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the relationship definition by its name (unique).Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getStructDefByGuidWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the struct definition for the given GUID.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getStructDefByNameWithResponse
(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the struct definition by its name (unique).Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getTermTemplateDefByGuidWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the term template definition for the given GUID.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getTermTemplateDefByNameWithResponse
(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the term template definition by its name (unique).Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getTypeDefinitionByGuidWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the type definition for the given GUID.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getTypeDefinitionByNameWithResponse
(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the type definition by its name (unique).Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
listTypeDefinitionHeadersWithResponse
(com.azure.core.http.rest.RequestOptions requestOptions) List all type definitions returned as a list of minimal information header.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
updateAtlasTypeDefinitionsWithResponse
(com.azure.core.util.BinaryData typesDef, com.azure.core.http.rest.RequestOptions requestOptions) Update all types in bulk, changes detected in the type definitions would be persisted.
-
Method Details
-
getBusinessMetadataDefByGuidWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getBusinessMetadataDefByGuidWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the businessMetadata definition for the given guid.Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] }
- Parameters:
guid
- businessMetadata guid.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the businessMetadata definition for the given 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.
-
getBusinessMetadataDefByNameWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getBusinessMetadataDefByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the businessMetadata definition by it's name (unique).Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] }
- Parameters:
name
- businessMetadata name.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the businessMetadata definition by it's name (unique) 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.
-
getClassificationDefByGuidWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getClassificationDefByGuidWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the classification definition for the given GUID.Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] entityTypes: [ String ] subTypes: [ String ] superTypes: [ String ] }
- Parameters:
guid
- The globally unique identifier of the classification.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the classification definition for the given 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.
-
getClassificationDefByNameWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getClassificationDefByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the classification definition by its name (unique).Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] entityTypes: [ String ] subTypes: [ String ] superTypes: [ String ] }
- Parameters:
name
- The name of the classification.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the classification definition by its name (unique) 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.
-
getEntityDefinitionByGuidWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getEntityDefinitionByGuidWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the Entity definition for the given GUID.Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] subTypes: [ String ] superTypes: [ String ] relationshipAttributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ (recursive schema, see above) ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer isLegacyAttribute: Boolean relationshipTypeName: String } ] }
- Parameters:
guid
- The globally unique identifier of the entity.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the Entity definition for the given 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.
-
getEntityDefinitionByNameWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getEntityDefinitionByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the entity definition by its name (unique).Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] subTypes: [ String ] superTypes: [ String ] relationshipAttributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ (recursive schema, see above) ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer isLegacyAttribute: Boolean relationshipTypeName: String } ] }
- Parameters:
name
- The name of the entity.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the entity definition by its name (unique) 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.
-
getEnumDefByGuidWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getEnumDefByGuidWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the enum definition for the given GUID.Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String defaultValue: String elementDefs: [ { description: String ordinal: Float value: String } ] }
- Parameters:
guid
- The globally unique identifier of the enum.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the enum definition for the given 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.
-
getEnumDefByNameWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getEnumDefByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the enum definition by its name (unique).Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String defaultValue: String elementDefs: [ { description: String ordinal: Float value: String } ] }
- Parameters:
name
- The name of the enum.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the enum definition by its name (unique) 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.
-
getRelationshipDefByGuidWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getRelationshipDefByGuidWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the relationship definition for the given GUID.Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] endDef1: { cardinality: String(SINGLE/LIST/SET) description: String isContainer: Boolean isLegacyAttribute: Boolean name: String type: String } endDef2: (recursive schema, see endDef2 above) relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION) relationshipLabel: String }
- Parameters:
guid
- The globally unique identifier of the relationship.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the relationship definition for the given 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.
-
getRelationshipDefByNameWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getRelationshipDefByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the relationship definition by its name (unique).Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] endDef1: { cardinality: String(SINGLE/LIST/SET) description: String isContainer: Boolean isLegacyAttribute: Boolean name: String type: String } endDef2: (recursive schema, see endDef2 above) relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION) relationshipLabel: String }
- Parameters:
name
- The name of the relationship.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the relationship definition by its name (unique) 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.
-
getStructDefByGuidWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getStructDefByGuidWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the struct definition for the given GUID.Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] }
- Parameters:
guid
- The globally unique identifier of the struct.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the struct definition for the given 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.
-
getStructDefByNameWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getStructDefByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the struct definition by its name (unique).Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] }
- Parameters:
name
- The name of the struct.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the struct definition by its name (unique) 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.
-
getTypeDefinitionByGuidWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getTypeDefinitionByGuidWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the type definition for the given GUID.Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String entityTypes: [ String ] subTypes: [ String ] superTypes: [ String ] relationshipAttributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer isLegacyAttribute: Boolean relationshipTypeName: String } ] defaultValue: String elementDefs: [ { description: String ordinal: Float value: String } ] endDef1: { cardinality: String(SINGLE/LIST/SET) description: String isContainer: Boolean isLegacyAttribute: Boolean name: String type: String } endDef2: (recursive schema, see endDef2 above) relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION) relationshipLabel: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ (recursive schema, see above) ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] }
- Parameters:
guid
- The globally unique identifier of the type.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the type definition for the given 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.
-
getTypeDefinitionByNameWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getTypeDefinitionByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the type definition by its name (unique).Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String entityTypes: [ String ] subTypes: [ String ] superTypes: [ String ] relationshipAttributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer isLegacyAttribute: Boolean relationshipTypeName: String } ] defaultValue: String elementDefs: [ { description: String ordinal: Float value: String } ] endDef1: { cardinality: String(SINGLE/LIST/SET) description: String isContainer: Boolean isLegacyAttribute: Boolean name: String type: String } endDef2: (recursive schema, see endDef2 above) relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION) relationshipLabel: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ (recursive schema, see above) ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] }
- Parameters:
name
- The name of the type.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the type definition by its name (unique) 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.
-
deleteTypeByNameWithResponse
public Mono<com.azure.core.http.rest.Response<Void>> deleteTypeByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions) Delete API for type identified by its name.- Parameters:
name
- The name of the type.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.
-
getAllTypeDefinitionsWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getAllTypeDefinitionsWithResponse(com.azure.core.http.rest.RequestOptions requestOptions) Get all type definitions in Atlas in bulk.Query Parameters
Query Parameters Name Type Required Description includeTermTemplate Boolean No Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template type String No Typedef name as search filter when get typedefs. Allowed values: enum, entity, classification, relationship, struct, term_template. Response Body Schema
{ businessMetadataDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] } ] classificationDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] entityTypes: [ String ] subTypes: [ String ] superTypes: [ String ] } ] entityDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] subTypes: [ String ] superTypes: [ String ] relationshipAttributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ (recursive schema, see above) ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer isLegacyAttribute: Boolean relationshipTypeName: String } ] } ] enumDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String defaultValue: String elementDefs: [ { description: String ordinal: Float value: String } ] } ] relationshipDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] endDef1: { cardinality: String(SINGLE/LIST/SET) description: String isContainer: Boolean isLegacyAttribute: Boolean name: String type: String } endDef2: (recursive schema, see endDef2 above) relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION) relationshipLabel: String } ] structDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] termTemplateDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] }
- Parameters:
requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- all type definitions in Atlas in bulk 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.
-
createTypeDefinitionsWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> createTypeDefinitionsWithResponse(com.azure.core.util.BinaryData typesDef, com.azure.core.http.rest.RequestOptions requestOptions) Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded.Request Body Schema
{ businessMetadataDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] } ] classificationDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] entityTypes: [ String ] subTypes: [ String ] superTypes: [ String ] } ] entityDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] subTypes: [ String ] superTypes: [ String ] relationshipAttributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ (recursive schema, see above) ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer isLegacyAttribute: Boolean relationshipTypeName: String } ] } ] enumDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String defaultValue: String elementDefs: [ { description: String ordinal: Float value: String } ] } ] relationshipDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] endDef1: { cardinality: String(SINGLE/LIST/SET) description: String isContainer: Boolean isLegacyAttribute: Boolean name: String type: String } endDef2: (recursive schema, see endDef2 above) relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION) relationshipLabel: String } ] structDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] termTemplateDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] }
Response Body Schema
{ businessMetadataDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] } ] classificationDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] entityTypes: [ String ] subTypes: [ String ] superTypes: [ String ] } ] entityDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] subTypes: [ String ] superTypes: [ String ] relationshipAttributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ (recursive schema, see above) ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer isLegacyAttribute: Boolean relationshipTypeName: String } ] } ] enumDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String defaultValue: String elementDefs: [ { description: String ordinal: Float value: String } ] } ] relationshipDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] endDef1: { cardinality: String(SINGLE/LIST/SET) description: String isContainer: Boolean isLegacyAttribute: Boolean name: String type: String } endDef2: (recursive schema, see endDef2 above) relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION) relationshipLabel: String } ] structDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] termTemplateDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] }
- Parameters:
typesDef
- A composite wrapper object with corresponding lists of the type definition.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- atlasTypesDef 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.
-
updateAtlasTypeDefinitionsWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> updateAtlasTypeDefinitionsWithResponse(com.azure.core.util.BinaryData typesDef, com.azure.core.http.rest.RequestOptions requestOptions) Update all types in bulk, changes detected in the type definitions would be persisted.Request Body Schema
{ businessMetadataDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] } ] classificationDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] entityTypes: [ String ] subTypes: [ String ] superTypes: [ String ] } ] entityDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] subTypes: [ String ] superTypes: [ String ] relationshipAttributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ (recursive schema, see above) ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer isLegacyAttribute: Boolean relationshipTypeName: String } ] } ] enumDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String defaultValue: String elementDefs: [ { description: String ordinal: Float value: String } ] } ] relationshipDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] endDef1: { cardinality: String(SINGLE/LIST/SET) description: String isContainer: Boolean isLegacyAttribute: Boolean name: String type: String } endDef2: (recursive schema, see endDef2 above) relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION) relationshipLabel: String } ] structDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] termTemplateDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] }
Response Body Schema
{ businessMetadataDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] } ] classificationDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] entityTypes: [ String ] subTypes: [ String ] superTypes: [ String ] } ] entityDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] subTypes: [ String ] superTypes: [ String ] relationshipAttributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ (recursive schema, see above) ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer isLegacyAttribute: Boolean relationshipTypeName: String } ] } ] enumDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String defaultValue: String elementDefs: [ { description: String ordinal: Float value: String } ] } ] relationshipDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] endDef1: { cardinality: String(SINGLE/LIST/SET) description: String isContainer: Boolean isLegacyAttribute: Boolean name: String type: String } endDef2: (recursive schema, see endDef2 above) relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION) relationshipLabel: String } ] structDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] termTemplateDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] }
- Parameters:
typesDef
- A composite object that captures all type definition changes.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- atlasTypesDef 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.
-
deleteTypeDefinitionsWithResponse
public Mono<com.azure.core.http.rest.Response<Void>> deleteTypeDefinitionsWithResponse(com.azure.core.util.BinaryData typesDef, com.azure.core.http.rest.RequestOptions requestOptions) Delete API for all types in bulk.Request Body Schema
{ businessMetadataDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] } ] classificationDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] entityTypes: [ String ] subTypes: [ String ] superTypes: [ String ] } ] entityDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] subTypes: [ String ] superTypes: [ String ] relationshipAttributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ (recursive schema, see above) ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer isLegacyAttribute: Boolean relationshipTypeName: String } ] } ] enumDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String defaultValue: String elementDefs: [ { description: String ordinal: Float value: String } ] } ] relationshipDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] endDef1: { cardinality: String(SINGLE/LIST/SET) description: String isContainer: Boolean isLegacyAttribute: Boolean name: String type: String } endDef2: (recursive schema, see endDef2 above) relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION) relationshipLabel: String } ] structDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] termTemplateDefs: [ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: (recursive schema, see dateFormatter above) description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ (recursive schema, see above) ] } ] }
- Parameters:
typesDef
- A composite object that captures all types to be deleted.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.
-
listTypeDefinitionHeadersWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> listTypeDefinitionHeadersWithResponse(com.azure.core.http.rest.RequestOptions requestOptions) List all type definitions returned as a list of minimal information header.Query Parameters
Query Parameters Name Type Required Description includeTermTemplate Boolean No Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template type String No Typedef name as search filter when get typedefs. Allowed values: enum, entity, classification, relationship, struct, term_template. Response Body Schema
[ { category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) guid: String name: String } ]
- Parameters:
requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- an array of AtlasTypeDefHeader matching the search criteria or an empty list if no match 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.
-
getTermTemplateDefByGuidWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getTermTemplateDefByGuidWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get the term template definition for the given GUID.Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] }
- Parameters:
guid
- The globally unique identifier of the term template.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the term template definition for the given 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.
-
getTermTemplateDefByNameWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getTermTemplateDefByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions) Get the term template definition by its name (unique).Response Body Schema
{ category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE) createTime: Float createdBy: String dateFormatter: { availableLocales: [ String ] calendar: Float dateInstance: (recursive schema, see dateInstance above) dateTimeInstance: (recursive schema, see dateTimeInstance above) instance: (recursive schema, see instance above) lenient: Boolean numberFormat: { availableLocales: [ String ] currency: String currencyInstance: (recursive schema, see currencyInstance above) groupingUsed: Boolean instance: (recursive schema, see instance above) integerInstance: (recursive schema, see integerInstance above) maximumFractionDigits: Integer maximumIntegerDigits: Integer minimumFractionDigits: Integer minimumIntegerDigits: Integer numberInstance: (recursive schema, see numberInstance above) parseIntegerOnly: Boolean percentInstance: (recursive schema, see percentInstance above) roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY) } timeInstance: (recursive schema, see timeInstance above) timeZone: { dstSavings: Integer id: String availableIds: [ String ] defaultProperty: (recursive schema, see defaultProperty above) displayName: String rawOffset: Integer } } description: String guid: String name: String options: { String: String } serviceType: String typeVersion: String updateTime: Float updatedBy: String version: Float lastModifiedTS: String attributeDefs: [ { cardinality: String(SINGLE/LIST/SET) constraints: [ { params: { String: Object } type: String } ] defaultValue: String description: String includeInNotification: Boolean isIndexable: Boolean isOptional: Boolean isUnique: Boolean name: String options: { String: String } typeName: String valuesMaxCount: Integer valuesMinCount: Integer } ] }
- Parameters:
name
- The name of the term template.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the term template definition by its name (unique) 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.
-