com.veeva.vault.vapil.api.model.response

Class VaultResponse

java.lang.Object

com.veeva.vault.vapil.api.model.VaultModel

com.veeva.vault.vapil.api.model.response.VaultResponse

Direct Known Subclasses:

ApiVersionResponse, AuditDetailsResponse, AuditMetadataResponse, AuditTypesResponse, AuthenticationResponse, BinderExportResponse, BinderResponse, BinderSectionResponse, BinderTemplateBulkResponse, BinderTemplateBulkResponse.TemplateResult, BinderTemplateMetadataResponse, BinderTemplateNodeBulkResponse, BinderTemplateNodeBulkResponse.TemplateNodeResult, BinderTemplateResponse, BulkWorkflowActionDetailsResponse, BulkWorkflowActionsResponse, BulkWorkflowJobStartResponse, ComponentContentResponse, DelegatedSessionResponse, DelegationsResponse, DirectDataResponse, DiscoveryResponse, DocumentActionEntryCriteriaResponse, DocumentActionInitiateResponse, DocumentActionResponse, DocumentAnnotationDeleteResponse, DocumentAnnotationReadResponse, DocumentAnnotationReplyReadResponse, DocumentAnnotationResponse, DocumentAttachmentBulkResponse, DocumentAttachmentResponse, DocumentBulkResponse, DocumentClassificationResponse, DocumentDeletionResponse, DocumentEventResponse, DocumentEventSubtypeResponse, DocumentEventTypeResponse, DocumentExportResponse, DocumentExportResponse.ExportedDocument, DocumentFieldResponse, DocumentLifecycleDeleteOverrideRulesResponse, DocumentLifecycleRoleAssignmentResponse, DocumentLifecycleRoleAssignmentRulesResponse, DocumentLockResponse, DocumentRelationshipBulkResponse, DocumentRelationshipMetadataResponse, DocumentRelationshipResponse, DocumentRelationshipRetrieveResponse, DocumentRenditionBulkResponse, DocumentRenditionResponse, DocumentResponse, DocumentRoleChangeBulkResponse, DocumentRoleChangeBulkResponse.DocumentRoleChange, DocumentRoleChangeResponse, DocumentRoleCheckForDCCResponse, DocumentRoleRetrieveResponse, DocumentsResponse, DocumentTemplateBulkResponse, DocumentTemplateBulkResponse.TemplateResult, DocumentTemplateMetadataResponse, DocumentTemplateResponse, DocumentTemplatesResponse, DocumentTokenResponse, DocumentTypesResponse, DocumentVersionResponse, DocumentWorkflowDetailsResponse, DocumentWorkflowResponse, DomainResponse, EDLMatchedDocumentResponse, EDLResponse, EmailNotificationHistoryResponse, FileStagingItemBulkResponse, FileStagingItemResponse, FileStagingJobResponse, FileStagingSessionBulkResponse, FileStagingSessionPartBulkResponse, FileStagingSessionPartResponse, FileStagingSessionResponse, GroupResponse, GroupRetrieveAutoManagedResponse, GroupRetrieveResponse, InitiateDocumentWorkflowResponse, JobCreateResponse, JobHistoryResponse, JobMonitorResponse, JobStatusResponse, JobTaskResponse, LoaderResponse, MdlResponse, MetaDataComponentRecordResponse, MetaDataComponentTypeBulkResponse, MetaDataComponentTypeResponse, MetaDataDocumentLockResponse, MetaDataGroupResponse, MetaDataObjectBulkResponse, MetaDataObjectFieldResponse, MetaDataObjectPageLayoutResponse, MetaDataObjectResponse, MetaDataSecurityPolicyResponse, MetaDataUserResponse, ObjectMultiRecordWorkflowDetailsResponse, ObjectMultiRecordWorkflowInitiateResponse, ObjectMultiRecordWorkflowsResponse, ObjectRecordActionBulkResponse, ObjectRecordActionResponse, ObjectRecordAttachmentResponse, ObjectRecordBulkResponse, ObjectRecordCollectionResponse, ObjectRecordDeletedResponse, ObjectRecordMergeJobResponse, ObjectRecordMergeResultsResponse, ObjectRecordResponse, ObjectRecordRoleChangeResponse, ObjectRecordRoleResponse, ObjectRecordTypeResponse, ObjectWorkflowActionDetailsResponse, ObjectWorkflowActionResponse, ObjectWorkflowResponse, ObjectWorkflowTaskActionDetailsResponse, ObjectWorkflowTaskResponse, OutboundPackageDependenciesResponse, PackageDeploymentResultsResponse, PackageImportResultsResponse, PicklistResponse, PicklistValueResponse, QueryResponse, QueueResponse, SandboxDetailsResponse, SandboxEntitlementResponse, SandboxResponse, SandboxSnapshotResponse, SCIMResponse, SCIMUserBulkResponse, SCIMUserResponse, SDKResponse, SecurityPoliciesResponse, SecurityPolicyResponse, UserBulkResponse, UserPermissionResponse, UserResponse, UserRetrieveResponse, ValidatePackageResponse

