Interface RequestIdService

All Known Subinterfaces:
FFDCResponse
All Known Implementing Classes:
AccessServiceConfigResponse, AccessServicesResponse, ActionRequestBody, ActionTargetStatusRequestBody, ActivityStatusFilterRequestBody, ActivityStatusRequestBody, ActivityStatusSearchString, AdminServicesAPIResponse, AnchorOptions, AnchorSearchMatchesListResponse, AnchorSearchMatchesResponse, AssetCatalogSupportedTypes, AssetLineageGraphRequestBody, AttachedClassificationsResponse, AttributeTypeDefCategoryRequest, AttributeTypeDefListResponse, AttributeTypeDefListResponse, AttributeTypeDefRequest, AttributeTypeDefResponse, AttributeTypeDefResponse, AuditLogReportResponse, AuditLogSeveritiesResponse, BasicOptions, BasicServerPropertiesResponse, BooleanResponse, BooleanResponse, CertificationElementsResponse, ClassificationListResponse, ClassificationProxyRequest, ClassificationRequest, ClassificationResponse, ClassificationWithEntityRequest, CohortConfigResponse, CohortListResponse, CohortMembershipListResponse, CohortMembershipResponse, CompletionStatusRequestBody, ConnectionListResponse, ConnectionResponse, ConnectionResponse, ConnectorReportResponse, ContentStatusFilterRequestBody, ContentStatusRequestBody, ContentStatusSearchString, DateResponse, DedicatedTopicListResponse, DeleteClassificationRequestBody, DeleteElementRequestBody, DeleteOptions, DeleteRelationshipRequestBody, DeleteRequestBody, DeploymentStatusFilterRequestBody, DeploymentStatusRequestBody, DeploymentStatusSearchString, ElementHeaderResponse, ElementHeadersResponse, EngineActionElementResponse, EngineActionElementsResponse, EngineActionStatusRequestBody, EngineHostServicesResponse, EntityCreateRequest, EntityDetailRequest, EntityDetailResponse, EntityFindRequest, EntityHistoricalFindRequest, EntityListResponse, EntityNeighborhoodFindRequest, EntityNeighborhoodHistoricalFindRequest, EntityPropertyFindRequest, EntityPropertyHistoricalFindRequest, EntityProxyRequest, EntitySummaryResponse, EventBusConfigResponse, ExternalIdEffectiveTimeQueryRequestBody, FFDCResponseBase, FilterRequestBody, FindDigitalResourceOriginProperties, FindProjectClassificationProperties, FindPropertyNameProperties, FindPropertyNamesProperties, FindRelationshipRequestBody, FindRequestBody, GAFAPIRequest, GAFAPIResponse, GetOptions, GetRequest, GetRequestBody, GlossaryTermActivityTypeListResponse, GlossaryTermRelationshipStatusListResponse, GlossaryTermStatusListResponse, GovernanceActionProcessGraphResponse, GovernanceEngineElementResponse, GovernanceEngineSummariesResponse, GovernanceEngineSummaryResponse, GUIDListResponse, GUIDResponse, HistoricalQueryOptions, HistoryExternalIdentifiersRequestBody, HistoryRangeRequest, HistoryRequest, HistoryRequestBody, InitiateEngineActionRequestBody, InitiateGovernanceActionProcessRequestBody, InitiateGovernanceActionTypeRequestBody, InstanceFindRequest, InstanceGraphRequest, InstanceGraphResponse, InstancePropertiesRequest, InstanceStatusRequest, IntegrationDaemonServicesResponse, IntegrationDaemonStatusResponse, IntegrationGroupElementResponse, IntegrationGroupsResponse, IntegrationGroupSummariesResponse, IntegrationGroupSummaryResponse, IntegrationReportResponse, IntegrationReportsResponse, LevelIdentifierQueryProperties, LocalRepositoryConfigResponse, MakeAnchorOptions, MatchCriteriaListResponse, MetadataCollectionIdRequest, MetadataCollectionIdResponse, MetadataElementSummariesResponse, MetadataElementSummaryResponse, MetadataRelationshipSummariesResponse, MetadataSourceOptions, MetadataSourceRequestBody, NameListResponse, NameRequestBody, NewAttachmentRequestBody, NewClassificationRequestBody, NewElementOptions, NewElementRequestBody, NewExternalIdRequestBody, NewLinkedElementOptions, NewOpenMetadataClassificationRequestBody, NewOpenMetadataElementRequestBody, NewRelatedElementsRequestBody, NewRelationshipRequestBody, OCFConnectionResponse, OCFConnectorTypeResponse, OMAGOMFAPIResponse, OMAGServerConfigResponse, OMAGServerConfigsResponse, OMAGServerStatusResponse, OMAGServerStatusResponse, OMRSAPIFindRequest, OMRSAPIHistoricalFindRequest, OMRSAPIPagedFindRequest, OMRSAPIPagedResponse, OMRSAPIRequest, OMRSAPIResponse, OpenMetadataDeleteRequestBody, OpenMetadataElementResponse, OpenMetadataElementsResponse, OpenMetadataGraphResponse, OpenMetadataRelationshipListResponse, OpenMetadataRelationshipResponse, OpenMetadataRootElementResponse, OpenMetadataRootElementsResponse, OpenMetadataTemplateRequestBody, PagingOptions, PlatformReportResponse, PropertiesResponse, PropertyComparisonOperatorListResponse, PropertyMatchFindRequest, PropertyMatchHistoricalFindRequest, ProxyClassificationRequest, QueryOptions, RegisteredGovernanceServiceResponse, RegisteredGovernanceServicesResponse, RegisteredIntegrationConnectorResponse, RegisteredIntegrationConnectorsResponse, RegisteredOMAGServiceResponse, RegisteredOMAGServicesResponse, RelatedEntitiesFindRequest, RelatedEntitiesHistoricalFindRequest, RelatedMetadataElementListResponse, RelatedMetadataElementsResponse, RelatedMetadataElementSummariesResponse, RelationshipCreateRequest, RelationshipFindRequest, RelationshipHistoricalFindRequest, RelationshipListResponse, RelationshipRequest, RelationshipResponse, ResultsRequestBody, SearchOptions, SearchStringRequestBody, SecurityTagQueryProperties, SemanticAssignmentQueryProperties, ServerListResponse, ServerReportResponse, ServerServicesListResponse, ServerStatusResponse, ServerTypeClassificationResponse, StringMapResponse, StringResponse, SubtypeLimitedFindRequest, SuccessMessageResponse, SuccessMessageResponse, TabularDataSetReportResponse, TechnologyTypeHierarchyResponse, TechnologyTypeReportResponse, TechnologyTypeSummaryListResponse, TemplateOptions, TemplateRequestBody, TranslationDetailResponse, TranslationListResponse, TypeDefCategoryRequest, TypeDefChangeRequest, TypeDefDeleteRequest, TypeDefGalleryRequest, TypeDefGalleryResponse, TypeDefGalleryResponse, TypeDefListResponse, TypeDefListResponse, TypeDefPatchRequest, TypeDefPropertiesRequest, TypeDefReIdentifyRequest, TypeDefRequest, TypeDefResponse, TypeDefResponse, TypeDefValidationForRequest, TypeLimitedFindRequest, TypeLimitedFindRequest, TypeLimitedHistoricalFindRequest, TypeLimitedHistoricalFindRequest, UniqueNameRequestBody, UpdateClassificationRequestBody, UpdateEffectivityDatesRequestBody, UpdateElementRequestBody, UpdateOptions, UpdatePropertiesRequestBody, UpdateRelationshipRequestBody, UpdateStatusRequestBody, UpdateWithTemplateOptions, UpdateWithTemplateRequestBody, UserAccountResponse, ValidMetadataValueListResponse, ValidMetadataValueResponse, ViewServiceConfigResponse, ViewServicesResponse, VoidResponse, VoidResponse

public interface RequestIdService
Interface for passing the request id on both request and response bodies. The request id is used to track and correlate requests and responses on the API, in the Audit logs, and in the open metadata repositories.
  • Method Summary

    Modifier and Type
    Method
    Description
    Return the identifier for the request.
    void
    setRequestId(String requestId)
    Set up the identifier for the request.
  • Method Details

    • getRequestId

      String getRequestId()
      Return the identifier for the request.
      Returns:
      string guid
    • setRequestId

      void setRequestId(String requestId)
      Set up the identifier for the request.
      Parameters:
      requestId - string guid