Index (Digital Architecture OMAS Client 2.9 API)

A C D F G L M O R S U V

A

assignReferenceValueToItem(String, String, String, int, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Link a valid value as a reference value to a referencable to act as a tag/classification to help with locating and grouping the referenceable.
assignValidValueToConsumer(String, String, String, boolean) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Link a valid value typically to a schema element or glossary term to show that it uses the valid values.
attachValidValueToSet(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Create a link between a valid value set or definition and a set.

C

callLocationGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a LocationResponse object.
callLocationsGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a LocationsResponse object.
callLocationsPostRESTCall(String, String, Object, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a POST REST call that returns a LocationsResponse object.
callReferenceValueAssignmentDefinitionsGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a ReferenceValueAssignmentDefinitionsResponse object.
callReferenceValueAssignmentItemsGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a ReferenceValueAssignmentItemsResponse object.
callValidValueAssignmentConsumersGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a ValidValueAssignmentConsumersResponse object.
callValidValueAssignmentDefinitionsGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a ValidValueAssignmentDefinitionsResponse object.
callValidValueGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a ValidValuesResponse object.
callValidValueMappingsGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a ValidValueMappingsResponse object.
callValidValuesGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a ValidValuesResponse object.
callValidValuesImplAssetsGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a ValidValuesImplAssetsResponse object.
callValidValuesImplDefinitionsGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a ValidValuesImplDefinitionsResponse object.
callValidValuesMappingsGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a GET REST call that returns a ValidValueMappingsResponse object.
callValidValuesPostRESTCall(String, String, Object, Object...) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Issue a POST REST call that returns a ValidValuesResponse object.
classifyAssetAsReferenceData(String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Add the ReferenceData classification to an asset.
clearAdjacentLocation(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Remove a peer-to-peer relationship between two locations.
clearLocationAsDigital(String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Remove the digital/cyber location designation from the location.
clearLocationAsFixedPhysical(String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Remove the fixed physical location designation from the location.
clearLocationAsSecure(String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Remove the secure location designation from the location.
clearNestedLocation(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Remove a parent-child relationship between two locations.
createLocation(String, LocationProperties) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Create a new metadata element to represent a location.
createLocationFromTemplate(String, String, TemplateProperties) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Create a new metadata element to represent a location using an existing metadata element as a template.
createValidValueDefinition(String, String, String, String, String, String, String, String, Map<String, String>, String, Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Create a new valid value definition.
createValidValueSet(String, String, String, String, String, String, Map<String, String>, String, Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Create a new valid value set.

D

declassifyAssetAsReferenceData(String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Remove the ReferenceData classification form an Asset.
deleteValidValue(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Remove the valid value form the repository.
detachValidValueFromSet(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Remove the link between a valid value and a set it is a member of.
DigitalArchitectureRESTClient - Class in org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest: DigitalArchitectureRESTClient is responsible for issuing calls to the OMAS REST APIs and managing exceptions returned in the responses.
DigitalArchitectureRESTClient(String, String, AuditLog) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Constructor for no authentication with audit log.
DigitalArchitectureRESTClient(String, String) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Constructor for no authentication.
DigitalArchitectureRESTClient(String, String, String, String, AuditLog) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Constructor for simple userId and password authentication with audit log.
DigitalArchitectureRESTClient(String, String, String, String) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient: Constructor for simple userId and password authentication.

F

findLocations(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Retrieve the list of location metadata elements that contain the search string.
findValidValues(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Locate valid values that match the search string.

G

getLocationByGUID(String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Retrieve the location metadata element with the supplied unique identifier.
getLocationsByName(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Retrieve the list of location metadata elements with a matching qualified or display name.
getReferenceValueAssignedItems(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Page through the list of referenceables that have this valid value as a reference value.
getReferenceValueAssignments(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Page through the list of assigned reference values for a referenceable.
getSetsForValidValue(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Page through the list of valid value sets that a valid value definition/set belongs to.
getValidValueByGUID(String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Retrieve a specific valid value from the repository.
getValidValueByName(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Retrieve a specific valid value from the repository.
getValidValueMappings(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Page through the list of mappings for a valid value.
getValidValuesAssignmentConsumers(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Page through the list of consumers for a valid value.
getValidValuesAssignmentDefinition(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Page through the list of valid values assigned to referenceable element.
getValidValueSetMembers(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Page through the members of a valid value set.
getValidValuesImplementationAssets(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Page through the list of implementations for a valid value.
getValidValuesImplementationDefinitions(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Page through the list of valid values defining the content of a reference data asset.
getValidValuesMappings(String, String, int, int) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Page through the list of mapping relationships associated with a valid value.

L

linkValidValueToImplementation(String, String, String, String, String, Map<String, String>) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Link a valid value to an asset that provides the implementation.
LocationManager - Class in org.odpi.openmetadata.accessservices.digitalarchitecture.client: LocationManager provides the API operations to create and maintain location definitions.
LocationManager(String, String, AuditLog) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Create a new client with no authentication embedded in the HTTP request and an audit log.
LocationManager(String, String) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Create a new client with no authentication embedded in the HTTP request.
LocationManager(String, String, String, String, AuditLog) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Create a new client that passes userId and password in each HTTP request.
LocationManager(String, String, String, String) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Create a new client that passes userId and password in each HTTP request.
LocationManager(String, String, DigitalArchitectureRESTClient, int, AuditLog) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Create a new client that is going to be used in an OMAG Server (view service or integration service typically).

M

mapValidValues(String, String, String, String, int, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Link together 2 valid values from different sets that have equivalent values/meanings.

O

org.odpi.openmetadata.accessservices.digitalarchitecture.client - package org.odpi.openmetadata.accessservices.digitalarchitecture.client: This package provides the Java clients for the Digital Architecture OMAS.
org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest - package org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest: This package provides the support for issuing REST API calls to the OMAG Server and processing common error responses (InvalidParameterException, UserNotAuthorizedException, PropertyServerException) from the calls.

R

removeLocation(String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Remove the metadata element representing a location.

S

setLocationAsDigital(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Classify the location to indicate that it represents a digital/cyber location.
setLocationAsFixedPhysical(String, String, String, String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Classify the location to indicate that it represents a fixed physical location.
setLocationAsSecure(String, String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Classify the location to indicate that it represents a secure location.
setupAdjacentLocation(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Create a peer-to-peer relationship between two locations.
setupNestedLocation(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Create a parent-child relationship between two locations.

U

unassignReferenceValueFromItem(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Remove the reference value link between a valid value and a referenceable (item).
unassignValidValueFromConsumer(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Remove the link between a valid value and a consumer.
unlinkValidValueFromImplementation(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Remove the link between a valid value and an implementing asset.
unmapValidValues(String, String, String) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Remove the reference value link between a valid value and a referenceable (item).
updateLocation(String, String, LocationProperties) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.LocationManager: Update the metadata element representing a location.
updateValidValue(String, String, String, String, String, String, String, String, boolean, Map<String, String>, String, Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Update the properties of the valid value.

V

ValidValuesManager - Class in org.odpi.openmetadata.accessservices.digitalarchitecture.client: ValidValuesManager provides the API operations to create and maintain lists of valid value definitions grouped into a valid value set.
ValidValuesManager(String, String, AuditLog) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Create a new client with no authentication embedded in the HTTP request and an audit log.
ValidValuesManager(String, String) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Create a new client with no authentication embedded in the HTTP request.
ValidValuesManager(String, String, String, String, AuditLog) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Create a new client that passes userId and password in each HTTP request.
ValidValuesManager(String, String, String, String) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Create a new client that passes userId and password in each HTTP request.
ValidValuesManager(String, String, DigitalArchitectureRESTClient, int, AuditLog) - Constructor for class org.odpi.openmetadata.accessservices.digitalarchitecture.client.ValidValuesManager: Create a new client that is going to be used in an OMAG Server (view service or integration service typically).

A C D F G L M O R S U V