public class VaultResponse
extends VaultModel

Base Vault API response message

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VaultResponse.APIResponseError
static class	VaultResponse.APIResponseWarning

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_HEADER_CONTENT_DISPOSITION Content-Disposition
static String	HTTP_HEADER_CONTENT_TYPE Content-Type
static String	HTTP_HEADER_DOWNTIME_EXPECTED_DURATION_MINUTES X-VaultAPI-DowntimeExpectedDurationMinutes
static String	HTTP_HEADER_STATUS X-VaultAPI-Status
static String	HTTP_HEADER_VAULT_BURST X-VaultAPI-BurstLimit
static String	HTTP_HEADER_VAULT_BURST_REMAINING X-VaultAPI-BurstLimitRemaining
static String	HTTP_HEADER_VAULT_EXECUTION_ID X-VaultAPI-ExecutionId
static String	HTTP_HEADER_VAULT_ID X-VaultAPI-VaultId
static String	HTTP_HEADER_VAULT_RESPONSE_DELAY X-VaultAPI-ResponseDelay
static String	HTTP_HEADER_VAULT_SDK_COUNT X-VaultAPI-SdkCount
static String	HTTP_HEADER_VAULT_SDK_CPU_TIME X-VaultAPI-SdkCpuTime
static String	HTTP_HEADER_VAULT_SDK_ELAPSED_TIME X-VaultAPI-SdkElapsedTime
static String	HTTP_HEADER_VAULT_SDK_GROSS_MEMORY X-VaultAPI-SdkGrossMemory
static String	HTTP_HEADER_VAULT_TRUNCATED_SESSION_ID X-VaultAPI-TruncatedSessionId
static String	HTTP_HEADER_VAULT_USER_ID X-VaultAPI-UserId
static String	HTTP_REFERENCE_ID X-VaultAPI-Status
static String	HTTP_RESPONSE_FAILURE responseStatus = FAILURE
static String	HTTP_RESPONSE_SUCCESS responseStatus = SUCCESS
static String	HTTP_RESPONSE_WARNING responseStatus = FAILURE

Constructor Summary

Constructors

Constructor and Description
VaultResponse()

Method Summary

Modifier and Type	Method and Description
byte[]	getBinaryContent() For requests returning binary content.
List<VaultResponse.APIResponseError>	getErrors()
String	getHeaderContentType()
Integer	getHeaderDowntimeExpectedDurationMinutes()
Object	getHeaderIgnoreCase(String header)
String	getHeaderReferenceId()
Map<String,List<String>>	getHeaders()
String	getHeaderStatus()
Integer	getHeaderVaultBurstLimit()
Integer	getHeaderVaultBurstLimitRemaining()
String	getHeaderVaultExecutionId()
Integer	getHeaderVaultId()
Integer	getHeaderVaultResponseDelay()
Integer	getHeaderVaultSdkCount()
Long	getHeaderVaultSdkCpuTime()
Long	getHeaderVaultSdkElapsedTime()
Long	getHeaderVaultSdkGrossMemory()
String	getHeaderVaultTruncatedSessionId()
String	getHeaderVaultUserId()
String	getHttpHeaderContentDisposition()
String	getOutputFilePath() Return the file path For requests creating files.
String	getResponse() Get the full response as a string.
com.fasterxml.jackson.databind.JsonNode	getResponseJSON() Get the full response as a JSON Object.
String	getResponseMessage()
String	getResponseStatus()
List<VaultResponse.APIResponseWarning>	getWarnings()
boolean	hasErrors() Determine if the response has errors.
boolean	hasWarnings() Determine if the response has warnings.
boolean	isFailure() Determine if the response status equals FAILURE.
boolean	isSuccessful() Determine if the response status equals SUCCESS.
boolean	isWarning() Determine if the response status equals WARNING.
void	setBinaryContent(byte[] binaryContent)
void	setErrors(List<VaultResponse.APIResponseError> errors)
void	setHeaders(Map<String,List<String>> headers)
void	setOutputFilePath(String outputFilePath)
void	setResponse(String response)
void	setResponseMessage(String responseMessage)
void	setResponseStatus(String responseStatus)
void	setWarnings(List<VaultResponse.APIResponseWarning> warnings)

