Package 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:
ActionInitiateResponse, ActionResponse, ApiVersionResponse, AuditDetailsResponse, AuditMetadataResponse, AuditTypesResponse, AuthenticationResponse, BinderExportResponse, BinderResponse, BinderSectionResponse, BinderTemplateBulkResponse, BinderTemplateBulkResponse.TemplateResult, BinderTemplateMetadataResponse, BinderTemplateNodeBulkResponse, BinderTemplateNodeBulkResponse.TemplateNodeResult, BinderTemplateResponse, BulkTranslationImportSummaryResponse, BulkTranslationJobResponse, BulkWorkflowActionDetailsResponse, BulkWorkflowActionsResponse, BulkWorkflowJobStartResponse, ComponentContentResponse, ComponentQueryResponse, CustomPagesDistributionBulkResponse, CustomPagesDistributionResponse, CustomPagesDistributionRetrieveResponse, DelegatedSessionResponse, DelegationsResponse, DirectDataResponse, DiscoveryResponse, DocumentAnnotationAnchorResponse, DocumentAnnotationBulkResponse, DocumentAnnotationDeleteResponse, DocumentAnnotationImportResponse, DocumentAnnotationPlacemarkTypeMetadataResponse, DocumentAnnotationReadResponse, DocumentAnnotationReferenceTypeMetadataResponse, DocumentAnnotationReplyReadResponse, DocumentAnnotationTypeMetadataResponse, DocumentAttachmentBulkResponse, DocumentAttachmentResponse, DocumentBulkResponse, DocumentClassificationResponse, DocumentCollaborativeCheckoutResponse, DocumentCollaborativeCheckoutResponse.UndoCheckoutResponse, DocumentDeletionResponse, DocumentEventResponse, DocumentEventSubtypeResponse, DocumentEventTypeResponse, DocumentExportResponse, DocumentExportResponse.ExportedDocument, DocumentFieldResponse, DocumentLifecycleDeleteOverrideRulesResponse, DocumentLifecycleRoleAssignmentResponse, DocumentLifecycleRoleAssignmentRulesResponse, DocumentLockResponse, DocumentRelationshipBulkResponse, DocumentRelationshipMetadataResponse, DocumentRelationshipResponse, DocumentRelationshipRetrieveResponse, DocumentRenditionBulkResponse, DocumentRenditionResponse, DocumentResponse, DocumentRoleCheckForDCCResponse, DocumentSignatureMetadataResponse, DocumentsResponse, DocumentTemplateBulkResponse, DocumentTemplateBulkResponse.TemplateResult, DocumentTemplateMetadataResponse, DocumentTemplateResponse, DocumentTemplatesResponse, DocumentTokenResponse, DocumentTypesResponse, DocumentVersionResponse, DocumentWorkflowDetailsResponse, DocumentWorkflowResponse, DomainResponse, DomainsResponse, EDLMatchedDocumentResponse, EDLResponse, EmailNotificationHistoryResponse, EntryCriteriaResponse, FileStagingItemBulkResponse, FileStagingItemResponse, FileStagingJobResponse, FileStagingSessionBulkResponse, FileStagingSessionPartBulkResponse, FileStagingSessionPartResponse, FileStagingSessionResponse, GroupResponse, GroupRetrieveAutoManagedResponse, GroupRetrieveResponse, InitiateDocumentWorkflowResponse, JobCreateResponse, JobHistoryResponse, JobMonitorResponse, JobStatusResponse, JobTaskResponse, LoaderResponse, MdlExecuteResponse, 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, ObjectRecordTypeBulkResponse, ObjectRecordTypeBulkResponse.ResponseDetails, ObjectRecordTypeResponse, ObjectWorkflowActionDetailsResponse, ObjectWorkflowActionResponse, ObjectWorkflowResponse, ObjectWorkflowTaskActionDetailsResponse, ObjectWorkflowTaskResponse, OutboundPackageDependenciesResponse, PackageDeploymentResultsResponse, PackageImportResultsResponse, PicklistResponse, PicklistValueResponse, QueryResponse, QueueResponse, RoleChangeBulkResponse, RoleChangeBulkResponse.RoleChange, RoleChangeResponse, RoleRetrieveResponse, SandboxDetailsResponse, SandboxEntitlementResponse, SandboxResponse, SandboxSnapshotResponse, SCIMResponse, SCIMUserBulkResponse, SCIMUserResponse, SdkDebugSessionBulkResponse, SdkDebugSessionCreateResponse, SdkDebugSessionCreateResponse.Data, SdkDebugSessionResponse, SdkProfilingSessionBulkResponse, SdkProfilingSessionCreateResponse, SdkProfilingSessionCreateResponse.Data, SdkProfilingSessionResponse, SDKResponse, SecurityPoliciesResponse, SecurityPolicyResponse, UserBulkResponse, UserLicenseUsageResponse, UserPermissionResponse, UserResponse, UserRetrieveResponse, ValidatePackageResponse
public class VaultResponse extends VaultModel
Base Vault API response message

  • Field Details

    • HTTP_RESPONSE_WARNING

      public static final String HTTP_RESPONSE_WARNING
      responseStatus = FAILURE
      See Also:

    • HTTP_RESPONSE_FAILURE

      public static final String HTTP_RESPONSE_FAILURE
      responseStatus = FAILURE
      See Also:

    • HTTP_RESPONSE_SUCCESS

      public static final String HTTP_RESPONSE_SUCCESS
      responseStatus = SUCCESS
      See Also:

    • HTTP_HEADER_CONTENT_DISPOSITION

      public static final String HTTP_HEADER_CONTENT_DISPOSITION
      Content-Disposition
      See Also:

    • HTTP_HEADER_CONTENT_TYPE

      public static final String HTTP_HEADER_CONTENT_TYPE
      Content-Type
      See Also:

    • HTTP_HEADER_VAULT_BURST

      public static final String HTTP_HEADER_VAULT_BURST
      X-VaultAPI-BurstLimit
      See Also:

    • HTTP_HEADER_VAULT_BURST_REMAINING

      public static final String HTTP_HEADER_VAULT_BURST_REMAINING
      X-VaultAPI-BurstLimitRemaining
      See Also:

    • HTTP_HEADER_VAULT_EXECUTION_ID

      public static final String HTTP_HEADER_VAULT_EXECUTION_ID
      X-VaultAPI-ExecutionId
      See Also:

    • HTTP_HEADER_VAULT_RESPONSE_DELAY

      public static final String HTTP_HEADER_VAULT_RESPONSE_DELAY
      X-VaultAPI-ResponseDelay
      See Also:

    • HTTP_HEADER_VAULT_TRUNCATED_SESSION_ID

      public static final String HTTP_HEADER_VAULT_TRUNCATED_SESSION_ID
      X-VaultAPI-TruncatedSessionId
      See Also:

    • HTTP_HEADER_VAULT_USER_ID

      public static final String HTTP_HEADER_VAULT_USER_ID
      X-VaultAPI-UserId
      See Also:

    • HTTP_HEADER_VAULT_ID

      public static final String HTTP_HEADER_VAULT_ID
      X-VaultAPI-VaultId
      See Also:

    • HTTP_HEADER_VAULT_SDK_COUNT

      public static final String HTTP_HEADER_VAULT_SDK_COUNT
      X-VaultAPI-SdkCount
      See Also:

    • HTTP_HEADER_VAULT_SDK_CPU_TIME

      public static final String HTTP_HEADER_VAULT_SDK_CPU_TIME
      X-VaultAPI-SdkCpuTime
      See Also:

    • HTTP_HEADER_VAULT_SDK_ELAPSED_TIME

      public static final String HTTP_HEADER_VAULT_SDK_ELAPSED_TIME
      X-VaultAPI-SdkElapsedTime
      See Also:

    • HTTP_HEADER_VAULT_SDK_GROSS_MEMORY

      public static final String HTTP_HEADER_VAULT_SDK_GROSS_MEMORY
      X-VaultAPI-SdkGrossMemory
      See Also:

    • HTTP_HEADER_DOWNTIME_EXPECTED_DURATION_MINUTES

      public static final String HTTP_HEADER_DOWNTIME_EXPECTED_DURATION_MINUTES
      X-VaultAPI-DowntimeExpectedDurationMinutes
      See Also:

    • HTTP_HEADER_STATUS

      public static final String HTTP_HEADER_STATUS
      X-VaultAPI-Status
      See Also:

    • HTTP_REFERENCE_ID

      public static final String HTTP_REFERENCE_ID
      X-VaultAPI-Status
      See Also:

  • Constructor Details

    • VaultResponse

      public VaultResponse()

  • Method Details

    • 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)