Package org.odpi.openmetadata.frameworks.connectors.properties

Class DeployedAPIOperation

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable

org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaElement

org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaType

org.odpi.openmetadata.frameworks.connectors.properties.beans.APIOperation

org.odpi.openmetadata.frameworks.connectors.properties.DeployedAPIOperation

public class DeployedAPIOperation
extends APIOperation

An asset that is a DeployedAPI has a schema made up of operations. These operations have a header, request and a response. Each of these has a list of schema attributes.

Field Summary

Fields

Modifier and Type	Field	Description
protected SchemaAttributes	headerAttributes
protected SchemaAttributes	requestAttributes
protected SchemaAttributes	responseAttributes

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.APIOperation

command, headerSchemaType, requestSchemaType, responseSchemaType

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaType

author, encodingStandard, formula, formulaType, namespace, queries, usage, versionNumber

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaElement

description, displayName, expression, expressionType, isCalculatedValue, isDeprecated

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable

meanings, searchKeywords

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

additionalProperties, qualifiedName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase

extendedProperties

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DeployedAPIOperation()	Constructor used by the subclasses
	DeployedAPIOperation(APIOperation schemaBean)	Bean constructor
	DeployedAPIOperation(DeployedAPIOperation template)	Copy/clone Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
SchemaAttributes	getHeaderAttributes()	Return the list of schema attributes in this API operation's header.
SchemaAttributes	getRequestAttributes()	Return the list of schema attributes in this API operation's request.
SchemaAttributes	getResponseAttributes()	Return the list of schema attributes in this API operation's response.
int	hashCode()	Hash of properties
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.APIOperation

cloneSchemaElement, cloneSchemaType, getCommand, getHeaderSchemaType, getRequestSchemaType, getResponseSchemaType, setCommand, setHeaderSchemaType, setRequestSchemaType, setResponseSchemaType

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaType

getAuthor, getEncodingStandard, getFormula, getFormulaType, getNamespace, getQueries, getUsage, getVersionNumber, setAuthor, setEncodingStandard, setFormula, setFormulaType, setNamespace, setQueries, setUsage, setVersionNumber

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaElement

getDescription, getDisplayName, getExpression, getExpressionType, getIsCalculatedValue, getIsDeprecated, setDescription, setDisplayName, setExpression, setExpressionType, setIsCalculatedValue, setIsDeprecated

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable

getMeanings, getSearchKeywords, setMeanings, setSearchKeywords

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase

getExtendedProperties, setExtendedProperties

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader

getClassifications, getGUID, setClassifications, setGUID

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

getHeaderVersion, getOrigin, getStatus, getType, getVersions, setHeaderVersion, setOrigin, setStatus, setType, setVersions

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

headerAttributes

protected SchemaAttributes headerAttributes

requestAttributes

protected SchemaAttributes requestAttributes

responseAttributes

protected SchemaAttributes responseAttributes

Constructor Details

DeployedAPIOperation

protected DeployedAPIOperation()

Constructor used by the subclasses

DeployedAPIOperation

public DeployedAPIOperation(APIOperation schemaBean)

Bean constructor

Parameters:

schemaBean - bean containing the schema properties

DeployedAPIOperation

public DeployedAPIOperation(DeployedAPIOperation template)

Copy/clone Constructor.

Parameters:

template - template object to copy.

Method Details

getHeaderAttributes

public SchemaAttributes getHeaderAttributes()

Return the list of schema attributes in this API operation's header.

Returns:

SchemaAttributes

getRequestAttributes

public SchemaAttributes getRequestAttributes()

Return the list of schema attributes in this API operation's request.

Returns:

SchemaAttributes

getResponseAttributes

public SchemaAttributes getResponseAttributes()

Return the list of schema attributes in this API operation's response.

Returns:

SchemaAttributes

toString

public String toString()

Standard toString method.

Overrides:

toString in class APIOperation

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class APIOperation

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Hash of properties

Overrides:

hashCode in class APIOperation

Returns:

int