Methods inherited from class com.veeva.vault.vapil.api.model.VaultModel

get, getBigDecimal, getBoolean, getFieldNames, getInteger, getListInteger, getListLong, getListString, getLong, getString, getVaultModelData, set, setVaultModelData, toJSONObject, toJsonString, toMap, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTTP_RESPONSE_WARNING

public static final String HTTP_RESPONSE_WARNING

responseStatus = FAILURE

See Also:

Constant Field Values

HTTP_RESPONSE_FAILURE

public static final String HTTP_RESPONSE_FAILURE

responseStatus = FAILURE

See Also:

Constant Field Values

HTTP_RESPONSE_SUCCESS

public static final String HTTP_RESPONSE_SUCCESS

responseStatus = SUCCESS

See Also:

Constant Field Values

HTTP_HEADER_CONTENT_DISPOSITION

public static final String HTTP_HEADER_CONTENT_DISPOSITION

Content-Disposition

See Also:

Constant Field Values

HTTP_HEADER_CONTENT_TYPE

public static final String HTTP_HEADER_CONTENT_TYPE

Content-Type

See Also:

Constant Field Values

HTTP_HEADER_VAULT_BURST

public static final String HTTP_HEADER_VAULT_BURST

X-VaultAPI-BurstLimit

See Also:

Constant Field Values

HTTP_HEADER_VAULT_BURST_REMAINING

public static final String HTTP_HEADER_VAULT_BURST_REMAINING

X-VaultAPI-BurstLimitRemaining

See Also:

Constant Field Values

HTTP_HEADER_VAULT_EXECUTION_ID

public static final String HTTP_HEADER_VAULT_EXECUTION_ID

X-VaultAPI-ExecutionId

See Also:

Constant Field Values

HTTP_HEADER_VAULT_RESPONSE_DELAY

public static final String HTTP_HEADER_VAULT_RESPONSE_DELAY

X-VaultAPI-ResponseDelay

See Also:

Constant Field Values

HTTP_HEADER_VAULT_TRUNCATED_SESSION_ID

public static final String HTTP_HEADER_VAULT_TRUNCATED_SESSION_ID

X-VaultAPI-TruncatedSessionId

See Also:

Constant Field Values

HTTP_HEADER_VAULT_USER_ID

public static final String HTTP_HEADER_VAULT_USER_ID

X-VaultAPI-UserId

See Also:

Constant Field Values

HTTP_HEADER_VAULT_ID

public static final String HTTP_HEADER_VAULT_ID

X-VaultAPI-VaultId

See Also:

Constant Field Values

HTTP_HEADER_VAULT_SDK_COUNT

public static final String HTTP_HEADER_VAULT_SDK_COUNT

X-VaultAPI-SdkCount

See Also:

Constant Field Values

HTTP_HEADER_VAULT_SDK_CPU_TIME

public static final String HTTP_HEADER_VAULT_SDK_CPU_TIME

X-VaultAPI-SdkCpuTime

See Also:

Constant Field Values

HTTP_HEADER_VAULT_SDK_ELAPSED_TIME

public static final String HTTP_HEADER_VAULT_SDK_ELAPSED_TIME

X-VaultAPI-SdkElapsedTime

See Also:

Constant Field Values

HTTP_HEADER_VAULT_SDK_GROSS_MEMORY

public static final String HTTP_HEADER_VAULT_SDK_GROSS_MEMORY

X-VaultAPI-SdkGrossMemory

See Also:

Constant Field Values

HTTP_HEADER_DOWNTIME_EXPECTED_DURATION_MINUTES

public static final String HTTP_HEADER_DOWNTIME_EXPECTED_DURATION_MINUTES

X-VaultAPI-DowntimeExpectedDurationMinutes

See Also:

Constant Field Values

HTTP_HEADER_STATUS

public static final String HTTP_HEADER_STATUS

X-VaultAPI-Status

See Also:

Constant Field Values

HTTP_REFERENCE_ID

public static final String HTTP_REFERENCE_ID

X-VaultAPI-Status

See Also:

Constant Field Values

Constructor Detail

VaultResponse

public VaultResponse()

Method Detail

isWarning

public boolean isWarning()

Determine if the response status equals WARNING.

Returns:

true if the response status equals WARNING

isFailure

public boolean isFailure()

Determine if the response status equals FAILURE.

Returns:

true if the response status equals FAILURE

isSuccessful

public boolean isSuccessful()

Determine if the response status equals SUCCESS.

Returns:

true if the response status equals SUCCESS

getResponseMessage

public String getResponseMessage()

setResponseMessage

public void setResponseMessage(String responseMessage)

getResponseStatus

public String getResponseStatus()

setResponseStatus

public void setResponseStatus(String responseStatus)

getResponse

public String getResponse()

Get the full response as a string.

Returns:

The full response as a string

setResponse

public void setResponse(String response)

getResponseJSON

public com.fasterxml.jackson.databind.JsonNode getResponseJSON()

Get the full response as a JSON Object.

Returns:

The full response as a JSON Object

getErrors

public List<VaultResponse.APIResponseError> getErrors()

setErrors

public void setErrors(List<VaultResponse.APIResponseError> errors)

hasErrors

public boolean hasErrors()

Determine if the response has errors.

Returns:

true if the response has errors

getWarnings

public List<VaultResponse.APIResponseWarning> getWarnings()

setWarnings

public void setWarnings(List<VaultResponse.APIResponseWarning> warnings)

hasWarnings

public boolean hasWarnings()

Determine if the response has warnings.

Returns:

true if the response has warnings

getHeaders

public Map<String,List<String>> getHeaders()

setHeaders

public void setHeaders(Map<String,List<String>> headers)

getHttpHeaderContentDisposition

public String getHttpHeaderContentDisposition()

getHeaderContentType

public String getHeaderContentType()

getHeaderVaultBurstLimit

public Integer getHeaderVaultBurstLimit()

getHeaderVaultBurstLimitRemaining

public Integer getHeaderVaultBurstLimitRemaining()

getHeaderVaultExecutionId

public String getHeaderVaultExecutionId()

getHeaderVaultId

public Integer getHeaderVaultId()

getHeaderVaultResponseDelay

public Integer getHeaderVaultResponseDelay()

getHeaderVaultTruncatedSessionId

public String getHeaderVaultTruncatedSessionId()

getHeaderVaultUserId

public String getHeaderVaultUserId()

getHeaderVaultSdkCount

public Integer getHeaderVaultSdkCount()

getHeaderVaultSdkCpuTime

public Long getHeaderVaultSdkCpuTime()

getHeaderVaultSdkElapsedTime

public Long getHeaderVaultSdkElapsedTime()

getHeaderVaultSdkGrossMemory

public Long getHeaderVaultSdkGrossMemory()

getHeaderDowntimeExpectedDurationMinutes

public Integer getHeaderDowntimeExpectedDurationMinutes()

getHeaderStatus

public String getHeaderStatus()

getHeaderReferenceId

public String getHeaderReferenceId()

getBinaryContent

public byte[] getBinaryContent()

For requests returning binary content.

Returns:

Byte array for the returned binary content

setBinaryContent

public void setBinaryContent(byte[] binaryContent)

getOutputFilePath

public String getOutputFilePath()

Return the file path For requests creating files.

Returns:

The file path of the created file

setOutputFilePath

public void setOutputFilePath(String outputFilePath)

getHeaderIgnoreCase

public Object getHeaderIgnoreCase(String header)