dataproducthubapiservicev1 package - github.com/IBM/data-product-exchange-go-sdk/v4/dataproducthubapiservicev1 - Go Packages

dataproducthubapiservicev1

package
v4.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 18, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package dataproducthubapiservicev1 : Operations and models for the DataProductHubAPIServiceV1 service

Index

Constants

View Source
const (
	ContainerReferenceTypeCatalogConst = "catalog"
	ContainerReferenceTypeProjectConst = "project"
)

Constants associated with the ContainerReference.Type property. Container type.

View Source
const (
	ContractTermsDocumentTypeSLAConst                = "sla"
	ContractTermsDocumentTypeTermsAndConditionsConst = "terms_and_conditions"
)

Constants associated with the ContractTermsDocument.Type property. Type of the contract document.

View Source
const (
	ContractTestStatusFailConst = "fail"
	ContractTestStatusPassConst = "pass"
)

Constants associated with the ContractTest.Status property. Status of the contract test (pass or fail).

View Source
const (
	CreateDataProductDraftOptionsStateAvailableConst = "available"
	CreateDataProductDraftOptionsStateDraftConst     = "draft"
	CreateDataProductDraftOptionsStateRetiredConst   = "retired"
)

Constants associated with the CreateDataProductDraftOptions.State property. The state of the data product version. If not specified, the data product version will be created in `draft` state.

View Source
const (
	CreateDataProductDraftOptionsTypesCodeConst = "code"
	CreateDataProductDraftOptionsTypesDataConst = "data"
)

Constants associated with the CreateDataProductDraftOptions.Types property.

View Source
const (
	CreateDraftContractTermsDocumentOptionsTypeSLAConst                = "sla"
	CreateDraftContractTermsDocumentOptionsTypeTermsAndConditionsConst = "terms_and_conditions"
)

Constants associated with the CreateDraftContractTermsDocumentOptions.Type property. Type of the contract document.

View Source
const (
	DqCheckResultStatusErrorConst   = "error"
	DqCheckResultStatusFailedConst  = "failed"
	DqCheckResultStatusPassedConst  = "passed"
	DqCheckResultStatusWarningConst = "warning"
)

Constants associated with the DqCheckResult.Status property. Status of the data quality check.

View Source
const (
	DqLogEntryLevelDebugConst   = "debug"
	DqLogEntryLevelErrorConst   = "error"
	DqLogEntryLevelInfoConst    = "info"
	DqLogEntryLevelWarningConst = "warning"
)

Constants associated with the DqLogEntry.Level property. Log level indicating severity.

View Source
const (
	DataProductDraftStateAvailableConst = "available"
	DataProductDraftStateDraftConst     = "draft"
	DataProductDraftStateRetiredConst   = "retired"
)

Constants associated with the DataProductDraft.State property. The state of the data product version.

View Source
const (
	DataProductDraftTypesCodeConst = "code"
	DataProductDraftTypesDataConst = "data"
)

Constants associated with the DataProductDraft.Types property.

View Source
const (
	DataProductDraftPrototypeStateAvailableConst = "available"
	DataProductDraftPrototypeStateDraftConst     = "draft"
	DataProductDraftPrototypeStateRetiredConst   = "retired"
)

Constants associated with the DataProductDraftPrototype.State property. The state of the data product version. If not specified, the data product version will be created in `draft` state.

View Source
const (
	DataProductDraftPrototypeTypesCodeConst = "code"
	DataProductDraftPrototypeTypesDataConst = "data"
)

Constants associated with the DataProductDraftPrototype.Types property.

View Source
const (
	DataProductDraftSummaryStateAvailableConst = "available"
	DataProductDraftSummaryStateDraftConst     = "draft"
	DataProductDraftSummaryStateRetiredConst   = "retired"
)

Constants associated with the DataProductDraftSummary.State property. The state of the data product version.

View Source
const (
	DataProductDraftSummaryTypesCodeConst = "code"
	DataProductDraftSummaryTypesDataConst = "data"
)

Constants associated with the DataProductDraftSummary.Types property.

View Source
const (
	DataProductReleaseStateAvailableConst = "available"
	DataProductReleaseStateDraftConst     = "draft"
	DataProductReleaseStateRetiredConst   = "retired"
)

Constants associated with the DataProductRelease.State property. The state of the data product version.

View Source
const (
	DataProductReleaseTypesCodeConst = "code"
	DataProductReleaseTypesDataConst = "data"
)

Constants associated with the DataProductRelease.Types property.

View Source
const (
	DataProductReleaseSummaryStateAvailableConst = "available"
	DataProductReleaseSummaryStateDraftConst     = "draft"
	DataProductReleaseSummaryStateRetiredConst   = "retired"
)

Constants associated with the DataProductReleaseSummary.State property. The state of the data product version.

View Source
const (
	DataProductReleaseSummaryTypesCodeConst = "code"
	DataProductReleaseSummaryTypesDataConst = "data"
)

Constants associated with the DataProductReleaseSummary.Types property.

View Source
const (
	DataProductVersionSummaryStateAvailableConst = "available"
	DataProductVersionSummaryStateDraftConst     = "draft"
	DataProductVersionSummaryStateRetiredConst   = "retired"
)

Constants associated with the DataProductVersionSummary.State property. The state of the data product version.

View Source
const (
	DataProductVersionSummaryTypesCodeConst = "code"
	DataProductVersionSummaryTypesDataConst = "data"
)

Constants associated with the DataProductVersionSummary.Types property.

View Source
const (
	EngineDetailsModelEngineTypePrestoConst = "presto"
	EngineDetailsModelEngineTypeSparkConst  = "spark"
)

Constants associated with the EngineDetailsModel.EngineType property. The type of the engine (eg: Presto/Spark).

View Source
const (
	ErrorModelResourceCodeAlreadyExistsConst          = "already_exists"
	ErrorModelResourceCodeConfigurationErrorConst     = "configuration_error"
	ErrorModelResourceCodeConflictConst               = "conflict"
	ErrorModelResourceCodeConstraintViolationConst    = "constraint_violation"
	ErrorModelResourceCodeCreateErrorConst            = "create_error"
	ErrorModelResourceCodeDataErrorConst              = "data_error"
	ErrorModelResourceCodeDatabaseErrorConst          = "database_error"
	ErrorModelResourceCodeDatabaseQueryErrorConst     = "database_query_error"
	ErrorModelResourceCodeDatabaseUsageLimitsConst    = "database_usage_limits"
	ErrorModelResourceCodeDeleteErrorConst            = "delete_error"
	ErrorModelResourceCodeDeletedConst                = "deleted"
	ErrorModelResourceCodeDependentServiceErrorConst  = "dependent_service_error"
	ErrorModelResourceCodeDoesNotExistConst           = "does_not_exist"
	ErrorModelResourceCodeEntitlementEnforcementConst = "entitlement_enforcement"
	ErrorModelResourceCodeFeatureNotEnabledConst      = "feature_not_enabled"
	ErrorModelResourceCodeFetchErrorConst             = "fetch_error"
	ErrorModelResourceCodeForbiddenConst              = "forbidden"
	ErrorModelResourceCodeGovernancePolicyDenialConst = "governance_policy_denial"
	ErrorModelResourceCodeInactiveUserConst           = "inactive_user"
	ErrorModelResourceCodeInvalidParameterConst       = "invalid_parameter"
	ErrorModelResourceCodeMissingAssetDetailsConst    = "missing_asset_details"
	ErrorModelResourceCodeMissingRequiredValueConst   = "missing_required_value"
	ErrorModelResourceCodeNotAuthenticatedConst       = "not_authenticated"
	ErrorModelResourceCodeNotAuthorizedConst          = "not_authorized"
	ErrorModelResourceCodeNotImplementedConst         = "not_implemented"
	ErrorModelResourceCodePatchErrorConst             = "patch_error"
	ErrorModelResourceCodeRequestBodyErrorConst       = "request_body_error"
	ErrorModelResourceCodeTooManyRequestsConst        = "too_many_requests"
	ErrorModelResourceCodeUnableToPerformConst        = "unable_to_perform"
	ErrorModelResourceCodeUnexpectedExceptionConst    = "unexpected_exception"
	ErrorModelResourceCodeUpdateErrorConst            = "update_error"
)

Constants associated with the ErrorModelResource.Code property. Error code.

View Source
const (
	InitializeOptionsIncludeCatalogConfigurationsConst    = "catalog_configurations"
	InitializeOptionsIncludeDataProductSamplesConst       = "data_product_samples"
	InitializeOptionsIncludeDeliveryMethodsConst          = "delivery_methods"
	InitializeOptionsIncludeDomainsMultiIndustryConst     = "domains_multi_industry"
	InitializeOptionsIncludeFunctionalAdminUserGroupConst = "functional_admin_user_group"
	InitializeOptionsIncludeGenAiOnboardingConst          = "gen_ai_onboarding"
	InitializeOptionsIncludeProjectConst                  = "project"
	InitializeOptionsIncludeWorkflowsConst                = "workflows"
)

Constants associated with the InitializeOptions.Include property.

View Source
const (
	InitializeResourceStatusFailedConst     = "failed"
	InitializeResourceStatusInProgressConst = "in_progress"
	InitializeResourceStatusNotStartedConst = "not_started"
	InitializeResourceStatusSucceededConst  = "succeeded"
)

Constants associated with the InitializeResource.Status property. Status of the initialize operation.

View Source
const (
	JSONPatchOperationOpAddConst     = "add"
	JSONPatchOperationOpCopyConst    = "copy"
	JSONPatchOperationOpMoveConst    = "move"
	JSONPatchOperationOpRemoveConst  = "remove"
	JSONPatchOperationOpReplaceConst = "replace"
	JSONPatchOperationOpTestConst    = "test"
)

Constants associated with the JSONPatchOperation.Op property. The operation to be performed.

View Source
const (
	ListDataProductReleasesOptionsStateAvailableConst = "available"
	ListDataProductReleasesOptionsStateRetiredConst   = "retired"
)

Constants associated with the ListDataProductReleasesOptions.State property.

View Source
const DefaultServiceName = "data_product_hub_api_service"

DefaultServiceName is the default key used to find external configuration information.

Variables

This section is empty.

Functions

func GetServiceURLForRegion

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAsset added in v4.1.0

func UnmarshalAsset(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAsset unmarshals an instance of Asset from the specified map of raw messages.

func UnmarshalAssetListAccessControl

func UnmarshalAssetListAccessControl(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAssetListAccessControl unmarshals an instance of AssetListAccessControl from the specified map of raw messages.

func UnmarshalAssetPartReference

func UnmarshalAssetPartReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAssetPartReference unmarshals an instance of AssetPartReference from the specified map of raw messages.

func UnmarshalAssetPrototype

func UnmarshalAssetPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAssetPrototype unmarshals an instance of AssetPrototype from the specified map of raw messages.

func UnmarshalAssetReference

func UnmarshalAssetReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAssetReference unmarshals an instance of AssetReference from the specified map of raw messages.

func UnmarshalBucketResponse

func UnmarshalBucketResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBucketResponse unmarshals an instance of BucketResponse from the specified map of raw messages.

func UnmarshalBucketValidationResponse

func UnmarshalBucketValidationResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBucketValidationResponse unmarshals an instance of BucketValidationResponse from the specified map of raw messages.

func UnmarshalContainerIdentity

func UnmarshalContainerIdentity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContainerIdentity unmarshals an instance of ContainerIdentity from the specified map of raw messages.

func UnmarshalContainerReference

func UnmarshalContainerReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContainerReference unmarshals an instance of ContainerReference from the specified map of raw messages.

func UnmarshalContractAsset added in v4.1.0

func UnmarshalContractAsset(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractAsset unmarshals an instance of ContractAsset from the specified map of raw messages.

func UnmarshalContractAuthoritativeDefinition added in v4.2.0

func UnmarshalContractAuthoritativeDefinition(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractAuthoritativeDefinition unmarshals an instance of ContractAuthoritativeDefinition from the specified map of raw messages.

func UnmarshalContractLogicalTypeOptions added in v4.2.0

func UnmarshalContractLogicalTypeOptions(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractLogicalTypeOptions unmarshals an instance of ContractLogicalTypeOptions from the specified map of raw messages.

func UnmarshalContractQualityRule added in v4.1.0

func UnmarshalContractQualityRule(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractQualityRule unmarshals an instance of ContractQualityRule from the specified map of raw messages.

func UnmarshalContractSchema

func UnmarshalContractSchema(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractSchema unmarshals an instance of ContractSchema from the specified map of raw messages.

func UnmarshalContractSchemaProperty

func UnmarshalContractSchemaProperty(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractSchemaProperty unmarshals an instance of ContractSchemaProperty from the specified map of raw messages.

func UnmarshalContractSchemaRelationship added in v4.2.0

func UnmarshalContractSchemaRelationship(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractSchemaRelationship unmarshals an instance of ContractSchemaRelationship from the specified map of raw messages.

func UnmarshalContractServer added in v4.1.0

func UnmarshalContractServer(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractServer unmarshals an instance of ContractServer from the specified map of raw messages.

func UnmarshalContractTemplateCustomProperty

func UnmarshalContractTemplateCustomProperty(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTemplateCustomProperty unmarshals an instance of ContractTemplateCustomProperty from the specified map of raw messages.

func UnmarshalContractTemplateMember added in v4.2.0

func UnmarshalContractTemplateMember(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTemplateMember unmarshals an instance of ContractTemplateMember from the specified map of raw messages.

func UnmarshalContractTemplateSLA

func UnmarshalContractTemplateSLA(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTemplateSLA unmarshals an instance of ContractTemplateSLA from the specified map of raw messages.

func UnmarshalContractTemplateSLAProperty

func UnmarshalContractTemplateSLAProperty(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTemplateSLAProperty unmarshals an instance of ContractTemplateSLAProperty from the specified map of raw messages.

func UnmarshalContractTemplateSupportAndCommunication

func UnmarshalContractTemplateSupportAndCommunication(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTemplateSupportAndCommunication unmarshals an instance of ContractTemplateSupportAndCommunication from the specified map of raw messages.

func UnmarshalContractTerms

func UnmarshalContractTerms(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTerms unmarshals an instance of ContractTerms from the specified map of raw messages.

func UnmarshalContractTermsDocument

func UnmarshalContractTermsDocument(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTermsDocument unmarshals an instance of ContractTermsDocument from the specified map of raw messages.

func UnmarshalContractTermsDocumentAttachment

func UnmarshalContractTermsDocumentAttachment(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTermsDocumentAttachment unmarshals an instance of ContractTermsDocumentAttachment from the specified map of raw messages.

func UnmarshalContractTermsTeam added in v4.2.0

func UnmarshalContractTermsTeam(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTermsTeam unmarshals an instance of ContractTermsTeam from the specified map of raw messages.

func UnmarshalContractTest

func UnmarshalContractTest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTest unmarshals an instance of ContractTest from the specified map of raw messages.

func UnmarshalContractTestSummary added in v4.2.0

func UnmarshalContractTestSummary(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractTestSummary unmarshals an instance of ContractTestSummary from the specified map of raw messages.

func UnmarshalContractValidationResponse added in v4.2.0

func UnmarshalContractValidationResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContractValidationResponse unmarshals an instance of ContractValidationResponse from the specified map of raw messages.

func UnmarshalDataAssetRelationship

func UnmarshalDataAssetRelationship(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataAssetRelationship unmarshals an instance of DataAssetRelationship from the specified map of raw messages.

func UnmarshalDataAssetVisualizationRes

func UnmarshalDataAssetVisualizationRes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataAssetVisualizationRes unmarshals an instance of DataAssetVisualizationRes from the specified map of raw messages.

func UnmarshalDataContractDqTestResult added in v4.2.0

func UnmarshalDataContractDqTestResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataContractDqTestResult unmarshals an instance of DataContractDqTestResult from the specified map of raw messages.

func UnmarshalDataProduct

func UnmarshalDataProduct(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProduct unmarshals an instance of DataProduct from the specified map of raw messages.

func UnmarshalDataProductCollection

func UnmarshalDataProductCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductCollection unmarshals an instance of DataProductCollection from the specified map of raw messages.

func UnmarshalDataProductContractTemplate

func UnmarshalDataProductContractTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductContractTemplate unmarshals an instance of DataProductContractTemplate from the specified map of raw messages.

func UnmarshalDataProductContractTemplateCollection

func UnmarshalDataProductContractTemplateCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductContractTemplateCollection unmarshals an instance of DataProductContractTemplateCollection from the specified map of raw messages.

func UnmarshalDataProductCustomWorkflowDefinition

func UnmarshalDataProductCustomWorkflowDefinition(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductCustomWorkflowDefinition unmarshals an instance of DataProductCustomWorkflowDefinition from the specified map of raw messages.

func UnmarshalDataProductDomain

func UnmarshalDataProductDomain(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductDomain unmarshals an instance of DataProductDomain from the specified map of raw messages.

func UnmarshalDataProductDomainCollection

func UnmarshalDataProductDomainCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductDomainCollection unmarshals an instance of DataProductDomainCollection from the specified map of raw messages.

func UnmarshalDataProductDraft

func UnmarshalDataProductDraft(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductDraft unmarshals an instance of DataProductDraft from the specified map of raw messages.

func UnmarshalDataProductDraftCollection

func UnmarshalDataProductDraftCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductDraftCollection unmarshals an instance of DataProductDraftCollection from the specified map of raw messages.

func UnmarshalDataProductDraftDataProduct

func UnmarshalDataProductDraftDataProduct(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductDraftDataProduct unmarshals an instance of DataProductDraftDataProduct from the specified map of raw messages.

func UnmarshalDataProductDraftPrototype

func UnmarshalDataProductDraftPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductDraftPrototype unmarshals an instance of DataProductDraftPrototype from the specified map of raw messages.

func UnmarshalDataProductDraftSummary

func UnmarshalDataProductDraftSummary(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductDraftSummary unmarshals an instance of DataProductDraftSummary from the specified map of raw messages.

func UnmarshalDataProductDraftSummaryDataProduct

func UnmarshalDataProductDraftSummaryDataProduct(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductDraftSummaryDataProduct unmarshals an instance of DataProductDraftSummaryDataProduct from the specified map of raw messages.

func UnmarshalDataProductDraftVersionRelease

func UnmarshalDataProductDraftVersionRelease(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductDraftVersionRelease unmarshals an instance of DataProductDraftVersionRelease from the specified map of raw messages.

func UnmarshalDataProductIdentity

func UnmarshalDataProductIdentity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductIdentity unmarshals an instance of DataProductIdentity from the specified map of raw messages.

func UnmarshalDataProductOrderAccessRequest

func UnmarshalDataProductOrderAccessRequest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductOrderAccessRequest unmarshals an instance of DataProductOrderAccessRequest from the specified map of raw messages.

func UnmarshalDataProductPart

func UnmarshalDataProductPart(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductPart unmarshals an instance of DataProductPart from the specified map of raw messages.

func UnmarshalDataProductRelease

func UnmarshalDataProductRelease(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductRelease unmarshals an instance of DataProductRelease from the specified map of raw messages.

func UnmarshalDataProductReleaseCollection

func UnmarshalDataProductReleaseCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductReleaseCollection unmarshals an instance of DataProductReleaseCollection from the specified map of raw messages.

func UnmarshalDataProductReleaseDataProduct

func UnmarshalDataProductReleaseDataProduct(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductReleaseDataProduct unmarshals an instance of DataProductReleaseDataProduct from the specified map of raw messages.

func UnmarshalDataProductReleaseSummary

func UnmarshalDataProductReleaseSummary(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductReleaseSummary unmarshals an instance of DataProductReleaseSummary from the specified map of raw messages.

func UnmarshalDataProductReleaseSummaryDataProduct

func UnmarshalDataProductReleaseSummaryDataProduct(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductReleaseSummaryDataProduct unmarshals an instance of DataProductReleaseSummaryDataProduct from the specified map of raw messages.

func UnmarshalDataProductSummary

func UnmarshalDataProductSummary(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductSummary unmarshals an instance of DataProductSummary from the specified map of raw messages.

func UnmarshalDataProductVersionCollection

func UnmarshalDataProductVersionCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductVersionCollection unmarshals an instance of DataProductVersionCollection from the specified map of raw messages.

func UnmarshalDataProductVersionSummary

func UnmarshalDataProductVersionSummary(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductVersionSummary unmarshals an instance of DataProductVersionSummary from the specified map of raw messages.

func UnmarshalDataProductVersionSummaryDataProduct

func UnmarshalDataProductVersionSummaryDataProduct(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductVersionSummaryDataProduct unmarshals an instance of DataProductVersionSummaryDataProduct from the specified map of raw messages.

func UnmarshalDataProductWorkflows

func UnmarshalDataProductWorkflows(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataProductWorkflows unmarshals an instance of DataProductWorkflows from the specified map of raw messages.

func UnmarshalDeliveryMethod

func UnmarshalDeliveryMethod(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeliveryMethod unmarshals an instance of DeliveryMethod from the specified map of raw messages.

func UnmarshalDeliveryMethodConfig added in v4.2.0

func UnmarshalDeliveryMethodConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeliveryMethodConfig unmarshals an instance of DeliveryMethodConfig from the specified map of raw messages.

func UnmarshalDeliveryMethodPropertiesModel

func UnmarshalDeliveryMethodPropertiesModel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeliveryMethodPropertiesModel unmarshals an instance of DeliveryMethodPropertiesModel from the specified map of raw messages.

func UnmarshalDeliveryMethodRes added in v4.2.0

func UnmarshalDeliveryMethodRes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeliveryMethodRes unmarshals an instance of DeliveryMethodRes from the specified map of raw messages.

func UnmarshalDeliveryMethodResCollection added in v4.2.0

func UnmarshalDeliveryMethodResCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeliveryMethodResCollection unmarshals an instance of DeliveryMethodResCollection from the specified map of raw messages.

func UnmarshalDescription

func UnmarshalDescription(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDescription unmarshals an instance of Description from the specified map of raw messages.

func UnmarshalDomain

func UnmarshalDomain(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDomain unmarshals an instance of Domain from the specified map of raw messages.

func UnmarshalDqCheckResult added in v4.2.0

func UnmarshalDqCheckResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDqCheckResult unmarshals an instance of DqCheckResult from the specified map of raw messages.

func UnmarshalDqConnection added in v4.2.0

func UnmarshalDqConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDqConnection unmarshals an instance of DqConnection from the specified map of raw messages.

func UnmarshalDqContract added in v4.2.0

func UnmarshalDqContract(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDqContract unmarshals an instance of DqContract from the specified map of raw messages.

func UnmarshalDqDataset added in v4.2.0

func UnmarshalDqDataset(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDqDataset unmarshals an instance of DqDataset from the specified map of raw messages.

func UnmarshalDqLogEntry added in v4.2.0

func UnmarshalDqLogEntry(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDqLogEntry unmarshals an instance of DqLogEntry from the specified map of raw messages.

func UnmarshalDqRule added in v4.2.0

func UnmarshalDqRule(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDqRule unmarshals an instance of DqRule from the specified map of raw messages.

func UnmarshalDqServerMapping added in v4.2.0

func UnmarshalDqServerMapping(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDqServerMapping unmarshals an instance of DqServerMapping from the specified map of raw messages.

func UnmarshalEngineDetailsModel

func UnmarshalEngineDetailsModel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEngineDetailsModel unmarshals an instance of EngineDetailsModel from the specified map of raw messages.

func UnmarshalErrorExtraResource

func UnmarshalErrorExtraResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalErrorExtraResource unmarshals an instance of ErrorExtraResource from the specified map of raw messages.

func UnmarshalErrorMessage

func UnmarshalErrorMessage(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalErrorMessage unmarshals an instance of ErrorMessage from the specified map of raw messages.

func UnmarshalErrorModelResource

func UnmarshalErrorModelResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalErrorModelResource unmarshals an instance of ErrorModelResource from the specified map of raw messages.

func UnmarshalFirstPage

func UnmarshalFirstPage(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalFirstPage unmarshals an instance of FirstPage from the specified map of raw messages.

func UnmarshalInitializeResource

func UnmarshalInitializeResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalInitializeResource unmarshals an instance of InitializeResource from the specified map of raw messages.

func UnmarshalInitializeSubDomain

func UnmarshalInitializeSubDomain(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalInitializeSubDomain unmarshals an instance of InitializeSubDomain from the specified map of raw messages.

func UnmarshalInitializedOption

func UnmarshalInitializedOption(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalInitializedOption unmarshals an instance of InitializedOption from the specified map of raw messages.

func UnmarshalJSONPatchOperation

func UnmarshalJSONPatchOperation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalJSONPatchOperation unmarshals an instance of JSONPatchOperation from the specified map of raw messages.

func UnmarshalMemberRolesSchema

func UnmarshalMemberRolesSchema(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMemberRolesSchema unmarshals an instance of MemberRolesSchema from the specified map of raw messages.

func UnmarshalNextPage

func UnmarshalNextPage(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNextPage unmarshals an instance of NextPage from the specified map of raw messages.

func UnmarshalOverview

func UnmarshalOverview(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalOverview unmarshals an instance of Overview from the specified map of raw messages.

func UnmarshalPricing

func UnmarshalPricing(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPricing unmarshals an instance of Pricing from the specified map of raw messages.

func UnmarshalProducerInputModel

func UnmarshalProducerInputModel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProducerInputModel unmarshals an instance of ProducerInputModel from the specified map of raw messages.

func UnmarshalPropertiesSchema

func UnmarshalPropertiesSchema(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPropertiesSchema unmarshals an instance of PropertiesSchema from the specified map of raw messages.

func UnmarshalProvidedCatalogWorkflows

func UnmarshalProvidedCatalogWorkflows(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProvidedCatalogWorkflows unmarshals an instance of ProvidedCatalogWorkflows from the specified map of raw messages.

func UnmarshalProvidedWorkflowResource

func UnmarshalProvidedWorkflowResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProvidedWorkflowResource unmarshals an instance of ProvidedWorkflowResource from the specified map of raw messages.

func UnmarshalRevokeAccessResponse added in v4.1.0

func UnmarshalRevokeAccessResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRevokeAccessResponse unmarshals an instance of RevokeAccessResponse from the specified map of raw messages.

func UnmarshalRevokeAccessStateResponse added in v4.1.0

func UnmarshalRevokeAccessStateResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRevokeAccessStateResponse unmarshals an instance of RevokeAccessStateResponse from the specified map of raw messages.

func UnmarshalRoles

func UnmarshalRoles(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRoles unmarshals an instance of Roles from the specified map of raw messages.

func UnmarshalSearchAssetPaginationInfo added in v4.1.0

func UnmarshalSearchAssetPaginationInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSearchAssetPaginationInfo unmarshals an instance of SearchAssetPaginationInfo from the specified map of raw messages.

func UnmarshalServerMapping added in v4.2.0

func UnmarshalServerMapping(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalServerMapping unmarshals an instance of ServerMapping from the specified map of raw messages.

func UnmarshalServiceIDCredentials

func UnmarshalServiceIDCredentials(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalServiceIDCredentials unmarshals an instance of ServiceIDCredentials from the specified map of raw messages.

func UnmarshalUseCase

func UnmarshalUseCase(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUseCase unmarshals an instance of UseCase from the specified map of raw messages.

func UnmarshalVisualization

func UnmarshalVisualization(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalVisualization unmarshals an instance of Visualization from the specified map of raw messages.

func UnmarshalWorkflowDefinitionReference

func UnmarshalWorkflowDefinitionReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWorkflowDefinitionReference unmarshals an instance of WorkflowDefinitionReference from the specified map of raw messages.

Types

type Asset added in v4.1.0

type Asset struct {
	// Metadata information about the asset.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Entity information containing the asset details.
	Entity map[string]interface{} `json:"entity,omitempty"`
}

Asset : Asset struct

type AssetListAccessControl

type AssetListAccessControl struct {
	// The owner of the asset.
	Owner *string `json:"owner,omitempty"`
}

AssetListAccessControl : Access control object.

type AssetPartReference

type AssetPartReference struct {
	// The unique identifier of the asset.
	ID *string `json:"id,omitempty"`

	// Asset name.
	Name *string `json:"name,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`

	// The type of the asset.
	Type *string `json:"type,omitempty"`
}

AssetPartReference : The asset represented in this part.

type AssetPrototype

type AssetPrototype struct {
	// The unique identifier of the asset.
	ID *string `json:"id,omitempty"`

	// The identity schema for a IBM knowledge catalog container (catalog/project/space).
	Container *ContainerIdentity `json:"container" validate:"required"`
}

AssetPrototype : New asset input properties.

type AssetReference

type AssetReference struct {
	// The unique identifier of the asset.
	ID *string `json:"id,omitempty"`

	// Asset name.
	Name *string `json:"name,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`
}

AssetReference : The reference schema for a asset in a container.

type BucketResponse

type BucketResponse struct {
	// Name of the Bucket.
	BucketName *string `json:"bucket_name,omitempty"`

	// Location of the Bucket stored.
	BucketLocation *string `json:"bucket_location,omitempty"`

	// Role ARN.
	RoleArn *string `json:"role_arn,omitempty"`

	// Bucket Type.
	BucketType *string `json:"bucket_type,omitempty"`

	// Is Shared Bucket.
	Shared *bool `json:"shared,omitempty"`
}

BucketResponse : BucketResponse to hold the Bucket response data.

type BucketValidationResponse

type BucketValidationResponse struct {
	// Flag of bucket existence.
	BucketExists *bool `json:"bucket_exists,omitempty"`
}

BucketValidationResponse : BucketValidationResponse to hold the bucket validation data.

type CompleteDraftContractTermsDocumentOptions

type CompleteDraftContractTermsDocumentOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// Document id.
	DocumentID *string `json:"document_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CompleteDraftContractTermsDocumentOptions : The CompleteDraftContractTermsDocument options.

func (*CompleteDraftContractTermsDocumentOptions) SetContractTermsID

SetContractTermsID : Allow user to set ContractTermsID

func (*CompleteDraftContractTermsDocumentOptions) SetDataProductID

SetDataProductID : Allow user to set DataProductID

func (*CompleteDraftContractTermsDocumentOptions) SetDocumentID

SetDocumentID : Allow user to set DocumentID

func (*CompleteDraftContractTermsDocumentOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*CompleteDraftContractTermsDocumentOptions) SetHeaders

SetHeaders : Allow user to set Headers

type ContainerIdentity

type ContainerIdentity struct {
	// Container identifier.
	ID *string `json:"id" validate:"required"`
}

ContainerIdentity : The identity schema for a IBM knowledge catalog container (catalog/project/space).

type ContainerReference

type ContainerReference struct {
	// Container identifier.
	ID *string `json:"id" validate:"required"`

	// Container type.
	Type *string `json:"type" validate:"required"`
}

ContainerReference : Container reference.

type ContractAsset added in v4.1.0

type ContractAsset struct {
	// ID of the data asset.
	ID *string `json:"id,omitempty"`

	// Name of the data asset.
	Name *string `json:"name,omitempty"`
}

ContractAsset : Defines a data asset name and id.

type ContractAuthoritativeDefinition added in v4.2.0

type ContractAuthoritativeDefinition struct {
	// Unique identifier for the authoritative definition.
	ID *string `json:"id,omitempty"`

	// The URL of the authoritative data source.
	URL *string `json:"url" validate:"required"`

	// The type of the authoritative data source.
	Type *string `json:"type" validate:"required"`

	// Description of the authoritative definition.
	Description *string `json:"description,omitempty"`
}

ContractAuthoritativeDefinition : Defines a quality rule for validating data assets.

type ContractLogicalTypeOptions added in v4.2.0

type ContractLogicalTypeOptions struct {
	// Format specification for the logical type (e.g., 'date-time', 'email', 'uuid').
	Format *string `json:"format,omitempty"`

	// Minimum value for numeric types or minimum date/time.
	Minimum *string `json:"minimum,omitempty"`

	// Maximum value for numeric types or maximum date/time.
	Maximum *string `json:"maximum,omitempty"`

	// Minimum length for string types.
	MinLength *int64 `json:"min_length,omitempty"`

	// Maximum length for string types.
	MaxLength *int64 `json:"max_length,omitempty"`

	// Regular expression pattern for string validation.
	Pattern *string `json:"pattern,omitempty"`

	// Values must be strictly less than this (string for date/timestamp, number for integer/number).
	ExclusiveMaximum *string `json:"exclusive_maximum,omitempty"`

	// Values must be strictly greater than this (string for date/timestamp, number for integer/number).
	ExclusiveMinimum *string `json:"exclusive_minimum,omitempty"`

	// Whether timezone is included (for logicalType='timestamp' or 'time').
	Timezone *bool `json:"timezone,omitempty"`

	// Default timezone (default: 'Etc/UTC') (for logicalType='timestamp' or 'time').
	DefaultTimezone *string `json:"default_timezone,omitempty"`

	// Values must be multiples of this (for logicalType='integer' or 'number').
	MultipleOf *float64 `json:"multiple_of,omitempty"`

	// Maximum number of properties (for logicalType='object').
	MaxProperties *int64 `json:"max_properties,omitempty"`

	// Minimum number of properties (default: 0) (for logicalType='object').
	MinProperties *int64 `json:"min_properties,omitempty"`

	// Property names that must exist in the object (for logicalType='object').
	Required []string `json:"required,omitempty"`

	// Maximum number of items (for logicalType='array').
	MaxItems *int64 `json:"max_items,omitempty"`

	// Minimum number of items (default: 0) (for logicalType='array').
	MinItems *int64 `json:"min_items,omitempty"`

	// Whether all items must be unique (default: false) (for logicalType='array').
	UniqueItems *bool `json:"unique_items,omitempty"`
}

ContractLogicalTypeOptions : Additional options for the logical type (e.g., format, minimum, maximum).

type ContractQualityRule added in v4.1.0

type ContractQualityRule struct {
	// Unique identifier for the quality rule.
	ID *string `json:"id,omitempty"`

	// The type of the quality rule: 'text', 'library', or 'sql'.
	Type *string `json:"type" validate:"required"`

	// A descriptive explanation of the quality rule.
	Description *string `json:"description,omitempty"`

	// Tags associated with the quality rule.
	Tags []string `json:"tags,omitempty"`

	// Metric name used by the quality rule (if applicable).
	Metric *string `json:"metric,omitempty"`

	// Threshold value used by the quality rule.
	Threshold *string `json:"threshold,omitempty"`

	// Allowed/valid values for the quality rule.
	ValidValues []string `json:"valid_values,omitempty"`

	// Dimension used by the quality rule.
	Dimension *string `json:"dimension,omitempty"`

	// Method used to evaluate the quality rule.
	Method *string `json:"method,omitempty"`

	// Severity level for the quality rule (e.g., low, medium, high).
	Severity *string `json:"severity,omitempty"`

	// Business impact description for rule violations.
	BusinessImpact *string `json:"business_impact,omitempty"`

	// Scheduler identifier for periodic rule execution.
	Scheduler *string `json:"scheduler,omitempty"`

	// Schedule expression (cron or human-readable) for running the rule.
	Schedule *string `json:"schedule,omitempty"`

	// The name or identifier of the library-based quality rule to be applied.
	Rule *string `json:"rule,omitempty"`

	// A text (non-parsed) block of code required for the third-party DQ engine to run.
	Implementation *string `json:"implementation,omitempty"`

	// Required for custom DQ rule: name of the third-party engine being used. Common values include soda,
	// greatExpectations, montecarlo, etc.
	Engine *string `json:"engine,omitempty"`

	// The threshold value that the quality check result must be less than.
	MustBeLessThan *string `json:"must_be_less_than,omitempty"`

	// The threshold value that the quality check result must be less than or equal to.
	MustBeLessOrEqualTo *string `json:"must_be_less_or_equal_to,omitempty"`

	// The threshold value that the quality check result must be greater than.
	MustBeGreaterThan *string `json:"must_be_greater_than,omitempty"`

	// Custom Properties for Quality Rule.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`

	// The threshold value that the quality check result must be greater than or equal to.
	MustBeGreaterOrEqualTo *string `json:"must_be_greater_or_equal_to,omitempty"`

	// Inclusive range (min and max) for the quality check result.
	MustBeBetween []string `json:"must_be_between,omitempty"`

	// Inclusive range (min and max) the quality check must not fall within.
	MustNotBeBetween []string `json:"must_not_be_between,omitempty"`

	// The exact value(s) the quality check result must match.
	MustBe *string `json:"must_be,omitempty"`

	// The exact value(s) the quality check result must not match.
	MustNotBe *string `json:"must_not_be,omitempty"`

	// User-friendly name for the quality rule.
	Name *string `json:"name,omitempty"`

	// Unit used for evaluating the quality rule (e.g., rows, records).
	Unit *string `json:"unit,omitempty"`

	// The SQL query to execute for validating quality in case of a 'sql' rule type.
	Query *string `json:"query,omitempty"`

	// Additional arguments for the metric (when type='library'). A dictionary/map of key-value pairs.
	Arguments map[string]interface{} `json:"arguments,omitempty"`

	// List of links to sources that provide more details on the data contract.
	AuthoritativeDefinitions []ContractAuthoritativeDefinition `json:"authoritative_definitions,omitempty"`
}

ContractQualityRule : Defines a quality rule for validating data assets.

type ContractSchema

type ContractSchema struct {
	// Unique identifier for the schema object.
	ID *string `json:"id,omitempty"`

	// Id of the data asset whose schema information is stored.
	AssetID *string `json:"asset_id" validate:"required"`

	// Connection Id of the data asset whose schema information is stored.
	ConnectionID *string `json:"connection_id" validate:"required"`

	// Name of the schema or data asset part.
	Name *string `json:"name,omitempty"`

	// Type of schema (e.g., table, view).
	Type *string `json:"type,omitempty"`

	// Description of the schema.
	Description *string `json:"description,omitempty"`

	// Connection path of the asset.
	ConnectionPath *string `json:"connection_path,omitempty"`

	// MIME type or physical type.
	PhysicalType *string `json:"physical_type,omitempty"`

	// The business name of the element.
	BusinessName *string `json:"business_name,omitempty"`

	// The logical element data type.
	LogicalType *string `json:"logical_type,omitempty"`

	// Physical name of the element.
	PhysicalName *string `json:"physical_name,omitempty"`

	// Granular level of the data in the object.
	DataGranularityDescription *string `json:"data_granularity_description,omitempty"`

	// Physical schema name.
	PhysicalSchema *string `json:"physical_schema,omitempty"`

	// Reference to server.
	Server *string `json:"server,omitempty"`

	// Links to sources that provide more details on the schema.
	AuthoritativeDefinitions []ContractAuthoritativeDefinition `json:"authoritative_definitions,omitempty"`

	// Tags for categorizing the schema element.
	Tags []string `json:"tags,omitempty"`

	// Custom properties for the schema element.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`

	// List of properties.
	Properties []ContractSchemaProperty `json:"properties,omitempty"`

	// List of quality rules defined for the asset.
	Quality []ContractQualityRule `json:"quality,omitempty"`

	// Relationships between schema objects.
	Relationships []ContractSchemaRelationship `json:"relationships,omitempty"`
}

ContractSchema : Schema definition of the data asset.

type ContractSchemaProperty

type ContractSchemaProperty struct {
	// Unique identifier for the schema property/column.
	ID *string `json:"id,omitempty"`

	// Property name.
	Name *string `json:"name" validate:"required"`

	// Indicates if this property is a primary key.
	PrimaryKey *bool `json:"primary_key,omitempty"`

	// Position of this property in the primary key (if applicable).
	PrimaryKeyPosition *int64 `json:"primary_key_position,omitempty"`

	// Logical data type of the property.
	LogicalType *string `json:"logical_type,omitempty"`

	// Additional options for the logical type (e.g., format, minimum, maximum).
	LogicalTypeOptions *ContractLogicalTypeOptions `json:"logical_type_options,omitempty"`

	// Physical data type of the property.
	PhysicalType *string `json:"physical_type,omitempty"`

	// Indicates if this property is required.
	Required *bool `json:"required,omitempty"`

	// Indicates if this property must have unique values.
	Unique *bool `json:"unique,omitempty"`

	// Description of the property.
	Description *string `json:"description,omitempty"`

	// Business name of the property.
	BusinessName *string `json:"business_name,omitempty"`

	// Tags for categorizing the property.
	Tags []string `json:"tags,omitempty"`

	// Sample values for the field.
	Examples []string `json:"examples,omitempty"`

	// Indicates if this property is used for partitioning.
	Partitioned *bool `json:"partitioned,omitempty"`

	// Position of this property in the partition key (if applicable).
	PartitionKeyPosition *int64 `json:"partition_key_position,omitempty"`

	// Data classification level (e.g., confidential, public).
	Classification *string `json:"classification,omitempty"`

	// List of quality rules defined for the column.
	Quality []ContractQualityRule `json:"quality,omitempty"`

	// Physical column name in database (e.g., 'col_str_a').
	PhysicalName *string `json:"physical_name,omitempty"`

	// Name of encrypted version of this field (e.g., 'email_address_encrypt').
	EncryptedName *string `json:"encrypted_name,omitempty"`

	// List of source objects used in transformation.
	TransformSourceObjects []string `json:"transform_source_objects,omitempty"`

	// Logic/code used in field transformation.
	TransformLogic *string `json:"transform_logic,omitempty"`

	// Human-readable description of transformation.
	TransformDescription *string `json:"transform_description,omitempty"`

	// Whether this is a critical data element (CDE).
	CriticalDataElement *bool `json:"critical_data_element,omitempty"`

	// Authoritative definitions for the property.
	AuthoritativeDefinitions []ContractAuthoritativeDefinition `json:"authoritative_definitions,omitempty"`

	// Custom properties for the property.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`

	// Relationships (e.g., foreign keys) for the property.
	Relationships []ContractSchemaRelationship `json:"relationships,omitempty"`
}

ContractSchemaProperty : Defines a property inside the schema.

type ContractSchemaRelationship added in v4.2.0

type ContractSchemaRelationship struct {
	// Type of relationship. Default: 'foreignKey'.
	Type *string `json:"type,omitempty"`

	// Source property/column reference(s). Format: table.column or schema/id/properties/id. Array for single or composite
	// keys.
	From []string `json:"from,omitempty"`

	// Target property/column reference(s). Format: table.column or schema/id/properties/id. Array for single or composite
	// keys.
	To []string `json:"to,omitempty"`

	// Custom properties for the relationship.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`
}

ContractSchemaRelationship : Defines relationships between schema objects (tables) - typically foreign key constraints.

type ContractServer added in v4.1.0

type ContractServer struct {
	// Fully qualified notation using id fields (section/id/properties/id), optionally prefixed with external file
	// reference.
	ID *string `json:"id,omitempty"`

	// Name of the server.
	Server *string `json:"server" validate:"required"`

	// Defines a data asset name and id.
	Asset *ContractAsset `json:"asset,omitempty"`

	// ID of the data source associated with data asset.
	ConnectionID *string `json:"connection_id,omitempty"`

	// Type of the server.
	Type *string `json:"type,omitempty"`

	// Description of the server.
	Description *string `json:"description,omitempty"`

	// Environment in which the server operates.
	Environment *string `json:"environment,omitempty"`

	// Account used by the server.
	Account *string `json:"account,omitempty"`

	// Catalog name.
	Catalog *string `json:"catalog,omitempty"`

	// Database name.
	Database *string `json:"database,omitempty"`

	// Dataset name.
	Dataset *string `json:"dataset,omitempty"`

	// Delimiter.
	Delimiter *string `json:"delimiter,omitempty"`

	// Server endpoint URL.
	EndpointURL *string `json:"endpoint_url,omitempty"`

	// File format.
	Format *string `json:"format,omitempty"`

	// Host name or IP address.
	Host *string `json:"host,omitempty"`

	// Location URL.
	Location *string `json:"location,omitempty"`

	// Relative or absolute path to the data.
	Path *string `json:"path,omitempty"`

	// Port to the server.
	Port *string `json:"port,omitempty"`

	// Project name.
	Project *string `json:"project,omitempty"`

	// Cloud region.
	Region *string `json:"region,omitempty"`

	// Region name.
	RegionName *string `json:"region_name,omitempty"`

	// Schema name.
	Schema *string `json:"schema,omitempty"`

	// Service name.
	ServiceName *string `json:"service_name,omitempty"`

	// Staging directory.
	StagingDir *string `json:"staging_dir,omitempty"`

	// Data stream name.
	Stream *string `json:"stream,omitempty"`

	// Warehouse or cluster name.
	Warehouse *string `json:"warehouse,omitempty"`

	// List of roles for the server.
	Roles []string `json:"roles,omitempty"`

	// List of custom properties for the server.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`
}

ContractServer : Schema definition of a server configuration for the asset.

type ContractTemplateCustomProperty

type ContractTemplateCustomProperty struct {
	// Unique identifier for the custom property.
	ID *string `json:"id,omitempty"`

	// The name of the property. Names should be in camel case–the same as if they were permanent properties in the
	// contract.
	Property *string `json:"property" validate:"required"`

	// The value of the property.
	Value *string `json:"value" validate:"required"`

	// Description of the custom property.
	Description *string `json:"description,omitempty"`
}

ContractTemplateCustomProperty : Represents a custom property within the contract.

type ContractTemplateMember added in v4.2.0

type ContractTemplateMember struct {
	// Unique identifier for the team member.
	ID *string `json:"id,omitempty"`

	// The user ID associated with the contract.
	UserID *string `json:"user_id" validate:"required"`

	// Name of the team member.
	Name *string `json:"name,omitempty"`

	// The role of the user in the contract.
	Role *string `json:"role" validate:"required"`

	// Description of the team member's responsibilities.
	Description *string `json:"description,omitempty"`

	// Date when the member joined the team.
	DateIn *strfmt.Date `json:"date_in,omitempty"`

	// Date when the member left the team.
	DateOut *strfmt.Date `json:"date_out,omitempty"`

	// Username of the person who replaced this member.
	ReplacedByUsername *string `json:"replaced_by_username,omitempty"`

	// Tags associated with the team member.
	Tags []string `json:"tags,omitempty"`

	// Custom properties for the team member.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`

	// Authoritative definitions for the team member.
	AuthoritativeDefinitions []ContractAuthoritativeDefinition `json:"authoritative_definitions,omitempty"`
}

ContractTemplateMember : Represents a user and their role in the contract.

type ContractTemplateSLA

type ContractTemplateSLA struct {
	// The default SLA element.
	DefaultElement *string `json:"default_element,omitempty"`

	// List of SLA properties and their values.
	Properties []ContractTemplateSLAProperty `json:"properties,omitempty"`
}

ContractTemplateSLA : Represents the SLA details of the contract.

type ContractTemplateSLAProperty

type ContractTemplateSLAProperty struct {
	// Unique identifier for the SLA property.
	ID *string `json:"id,omitempty"`

	// The SLA property name.
	Property *string `json:"property" validate:"required"`

	// The value associated with the SLA property.
	Value *string `json:"value" validate:"required"`

	// Extended agreement value.
	ValueExt *string `json:"value_ext,omitempty"`

	// Unit of measure (e.g., d for days, y for years). Uses ISO standard.
	Unit *string `json:"unit,omitempty"`

	// Element(s) to check on. Multiple elements separated by commas.
	Element *string `json:"element,omitempty"`

	// Importance of SLA: regulatory, analytics, or operational.
	Driver *string `json:"driver,omitempty"`

	// Human-readable description of the SLA.
	Description *string `json:"description,omitempty"`

	// Scheduler type (e.g., cron).
	Scheduler *string `json:"scheduler,omitempty"`

	// Schedule expression (e.g., 0 20 * * *).
	Schedule *string `json:"schedule,omitempty"`
}

ContractTemplateSLAProperty : Represents an SLA property and its value.

type ContractTemplateSupportAndCommunication

type ContractTemplateSupportAndCommunication struct {
	// Unique identifier for the support item.
	ID *string `json:"id,omitempty"`

	// The communication channel.
	Channel *string `json:"channel" validate:"required"`

	// The URL associated with the communication channel.
	URL *string `json:"url,omitempty"`

	// Description of the channel, free text.
	Description *string `json:"description,omitempty"`

	// Name of the tool: email, slack, teams, discord, ticket, googlechat, or other.
	Tool *string `json:"tool,omitempty"`

	// Scope: interactive, announcements, issues, or notifications.
	Scope *string `json:"scope,omitempty"`

	// Invitation URL for requesting or subscribing.
	InvitationURL *string `json:"invitation_url,omitempty"`

	// Custom properties for the support channel.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`
}

ContractTemplateSupportAndCommunication : Represents a support and communication channel for the contract.

type ContractTerms

type ContractTerms struct {
	// The reference schema for a asset in a container.
	Asset *AssetReference `json:"asset,omitempty"`

	// ID of the contract terms.
	ID *string `json:"id,omitempty"`

	// Collection of contract terms documents.
	Documents []ContractTermsDocument `json:"documents,omitempty"`

	// An error message, if existing, relating to the contract terms.
	ErrorMsg *string `json:"error_msg,omitempty"`

	// Overview details of a data contract.
	Overview *Overview `json:"overview,omitempty"`

	// Description details of a data contract.
	Description *Description `json:"description,omitempty"`

	// Represents a team with members and their roles in the contract.
	Team *ContractTermsTeam `json:"team,omitempty"`

	// List of roles associated with the contract.
	Roles []Roles `json:"roles,omitempty"`

	// Represents the pricing details of the contract.
	Price *Pricing `json:"price,omitempty"`

	// Represents the SLA details of the contract.
	SLA *ContractTemplateSLA `json:"sla,omitempty"`

	// Support and communication details for the contract.
	Support []ContractTemplateSupportAndCommunication `json:"support,omitempty"`

	// Custom properties that are not part of the standard contract.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`

	// Contains the contract test status and related metadata.
	ContractTest *ContractTest `json:"contract_test,omitempty"`

	// List of server definitions.
	Servers []ContractServer `json:"servers,omitempty"`

	// Schema details of the data asset.
	Schema []ContractSchema `json:"schema,omitempty"`
}

ContractTerms : Defines the complete structure of a contract terms.

type ContractTermsDocument

type ContractTermsDocument struct {
	// URL that can be used to retrieve the contract document.
	URL *string `json:"url,omitempty"`

	// Type of the contract document.
	Type *string `json:"type" validate:"required"`

	// Name of the contract document.
	Name *string `json:"name" validate:"required"`

	// Id uniquely identifying this document within the contract terms instance.
	ID *string `json:"id" validate:"required"`

	// Attachment associated witht the document.
	Attachment *ContractTermsDocumentAttachment `json:"attachment,omitempty"`

	// URL which can be used to upload document file.
	UploadURL *string `json:"upload_url,omitempty"`
}

ContractTermsDocument : Standard contract terms document, which is used for get and list contract terms responses.

type ContractTermsDocumentAttachment

type ContractTermsDocumentAttachment struct {
	// Id representing the corresponding attachment.
	ID *string `json:"id,omitempty"`
}

ContractTermsDocumentAttachment : Attachment associated witht the document.

type ContractTermsTeam added in v4.2.0

type ContractTermsTeam struct {
	// Unique identifier for the team.
	ID *string `json:"id,omitempty"`

	// Team name.
	Name *string `json:"name,omitempty"`

	// Team description.
	Description *string `json:"description,omitempty"`

	// List of team members.
	Members []ContractTemplateMember `json:"members,omitempty"`

	// Tags associated with the team.
	Tags []string `json:"tags,omitempty"`

	// Custom properties for the team.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`

	// Authoritative definitions for the team.
	AuthoritativeDefinitions []ContractAuthoritativeDefinition `json:"authoritative_definitions,omitempty"`
}

ContractTermsTeam : Represents a team with members and their roles in the contract.

type ContractTest

type ContractTest struct {
	// Status of the contract test (pass or fail).
	Status *string `json:"status" validate:"required"`

	// Timestamp of when the contract was last tested.
	LastTestedTime *strfmt.DateTime `json:"last_tested_time" validate:"required"`

	// The unique identifier of the data contract associated with this test.
	DataContractID *string `json:"data_contract_id,omitempty"`

	// The unique identifier of the project associated with this test.
	ProjectID *string `json:"project_id,omitempty"`

	// Optional message or details about the contract test.
	Message *string `json:"message,omitempty"`

	// The unique identifier of the test run.
	TestRunID *string `json:"test_run_id,omitempty"`

	// Array of test summary results.
	TestSummary []ContractTestSummary `json:"test_summary,omitempty"`
}

ContractTest : Contains the contract test status and related metadata.

type ContractTestSummary added in v4.2.0

type ContractTestSummary struct {
	// Test execution status.
	Status *string `json:"status,omitempty"`

	// DQ rule name.
	Check *string `json:"check,omitempty"`

	// Name of the asset.
	AssetName *string `json:"asset_name,omitempty"`

	// Number of rows returned.
	RecordsReturned *string `json:"records_returned,omitempty"`
}

ContractTestSummary : Summary of a contract test execution result.

type ContractValidationResponse added in v4.2.0

type ContractValidationResponse struct {
	// Indicates whether the contract template passed validation.
	Valid *bool `json:"valid" validate:"required"`

	// Summary message describing the validation result.
	Message *string `json:"message,omitempty"`

	// List of validation error messages if validation failed.
	Errors []string `json:"errors,omitempty"`
}

ContractValidationResponse : Response model for contract template YAML validation against ODCS v3.1.0 standard.

type CreateContractTemplateOptions

type CreateContractTemplateOptions struct {
	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`

	// The identifier of the data product contract template.
	ID *string `json:"id,omitempty"`

	// The identifier of the user who created the data product contract template.
	CreatorID *string `json:"creator_id,omitempty"`

	// The timestamp when the data product contract template was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The name of the contract template.
	Name *string `json:"name,omitempty"`

	// Contains the code and details.
	Error *ErrorMessage `json:"error,omitempty"`

	// Defines the complete structure of a contract terms.
	ContractTerms *ContractTerms `json:"contract_terms,omitempty"`

	// Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using the uid of
	// the default data product catalog.
	ContainerID *string `json:"container.id,omitempty"`

	// Name of the data product contract template. If not supplied, the data product templates within the catalog will
	// returned.
	ContractTemplateName *string `json:"contract_template.name,omitempty"`

	// Status of the data product contract template. If not supplied, the data product templates within the catalog will
	// returned.
	ContractTemplateStatus *string `json:"contract_template.status,omitempty"`

	// Comma-separated domain IDs to filter data product contract templates. If not supplied, the data product templates
	// within the catalog will returned.
	DomainIds *string `json:"domain.ids,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateContractTemplateOptions : The CreateContractTemplate options.

func (*CreateContractTemplateOptions) SetContainer

SetContainer : Allow user to set Container

func (*CreateContractTemplateOptions) SetContainerID

func (_options *CreateContractTemplateOptions) SetContainerID(containerID string) *CreateContractTemplateOptions

SetContainerID : Allow user to set ContainerID

func (*CreateContractTemplateOptions) SetContractTemplateName

func (_options *CreateContractTemplateOptions) SetContractTemplateName(contractTemplateName string) *CreateContractTemplateOptions

SetContractTemplateName : Allow user to set ContractTemplateName

func (*CreateContractTemplateOptions) SetContractTemplateStatus added in v4.2.0

func (_options *CreateContractTemplateOptions) SetContractTemplateStatus(contractTemplateStatus string) *CreateContractTemplateOptions

SetContractTemplateStatus : Allow user to set ContractTemplateStatus

func (*CreateContractTemplateOptions) SetContractTerms

func (_options *CreateContractTemplateOptions) SetContractTerms(contractTerms *ContractTerms) *CreateContractTemplateOptions

SetContractTerms : Allow user to set ContractTerms

func (*CreateContractTemplateOptions) SetCreatedAt added in v4.1.0

func (_options *CreateContractTemplateOptions) SetCreatedAt(createdAt *strfmt.DateTime) *CreateContractTemplateOptions

SetCreatedAt : Allow user to set CreatedAt

func (*CreateContractTemplateOptions) SetCreatorID added in v4.1.0

func (_options *CreateContractTemplateOptions) SetCreatorID(creatorID string) *CreateContractTemplateOptions

SetCreatorID : Allow user to set CreatorID

func (*CreateContractTemplateOptions) SetDomainIds added in v4.1.0

func (_options *CreateContractTemplateOptions) SetDomainIds(domainIds string) *CreateContractTemplateOptions

SetDomainIds : Allow user to set DomainIds

func (*CreateContractTemplateOptions) SetError

SetError : Allow user to set Error

func (*CreateContractTemplateOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateContractTemplateOptions) SetID

SetID : Allow user to set ID

func (*CreateContractTemplateOptions) SetName

SetName : Allow user to set Name

type CreateDataAssetVisualizationOptions

type CreateDataAssetVisualizationOptions struct {
	// Data product hub asset and it's related part asset.
	Assets []DataAssetRelationship `json:"assets,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateDataAssetVisualizationOptions : The CreateDataAssetVisualization options.

func (*CreateDataAssetVisualizationOptions) SetAssets

SetAssets : Allow user to set Assets

func (*CreateDataAssetVisualizationOptions) SetHeaders

SetHeaders : Allow user to set Headers

type CreateDataContractTestRunOptions added in v4.2.0

type CreateDataContractTestRunOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// ProjectId in which the assets will copy to.
	ProjectID *string `json:"project_id" validate:"required"`

	// CatalogId in which the source of the data product assets exists.
	CatalogID *string `json:"catalog_id" validate:"required"`

	// Name of the data product contract.
	ContractName *string `json:"contract_name" validate:"required"`

	// The contract content as YAML, represented as a string.
	ContractYaml *string `json:"contract_yaml" validate:"required"`

	// Data product assets to perform the bulkCopy.
	AssetIds []string `json:"asset_ids,omitempty"`

	// Data contract server information to create DQ contract.
	ServerMapping []ServerMapping `json:"server_mapping,omitempty"`

	// ID of the data contract being tested.
	DataContractID *string `json:"data_contract_id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateDataContractTestRunOptions : The CreateDataContractTestRun options.

func (*CreateDataContractTestRunOptions) SetAssetIds added in v4.2.0

SetAssetIds : Allow user to set AssetIds

func (*CreateDataContractTestRunOptions) SetCatalogID added in v4.2.0

SetCatalogID : Allow user to set CatalogID

func (*CreateDataContractTestRunOptions) SetContractName added in v4.2.0

func (_options *CreateDataContractTestRunOptions) SetContractName(contractName string) *CreateDataContractTestRunOptions

SetContractName : Allow user to set ContractName

func (*CreateDataContractTestRunOptions) SetContractYaml added in v4.2.0

func (_options *CreateDataContractTestRunOptions) SetContractYaml(contractYaml string) *CreateDataContractTestRunOptions

SetContractYaml : Allow user to set ContractYaml

func (*CreateDataContractTestRunOptions) SetDataContractID added in v4.2.0

func (_options *CreateDataContractTestRunOptions) SetDataContractID(dataContractID string) *CreateDataContractTestRunOptions

SetDataContractID : Allow user to set DataContractID

func (*CreateDataContractTestRunOptions) SetDataProductID added in v4.2.0

func (_options *CreateDataContractTestRunOptions) SetDataProductID(dataProductID string) *CreateDataContractTestRunOptions

SetDataProductID : Allow user to set DataProductID

func (*CreateDataContractTestRunOptions) SetHeaders added in v4.2.0

SetHeaders : Allow user to set Headers

func (*CreateDataContractTestRunOptions) SetProjectID added in v4.2.0

SetProjectID : Allow user to set ProjectID

func (*CreateDataContractTestRunOptions) SetServerMapping added in v4.2.0

func (_options *CreateDataContractTestRunOptions) SetServerMapping(serverMapping []ServerMapping) *CreateDataContractTestRunOptions

SetServerMapping : Allow user to set ServerMapping

type CreateDataProductDomainOptions

type CreateDataProductDomainOptions struct {
	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`

	// The id to trace the failed domain creations.
	Trace *string `json:"trace,omitempty"`

	// Set of errors on the sub domain creation.
	Errors []ErrorModelResource `json:"errors,omitempty"`

	// The name of the data product domain.
	Name *string `json:"name,omitempty"`

	// The description of the data product domain.
	Description *string `json:"description,omitempty"`

	// The identifier of the data product domain.
	ID *string `json:"id,omitempty"`

	// The identifier of the creator of the data product domain.
	CreatedBy *string `json:"created_by,omitempty"`

	// Member roles of a corresponding asset.
	MemberRoles *MemberRolesSchema `json:"member_roles,omitempty"`

	// Properties of the corresponding asset.
	Properties *PropertiesSchema `json:"properties,omitempty"`

	// List of sub domains to be added within a domain.
	SubDomains []InitializeSubDomain `json:"sub_domains,omitempty"`

	// The identity schema for a IBM knowledge catalog container (catalog/project/space).
	SubContainer *ContainerIdentity `json:"sub_container,omitempty"`

	// Link domains to subcontainers.
	LinkToSubcontainers *bool `json:"link_to_subcontainers,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateDataProductDomainOptions : The CreateDataProductDomain options.

func (*CreateDataProductDomainOptions) SetContainer

SetContainer : Allow user to set Container

func (*CreateDataProductDomainOptions) SetCreatedBy added in v4.1.0

func (_options *CreateDataProductDomainOptions) SetCreatedBy(createdBy string) *CreateDataProductDomainOptions

SetCreatedBy : Allow user to set CreatedBy

func (*CreateDataProductDomainOptions) SetDescription

func (_options *CreateDataProductDomainOptions) SetDescription(description string) *CreateDataProductDomainOptions

SetDescription : Allow user to set Description

func (*CreateDataProductDomainOptions) SetErrors

SetErrors : Allow user to set Errors

func (*CreateDataProductDomainOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateDataProductDomainOptions) SetID

SetID : Allow user to set ID

func (*CreateDataProductDomainOptions) SetLinkToSubcontainers added in v4.1.0

func (_options *CreateDataProductDomainOptions) SetLinkToSubcontainers(linkToSubcontainers bool) *CreateDataProductDomainOptions

SetLinkToSubcontainers : Allow user to set LinkToSubcontainers

func (*CreateDataProductDomainOptions) SetMemberRoles

SetMemberRoles : Allow user to set MemberRoles

func (*CreateDataProductDomainOptions) SetName

SetName : Allow user to set Name

func (*CreateDataProductDomainOptions) SetProperties

SetProperties : Allow user to set Properties

func (*CreateDataProductDomainOptions) SetSubContainer added in v4.1.0

func (_options *CreateDataProductDomainOptions) SetSubContainer(subContainer *ContainerIdentity) *CreateDataProductDomainOptions

SetSubContainer : Allow user to set SubContainer

func (*CreateDataProductDomainOptions) SetSubDomains

SetSubDomains : Allow user to set SubDomains

func (*CreateDataProductDomainOptions) SetTrace

SetTrace : Allow user to set Trace

type CreateDataProductDraftOptions

type CreateDataProductDraftOptions struct {
	// Data product ID.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// New asset input properties.
	Asset *AssetPrototype `json:"asset" validate:"required"`

	// The data product version number.
	Version *string `json:"version,omitempty"`

	// The state of the data product version. If not specified, the data product version will be created in `draft` state.
	State *string `json:"state,omitempty"`

	// Data product identifier.
	DataProduct *DataProductIdentity `json:"data_product,omitempty"`

	// The name that refers to the new data product version. If this is a new data product, this value must be specified.
	// If this is a new version of an existing data product, the name will default to the name of the previous data product
	// version. A name can contain letters, numbers, understores, dashes, spaces or periods. A name must contain at least
	// one non-space character.
	Name *string `json:"name,omitempty"`

	// Description of the data product version. If this is a new version of an existing data product, the description will
	// default to the description of the previous version of the data product.
	Description *string `json:"description,omitempty"`

	// Tags on the data product.
	Tags []string `json:"tags,omitempty"`

	// A list of use cases associated with the data product version.
	UseCases []UseCase `json:"use_cases,omitempty"`

	// Types of parts on the data product.
	Types []string `json:"types,omitempty"`

	// Contract terms binding various aspects of the data product.
	ContractTerms []ContractTerms `json:"contract_terms,omitempty"`

	// Domain that the data product version belongs to. If this is the first version of a data product, this field is
	// required. If this is a new version of an existing data product, the domain will default to the domain of the
	// previous version of the data product.
	Domain *Domain `json:"domain,omitempty"`

	// The outgoing parts of this data product version to be delivered to consumers. If this is the first version of a data
	// product, this field defaults to an empty list. If this is a new version of an existing data product, the data
	// product parts will default to the parts list from the previous version of the data product.
	PartsOut []DataProductPart `json:"parts_out,omitempty"`

	// The workflows associated with the data product version.
	Workflows *DataProductWorkflows `json:"workflows,omitempty"`

	// Indicates whether the dataView has enabled for data product.
	DataviewEnabled *bool `json:"dataview_enabled,omitempty"`

	// Comments by a producer that are provided either at the time of data product version creation or retiring.
	Comments *string `json:"comments,omitempty"`

	// Access control object.
	AccessControl *AssetListAccessControl `json:"access_control,omitempty"`

	// Timestamp of last asset update.
	LastUpdatedAt *strfmt.DateTime `json:"last_updated_at,omitempty"`

	// Timestamp of createddate.
	CreatedDate *strfmt.DateTime `json:"created_date,omitempty"`

	// The identity schema for a IBM knowledge catalog container (catalog/project/space).
	SubContainer *ContainerIdentity `json:"sub_container,omitempty"`

	// Indicates whether the data product is restricted or not. A restricted data product indicates that orders of the data
	// product requires explicit approval before data is delivered.
	IsRestricted *bool `json:"is_restricted,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateDataProductDraftOptions : The CreateDataProductDraft options.

func (*CreateDataProductDraftOptions) SetAccessControl

func (_options *CreateDataProductDraftOptions) SetAccessControl(accessControl *AssetListAccessControl) *CreateDataProductDraftOptions

SetAccessControl : Allow user to set AccessControl

func (*CreateDataProductDraftOptions) SetAsset

SetAsset : Allow user to set Asset

func (*CreateDataProductDraftOptions) SetComments

func (_options *CreateDataProductDraftOptions) SetComments(comments string) *CreateDataProductDraftOptions

SetComments : Allow user to set Comments

func (*CreateDataProductDraftOptions) SetContractTerms

func (_options *CreateDataProductDraftOptions) SetContractTerms(contractTerms []ContractTerms) *CreateDataProductDraftOptions

SetContractTerms : Allow user to set ContractTerms

func (*CreateDataProductDraftOptions) SetCreatedDate added in v4.2.0

func (_options *CreateDataProductDraftOptions) SetCreatedDate(createdDate *strfmt.DateTime) *CreateDataProductDraftOptions

SetCreatedDate : Allow user to set CreatedDate

func (*CreateDataProductDraftOptions) SetDataProduct

SetDataProduct : Allow user to set DataProduct

func (*CreateDataProductDraftOptions) SetDataProductID

func (_options *CreateDataProductDraftOptions) SetDataProductID(dataProductID string) *CreateDataProductDraftOptions

SetDataProductID : Allow user to set DataProductID

func (*CreateDataProductDraftOptions) SetDataviewEnabled

func (_options *CreateDataProductDraftOptions) SetDataviewEnabled(dataviewEnabled bool) *CreateDataProductDraftOptions

SetDataviewEnabled : Allow user to set DataviewEnabled

func (*CreateDataProductDraftOptions) SetDescription

func (_options *CreateDataProductDraftOptions) SetDescription(description string) *CreateDataProductDraftOptions

SetDescription : Allow user to set Description

func (*CreateDataProductDraftOptions) SetDomain

SetDomain : Allow user to set Domain

func (*CreateDataProductDraftOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateDataProductDraftOptions) SetIsRestricted

func (_options *CreateDataProductDraftOptions) SetIsRestricted(isRestricted bool) *CreateDataProductDraftOptions

SetIsRestricted : Allow user to set IsRestricted

func (*CreateDataProductDraftOptions) SetLastUpdatedAt

func (_options *CreateDataProductDraftOptions) SetLastUpdatedAt(lastUpdatedAt *strfmt.DateTime) *CreateDataProductDraftOptions

SetLastUpdatedAt : Allow user to set LastUpdatedAt

func (*CreateDataProductDraftOptions) SetName

SetName : Allow user to set Name

func (*CreateDataProductDraftOptions) SetPartsOut

SetPartsOut : Allow user to set PartsOut

func (*CreateDataProductDraftOptions) SetState

SetState : Allow user to set State

func (*CreateDataProductDraftOptions) SetSubContainer added in v4.1.0

func (_options *CreateDataProductDraftOptions) SetSubContainer(subContainer *ContainerIdentity) *CreateDataProductDraftOptions

SetSubContainer : Allow user to set SubContainer

func (*CreateDataProductDraftOptions) SetTags

SetTags : Allow user to set Tags

func (*CreateDataProductDraftOptions) SetTypes

SetTypes : Allow user to set Types

func (*CreateDataProductDraftOptions) SetUseCases

func (_options *CreateDataProductDraftOptions) SetUseCases(useCases []UseCase) *CreateDataProductDraftOptions

SetUseCases : Allow user to set UseCases

func (*CreateDataProductDraftOptions) SetVersion

SetVersion : Allow user to set Version

func (*CreateDataProductDraftOptions) SetWorkflows

SetWorkflows : Allow user to set Workflows

type CreateDataProductOptions

type CreateDataProductOptions struct {
	// Collection of data products drafts to add to data product.
	Drafts []DataProductDraftPrototype `json:"drafts" validate:"required"`

	// Limit the number of data products in the results. The maximum limit is 200.
	Limit *int64 `json:"limit,omitempty"`

	// Start token for pagination.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateDataProductOptions : The CreateDataProduct options.

func (*CreateDataProductOptions) SetDrafts

SetDrafts : Allow user to set Drafts

func (*CreateDataProductOptions) SetHeaders

func (options *CreateDataProductOptions) SetHeaders(param map[string]string) *CreateDataProductOptions

SetHeaders : Allow user to set Headers

func (*CreateDataProductOptions) SetLimit

func (_options *CreateDataProductOptions) SetLimit(limit int64) *CreateDataProductOptions

SetLimit : Allow user to set Limit

func (*CreateDataProductOptions) SetStart

func (_options *CreateDataProductOptions) SetStart(start string) *CreateDataProductOptions

SetStart : Allow user to set Start

type CreateDataProductSubdomainOptions

type CreateDataProductSubdomainOptions struct {
	// Domain id.
	DomainID *string `json:"domain_id" validate:"required,ne="`

	// Container ID of the data product catalog.
	ContainerID *string `json:"container.id" validate:"required"`

	// The name of the data product subdomain.
	Name *string `json:"name,omitempty"`

	// The identifier of the data product subdomain.
	ID *string `json:"id,omitempty"`

	// The description of the data product subdomain.
	Description *string `json:"description,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateDataProductSubdomainOptions : The CreateDataProductSubdomain options.

func (*CreateDataProductSubdomainOptions) SetContainerID

func (_options *CreateDataProductSubdomainOptions) SetContainerID(containerID string) *CreateDataProductSubdomainOptions

SetContainerID : Allow user to set ContainerID

func (*CreateDataProductSubdomainOptions) SetDescription

func (_options *CreateDataProductSubdomainOptions) SetDescription(description string) *CreateDataProductSubdomainOptions

SetDescription : Allow user to set Description

func (*CreateDataProductSubdomainOptions) SetDomainID

SetDomainID : Allow user to set DomainID

func (*CreateDataProductSubdomainOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateDataProductSubdomainOptions) SetID

SetID : Allow user to set ID

func (*CreateDataProductSubdomainOptions) SetName

SetName : Allow user to set Name

type CreateDeliveryMethodOptions added in v4.2.0

type CreateDeliveryMethodOptions struct {
	// The catalog ID where delivery methods are stored.
	CatalogID *string `json:"catalog_id" validate:"required"`

	// The name of the delivery method.
	Name *string `json:"name" validate:"required"`

	// The unique resource key of the delivery method.
	ResourceKey *string `json:"resource_key" validate:"required"`

	// The description of the delivery method.
	Description *string `json:"description" validate:"required"`

	// The status of the delivery method.
	Status *string `json:"status" validate:"required"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`

	// List of asset types supported by this delivery method.
	SupportedAssetTypes []string `json:"supported_asset_types,omitempty"`

	// List of authentication methods supported by this delivery method.
	SupportedAuthMethods []string `json:"supported_auth_methods,omitempty"`

	// List of authentication methods supported by this delivery method in CPD.
	SupportedAuthMethodsCpd []string `json:"supported_auth_methods_cpd,omitempty"`

	// List of data source IDs supported by this delivery method.
	SupportedDataSources []string `json:"supported_data_sources,omitempty"`

	// Whether the delivery method supports redelivery.
	SupportsRedelivery *bool `json:"supports_redelivery,omitempty"`

	// Indicates if the delivery method is restricted.
	IsRestricted *bool `json:"is_restricted,omitempty"`

	// Whether the delivery method supports retry on failure.
	SupportsRetryOnFailure *bool `json:"supports_retry_on_failure,omitempty"`

	// Whether the delivery method supports revoke access.
	SupportsRevokeAccess *bool `json:"supports_revoke_access,omitempty"`

	// Whether the delivery method supports column selection.
	SupportsColumnSelection *bool `json:"supports_column_selection,omitempty"`

	// Whether the delivery method supports adding to project.
	SupportsAddToProject *bool `json:"supports_add_to_project,omitempty"`

	// Input fields required from the data product producer.
	ProducerInput []map[string]interface{} `json:"producer_input,omitempty"`

	// Input fields required from the data consumer.
	ConsumerInput []map[string]interface{} `json:"consumer_input,omitempty"`

	// Output format specifications for the delivery.
	OutputFormat []map[string]interface{} `json:"output_format,omitempty"`

	// Whether the delivery method automatically marks deliveries as delivered.
	AutoMarkDelivered *bool `json:"auto_mark_delivered,omitempty"`

	// Whether the delivery method uses functional credentials for delivery.
	DeliveryUsesFunctionalCredentials *bool `json:"delivery_uses_functional_credentials,omitempty"`

	// Properties specific to data sources.
	DataSourceProperties map[string]interface{} `json:"data_source_properties,omitempty"`

	// Delivery output configuration including output assets.
	DeliveryOutput map[string]interface{} `json:"delivery_output,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateDeliveryMethodOptions : The CreateDeliveryMethod options.

func (*CreateDeliveryMethodOptions) SetAutoMarkDelivered added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetAutoMarkDelivered(autoMarkDelivered bool) *CreateDeliveryMethodOptions

SetAutoMarkDelivered : Allow user to set AutoMarkDelivered

func (*CreateDeliveryMethodOptions) SetCatalogID added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetCatalogID(catalogID string) *CreateDeliveryMethodOptions

SetCatalogID : Allow user to set CatalogID

func (*CreateDeliveryMethodOptions) SetConsumerInput added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetConsumerInput(consumerInput []map[string]interface{}) *CreateDeliveryMethodOptions

SetConsumerInput : Allow user to set ConsumerInput

func (*CreateDeliveryMethodOptions) SetContainer added in v4.2.0

SetContainer : Allow user to set Container

func (*CreateDeliveryMethodOptions) SetDataSourceProperties added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetDataSourceProperties(dataSourceProperties map[string]interface{}) *CreateDeliveryMethodOptions

SetDataSourceProperties : Allow user to set DataSourceProperties

func (*CreateDeliveryMethodOptions) SetDeliveryOutput added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetDeliveryOutput(deliveryOutput map[string]interface{}) *CreateDeliveryMethodOptions

SetDeliveryOutput : Allow user to set DeliveryOutput

func (*CreateDeliveryMethodOptions) SetDeliveryUsesFunctionalCredentials added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetDeliveryUsesFunctionalCredentials(deliveryUsesFunctionalCredentials bool) *CreateDeliveryMethodOptions

SetDeliveryUsesFunctionalCredentials : Allow user to set DeliveryUsesFunctionalCredentials // pragma: allowlist secret

func (*CreateDeliveryMethodOptions) SetDescription added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetDescription(description string) *CreateDeliveryMethodOptions

SetDescription : Allow user to set Description

func (*CreateDeliveryMethodOptions) SetHeaders added in v4.2.0

func (options *CreateDeliveryMethodOptions) SetHeaders(param map[string]string) *CreateDeliveryMethodOptions

SetHeaders : Allow user to set Headers

func (*CreateDeliveryMethodOptions) SetIsRestricted added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetIsRestricted(isRestricted bool) *CreateDeliveryMethodOptions

SetIsRestricted : Allow user to set IsRestricted

func (*CreateDeliveryMethodOptions) SetName added in v4.2.0

SetName : Allow user to set Name

func (*CreateDeliveryMethodOptions) SetOutputFormat added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetOutputFormat(outputFormat []map[string]interface{}) *CreateDeliveryMethodOptions

SetOutputFormat : Allow user to set OutputFormat

func (*CreateDeliveryMethodOptions) SetProducerInput added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetProducerInput(producerInput []map[string]interface{}) *CreateDeliveryMethodOptions

SetProducerInput : Allow user to set ProducerInput

func (*CreateDeliveryMethodOptions) SetResourceKey added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetResourceKey(resourceKey string) *CreateDeliveryMethodOptions

SetResourceKey : Allow user to set ResourceKey

func (*CreateDeliveryMethodOptions) SetStatus added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetStatus(status string) *CreateDeliveryMethodOptions

SetStatus : Allow user to set Status

func (*CreateDeliveryMethodOptions) SetSupportedAssetTypes added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetSupportedAssetTypes(supportedAssetTypes []string) *CreateDeliveryMethodOptions

SetSupportedAssetTypes : Allow user to set SupportedAssetTypes

func (*CreateDeliveryMethodOptions) SetSupportedAuthMethods added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetSupportedAuthMethods(supportedAuthMethods []string) *CreateDeliveryMethodOptions

SetSupportedAuthMethods : Allow user to set SupportedAuthMethods

func (*CreateDeliveryMethodOptions) SetSupportedAuthMethodsCpd added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetSupportedAuthMethodsCpd(supportedAuthMethodsCpd []string) *CreateDeliveryMethodOptions

SetSupportedAuthMethodsCpd : Allow user to set SupportedAuthMethodsCpd

func (*CreateDeliveryMethodOptions) SetSupportedDataSources added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetSupportedDataSources(supportedDataSources []string) *CreateDeliveryMethodOptions

SetSupportedDataSources : Allow user to set SupportedDataSources

func (*CreateDeliveryMethodOptions) SetSupportsAddToProject added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetSupportsAddToProject(supportsAddToProject bool) *CreateDeliveryMethodOptions

SetSupportsAddToProject : Allow user to set SupportsAddToProject

func (*CreateDeliveryMethodOptions) SetSupportsColumnSelection added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetSupportsColumnSelection(supportsColumnSelection bool) *CreateDeliveryMethodOptions

SetSupportsColumnSelection : Allow user to set SupportsColumnSelection

func (*CreateDeliveryMethodOptions) SetSupportsRedelivery added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetSupportsRedelivery(supportsRedelivery bool) *CreateDeliveryMethodOptions

SetSupportsRedelivery : Allow user to set SupportsRedelivery

func (*CreateDeliveryMethodOptions) SetSupportsRetryOnFailure added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetSupportsRetryOnFailure(supportsRetryOnFailure bool) *CreateDeliveryMethodOptions

SetSupportsRetryOnFailure : Allow user to set SupportsRetryOnFailure

func (*CreateDeliveryMethodOptions) SetSupportsRevokeAccess added in v4.2.0

func (_options *CreateDeliveryMethodOptions) SetSupportsRevokeAccess(supportsRevokeAccess bool) *CreateDeliveryMethodOptions

SetSupportsRevokeAccess : Allow user to set SupportsRevokeAccess

type CreateDraftContractTermsDocumentOptions

type CreateDraftContractTermsDocumentOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// Type of the contract document.
	Type *string `json:"type" validate:"required"`

	// Name of the contract document.
	Name *string `json:"name" validate:"required"`

	// URL that can be used to retrieve the contract document.
	URL *string `json:"url,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateDraftContractTermsDocumentOptions : The CreateDraftContractTermsDocument options.

func (*CreateDraftContractTermsDocumentOptions) SetContractTermsID

func (_options *CreateDraftContractTermsDocumentOptions) SetContractTermsID(contractTermsID string) *CreateDraftContractTermsDocumentOptions

SetContractTermsID : Allow user to set ContractTermsID

func (*CreateDraftContractTermsDocumentOptions) SetDataProductID

SetDataProductID : Allow user to set DataProductID

func (*CreateDraftContractTermsDocumentOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*CreateDraftContractTermsDocumentOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateDraftContractTermsDocumentOptions) SetName

SetName : Allow user to set Name

func (*CreateDraftContractTermsDocumentOptions) SetType

SetType : Allow user to set Type

func (*CreateDraftContractTermsDocumentOptions) SetURL

SetURL : Allow user to set URL

type CreateRevokeAccessProcessOptions added in v4.1.0

type CreateRevokeAccessProcessOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// The unique identifier of the data product release.
	ReleaseID *string `json:"release_id" validate:"required,ne="`

	// Request parameters to handle revoke access from subscriptions.
	Body io.ReadCloser `json:"body,omitempty"`

	// The type of the input.
	ContentType *string `json:"Content-Type,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateRevokeAccessProcessOptions : The CreateRevokeAccessProcess options.

func (*CreateRevokeAccessProcessOptions) SetBody added in v4.1.0

SetBody : Allow user to set Body

func (*CreateRevokeAccessProcessOptions) SetContentType added in v4.1.0

func (_options *CreateRevokeAccessProcessOptions) SetContentType(contentType string) *CreateRevokeAccessProcessOptions

SetContentType : Allow user to set ContentType

func (*CreateRevokeAccessProcessOptions) SetDataProductID added in v4.1.0

func (_options *CreateRevokeAccessProcessOptions) SetDataProductID(dataProductID string) *CreateRevokeAccessProcessOptions

SetDataProductID : Allow user to set DataProductID

func (*CreateRevokeAccessProcessOptions) SetHeaders added in v4.1.0

SetHeaders : Allow user to set Headers

func (*CreateRevokeAccessProcessOptions) SetReleaseID added in v4.1.0

SetReleaseID : Allow user to set ReleaseID

type CreateS3BucketOptions

type CreateS3BucketOptions struct {
	// Flag to specify whether the bucket is dedicated or shared.
	IsShared *bool `json:"is_shared" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateS3BucketOptions : The CreateS3Bucket options.

func (*CreateS3BucketOptions) SetHeaders

func (options *CreateS3BucketOptions) SetHeaders(param map[string]string) *CreateS3BucketOptions

SetHeaders : Allow user to set Headers

func (*CreateS3BucketOptions) SetIsShared

func (_options *CreateS3BucketOptions) SetIsShared(isShared bool) *CreateS3BucketOptions

SetIsShared : Allow user to set IsShared

type DataAssetRelationship

type DataAssetRelationship struct {
	// Data members for visualization.
	Visualization *Visualization `json:"visualization,omitempty"`

	// The reference schema for a asset in a container.
	Asset *AssetReference `json:"asset" validate:"required"`

	// The reference schema for a asset in a container.
	RelatedAsset *AssetReference `json:"related_asset" validate:"required"`

	// Contains the code and details.
	Error *ErrorMessage `json:"error,omitempty"`
}

DataAssetRelationship : Data members for visualization process.

type DataAssetVisualizationRes

type DataAssetVisualizationRes struct {
	// Data asset Ids and their related asset Ids.
	Results []DataAssetRelationship `json:"results,omitempty"`
}

DataAssetVisualizationRes : Data relationships for the visualization process response.

type DataContractDqTestResult added in v4.2.0

type DataContractDqTestResult struct {
	// Unique identifier for the test run.
	TestRunID *string `json:"test_run_id,omitempty"`

	// Current status of the test run.
	Status *string `json:"status" validate:"required"`

	// ID of the data contract being tested.
	DataContractID *string `json:"data_contract_id,omitempty"`

	// Name of the data contract.
	DataContractName *string `json:"data_contract_name,omitempty"`

	// Version of the data contract.
	DataContractVersion *string `json:"data_contract_version,omitempty"`

	// Start time of the test run (legacy field).
	StartTime *strfmt.DateTime `json:"start_time,omitempty"`

	// User or service ID who initiated the test.
	RunBy *string `json:"run_by,omitempty"`

	// Descriptive message about the test result.
	Message *string `json:"message,omitempty"`

	// Error messages during the execution phase.
	ErrorMessages []ErrorMessage `json:"error_messages,omitempty"`

	// Contract information for data quality test.
	Contract *DqContract `json:"contract" validate:"required"`

	// Server mappings for the test execution.
	ServerMappings []DqServerMapping `json:"server_mappings,omitempty"`

	// Data product name associated with the test.
	DataProduct *string `json:"data_product,omitempty"`

	// Start time of the test in ISO 8601 format.
	Start *strfmt.DateTime `json:"start" validate:"required"`

	// End time of the test in ISO 8601 format.
	End *strfmt.DateTime `json:"end" validate:"required"`

	// Log entries for the test execution.
	Logs []DqLogEntry `json:"logs,omitempty"`

	// Check results for each dataset and rule combination.
	CheckResults []DqCheckResult `json:"check_results,omitempty"`
}

DataContractDqTestResult : Data contract quality test execution results and run information.

type DataProduct

type DataProduct struct {
	// Data product identifier.
	ID *string `json:"id" validate:"required"`

	// A data product draft version object.
	Release *DataProductDraftVersionRelease `json:"release,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`

	// Data product name.
	Name *string `json:"name,omitempty"`

	// Summary of Data Product Version object.
	LatestRelease *DataProductVersionSummary `json:"latest_release,omitempty"`

	// List of draft summaries of this data product.
	Drafts []DataProductVersionSummary `json:"drafts,omitempty"`
}

DataProduct : Data Product.

type DataProductCollection

type DataProductCollection struct {
	// Set a limit on the number of results returned.
	Limit *int64 `json:"limit" validate:"required"`

	// First page in the collection.
	First *FirstPage `json:"first" validate:"required"`

	// Next page in the collection.
	Next *NextPage `json:"next,omitempty"`

	// Indicates the total number of results returned.
	TotalResults *int64 `json:"total_results,omitempty"`

	// Collection of data product summaries.
	DataProducts []DataProductSummary `json:"data_products" validate:"required"`
}

DataProductCollection : A collection of data product summaries.

func (*DataProductCollection) GetNextStart

func (resp *DataProductCollection) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type DataProductContractTemplate

type DataProductContractTemplate struct {
	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`

	// The identifier of the data product contract template.
	ID *string `json:"id,omitempty"`

	// The identifier of the user who created the data product contract template.
	CreatorID *string `json:"creator_id,omitempty"`

	// The timestamp when the data product contract template was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The name of the contract template.
	Name *string `json:"name,omitempty"`

	// Contains the code and details.
	Error *ErrorMessage `json:"error,omitempty"`

	// Defines the complete structure of a contract terms.
	ContractTerms *ContractTerms `json:"contract_terms,omitempty"`
}

DataProductContractTemplate : Defines the complete structure of a contract template.

type DataProductContractTemplateCollection

type DataProductContractTemplateCollection struct {
	// Collection of data product contract templates.
	ContractTemplates []DataProductContractTemplate `json:"contract_templates" validate:"required"`
}

DataProductContractTemplateCollection : A collection of data product contract templates.

type DataProductCustomWorkflowDefinition

type DataProductCustomWorkflowDefinition struct {
	// ID of a workflow definition.
	ID *string `json:"id,omitempty"`
}

DataProductCustomWorkflowDefinition : A custom workflow definition to be used to create a workflow to approve a data product subscription.

type DataProductDomain

type DataProductDomain struct {
	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`

	// The id to trace the failed domain creations.
	Trace *string `json:"trace,omitempty"`

	// Set of errors on the sub domain creation.
	Errors []ErrorModelResource `json:"errors,omitempty"`

	// The name of the data product domain.
	Name *string `json:"name,omitempty"`

	// The description of the data product domain.
	Description *string `json:"description,omitempty"`

	// The identifier of the data product domain.
	ID *string `json:"id,omitempty"`

	// The identifier of the creator of the data product domain.
	CreatedBy *string `json:"created_by,omitempty"`

	// Member roles of a corresponding asset.
	MemberRoles *MemberRolesSchema `json:"member_roles,omitempty"`

	// Properties of the corresponding asset.
	Properties *PropertiesSchema `json:"properties,omitempty"`

	// List of sub domains to be added within a domain.
	SubDomains []InitializeSubDomain `json:"sub_domains,omitempty"`

	// The identity schema for a IBM knowledge catalog container (catalog/project/space).
	SubContainer *ContainerIdentity `json:"sub_container,omitempty"`
}

DataProductDomain : The data product domain.

type DataProductDomainCollection

type DataProductDomainCollection struct {
	// Collection of data product domains.
	Domains []DataProductDomain `json:"domains" validate:"required"`
}

DataProductDomainCollection : A collection of data product domains.

type DataProductDraft

type DataProductDraft struct {
	// The data product version number.
	Version *string `json:"version" validate:"required"`

	// The state of the data product version.
	State *string `json:"state" validate:"required"`

	// Data product reference.
	DataProduct *DataProductDraftDataProduct `json:"data_product" validate:"required"`

	// The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or periods.
	// Names are mutable and reusable.
	Name *string `json:"name" validate:"required"`

	// The description of the data product version.
	Description *string `json:"description" validate:"required"`

	// Tags on the data product.
	Tags []string `json:"tags" validate:"required"`

	// A list of use cases associated with the data product version.
	UseCases []UseCase `json:"use_cases,omitempty"`

	// Types of parts on the data product.
	Types []string `json:"types" validate:"required"`

	// Contract terms binding various aspects of the data product.
	ContractTerms []ContractTerms `json:"contract_terms" validate:"required"`

	// Domain that the data product version belongs to. If this is the first version of a data product, this field is
	// required. If this is a new version of an existing data product, the domain will default to the domain of the
	// previous version of the data product.
	Domain *Domain `json:"domain" validate:"required"`

	// The outgoing parts of this data product version to be delivered to consumers. If this is the first version of a data
	// product, this field defaults to an empty list. If this is a new version of an existing data product, the data
	// product parts will default to the parts list from the previous version of the data product.
	PartsOut []DataProductPart `json:"parts_out" validate:"required"`

	// The workflows associated with the data product version.
	Workflows *DataProductWorkflows `json:"workflows,omitempty"`

	// Indicates whether the dataView has enabled for data product.
	DataviewEnabled *bool `json:"dataview_enabled,omitempty"`

	// Comments by a producer that are provided either at the time of data product version creation or retiring.
	Comments *string `json:"comments,omitempty"`

	// Access control object.
	AccessControl *AssetListAccessControl `json:"access_control,omitempty"`

	// Timestamp of last asset update.
	LastUpdatedAt *strfmt.DateTime `json:"last_updated_at,omitempty"`

	// Timestamp of createddate.
	CreatedDate *strfmt.DateTime `json:"created_date,omitempty"`

	// The identity schema for a IBM knowledge catalog container (catalog/project/space).
	SubContainer *ContainerIdentity `json:"sub_container,omitempty"`

	// Indicates whether the data product is restricted or not. A restricted data product indicates that orders of the data
	// product requires explicit approval before data is delivered.
	IsRestricted *bool `json:"is_restricted" validate:"required"`

	// The identifier of the data product version.
	ID *string `json:"id" validate:"required"`

	// The reference schema for a asset in a container.
	Asset *AssetReference `json:"asset" validate:"required"`

	// The user who published this data product version.
	PublishedBy *string `json:"published_by,omitempty"`

	// The time when this data product version was published.
	PublishedAt *strfmt.DateTime `json:"published_at,omitempty"`

	// The creator of this data product version.
	CreatedBy *string `json:"created_by" validate:"required"`

	// The time when this data product version was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// Metadata properties on data products.
	Properties map[string]interface{} `json:"properties,omitempty"`

	// Errors encountered during the visualization creation process.
	VisualizationErrors []DataAssetRelationship `json:"visualization_errors,omitempty"`
}

DataProductDraft : Data Product version draft.

type DataProductDraftCollection

type DataProductDraftCollection struct {
	// Set a limit on the number of results returned.
	Limit *int64 `json:"limit" validate:"required"`

	// First page in the collection.
	First *FirstPage `json:"first" validate:"required"`

	// Next page in the collection.
	Next *NextPage `json:"next,omitempty"`

	// Indicates the total number of results returned.
	TotalResults *int64 `json:"total_results,omitempty"`

	// Collection of data product drafts.
	Drafts []DataProductDraftSummary `json:"drafts" validate:"required"`
}

DataProductDraftCollection : A collection of data product draft summaries.

func (*DataProductDraftCollection) GetNextStart

func (resp *DataProductDraftCollection) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type DataProductDraftDataProduct

type DataProductDraftDataProduct struct {
	// Data product identifier.
	ID *string `json:"id" validate:"required"`

	// A data product draft version object.
	Release *DataProductDraftVersionRelease `json:"release,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`
}

DataProductDraftDataProduct : Data product reference.

type DataProductDraftPrototype

type DataProductDraftPrototype struct {
	// The data product version number.
	Version *string `json:"version,omitempty"`

	// The state of the data product version. If not specified, the data product version will be created in `draft` state.
	State *string `json:"state,omitempty"`

	// Data product identifier.
	DataProduct *DataProductIdentity `json:"data_product,omitempty"`

	// The name that refers to the new data product version. If this is a new data product, this value must be specified.
	// If this is a new version of an existing data product, the name will default to the name of the previous data product
	// version. A name can contain letters, numbers, understores, dashes, spaces or periods. A name must contain at least
	// one non-space character.
	Name *string `json:"name,omitempty"`

	// Description of the data product version. If this is a new version of an existing data product, the description will
	// default to the description of the previous version of the data product.
	Description *string `json:"description,omitempty"`

	// Tags on the data product.
	Tags []string `json:"tags,omitempty"`

	// A list of use cases associated with the data product version.
	UseCases []UseCase `json:"use_cases,omitempty"`

	// Types of parts on the data product.
	Types []string `json:"types,omitempty"`

	// Contract terms binding various aspects of the data product.
	ContractTerms []ContractTerms `json:"contract_terms,omitempty"`

	// Domain that the data product version belongs to. If this is the first version of a data product, this field is
	// required. If this is a new version of an existing data product, the domain will default to the domain of the
	// previous version of the data product.
	Domain *Domain `json:"domain,omitempty"`

	// The outgoing parts of this data product version to be delivered to consumers. If this is the first version of a data
	// product, this field defaults to an empty list. If this is a new version of an existing data product, the data
	// product parts will default to the parts list from the previous version of the data product.
	PartsOut []DataProductPart `json:"parts_out,omitempty"`

	// The workflows associated with the data product version.
	Workflows *DataProductWorkflows `json:"workflows,omitempty"`

	// Indicates whether the dataView has enabled for data product.
	DataviewEnabled *bool `json:"dataview_enabled,omitempty"`

	// Comments by a producer that are provided either at the time of data product version creation or retiring.
	Comments *string `json:"comments,omitempty"`

	// Access control object.
	AccessControl *AssetListAccessControl `json:"access_control,omitempty"`

	// Timestamp of last asset update.
	LastUpdatedAt *strfmt.DateTime `json:"last_updated_at,omitempty"`

	// Timestamp of createddate.
	CreatedDate *strfmt.DateTime `json:"created_date,omitempty"`

	// The identity schema for a IBM knowledge catalog container (catalog/project/space).
	SubContainer *ContainerIdentity `json:"sub_container,omitempty"`

	// Indicates whether the data product is restricted or not. A restricted data product indicates that orders of the data
	// product requires explicit approval before data is delivered.
	IsRestricted *bool `json:"is_restricted,omitempty"`

	// New asset input properties.
	Asset *AssetPrototype `json:"asset" validate:"required"`
}

DataProductDraftPrototype : New data product version input properties.

type DataProductDraftSummary

type DataProductDraftSummary struct {
	// The data product version number.
	Version *string `json:"version" validate:"required"`

	// The state of the data product version.
	State *string `json:"state" validate:"required"`

	// Data product reference.
	DataProduct *DataProductDraftSummaryDataProduct `json:"data_product" validate:"required"`

	// The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or periods.
	// Names are mutable and reusable.
	Name *string `json:"name" validate:"required"`

	// The description of the data product version.
	Description *string `json:"description" validate:"required"`

	// Tags on the data product.
	Tags []string `json:"tags" validate:"required"`

	// A list of use cases associated with the data product version.
	UseCases []UseCase `json:"use_cases,omitempty"`

	// Types of parts on the data product.
	Types []string `json:"types" validate:"required"`

	// Contract terms binding various aspects of the data product.
	ContractTerms []ContractTerms `json:"contract_terms" validate:"required"`

	// Domain that the data product version belongs to. If this is the first version of a data product, this field is
	// required. If this is a new version of an existing data product, the domain will default to the domain of the
	// previous version of the data product.
	Domain *Domain `json:"domain,omitempty"`

	// The outgoing parts of this data product version to be delivered to consumers. If this is the first version of a data
	// product, this field defaults to an empty list. If this is a new version of an existing data product, the data
	// product parts will default to the parts list from the previous version of the data product.
	PartsOut []DataProductPart `json:"parts_out,omitempty"`

	// The workflows associated with the data product version.
	Workflows *DataProductWorkflows `json:"workflows,omitempty"`

	// Indicates whether the dataView has enabled for data product.
	DataviewEnabled *bool `json:"dataview_enabled,omitempty"`

	// Comments by a producer that are provided either at the time of data product version creation or retiring.
	Comments *string `json:"comments,omitempty"`

	// Access control object.
	AccessControl *AssetListAccessControl `json:"access_control,omitempty"`

	// Timestamp of last asset update.
	LastUpdatedAt *strfmt.DateTime `json:"last_updated_at,omitempty"`

	// Timestamp of createddate.
	CreatedDate *strfmt.DateTime `json:"created_date,omitempty"`

	// The identity schema for a IBM knowledge catalog container (catalog/project/space).
	SubContainer *ContainerIdentity `json:"sub_container,omitempty"`

	// Indicates whether the data product is restricted or not. A restricted data product indicates that orders of the data
	// product requires explicit approval before data is delivered.
	IsRestricted *bool `json:"is_restricted" validate:"required"`

	// The identifier of the data product version.
	ID *string `json:"id" validate:"required"`

	// The reference schema for a asset in a container.
	Asset *AssetReference `json:"asset" validate:"required"`
}

DataProductDraftSummary : Summary of Data Product Version object.

type DataProductDraftSummaryDataProduct

type DataProductDraftSummaryDataProduct struct {
	// Data product identifier.
	ID *string `json:"id" validate:"required"`

	// A data product draft version object.
	Release *DataProductDraftVersionRelease `json:"release,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`
}

DataProductDraftSummaryDataProduct : Data product reference.

type DataProductDraftVersionRelease

type DataProductDraftVersionRelease struct {
	// ID of a draft version of data product.
	ID *string `json:"id,omitempty"`
}

DataProductDraftVersionRelease : A data product draft version object.

type DataProductDraftsPager

type DataProductDraftsPager struct {
	// contains filtered or unexported fields
}

DataProductDraftsPager can be used to simplify the use of the "ListDataProductDrafts" method.

func (*DataProductDraftsPager) GetAll

func (pager *DataProductDraftsPager) GetAll() (allItems []DataProductDraftSummary, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*DataProductDraftsPager) GetAllWithContext

func (pager *DataProductDraftsPager) GetAllWithContext(ctx context.Context) (allItems []DataProductDraftSummary, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*DataProductDraftsPager) GetNext

func (pager *DataProductDraftsPager) GetNext() (page []DataProductDraftSummary, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*DataProductDraftsPager) GetNextWithContext

func (pager *DataProductDraftsPager) GetNextWithContext(ctx context.Context) (page []DataProductDraftSummary, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*DataProductDraftsPager) HasNext

func (pager *DataProductDraftsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type DataProductHubAPIServiceV1

type DataProductHubAPIServiceV1 struct {
	Service *core.BaseService
}

DataProductHubAPIServiceV1 : Data Product Hub API Service

API Version: 1

func NewDataProductHubAPIServiceV1

func NewDataProductHubAPIServiceV1(options *DataProductHubAPIServiceV1Options) (service *DataProductHubAPIServiceV1, err error)

NewDataProductHubAPIServiceV1 : constructs an instance of DataProductHubAPIServiceV1 with passed in options.

func NewDataProductHubAPIServiceV1UsingExternalConfig

func NewDataProductHubAPIServiceV1UsingExternalConfig(options *DataProductHubAPIServiceV1Options) (dataProductHubApiService *DataProductHubAPIServiceV1, err error)

NewDataProductHubAPIServiceV1UsingExternalConfig : constructs an instance of DataProductHubAPIServiceV1 with passed in options and external configuration.

func (*DataProductHubAPIServiceV1) Clone

func (dataProductHubApiService *DataProductHubAPIServiceV1) Clone() *DataProductHubAPIServiceV1

Clone makes a copy of "dataProductHubApiService" suitable for processing requests.

func (*DataProductHubAPIServiceV1) CompleteDraftContractTermsDocument

func (dataProductHubApiService *DataProductHubAPIServiceV1) CompleteDraftContractTermsDocument(completeDraftContractTermsDocumentOptions *CompleteDraftContractTermsDocumentOptions) (result *ContractTermsDocument, response *core.DetailedResponse, err error)

CompleteDraftContractTermsDocument : Complete a contract document upload operation After uploading a file to the provided signed URL, call this endpoint to mark the upload as complete. After the upload operation is marked as complete, the file is available to download. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly. - After the upload is marked as complete, the returned URL is displayed in the "url" field. The signed URL is used to download the document. - Calling complete on referential documents results in an error. - Calling complete on attachment documents for which the file has not been uploaded will result in an error.

func (*DataProductHubAPIServiceV1) CompleteDraftContractTermsDocumentWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) CompleteDraftContractTermsDocumentWithContext(ctx context.Context, completeDraftContractTermsDocumentOptions *CompleteDraftContractTermsDocumentOptions) (result *ContractTermsDocument, response *core.DetailedResponse, err error)

CompleteDraftContractTermsDocumentWithContext is an alternate form of the CompleteDraftContractTermsDocument method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateContractTemplate

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateContractTemplate(createContractTemplateOptions *CreateContractTemplateOptions) (result *DataProductContractTemplate, response *core.DetailedResponse, err error)

CreateContractTemplate : Create new data product contract template Create new data product contract template.

func (*DataProductHubAPIServiceV1) CreateContractTemplateWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateContractTemplateWithContext(ctx context.Context, createContractTemplateOptions *CreateContractTemplateOptions) (result *DataProductContractTemplate, response *core.DetailedResponse, err error)

CreateContractTemplateWithContext is an alternate form of the CreateContractTemplate method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateDataAssetVisualization

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataAssetVisualization(createDataAssetVisualizationOptions *CreateDataAssetVisualizationOptions) (result *DataAssetVisualizationRes, response *core.DetailedResponse, err error)

CreateDataAssetVisualization : Create visualization asset and initialize profiling for the provided data assets Use this API to create visualization asset and initialize profiling for the provided data assets<br/><br/>Provide the below required fields<br/><br/>Required fields:<br/><br/>- catalog_id<br/>- Collection of assetId with it's related asset id<br/><br/>.

func (*DataProductHubAPIServiceV1) CreateDataAssetVisualizationWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataAssetVisualizationWithContext(ctx context.Context, createDataAssetVisualizationOptions *CreateDataAssetVisualizationOptions) (result *DataAssetVisualizationRes, response *core.DetailedResponse, err error)

CreateDataAssetVisualizationWithContext is an alternate form of the CreateDataAssetVisualization method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateDataContractTestRun added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataContractTestRun(createDataContractTestRunOptions *CreateDataContractTestRunOptions) (result *DataContractDqTestResult, response *core.DetailedResponse, err error)

CreateDataContractTestRun : Test data contract with DQ Tests data contract by cloning assets from catalog to project and validating with DQ rules.Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) CreateDataContractTestRunWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataContractTestRunWithContext(ctx context.Context, createDataContractTestRunOptions *CreateDataContractTestRunOptions) (result *DataContractDqTestResult, response *core.DetailedResponse, err error)

CreateDataContractTestRunWithContext is an alternate form of the CreateDataContractTestRun method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateDataProduct

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataProduct(createDataProductOptions *CreateDataProductOptions) (result *DataProduct, response *core.DetailedResponse, err error)

CreateDataProduct : Create a new data product Use this API to create a new data product.<br/><br/>Provide the initial draft of the data product.<br/><br/>Required fields:<br/><br/>- name<br/>- container<br/><br/>If `version` is not specified, the default version **1.0.0** will be used.<br/><br/>The `domain` is optional.

func (*DataProductHubAPIServiceV1) CreateDataProductDomain

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataProductDomain(createDataProductDomainOptions *CreateDataProductDomainOptions) (result *DataProductDomain, response *core.DetailedResponse, err error)

CreateDataProductDomain : Create new data product domain Create new data product domain.

func (*DataProductHubAPIServiceV1) CreateDataProductDomainWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataProductDomainWithContext(ctx context.Context, createDataProductDomainOptions *CreateDataProductDomainOptions) (result *DataProductDomain, response *core.DetailedResponse, err error)

CreateDataProductDomainWithContext is an alternate form of the CreateDataProductDomain method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateDataProductDraft

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataProductDraft(createDataProductDraftOptions *CreateDataProductDraftOptions) (result *DataProductDraft, response *core.DetailedResponse, err error)

CreateDataProductDraft : Create a new draft of an existing data product Create a new draft of an existing data product.

func (*DataProductHubAPIServiceV1) CreateDataProductDraftWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataProductDraftWithContext(ctx context.Context, createDataProductDraftOptions *CreateDataProductDraftOptions) (result *DataProductDraft, response *core.DetailedResponse, err error)

CreateDataProductDraftWithContext is an alternate form of the CreateDataProductDraft method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateDataProductSubdomain

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataProductSubdomain(createDataProductSubdomainOptions *CreateDataProductSubdomainOptions) (result *InitializeSubDomain, response *core.DetailedResponse, err error)

CreateDataProductSubdomain : Create data product subdomains for a specific domain identified by id Create data product subdomains for a specific domain identified by id.

func (*DataProductHubAPIServiceV1) CreateDataProductSubdomainWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataProductSubdomainWithContext(ctx context.Context, createDataProductSubdomainOptions *CreateDataProductSubdomainOptions) (result *InitializeSubDomain, response *core.DetailedResponse, err error)

CreateDataProductSubdomainWithContext is an alternate form of the CreateDataProductSubdomain method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateDataProductWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDataProductWithContext(ctx context.Context, createDataProductOptions *CreateDataProductOptions) (result *DataProduct, response *core.DetailedResponse, err error)

CreateDataProductWithContext is an alternate form of the CreateDataProduct method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateDeliveryMethod added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDeliveryMethod(createDeliveryMethodOptions *CreateDeliveryMethodOptions) (result *DeliveryMethodRes, response *core.DetailedResponse, err error)

CreateDeliveryMethod : Create a new delivery method Creates a new delivery method with provided configurations.

func (*DataProductHubAPIServiceV1) CreateDeliveryMethodWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDeliveryMethodWithContext(ctx context.Context, createDeliveryMethodOptions *CreateDeliveryMethodOptions) (result *DeliveryMethodRes, response *core.DetailedResponse, err error)

CreateDeliveryMethodWithContext is an alternate form of the CreateDeliveryMethod method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateDraftContractTermsDocument

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDraftContractTermsDocument(createDraftContractTermsDocumentOptions *CreateDraftContractTermsDocumentOptions) (result *ContractTermsDocument, response *core.DetailedResponse, err error)

CreateDraftContractTermsDocument : Upload a contract document to the data product draft contract terms Upload a contract document to the data product draft identified by draft_id. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

- If the request object contains a "url" parameter, a referential document is created to store the provided url. - If the request object does not contain a "url" parameter, an attachment document is created, and a signed url will be returned in an "upload_url" parameter. The data product producer can upload the document using the provided "upload_url". After the upload is completed, call "complete_contract_terms_document" for the given document needs to be called to mark the upload as completed. After completion of the upload, "get_contract_terms_document" for the given document returns a signed "url" parameter that can be used to download the attachment document.

func (*DataProductHubAPIServiceV1) CreateDraftContractTermsDocumentWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateDraftContractTermsDocumentWithContext(ctx context.Context, createDraftContractTermsDocumentOptions *CreateDraftContractTermsDocumentOptions) (result *ContractTermsDocument, response *core.DetailedResponse, err error)

CreateDraftContractTermsDocumentWithContext is an alternate form of the CreateDraftContractTermsDocument method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateRevokeAccessProcess added in v4.1.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateRevokeAccessProcess(createRevokeAccessProcessOptions *CreateRevokeAccessProcessOptions) (result *RevokeAccessResponse, response *core.DetailedResponse, err error)

CreateRevokeAccessProcess : Revoke access from Data Product subscriptions Revoke's access from Subscriptions of the data product id passed in the path parameter.

func (*DataProductHubAPIServiceV1) CreateRevokeAccessProcessWithContext added in v4.1.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateRevokeAccessProcessWithContext(ctx context.Context, createRevokeAccessProcessOptions *CreateRevokeAccessProcessOptions) (result *RevokeAccessResponse, response *core.DetailedResponse, err error)

CreateRevokeAccessProcessWithContext is an alternate form of the CreateRevokeAccessProcess method which supports a Context parameter

func (*DataProductHubAPIServiceV1) CreateS3Bucket

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateS3Bucket(createS3BucketOptions *CreateS3BucketOptions) (result *BucketResponse, response *core.DetailedResponse, err error)

CreateS3Bucket : Create a new Bucket Use this API to create a new S3 Bucket on an AWS Hosting.

func (*DataProductHubAPIServiceV1) CreateS3BucketWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) CreateS3BucketWithContext(ctx context.Context, createS3BucketOptions *CreateS3BucketOptions) (result *BucketResponse, response *core.DetailedResponse, err error)

CreateS3BucketWithContext is an alternate form of the CreateS3Bucket method which supports a Context parameter

func (*DataProductHubAPIServiceV1) DeleteDataProductContractTemplate

func (dataProductHubApiService *DataProductHubAPIServiceV1) DeleteDataProductContractTemplate(deleteDataProductContractTemplateOptions *DeleteDataProductContractTemplateOptions) (response *core.DetailedResponse, err error)

DeleteDataProductContractTemplate : Delete a data product contract template identified by id Delete a data product contract template identified by id.

func (*DataProductHubAPIServiceV1) DeleteDataProductContractTemplateWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) DeleteDataProductContractTemplateWithContext(ctx context.Context, deleteDataProductContractTemplateOptions *DeleteDataProductContractTemplateOptions) (response *core.DetailedResponse, err error)

DeleteDataProductContractTemplateWithContext is an alternate form of the DeleteDataProductContractTemplate method which supports a Context parameter

func (*DataProductHubAPIServiceV1) DeleteDataProductDraft

func (dataProductHubApiService *DataProductHubAPIServiceV1) DeleteDataProductDraft(deleteDataProductDraftOptions *DeleteDataProductDraftOptions) (response *core.DetailedResponse, err error)

DeleteDataProductDraft : Delete a data product draft identified by ID Delete a data product draft identified by a valid ID. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) DeleteDataProductDraftWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) DeleteDataProductDraftWithContext(ctx context.Context, deleteDataProductDraftOptions *DeleteDataProductDraftOptions) (response *core.DetailedResponse, err error)

DeleteDataProductDraftWithContext is an alternate form of the DeleteDataProductDraft method which supports a Context parameter

func (*DataProductHubAPIServiceV1) DeleteDeliveryMethod added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) DeleteDeliveryMethod(deleteDeliveryMethodOptions *DeleteDeliveryMethodOptions) (response *core.DetailedResponse, err error)

DeleteDeliveryMethod : Delete delivery method Delete external delivery method by its ID.

func (*DataProductHubAPIServiceV1) DeleteDeliveryMethodWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) DeleteDeliveryMethodWithContext(ctx context.Context, deleteDeliveryMethodOptions *DeleteDeliveryMethodOptions) (response *core.DetailedResponse, err error)

DeleteDeliveryMethodWithContext is an alternate form of the DeleteDeliveryMethod method which supports a Context parameter

func (*DataProductHubAPIServiceV1) DeleteDomain

func (dataProductHubApiService *DataProductHubAPIServiceV1) DeleteDomain(deleteDomainOptions *DeleteDomainOptions) (response *core.DetailedResponse, err error)

DeleteDomain : Delete a data product domain identified by id Delete a data product domain identified by id.

func (*DataProductHubAPIServiceV1) DeleteDomainWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) DeleteDomainWithContext(ctx context.Context, deleteDomainOptions *DeleteDomainOptions) (response *core.DetailedResponse, err error)

DeleteDomainWithContext is an alternate form of the DeleteDomain method which supports a Context parameter

func (*DataProductHubAPIServiceV1) DeleteDraftContractTermsDocument

func (dataProductHubApiService *DataProductHubAPIServiceV1) DeleteDraftContractTermsDocument(deleteDraftContractTermsDocumentOptions *DeleteDraftContractTermsDocumentOptions) (response *core.DetailedResponse, err error)

DeleteDraftContractTermsDocument : Delete a contract document Delete an existing contract document.

Contract documents can only be deleted for data product versions that are in DRAFT state. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) DeleteDraftContractTermsDocumentWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) DeleteDraftContractTermsDocumentWithContext(ctx context.Context, deleteDraftContractTermsDocumentOptions *DeleteDraftContractTermsDocumentOptions) (response *core.DetailedResponse, err error)

DeleteDraftContractTermsDocumentWithContext is an alternate form of the DeleteDraftContractTermsDocument method which supports a Context parameter

func (*DataProductHubAPIServiceV1) DisableRetries

func (dataProductHubApiService *DataProductHubAPIServiceV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*DataProductHubAPIServiceV1) EnableRetries

func (dataProductHubApiService *DataProductHubAPIServiceV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*DataProductHubAPIServiceV1) GetContractTemplate

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetContractTemplate(getContractTemplateOptions *GetContractTemplateOptions) (result *DataProductContractTemplate, response *core.DetailedResponse, err error)

GetContractTemplate : Retrieve a data product contract template identified by id Retrieve a data product contract template identified by id.

func (*DataProductHubAPIServiceV1) GetContractTemplateWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetContractTemplateWithContext(ctx context.Context, getContractTemplateOptions *GetContractTemplateOptions) (result *DataProductContractTemplate, response *core.DetailedResponse, err error)

GetContractTemplateWithContext is an alternate form of the GetContractTemplate method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetContractTemplatesByDomain added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetContractTemplatesByDomain(getContractTemplatesByDomainOptions *GetContractTemplatesByDomainOptions) (result *DataProductVersionCollection, response *core.DetailedResponse, err error)

GetContractTemplatesByDomain : Retrieve all contract templates in a domain by id Retrieve all the contract templates tagged to the domain identified by id or any of it's subdomains.

func (*DataProductHubAPIServiceV1) GetContractTemplatesByDomainWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetContractTemplatesByDomainWithContext(ctx context.Context, getContractTemplatesByDomainOptions *GetContractTemplatesByDomainOptions) (result *DataProductVersionCollection, response *core.DetailedResponse, err error)

GetContractTemplatesByDomainWithContext is an alternate form of the GetContractTemplatesByDomain method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetContractTermsInSpecifiedFormat added in v4.1.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetContractTermsInSpecifiedFormat(getContractTermsInSpecifiedFormatOptions *GetContractTermsInSpecifiedFormatOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetContractTermsInSpecifiedFormat : Retrieve a data product contract terms identified by id in specified format Retrieve a data product contract terms identified by id in specified format.

func (*DataProductHubAPIServiceV1) GetContractTermsInSpecifiedFormatWithContext added in v4.1.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetContractTermsInSpecifiedFormatWithContext(ctx context.Context, getContractTermsInSpecifiedFormatOptions *GetContractTermsInSpecifiedFormatOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetContractTermsInSpecifiedFormatWithContext is an alternate form of the GetContractTermsInSpecifiedFormat method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetDataContractTestResults added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataContractTestResults(getDataContractTestResultsOptions *GetDataContractTestResultsOptions) (result *DataContractDqTestResult, response *core.DetailedResponse, err error)

GetDataContractTestResults : Get data contract test results Retrieves the test results from DQ service for a data contract test run. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) GetDataContractTestResultsWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataContractTestResultsWithContext(ctx context.Context, getDataContractTestResultsOptions *GetDataContractTestResultsOptions) (result *DataContractDqTestResult, response *core.DetailedResponse, err error)

GetDataContractTestResultsWithContext is an alternate form of the GetDataContractTestResults method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetDataProduct

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataProduct(getDataProductOptions *GetDataProductOptions) (result *DataProduct, response *core.DetailedResponse, err error)

GetDataProduct : Retrieve a data product identified by id Retrieve a data product identified by id.

func (*DataProductHubAPIServiceV1) GetDataProductByDomain

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataProductByDomain(getDataProductByDomainOptions *GetDataProductByDomainOptions) (result *DataProductVersionCollection, response *core.DetailedResponse, err error)

GetDataProductByDomain : Retrieve all data products in a domain specified by id or any of it's subdomains Retrieve all the data products tagged to the domain identified by id or any of it's subdomains.

func (*DataProductHubAPIServiceV1) GetDataProductByDomainWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataProductByDomainWithContext(ctx context.Context, getDataProductByDomainOptions *GetDataProductByDomainOptions) (result *DataProductVersionCollection, response *core.DetailedResponse, err error)

GetDataProductByDomainWithContext is an alternate form of the GetDataProductByDomain method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetDataProductDraft

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataProductDraft(getDataProductDraftOptions *GetDataProductDraftOptions) (result *DataProductDraft, response *core.DetailedResponse, err error)

GetDataProductDraft : Get a draft of an existing data product Get a draft of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) GetDataProductDraftContractTerms

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataProductDraftContractTerms(getDataProductDraftContractTermsOptions *GetDataProductDraftContractTermsOptions) (result *ContractTerms, response *core.DetailedResponse, err error)

GetDataProductDraftContractTerms : Retrieve a data product contract terms identified by id Retrieve a data product contract terms identified by id.

func (*DataProductHubAPIServiceV1) GetDataProductDraftContractTermsWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataProductDraftContractTermsWithContext(ctx context.Context, getDataProductDraftContractTermsOptions *GetDataProductDraftContractTermsOptions) (result *ContractTerms, response *core.DetailedResponse, err error)

GetDataProductDraftContractTermsWithContext is an alternate form of the GetDataProductDraftContractTerms method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetDataProductDraftWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataProductDraftWithContext(ctx context.Context, getDataProductDraftOptions *GetDataProductDraftOptions) (result *DataProductDraft, response *core.DetailedResponse, err error)

GetDataProductDraftWithContext is an alternate form of the GetDataProductDraft method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetDataProductRelease

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataProductRelease(getDataProductReleaseOptions *GetDataProductReleaseOptions) (result *DataProductRelease, response *core.DetailedResponse, err error)

GetDataProductRelease : Get a release of an existing data product Get a release of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) GetDataProductReleaseWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataProductReleaseWithContext(ctx context.Context, getDataProductReleaseOptions *GetDataProductReleaseOptions) (result *DataProductRelease, response *core.DetailedResponse, err error)

GetDataProductReleaseWithContext is an alternate form of the GetDataProductRelease method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetDataProductWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDataProductWithContext(ctx context.Context, getDataProductOptions *GetDataProductOptions) (result *DataProduct, response *core.DetailedResponse, err error)

GetDataProductWithContext is an alternate form of the GetDataProduct method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetDeliveryConfiguration added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDeliveryConfiguration(getDeliveryConfigurationOptions *GetDeliveryConfigurationOptions) (result *DeliveryMethodConfig, response *core.DetailedResponse, err error)

GetDeliveryConfiguration : list delivery configuration Use this API to list delivery method information in the global configuration.

func (*DataProductHubAPIServiceV1) GetDeliveryConfigurationWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDeliveryConfigurationWithContext(ctx context.Context, getDeliveryConfigurationOptions *GetDeliveryConfigurationOptions) (result *DeliveryMethodConfig, response *core.DetailedResponse, err error)

GetDeliveryConfigurationWithContext is an alternate form of the GetDeliveryConfiguration method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetDeliveryMethod added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDeliveryMethod(getDeliveryMethodOptions *GetDeliveryMethodOptions) (result *DeliveryMethodRes, response *core.DetailedResponse, err error)

GetDeliveryMethod : Retrieve delivery method Retrieve a specific delivery method by its ID.

func (*DataProductHubAPIServiceV1) GetDeliveryMethodWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDeliveryMethodWithContext(ctx context.Context, getDeliveryMethodOptions *GetDeliveryMethodOptions) (result *DeliveryMethodRes, response *core.DetailedResponse, err error)

GetDeliveryMethodWithContext is an alternate form of the GetDeliveryMethod method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetDomain

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDomain(getDomainOptions *GetDomainOptions) (result *DataProductDomain, response *core.DetailedResponse, err error)

GetDomain : Retrieve a data product domain or subdomain identified by id Retrieve a data product domain or subdomain identified by id.

func (*DataProductHubAPIServiceV1) GetDomainWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDomainWithContext(ctx context.Context, getDomainOptions *GetDomainOptions) (result *DataProductDomain, response *core.DetailedResponse, err error)

GetDomainWithContext is an alternate form of the GetDomain method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetDraftContractTermsDocument

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDraftContractTermsDocument(getDraftContractTermsDocumentOptions *GetDraftContractTermsDocumentOptions) (result *ContractTermsDocument, response *core.DetailedResponse, err error)

GetDraftContractTermsDocument : Get a contract document If a document has a completed attachment, the response contains the `url` which can be used to download the attachment. If a document does not have a completed attachment, the response contains the `url` which was submitted at document creation. If a document has an attachment that is incomplete, an error is returned to prompt the user to upload the document file and complete it. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) GetDraftContractTermsDocumentWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetDraftContractTermsDocumentWithContext(ctx context.Context, getDraftContractTermsDocumentOptions *GetDraftContractTermsDocumentOptions) (result *ContractTermsDocument, response *core.DetailedResponse, err error)

GetDraftContractTermsDocumentWithContext is an alternate form of the GetDraftContractTermsDocument method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetEnableGzipCompression

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*DataProductHubAPIServiceV1) GetInitializeStatus

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetInitializeStatus(getInitializeStatusOptions *GetInitializeStatusOptions) (result *InitializeResource, response *core.DetailedResponse, err error)

GetInitializeStatus : Get resource initialization status Use this API to get the status of resource initialization in Data Product Hub.<br/><br/>If the data product catalog exists but has never been initialized, the status will be "not_started".<br/><br/>If the data product catalog exists and has been or is being initialized, the response will contain the status of the last or current initialization. If the initialization failed, the "errors" and "trace" fields will contain the error(s) encountered during the initialization, including the ID to trace the error(s).<br/><br/>If the data product catalog doesn't exist, an HTTP 404 response is returned.

func (*DataProductHubAPIServiceV1) GetInitializeStatusWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetInitializeStatusWithContext(ctx context.Context, getInitializeStatusOptions *GetInitializeStatusOptions) (result *InitializeResource, response *core.DetailedResponse, err error)

GetInitializeStatusWithContext is an alternate form of the GetInitializeStatus method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetPublishedDataProductDraftContractTerms

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetPublishedDataProductDraftContractTerms(getPublishedDataProductDraftContractTermsOptions *GetPublishedDataProductDraftContractTermsOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetPublishedDataProductDraftContractTerms : Retrieve a published data product contract terms identified by id Retrieve a published data product contract terms identified by id.

func (*DataProductHubAPIServiceV1) GetPublishedDataProductDraftContractTermsWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetPublishedDataProductDraftContractTermsWithContext(ctx context.Context, getPublishedDataProductDraftContractTermsOptions *GetPublishedDataProductDraftContractTermsOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetPublishedDataProductDraftContractTermsWithContext is an alternate form of the GetPublishedDataProductDraftContractTerms method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetReleaseContractTermsDocument

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetReleaseContractTermsDocument(getReleaseContractTermsDocumentOptions *GetReleaseContractTermsDocumentOptions) (result *ContractTermsDocument, response *core.DetailedResponse, err error)

GetReleaseContractTermsDocument : Get a contract document If the document has a completed attachment, the response contains the `url` to download the attachment.<br/><br/> If the document does not have an attachment, the response contains the `url` which was submitted at document creation.<br/><br/> If the document has an incomplete attachment, an error is returned to prompt the user to upload the document file to complete the attachment. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) GetReleaseContractTermsDocumentWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetReleaseContractTermsDocumentWithContext(ctx context.Context, getReleaseContractTermsDocumentOptions *GetReleaseContractTermsDocumentOptions) (result *ContractTermsDocument, response *core.DetailedResponse, err error)

GetReleaseContractTermsDocumentWithContext is an alternate form of the GetReleaseContractTermsDocument method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetRevokeAccessProcessState added in v4.1.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetRevokeAccessProcessState(getRevokeAccessProcessStateOptions *GetRevokeAccessProcessStateOptions) (result *RevokeAccessStateResponse, response *core.DetailedResponse, err error)

GetRevokeAccessProcessState : Access revoke status of the subscriptions against the data product release id Retrieves the status of revoke access requests.

func (*DataProductHubAPIServiceV1) GetRevokeAccessProcessStateWithContext added in v4.1.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetRevokeAccessProcessStateWithContext(ctx context.Context, getRevokeAccessProcessStateOptions *GetRevokeAccessProcessStateOptions) (result *RevokeAccessStateResponse, response *core.DetailedResponse, err error)

GetRevokeAccessProcessStateWithContext is an alternate form of the GetRevokeAccessProcessState method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetS3BucketValidation

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetS3BucketValidation(getS3BucketValidationOptions *GetS3BucketValidationOptions) (result *BucketValidationResponse, response *core.DetailedResponse, err error)

GetS3BucketValidation : Validate the Bucket Existence Use this API to validate the bucket existence on an AWS hosting.

func (*DataProductHubAPIServiceV1) GetS3BucketValidationWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetS3BucketValidationWithContext(ctx context.Context, getS3BucketValidationOptions *GetS3BucketValidationOptions) (result *BucketValidationResponse, response *core.DetailedResponse, err error)

GetS3BucketValidationWithContext is an alternate form of the GetS3BucketValidation method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetServiceIDCredentials

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetServiceIDCredentials(getServiceIDCredentialsOptions *GetServiceIDCredentialsOptions) (result *ServiceIDCredentials, response *core.DetailedResponse, err error)

GetServiceIDCredentials : Get service id credentials Use this API to get the information of service id credentials in Data Product Hub.

func (*DataProductHubAPIServiceV1) GetServiceIDCredentialsWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetServiceIDCredentialsWithContext(ctx context.Context, getServiceIDCredentialsOptions *GetServiceIDCredentialsOptions) (result *ServiceIDCredentials, response *core.DetailedResponse, err error)

GetServiceIDCredentialsWithContext is an alternate form of the GetServiceIDCredentials method which supports a Context parameter

func (*DataProductHubAPIServiceV1) GetServiceURL

func (dataProductHubApiService *DataProductHubAPIServiceV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*DataProductHubAPIServiceV1) Initialize

func (dataProductHubApiService *DataProductHubAPIServiceV1) Initialize(initializeOptions *InitializeOptions) (result *InitializeResource, response *core.DetailedResponse, err error)

Initialize : Initialize resources Use this API to initialize default assets for data product hub. <br/><br/>You can initialize: <br/><ul><li>`delivery_methods` - Methods through which data product parts can be delivered to consumers of the data product hub</li><li>`domains_multi_industry` - Taxonomy of domains and use cases applicable to multiple industries</li><li>`data_product_samples` - Sample data products used to illustrate capabilities of the data product hub</li><li>`workflows` - Workflows to enable restricted data products</li><li>`project` - A default project for exporting data assets to files</li><li>`catalog_configurations` - Catalog configurations for the default data product catalog</li><li>`gen_ai_onboarding` - Enable GenAI capabilities for the data product catalog and onboard the associated project</li></ul><br/><br/>If a resource depends on resources that are not specified in the request, these dependent resources will be automatically initialized. E.g., initializing `data_product_samples` will also initialize `domains_multi_industry` and `delivery_methods` even if they are not specified in the request because it depends on them.<br/><br/>If initializing the data product hub for the first time, do not specify a container. The default data product catalog will be created.<br/>For first time initialization, it is recommended that at least `delivery_methods` and `domains_multi_industry` is included in the initialize operation.<br/><br/>If the data product hub has already been initialized, you may call this API again to initialize new resources, such as new delivery methods. In this case, specify the default data product catalog container information.

func (*DataProductHubAPIServiceV1) InitializeWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) InitializeWithContext(ctx context.Context, initializeOptions *InitializeOptions) (result *InitializeResource, response *core.DetailedResponse, err error)

InitializeWithContext is an alternate form of the Initialize method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ListDataProductContractTemplate

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDataProductContractTemplate(listDataProductContractTemplateOptions *ListDataProductContractTemplateOptions) (result *DataProductContractTemplateCollection, response *core.DetailedResponse, err error)

ListDataProductContractTemplate : Retrieve a list of data product contract templates Retrieve a list of data product contract templates.

func (*DataProductHubAPIServiceV1) ListDataProductContractTemplateWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDataProductContractTemplateWithContext(ctx context.Context, listDataProductContractTemplateOptions *ListDataProductContractTemplateOptions) (result *DataProductContractTemplateCollection, response *core.DetailedResponse, err error)

ListDataProductContractTemplateWithContext is an alternate form of the ListDataProductContractTemplate method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ListDataProductDomains

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDataProductDomains(listDataProductDomainsOptions *ListDataProductDomainsOptions) (result *DataProductDomainCollection, response *core.DetailedResponse, err error)

ListDataProductDomains : Retrieve a list of data product domains Retrieve a list of data product domains.

func (*DataProductHubAPIServiceV1) ListDataProductDomainsWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDataProductDomainsWithContext(ctx context.Context, listDataProductDomainsOptions *ListDataProductDomainsOptions) (result *DataProductDomainCollection, response *core.DetailedResponse, err error)

ListDataProductDomainsWithContext is an alternate form of the ListDataProductDomains method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ListDataProductDrafts

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDataProductDrafts(listDataProductDraftsOptions *ListDataProductDraftsOptions) (result *DataProductDraftCollection, response *core.DetailedResponse, err error)

ListDataProductDrafts : Retrieve a list of data product drafts Retrieve a list of data product drafts. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) ListDataProductDraftsWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDataProductDraftsWithContext(ctx context.Context, listDataProductDraftsOptions *ListDataProductDraftsOptions) (result *DataProductDraftCollection, response *core.DetailedResponse, err error)

ListDataProductDraftsWithContext is an alternate form of the ListDataProductDrafts method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ListDataProductReleases

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDataProductReleases(listDataProductReleasesOptions *ListDataProductReleasesOptions) (result *DataProductReleaseCollection, response *core.DetailedResponse, err error)

ListDataProductReleases : Retrieve a list of data product releases Retrieve a list of data product releases. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) ListDataProductReleasesWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDataProductReleasesWithContext(ctx context.Context, listDataProductReleasesOptions *ListDataProductReleasesOptions) (result *DataProductReleaseCollection, response *core.DetailedResponse, err error)

ListDataProductReleasesWithContext is an alternate form of the ListDataProductReleases method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ListDataProducts

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDataProducts(listDataProductsOptions *ListDataProductsOptions) (result *DataProductCollection, response *core.DetailedResponse, err error)

ListDataProducts : Retrieve a list of data products Retrieve a list of data products.

func (*DataProductHubAPIServiceV1) ListDataProductsWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDataProductsWithContext(ctx context.Context, listDataProductsOptions *ListDataProductsOptions) (result *DataProductCollection, response *core.DetailedResponse, err error)

ListDataProductsWithContext is an alternate form of the ListDataProducts method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ListDeliveryMethods added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDeliveryMethods(listDeliveryMethodsOptions *ListDeliveryMethodsOptions) (result *DeliveryMethodResCollection, response *core.DetailedResponse, err error)

ListDeliveryMethods : List delivery methods Returns all available delivery methods with enablement status.

func (*DataProductHubAPIServiceV1) ListDeliveryMethodsWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListDeliveryMethodsWithContext(ctx context.Context, listDeliveryMethodsOptions *ListDeliveryMethodsOptions) (result *DeliveryMethodResCollection, response *core.DetailedResponse, err error)

ListDeliveryMethodsWithContext is an alternate form of the ListDeliveryMethods method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ListRetiredDataProductReleasesLatest added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListRetiredDataProductReleasesLatest(listRetiredDataProductReleasesLatestOptions *ListRetiredDataProductReleasesLatestOptions) (result *DataProductReleaseCollection, response *core.DetailedResponse, err error)

ListRetiredDataProductReleasesLatest : Retrieve a list of retired data product releases (latest version only) Retrieve a list of retired data product releases, showing only the latest version per product ID. This endpoint filters retired versions to show one entry per product. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) ListRetiredDataProductReleasesLatestWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) ListRetiredDataProductReleasesLatestWithContext(ctx context.Context, listRetiredDataProductReleasesLatestOptions *ListRetiredDataProductReleasesLatestOptions) (result *DataProductReleaseCollection, response *core.DetailedResponse, err error)

ListRetiredDataProductReleasesLatestWithContext is an alternate form of the ListRetiredDataProductReleasesLatest method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ManageAPIKeys

func (dataProductHubApiService *DataProductHubAPIServiceV1) ManageAPIKeys(manageAPIKeysOptions *ManageAPIKeysOptions) (response *core.DetailedResponse, err error)

ManageAPIKeys : Rotate credentials for a Data Product Hub instance Use this API to rotate credentials for a Data Product Hub instance.

func (*DataProductHubAPIServiceV1) ManageAPIKeysWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) ManageAPIKeysWithContext(ctx context.Context, manageAPIKeysOptions *ManageAPIKeysOptions) (response *core.DetailedResponse, err error)

ManageAPIKeysWithContext is an alternate form of the ManageAPIKeys method which supports a Context parameter

func (*DataProductHubAPIServiceV1) NewAssetPartReference

func (*DataProductHubAPIServiceV1) NewAssetPartReference(container *ContainerReference) (_model *AssetPartReference, err error)

NewAssetPartReference : Instantiate AssetPartReference (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewAssetPrototype

func (*DataProductHubAPIServiceV1) NewAssetPrototype(container *ContainerIdentity) (_model *AssetPrototype, err error)

NewAssetPrototype : Instantiate AssetPrototype (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewAssetReference

func (*DataProductHubAPIServiceV1) NewAssetReference(container *ContainerReference) (_model *AssetReference, err error)

NewAssetReference : Instantiate AssetReference (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewCompleteDraftContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewCompleteDraftContractTermsDocumentOptions(dataProductID string, draftID string, contractTermsID string, documentID string) *CompleteDraftContractTermsDocumentOptions

NewCompleteDraftContractTermsDocumentOptions : Instantiate CompleteDraftContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewContainerIdentity

func (*DataProductHubAPIServiceV1) NewContainerIdentity(id string) (_model *ContainerIdentity, err error)

NewContainerIdentity : Instantiate ContainerIdentity (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContainerReference

func (*DataProductHubAPIServiceV1) NewContainerReference(id string, typeVar string) (_model *ContainerReference, err error)

NewContainerReference : Instantiate ContainerReference (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractAuthoritativeDefinition added in v4.2.0

func (*DataProductHubAPIServiceV1) NewContractAuthoritativeDefinition(url string, typeVar string) (_model *ContractAuthoritativeDefinition, err error)

NewContractAuthoritativeDefinition : Instantiate ContractAuthoritativeDefinition (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractQualityRule added in v4.1.0

func (*DataProductHubAPIServiceV1) NewContractQualityRule(typeVar string) (_model *ContractQualityRule, err error)

NewContractQualityRule : Instantiate ContractQualityRule (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractSchema added in v4.1.0

func (*DataProductHubAPIServiceV1) NewContractSchema(assetID string, connectionID string) (_model *ContractSchema, err error)

NewContractSchema : Instantiate ContractSchema (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractSchemaProperty

func (*DataProductHubAPIServiceV1) NewContractSchemaProperty(name string) (_model *ContractSchemaProperty, err error)

NewContractSchemaProperty : Instantiate ContractSchemaProperty (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractServer added in v4.1.0

func (*DataProductHubAPIServiceV1) NewContractServer(server string) (_model *ContractServer, err error)

NewContractServer : Instantiate ContractServer (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractTemplateCustomProperty

func (*DataProductHubAPIServiceV1) NewContractTemplateCustomProperty(property string, value string) (_model *ContractTemplateCustomProperty, err error)

NewContractTemplateCustomProperty : Instantiate ContractTemplateCustomProperty (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractTemplateMember added in v4.2.0

func (*DataProductHubAPIServiceV1) NewContractTemplateMember(userID string, role string) (_model *ContractTemplateMember, err error)

NewContractTemplateMember : Instantiate ContractTemplateMember (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractTemplateSLAProperty

func (*DataProductHubAPIServiceV1) NewContractTemplateSLAProperty(property string, value string) (_model *ContractTemplateSLAProperty, err error)

NewContractTemplateSLAProperty : Instantiate ContractTemplateSLAProperty (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractTemplateSupportAndCommunication

func (*DataProductHubAPIServiceV1) NewContractTemplateSupportAndCommunication(channel string) (_model *ContractTemplateSupportAndCommunication, err error)

NewContractTemplateSupportAndCommunication : Instantiate ContractTemplateSupportAndCommunication (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractTermsDocument

func (*DataProductHubAPIServiceV1) NewContractTermsDocument(typeVar string, name string, id string) (_model *ContractTermsDocument, err error)

NewContractTermsDocument : Instantiate ContractTermsDocument (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewContractTermsDocumentPatch

func (*DataProductHubAPIServiceV1) NewContractTermsDocumentPatch(contractTermsDocument *ContractTermsDocument) (_patch []JSONPatchOperation)

func (*DataProductHubAPIServiceV1) NewContractTermsPatch

func (*DataProductHubAPIServiceV1) NewContractTermsPatch(contractTerms *ContractTerms) (_patch []JSONPatchOperation)

func (*DataProductHubAPIServiceV1) NewContractTest

func (*DataProductHubAPIServiceV1) NewContractTest(status string, lastTestedTime *strfmt.DateTime) (_model *ContractTest, err error)

NewContractTest : Instantiate ContractTest (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewCreateContractTemplateOptions

func (*DataProductHubAPIServiceV1) NewCreateContractTemplateOptions(container *ContainerReference) *CreateContractTemplateOptions

NewCreateContractTemplateOptions : Instantiate CreateContractTemplateOptions

func (*DataProductHubAPIServiceV1) NewCreateDataAssetVisualizationOptions

func (*DataProductHubAPIServiceV1) NewCreateDataAssetVisualizationOptions() *CreateDataAssetVisualizationOptions

NewCreateDataAssetVisualizationOptions : Instantiate CreateDataAssetVisualizationOptions

func (*DataProductHubAPIServiceV1) NewCreateDataContractTestRunOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewCreateDataContractTestRunOptions(dataProductID string, projectID string, catalogID string, contractName string, contractYaml string) *CreateDataContractTestRunOptions

NewCreateDataContractTestRunOptions : Instantiate CreateDataContractTestRunOptions

func (*DataProductHubAPIServiceV1) NewCreateDataProductDomainOptions

func (*DataProductHubAPIServiceV1) NewCreateDataProductDomainOptions(container *ContainerReference) *CreateDataProductDomainOptions

NewCreateDataProductDomainOptions : Instantiate CreateDataProductDomainOptions

func (*DataProductHubAPIServiceV1) NewCreateDataProductDraftOptions

func (*DataProductHubAPIServiceV1) NewCreateDataProductDraftOptions(dataProductID string, asset *AssetPrototype) *CreateDataProductDraftOptions

NewCreateDataProductDraftOptions : Instantiate CreateDataProductDraftOptions

func (*DataProductHubAPIServiceV1) NewCreateDataProductOptions

func (*DataProductHubAPIServiceV1) NewCreateDataProductOptions(drafts []DataProductDraftPrototype) *CreateDataProductOptions

NewCreateDataProductOptions : Instantiate CreateDataProductOptions

func (*DataProductHubAPIServiceV1) NewCreateDataProductSubdomainOptions

func (*DataProductHubAPIServiceV1) NewCreateDataProductSubdomainOptions(domainID string, containerID string) *CreateDataProductSubdomainOptions

NewCreateDataProductSubdomainOptions : Instantiate CreateDataProductSubdomainOptions

func (*DataProductHubAPIServiceV1) NewCreateDeliveryMethodOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewCreateDeliveryMethodOptions(catalogID string, name string, resourceKey string, description string, status string, container *ContainerReference) *CreateDeliveryMethodOptions

NewCreateDeliveryMethodOptions : Instantiate CreateDeliveryMethodOptions

func (*DataProductHubAPIServiceV1) NewCreateDraftContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewCreateDraftContractTermsDocumentOptions(dataProductID string, draftID string, contractTermsID string, typeVar string, name string) *CreateDraftContractTermsDocumentOptions

NewCreateDraftContractTermsDocumentOptions : Instantiate CreateDraftContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewCreateRevokeAccessProcessOptions added in v4.1.0

func (*DataProductHubAPIServiceV1) NewCreateRevokeAccessProcessOptions(dataProductID string, releaseID string) *CreateRevokeAccessProcessOptions

NewCreateRevokeAccessProcessOptions : Instantiate CreateRevokeAccessProcessOptions

func (*DataProductHubAPIServiceV1) NewCreateS3BucketOptions

func (*DataProductHubAPIServiceV1) NewCreateS3BucketOptions(isShared bool) *CreateS3BucketOptions

NewCreateS3BucketOptions : Instantiate CreateS3BucketOptions

func (*DataProductHubAPIServiceV1) NewDataAssetRelationship

func (*DataProductHubAPIServiceV1) NewDataAssetRelationship(asset *AssetReference, relatedAsset *AssetReference) (_model *DataAssetRelationship, err error)

NewDataAssetRelationship : Instantiate DataAssetRelationship (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewDataProductContractTemplate

func (*DataProductHubAPIServiceV1) NewDataProductContractTemplate(container *ContainerReference) (_model *DataProductContractTemplate, err error)

NewDataProductContractTemplate : Instantiate DataProductContractTemplate (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewDataProductContractTemplatePatch

func (*DataProductHubAPIServiceV1) NewDataProductContractTemplatePatch(dataProductContractTemplate *DataProductContractTemplate) (_patch []JSONPatchOperation)

func (*DataProductHubAPIServiceV1) NewDataProductDomain

func (*DataProductHubAPIServiceV1) NewDataProductDomain(container *ContainerReference) (_model *DataProductDomain, err error)

NewDataProductDomain : Instantiate DataProductDomain (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewDataProductDomainPatch

func (*DataProductHubAPIServiceV1) NewDataProductDomainPatch(dataProductDomain *DataProductDomain) (_patch []JSONPatchOperation)

func (*DataProductHubAPIServiceV1) NewDataProductDraftPatch

func (*DataProductHubAPIServiceV1) NewDataProductDraftPatch(dataProductDraft *DataProductDraft) (_patch []JSONPatchOperation)

func (*DataProductHubAPIServiceV1) NewDataProductDraftPrototype

func (*DataProductHubAPIServiceV1) NewDataProductDraftPrototype(asset *AssetPrototype) (_model *DataProductDraftPrototype, err error)

NewDataProductDraftPrototype : Instantiate DataProductDraftPrototype (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewDataProductDraftsPager

func (dataProductHubApiService *DataProductHubAPIServiceV1) NewDataProductDraftsPager(options *ListDataProductDraftsOptions) (pager *DataProductDraftsPager, err error)

NewDataProductDraftsPager returns a new DataProductDraftsPager instance.

func (*DataProductHubAPIServiceV1) NewDataProductIdentity

func (*DataProductHubAPIServiceV1) NewDataProductIdentity(id string) (_model *DataProductIdentity, err error)

NewDataProductIdentity : Instantiate DataProductIdentity (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewDataProductPart

func (*DataProductHubAPIServiceV1) NewDataProductPart(asset *AssetPartReference, deliveryMethods []DeliveryMethod) (_model *DataProductPart, err error)

NewDataProductPart : Instantiate DataProductPart (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewDataProductReleasePatch

func (*DataProductHubAPIServiceV1) NewDataProductReleasePatch(dataProductRelease *DataProductRelease) (_patch []JSONPatchOperation)

func (*DataProductHubAPIServiceV1) NewDataProductReleasesPager

func (dataProductHubApiService *DataProductHubAPIServiceV1) NewDataProductReleasesPager(options *ListDataProductReleasesOptions) (pager *DataProductReleasesPager, err error)

NewDataProductReleasesPager returns a new DataProductReleasesPager instance.

func (*DataProductHubAPIServiceV1) NewDataProductsPager

func (dataProductHubApiService *DataProductHubAPIServiceV1) NewDataProductsPager(options *ListDataProductsOptions) (pager *DataProductsPager, err error)

NewDataProductsPager returns a new DataProductsPager instance.

func (*DataProductHubAPIServiceV1) NewDeleteDataProductContractTemplateOptions

func (*DataProductHubAPIServiceV1) NewDeleteDataProductContractTemplateOptions(contractTemplateID string, containerID string) *DeleteDataProductContractTemplateOptions

NewDeleteDataProductContractTemplateOptions : Instantiate DeleteDataProductContractTemplateOptions

func (*DataProductHubAPIServiceV1) NewDeleteDataProductDraftOptions

func (*DataProductHubAPIServiceV1) NewDeleteDataProductDraftOptions(dataProductID string, draftID string) *DeleteDataProductDraftOptions

NewDeleteDataProductDraftOptions : Instantiate DeleteDataProductDraftOptions

func (*DataProductHubAPIServiceV1) NewDeleteDeliveryMethodOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewDeleteDeliveryMethodOptions(catalogID string, deliveryMethodID string) *DeleteDeliveryMethodOptions

NewDeleteDeliveryMethodOptions : Instantiate DeleteDeliveryMethodOptions

func (*DataProductHubAPIServiceV1) NewDeleteDomainOptions

func (*DataProductHubAPIServiceV1) NewDeleteDomainOptions(domainID string) *DeleteDomainOptions

NewDeleteDomainOptions : Instantiate DeleteDomainOptions

func (*DataProductHubAPIServiceV1) NewDeleteDraftContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewDeleteDraftContractTermsDocumentOptions(dataProductID string, draftID string, contractTermsID string, documentID string) *DeleteDraftContractTermsDocumentOptions

NewDeleteDraftContractTermsDocumentOptions : Instantiate DeleteDraftContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewDeliveryMethod

func (*DataProductHubAPIServiceV1) NewDeliveryMethod(id string, container *ContainerReference) (_model *DeliveryMethod, err error)

NewDeliveryMethod : Instantiate DeliveryMethod (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewDeliveryMethodConfigPatch added in v4.2.0

func (*DataProductHubAPIServiceV1) NewDeliveryMethodConfigPatch(deliveryMethodConfig *DeliveryMethodConfig) (_patch []JSONPatchOperation)

func (*DataProductHubAPIServiceV1) NewDeliveryMethodResPatch added in v4.2.0

func (*DataProductHubAPIServiceV1) NewDeliveryMethodResPatch(deliveryMethodRes *DeliveryMethodRes) (_patch []JSONPatchOperation)

func (*DataProductHubAPIServiceV1) NewDomain

func (*DataProductHubAPIServiceV1) NewDomain(id string) (_model *Domain, err error)

NewDomain : Instantiate Domain (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewEngineDetailsModel added in v4.1.0

func (*DataProductHubAPIServiceV1) NewEngineDetailsModel(engineType string) (_model *EngineDetailsModel, err error)

NewEngineDetailsModel : Instantiate EngineDetailsModel (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewErrorMessage

func (*DataProductHubAPIServiceV1) NewErrorMessage(code string, message string) (_model *ErrorMessage, err error)

NewErrorMessage : Instantiate ErrorMessage (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewErrorModelResource

func (*DataProductHubAPIServiceV1) NewErrorModelResource(code string) (_model *ErrorModelResource, err error)

NewErrorModelResource : Instantiate ErrorModelResource (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewGetContractTemplateOptions

func (*DataProductHubAPIServiceV1) NewGetContractTemplateOptions(contractTemplateID string, containerID string) *GetContractTemplateOptions

NewGetContractTemplateOptions : Instantiate GetContractTemplateOptions

func (*DataProductHubAPIServiceV1) NewGetContractTemplatesByDomainOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewGetContractTemplatesByDomainOptions(domainID string, containerID string) *GetContractTemplatesByDomainOptions

NewGetContractTemplatesByDomainOptions : Instantiate GetContractTemplatesByDomainOptions

func (*DataProductHubAPIServiceV1) NewGetContractTermsInSpecifiedFormatOptions added in v4.1.0

func (*DataProductHubAPIServiceV1) NewGetContractTermsInSpecifiedFormatOptions(dataProductID string, draftID string, contractTermsID string, format string, formatVersion string) *GetContractTermsInSpecifiedFormatOptions

NewGetContractTermsInSpecifiedFormatOptions : Instantiate GetContractTermsInSpecifiedFormatOptions

func (*DataProductHubAPIServiceV1) NewGetDataContractTestResultsOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewGetDataContractTestResultsOptions(dataProductID string, dataContractID string, testRunID string, projectID string) *GetDataContractTestResultsOptions

NewGetDataContractTestResultsOptions : Instantiate GetDataContractTestResultsOptions

func (*DataProductHubAPIServiceV1) NewGetDataProductByDomainOptions

func (*DataProductHubAPIServiceV1) NewGetDataProductByDomainOptions(domainID string, containerID string) *GetDataProductByDomainOptions

NewGetDataProductByDomainOptions : Instantiate GetDataProductByDomainOptions

func (*DataProductHubAPIServiceV1) NewGetDataProductDraftContractTermsOptions

func (*DataProductHubAPIServiceV1) NewGetDataProductDraftContractTermsOptions(dataProductID string, draftID string, contractTermsID string) *GetDataProductDraftContractTermsOptions

NewGetDataProductDraftContractTermsOptions : Instantiate GetDataProductDraftContractTermsOptions

func (*DataProductHubAPIServiceV1) NewGetDataProductDraftOptions

func (*DataProductHubAPIServiceV1) NewGetDataProductDraftOptions(dataProductID string, draftID string) *GetDataProductDraftOptions

NewGetDataProductDraftOptions : Instantiate GetDataProductDraftOptions

func (*DataProductHubAPIServiceV1) NewGetDataProductOptions

func (*DataProductHubAPIServiceV1) NewGetDataProductOptions(dataProductID string) *GetDataProductOptions

NewGetDataProductOptions : Instantiate GetDataProductOptions

func (*DataProductHubAPIServiceV1) NewGetDataProductReleaseOptions

func (*DataProductHubAPIServiceV1) NewGetDataProductReleaseOptions(dataProductID string, releaseID string) *GetDataProductReleaseOptions

NewGetDataProductReleaseOptions : Instantiate GetDataProductReleaseOptions

func (*DataProductHubAPIServiceV1) NewGetDeliveryConfigurationOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewGetDeliveryConfigurationOptions() *GetDeliveryConfigurationOptions

NewGetDeliveryConfigurationOptions : Instantiate GetDeliveryConfigurationOptions

func (*DataProductHubAPIServiceV1) NewGetDeliveryMethodOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewGetDeliveryMethodOptions(catalogID string, deliveryMethodID string) *GetDeliveryMethodOptions

NewGetDeliveryMethodOptions : Instantiate GetDeliveryMethodOptions

func (*DataProductHubAPIServiceV1) NewGetDomainOptions

func (*DataProductHubAPIServiceV1) NewGetDomainOptions(domainID string) *GetDomainOptions

NewGetDomainOptions : Instantiate GetDomainOptions

func (*DataProductHubAPIServiceV1) NewGetDraftContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewGetDraftContractTermsDocumentOptions(dataProductID string, draftID string, contractTermsID string, documentID string) *GetDraftContractTermsDocumentOptions

NewGetDraftContractTermsDocumentOptions : Instantiate GetDraftContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewGetInitializeStatusOptions

func (*DataProductHubAPIServiceV1) NewGetInitializeStatusOptions() *GetInitializeStatusOptions

NewGetInitializeStatusOptions : Instantiate GetInitializeStatusOptions

func (*DataProductHubAPIServiceV1) NewGetPublishedDataProductDraftContractTermsOptions

func (*DataProductHubAPIServiceV1) NewGetPublishedDataProductDraftContractTermsOptions(dataProductID string, releaseID string, contractTermsID string) *GetPublishedDataProductDraftContractTermsOptions

NewGetPublishedDataProductDraftContractTermsOptions : Instantiate GetPublishedDataProductDraftContractTermsOptions

func (*DataProductHubAPIServiceV1) NewGetReleaseContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewGetReleaseContractTermsDocumentOptions(dataProductID string, releaseID string, contractTermsID string, documentID string) *GetReleaseContractTermsDocumentOptions

NewGetReleaseContractTermsDocumentOptions : Instantiate GetReleaseContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewGetRevokeAccessProcessStateOptions added in v4.1.0

func (*DataProductHubAPIServiceV1) NewGetRevokeAccessProcessStateOptions(releaseID string) *GetRevokeAccessProcessStateOptions

NewGetRevokeAccessProcessStateOptions : Instantiate GetRevokeAccessProcessStateOptions

func (*DataProductHubAPIServiceV1) NewGetS3BucketValidationOptions

func (*DataProductHubAPIServiceV1) NewGetS3BucketValidationOptions(bucketName string) *GetS3BucketValidationOptions

NewGetS3BucketValidationOptions : Instantiate GetS3BucketValidationOptions

func (*DataProductHubAPIServiceV1) NewGetServiceIDCredentialsOptions

func (*DataProductHubAPIServiceV1) NewGetServiceIDCredentialsOptions() *GetServiceIDCredentialsOptions

NewGetServiceIDCredentialsOptions : Instantiate GetServiceIDCredentialsOptions

func (*DataProductHubAPIServiceV1) NewInitializeOptions

func (*DataProductHubAPIServiceV1) NewInitializeOptions() *InitializeOptions

NewInitializeOptions : Instantiate InitializeOptions

func (*DataProductHubAPIServiceV1) NewJSONPatchOperation

func (*DataProductHubAPIServiceV1) NewJSONPatchOperation(op string, path string) (_model *JSONPatchOperation, err error)

NewJSONPatchOperation : Instantiate JSONPatchOperation (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewListDataProductContractTemplateOptions

func (*DataProductHubAPIServiceV1) NewListDataProductContractTemplateOptions() *ListDataProductContractTemplateOptions

NewListDataProductContractTemplateOptions : Instantiate ListDataProductContractTemplateOptions

func (*DataProductHubAPIServiceV1) NewListDataProductDomainsOptions

func (*DataProductHubAPIServiceV1) NewListDataProductDomainsOptions() *ListDataProductDomainsOptions

NewListDataProductDomainsOptions : Instantiate ListDataProductDomainsOptions

func (*DataProductHubAPIServiceV1) NewListDataProductDraftsOptions

func (*DataProductHubAPIServiceV1) NewListDataProductDraftsOptions(dataProductID string) *ListDataProductDraftsOptions

NewListDataProductDraftsOptions : Instantiate ListDataProductDraftsOptions

func (*DataProductHubAPIServiceV1) NewListDataProductReleasesOptions

func (*DataProductHubAPIServiceV1) NewListDataProductReleasesOptions(dataProductID string) *ListDataProductReleasesOptions

NewListDataProductReleasesOptions : Instantiate ListDataProductReleasesOptions

func (*DataProductHubAPIServiceV1) NewListDataProductsOptions

func (*DataProductHubAPIServiceV1) NewListDataProductsOptions() *ListDataProductsOptions

NewListDataProductsOptions : Instantiate ListDataProductsOptions

func (*DataProductHubAPIServiceV1) NewListDeliveryMethodsOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewListDeliveryMethodsOptions(catalogID string) *ListDeliveryMethodsOptions

NewListDeliveryMethodsOptions : Instantiate ListDeliveryMethodsOptions

func (*DataProductHubAPIServiceV1) NewListRetiredDataProductReleasesLatestOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewListRetiredDataProductReleasesLatestOptions(dataProductID string) *ListRetiredDataProductReleasesLatestOptions

NewListRetiredDataProductReleasesLatestOptions : Instantiate ListRetiredDataProductReleasesLatestOptions

func (*DataProductHubAPIServiceV1) NewManageAPIKeysOptions

func (*DataProductHubAPIServiceV1) NewManageAPIKeysOptions() *ManageAPIKeysOptions

NewManageAPIKeysOptions : Instantiate ManageAPIKeysOptions

func (*DataProductHubAPIServiceV1) NewOverview

func (*DataProductHubAPIServiceV1) NewOverview(version string, id string) (_model *Overview, err error)

NewOverview : Instantiate Overview (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewPublishDataProductDraftOptions

func (*DataProductHubAPIServiceV1) NewPublishDataProductDraftOptions(dataProductID string, draftID string) *PublishDataProductDraftOptions

NewPublishDataProductDraftOptions : Instantiate PublishDataProductDraftOptions

func (*DataProductHubAPIServiceV1) NewReinitiateDataAssetVisualizationOptions

func (*DataProductHubAPIServiceV1) NewReinitiateDataAssetVisualizationOptions() *ReinitiateDataAssetVisualizationOptions

NewReinitiateDataAssetVisualizationOptions : Instantiate ReinitiateDataAssetVisualizationOptions

func (*DataProductHubAPIServiceV1) NewReplaceDataProductDraftContractTermsOptions

func (*DataProductHubAPIServiceV1) NewReplaceDataProductDraftContractTermsOptions(dataProductID string, draftID string, contractTermsID string) *ReplaceDataProductDraftContractTermsOptions

NewReplaceDataProductDraftContractTermsOptions : Instantiate ReplaceDataProductDraftContractTermsOptions

func (*DataProductHubAPIServiceV1) NewRetireDataProductReleaseOptions

func (*DataProductHubAPIServiceV1) NewRetireDataProductReleaseOptions(dataProductID string, releaseID string) *RetireDataProductReleaseOptions

NewRetireDataProductReleaseOptions : Instantiate RetireDataProductReleaseOptions

func (*DataProductHubAPIServiceV1) NewRetiredDataProductReleasesLatestPager added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) NewRetiredDataProductReleasesLatestPager(options *ListRetiredDataProductReleasesLatestOptions) (pager *RetiredDataProductReleasesLatestPager, err error)

NewRetiredDataProductReleasesLatestPager returns a new RetiredDataProductReleasesLatestPager instance.

func (*DataProductHubAPIServiceV1) NewRoles added in v4.2.0

func (*DataProductHubAPIServiceV1) NewRoles(role string) (_model *Roles, err error)

NewRoles : Instantiate Roles (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewServerMapping added in v4.2.0

func (*DataProductHubAPIServiceV1) NewServerMapping(serverName string, connectionID string) (_model *ServerMapping, err error)

NewServerMapping : Instantiate ServerMapping (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewUpdateDataProductContractTemplateOptions

func (*DataProductHubAPIServiceV1) NewUpdateDataProductContractTemplateOptions(contractTemplateID string, containerID string, jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductContractTemplateOptions

NewUpdateDataProductContractTemplateOptions : Instantiate UpdateDataProductContractTemplateOptions

func (*DataProductHubAPIServiceV1) NewUpdateDataProductDomainOptions

func (*DataProductHubAPIServiceV1) NewUpdateDataProductDomainOptions(domainID string, containerID string, jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductDomainOptions

NewUpdateDataProductDomainOptions : Instantiate UpdateDataProductDomainOptions

func (*DataProductHubAPIServiceV1) NewUpdateDataProductDraftContractTermsOptions

func (*DataProductHubAPIServiceV1) NewUpdateDataProductDraftContractTermsOptions(dataProductID string, draftID string, contractTermsID string, jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductDraftContractTermsOptions

NewUpdateDataProductDraftContractTermsOptions : Instantiate UpdateDataProductDraftContractTermsOptions

func (*DataProductHubAPIServiceV1) NewUpdateDataProductDraftOptions

func (*DataProductHubAPIServiceV1) NewUpdateDataProductDraftOptions(dataProductID string, draftID string, jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductDraftOptions

NewUpdateDataProductDraftOptions : Instantiate UpdateDataProductDraftOptions

func (*DataProductHubAPIServiceV1) NewUpdateDataProductReleaseOptions

func (*DataProductHubAPIServiceV1) NewUpdateDataProductReleaseOptions(dataProductID string, releaseID string, jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductReleaseOptions

NewUpdateDataProductReleaseOptions : Instantiate UpdateDataProductReleaseOptions

func (*DataProductHubAPIServiceV1) NewUpdateDeliveryConfigurationOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewUpdateDeliveryConfigurationOptions(containerID string, jsonPatchOperation []JSONPatchOperation) *UpdateDeliveryConfigurationOptions

NewUpdateDeliveryConfigurationOptions : Instantiate UpdateDeliveryConfigurationOptions

func (*DataProductHubAPIServiceV1) NewUpdateDeliveryMethodOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewUpdateDeliveryMethodOptions(catalogID string, deliveryMethodID string, jsonPatchOperation []JSONPatchOperation) *UpdateDeliveryMethodOptions

NewUpdateDeliveryMethodOptions : Instantiate UpdateDeliveryMethodOptions

func (*DataProductHubAPIServiceV1) NewUpdateDraftContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewUpdateDraftContractTermsDocumentOptions(dataProductID string, draftID string, contractTermsID string, documentID string, jsonPatchInstructions []JSONPatchOperation) *UpdateDraftContractTermsDocumentOptions

NewUpdateDraftContractTermsDocumentOptions : Instantiate UpdateDraftContractTermsDocumentOptions

func (*DataProductHubAPIServiceV1) NewUseCase

func (*DataProductHubAPIServiceV1) NewUseCase(id string) (_model *UseCase, err error)

NewUseCase : Instantiate UseCase (Generic Model Constructor)

func (*DataProductHubAPIServiceV1) NewValidateContractTemplateYamlOptions added in v4.2.0

func (*DataProductHubAPIServiceV1) NewValidateContractTemplateYamlOptions(body string) *ValidateContractTemplateYamlOptions

NewValidateContractTemplateYamlOptions : Instantiate ValidateContractTemplateYamlOptions

func (*DataProductHubAPIServiceV1) PublishDataProductDraft

func (dataProductHubApiService *DataProductHubAPIServiceV1) PublishDataProductDraft(publishDataProductDraftOptions *PublishDataProductDraftOptions) (result *DataProductRelease, response *core.DetailedResponse, err error)

PublishDataProductDraft : Publish a draft of an existing data product Publish a draft of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) PublishDataProductDraftWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) PublishDataProductDraftWithContext(ctx context.Context, publishDataProductDraftOptions *PublishDataProductDraftOptions) (result *DataProductRelease, response *core.DetailedResponse, err error)

PublishDataProductDraftWithContext is an alternate form of the PublishDataProductDraft method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ReinitiateDataAssetVisualization

func (dataProductHubApiService *DataProductHubAPIServiceV1) ReinitiateDataAssetVisualization(reinitiateDataAssetVisualizationOptions *ReinitiateDataAssetVisualizationOptions) (result *DataAssetVisualizationRes, response *core.DetailedResponse, err error)

ReinitiateDataAssetVisualization : Reinitiate visualization for an asset Use this API to Reinitiate visualization for an asset which is in below scenarios<br/><br/>- Previous bucket got deleted and new bucket is created.<br/>- Data visualization attachment is missing in asset details.<br/>- Visualization asset reference is missing in related asset details.<br/><br/>.

func (*DataProductHubAPIServiceV1) ReinitiateDataAssetVisualizationWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) ReinitiateDataAssetVisualizationWithContext(ctx context.Context, reinitiateDataAssetVisualizationOptions *ReinitiateDataAssetVisualizationOptions) (result *DataAssetVisualizationRes, response *core.DetailedResponse, err error)

ReinitiateDataAssetVisualizationWithContext is an alternate form of the ReinitiateDataAssetVisualization method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ReplaceDataProductDraftContractTerms

func (dataProductHubApiService *DataProductHubAPIServiceV1) ReplaceDataProductDraftContractTerms(replaceDataProductDraftContractTermsOptions *ReplaceDataProductDraftContractTermsOptions) (result *ContractTerms, response *core.DetailedResponse, err error)

ReplaceDataProductDraftContractTerms : Update contract terms by id Update a data product contract terms identified by id - primarily used for clearing contents of contract terms. This endpoint does not support addition of servers and schema information except empty arrays.

func (*DataProductHubAPIServiceV1) ReplaceDataProductDraftContractTermsWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) ReplaceDataProductDraftContractTermsWithContext(ctx context.Context, replaceDataProductDraftContractTermsOptions *ReplaceDataProductDraftContractTermsOptions) (result *ContractTerms, response *core.DetailedResponse, err error)

ReplaceDataProductDraftContractTermsWithContext is an alternate form of the ReplaceDataProductDraftContractTerms method which supports a Context parameter

func (*DataProductHubAPIServiceV1) RetireDataProductRelease

func (dataProductHubApiService *DataProductHubAPIServiceV1) RetireDataProductRelease(retireDataProductReleaseOptions *RetireDataProductReleaseOptions) (result *DataProductRelease, response *core.DetailedResponse, err error)

RetireDataProductRelease : Retire a release of an existing data product Retire a release of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) RetireDataProductReleaseWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) RetireDataProductReleaseWithContext(ctx context.Context, retireDataProductReleaseOptions *RetireDataProductReleaseOptions) (result *DataProductRelease, response *core.DetailedResponse, err error)

RetireDataProductReleaseWithContext is an alternate form of the RetireDataProductRelease method which supports a Context parameter

func (*DataProductHubAPIServiceV1) SetDefaultHeaders

func (dataProductHubApiService *DataProductHubAPIServiceV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*DataProductHubAPIServiceV1) SetEnableGzipCompression

func (dataProductHubApiService *DataProductHubAPIServiceV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*DataProductHubAPIServiceV1) SetServiceURL

func (dataProductHubApiService *DataProductHubAPIServiceV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*DataProductHubAPIServiceV1) UpdateDataProductContractTemplate

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDataProductContractTemplate(updateDataProductContractTemplateOptions *UpdateDataProductContractTemplateOptions) (result *DataProductContractTemplate, response *core.DetailedResponse, err error)

UpdateDataProductContractTemplate : Update the data product contract template identified by ID Use this API to update the properties of a data product contract template identified by a valid ID.<br/><br/>Specify patch operations using http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the name of a data product contract template<br/><br/>- Update the contract terms of data product contract template<br/><br/>.

func (*DataProductHubAPIServiceV1) UpdateDataProductContractTemplateWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDataProductContractTemplateWithContext(ctx context.Context, updateDataProductContractTemplateOptions *UpdateDataProductContractTemplateOptions) (result *DataProductContractTemplate, response *core.DetailedResponse, err error)

UpdateDataProductContractTemplateWithContext is an alternate form of the UpdateDataProductContractTemplate method which supports a Context parameter

func (*DataProductHubAPIServiceV1) UpdateDataProductDomain

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDataProductDomain(updateDataProductDomainOptions *UpdateDataProductDomainOptions) (result *DataProductDomain, response *core.DetailedResponse, err error)

UpdateDataProductDomain : Update the data product domain identified by ID Use this API to update the properties of a data product domain identified by a valid ID.<br/><br/>Specify patch operations using http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the name of a data product domain<br/><br/>- Update the description of a data product domain<br/><br/>- Update the rov of a data product domain<br/><br/>.

func (*DataProductHubAPIServiceV1) UpdateDataProductDomainWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDataProductDomainWithContext(ctx context.Context, updateDataProductDomainOptions *UpdateDataProductDomainOptions) (result *DataProductDomain, response *core.DetailedResponse, err error)

UpdateDataProductDomainWithContext is an alternate form of the UpdateDataProductDomain method which supports a Context parameter

func (*DataProductHubAPIServiceV1) UpdateDataProductDraft

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDataProductDraft(updateDataProductDraftOptions *UpdateDataProductDraftOptions) (result *DataProductDraft, response *core.DetailedResponse, err error)

UpdateDataProductDraft : Update the data product draft identified by ID Use this API to update the properties of a data product draft identified by a valid ID. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.<br/><br/>Specify patch operations using http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the properties of a data product<br/><br/>- Add/Remove parts from a data product (up to 20 parts)<br/><br/>- Add/Remove use cases from a data product<br/><br/>- Update the data product state<br/><br/>.

func (*DataProductHubAPIServiceV1) UpdateDataProductDraftContractTerms

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDataProductDraftContractTerms(updateDataProductDraftContractTermsOptions *UpdateDataProductDraftContractTermsOptions) (result *ContractTerms, response *core.DetailedResponse, err error)

UpdateDataProductDraftContractTerms : Update a contract terms property Use this API to update the properties of a contract terms that is identified by a valid ID.

Specify patch operations using http://jsonpatch.com/ syntax.

Supported patch operations include: - Update the contract terms properties. <br/><br/>Contract terms can only be updated if the associated data product version is in DRAFT state.

func (*DataProductHubAPIServiceV1) UpdateDataProductDraftContractTermsWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDataProductDraftContractTermsWithContext(ctx context.Context, updateDataProductDraftContractTermsOptions *UpdateDataProductDraftContractTermsOptions) (result *ContractTerms, response *core.DetailedResponse, err error)

UpdateDataProductDraftContractTermsWithContext is an alternate form of the UpdateDataProductDraftContractTerms method which supports a Context parameter

func (*DataProductHubAPIServiceV1) UpdateDataProductDraftWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDataProductDraftWithContext(ctx context.Context, updateDataProductDraftOptions *UpdateDataProductDraftOptions) (result *DataProductDraft, response *core.DetailedResponse, err error)

UpdateDataProductDraftWithContext is an alternate form of the UpdateDataProductDraft method which supports a Context parameter

func (*DataProductHubAPIServiceV1) UpdateDataProductRelease

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDataProductRelease(updateDataProductReleaseOptions *UpdateDataProductReleaseOptions) (result *DataProductRelease, response *core.DetailedResponse, err error)

UpdateDataProductRelease : Update the data product release identified by ID Use this API to update the properties of a data product release identified by a valid ID. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.<br/><br/>Specify patch operations using http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the properties of a data product<br/><br/>- Add/remove parts from a data product (up to 20 parts)<br/><br/>- Add/remove use cases from a data product<br/><br/>.

func (*DataProductHubAPIServiceV1) UpdateDataProductReleaseWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDataProductReleaseWithContext(ctx context.Context, updateDataProductReleaseOptions *UpdateDataProductReleaseOptions) (result *DataProductRelease, response *core.DetailedResponse, err error)

UpdateDataProductReleaseWithContext is an alternate form of the UpdateDataProductRelease method which supports a Context parameter

func (*DataProductHubAPIServiceV1) UpdateDeliveryConfiguration added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDeliveryConfiguration(updateDeliveryConfigurationOptions *UpdateDeliveryConfigurationOptions) (result *DeliveryMethodConfig, response *core.DetailedResponse, err error)

UpdateDeliveryConfiguration : Update delivery configuration Use this API to update delivery method information in the global configuration. This allows patching delivery configuration such as delivery_methods status.

func (*DataProductHubAPIServiceV1) UpdateDeliveryConfigurationWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDeliveryConfigurationWithContext(ctx context.Context, updateDeliveryConfigurationOptions *UpdateDeliveryConfigurationOptions) (result *DeliveryMethodConfig, response *core.DetailedResponse, err error)

UpdateDeliveryConfigurationWithContext is an alternate form of the UpdateDeliveryConfiguration method which supports a Context parameter

func (*DataProductHubAPIServiceV1) UpdateDeliveryMethod added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDeliveryMethod(updateDeliveryMethodOptions *UpdateDeliveryMethodOptions) (result *DeliveryMethodRes, response *core.DetailedResponse, err error)

UpdateDeliveryMethod : Update a delivery method Update the delivery method identified by ID. Allows partial updates to delivery method configuration including status (enable/disable), configuration settings, and localization.

func (*DataProductHubAPIServiceV1) UpdateDeliveryMethodWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDeliveryMethodWithContext(ctx context.Context, updateDeliveryMethodOptions *UpdateDeliveryMethodOptions) (result *DeliveryMethodRes, response *core.DetailedResponse, err error)

UpdateDeliveryMethodWithContext is an alternate form of the UpdateDeliveryMethod method which supports a Context parameter

func (*DataProductHubAPIServiceV1) UpdateDraftContractTermsDocument

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDraftContractTermsDocument(updateDraftContractTermsDocumentOptions *UpdateDraftContractTermsDocumentOptions) (result *ContractTermsDocument, response *core.DetailedResponse, err error)

UpdateDraftContractTermsDocument : Update a contract document Use this API to update the properties of a contract document that is identified by a valid ID.

Specify patch operations using http://jsonpatch.com/ syntax.

Supported patch operations include: - Update the url of document if it does not have an attachment. - Update the type of the document. <br/><br/>Contract terms documents can only be updated if the associated data product version is in DRAFT state. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.

func (*DataProductHubAPIServiceV1) UpdateDraftContractTermsDocumentWithContext

func (dataProductHubApiService *DataProductHubAPIServiceV1) UpdateDraftContractTermsDocumentWithContext(ctx context.Context, updateDraftContractTermsDocumentOptions *UpdateDraftContractTermsDocumentOptions) (result *ContractTermsDocument, response *core.DetailedResponse, err error)

UpdateDraftContractTermsDocumentWithContext is an alternate form of the UpdateDraftContractTermsDocument method which supports a Context parameter

func (*DataProductHubAPIServiceV1) ValidateContractTemplateYaml added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) ValidateContractTemplateYaml(validateContractTemplateYamlOptions *ValidateContractTemplateYamlOptions) (result *ContractValidationResponse, response *core.DetailedResponse, err error)

ValidateContractTemplateYaml : Validate YAML against ODCS v3.1.0 standard Validates a YAML file against the Open Data Contract Standard (ODCS) v3.1.0 JSON schema. This endpoint checks for mandatory fields, data types, and mappings as required by the ODCS v3.1.0 standard. The endpoint always returns HTTP 200 with validation results in the response body. Check the 'valid' field in the response to determine if validation passed or failed.

func (*DataProductHubAPIServiceV1) ValidateContractTemplateYamlWithContext added in v4.2.0

func (dataProductHubApiService *DataProductHubAPIServiceV1) ValidateContractTemplateYamlWithContext(ctx context.Context, validateContractTemplateYamlOptions *ValidateContractTemplateYamlOptions) (result *ContractValidationResponse, response *core.DetailedResponse, err error)

ValidateContractTemplateYamlWithContext is an alternate form of the ValidateContractTemplateYaml method which supports a Context parameter

type DataProductHubAPIServiceV1Options

type DataProductHubAPIServiceV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

DataProductHubAPIServiceV1Options : Service options

type DataProductIdentity

type DataProductIdentity struct {
	// Data product identifier.
	ID *string `json:"id" validate:"required"`

	// A data product draft version object.
	Release *DataProductDraftVersionRelease `json:"release,omitempty"`
}

DataProductIdentity : Data product identifier.

type DataProductOrderAccessRequest

type DataProductOrderAccessRequest struct {
	// The workflow approvers associated with the data product version.
	TaskAssigneeUsers []string `json:"task_assignee_users,omitempty"`

	// The list of users or groups whose request will get pre-approved associated with the data product version.
	PreApprovedUsers []string `json:"pre_approved_users,omitempty"`

	// A custom workflow definition to be used to create a workflow to approve a data product subscription.
	CustomWorkflowDefinition *DataProductCustomWorkflowDefinition `json:"custom_workflow_definition,omitempty"`
}

DataProductOrderAccessRequest : The approval workflows associated with the data product version.

type DataProductPart

type DataProductPart struct {
	// The asset represented in this part.
	Asset *AssetPartReference `json:"asset" validate:"required"`

	// Delivery methods describing the delivery options available for this part.
	DeliveryMethods []DeliveryMethod `json:"delivery_methods" validate:"required"`
}

DataProductPart : Data Product Part.

type DataProductRelease

type DataProductRelease struct {
	// The data product version number.
	Version *string `json:"version" validate:"required"`

	// The state of the data product version.
	State *string `json:"state" validate:"required"`

	// Data product reference.
	DataProduct *DataProductReleaseDataProduct `json:"data_product" validate:"required"`

	// The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or periods.
	// Names are mutable and reusable.
	Name *string `json:"name" validate:"required"`

	// The description of the data product version.
	Description *string `json:"description" validate:"required"`

	// Tags on the data product.
	Tags []string `json:"tags" validate:"required"`

	// A list of use cases associated with the data product version.
	UseCases []UseCase `json:"use_cases,omitempty"`

	// Types of parts on the data product.
	Types []string `json:"types" validate:"required"`

	// Contract terms binding various aspects of the data product.
	ContractTerms []ContractTerms `json:"contract_terms" validate:"required"`

	// Domain that the data product version belongs to. If this is the first version of a data product, this field is
	// required. If this is a new version of an existing data product, the domain will default to the domain of the
	// previous version of the data product.
	Domain *Domain `json:"domain" validate:"required"`

	// The outgoing parts of this data product version to be delivered to consumers. If this is the first version of a data
	// product, this field defaults to an empty list. If this is a new version of an existing data product, the data
	// product parts will default to the parts list from the previous version of the data product.
	PartsOut []DataProductPart `json:"parts_out" validate:"required"`

	// The workflows associated with the data product version.
	Workflows *DataProductWorkflows `json:"workflows,omitempty"`

	// Indicates whether the dataView has enabled for data product.
	DataviewEnabled *bool `json:"dataview_enabled,omitempty"`

	// Comments by a producer that are provided either at the time of data product version creation or retiring.
	Comments *string `json:"comments,omitempty"`

	// Access control object.
	AccessControl *AssetListAccessControl `json:"access_control,omitempty"`

	// Timestamp of last asset update.
	LastUpdatedAt *strfmt.DateTime `json:"last_updated_at,omitempty"`

	// Timestamp of createddate.
	CreatedDate *strfmt.DateTime `json:"created_date,omitempty"`

	// The identity schema for a IBM knowledge catalog container (catalog/project/space).
	SubContainer *ContainerIdentity `json:"sub_container,omitempty"`

	// Indicates whether the data product is restricted or not. A restricted data product indicates that orders of the data
	// product requires explicit approval before data is delivered.
	IsRestricted *bool `json:"is_restricted" validate:"required"`

	// The identifier of the data product version.
	ID *string `json:"id" validate:"required"`

	// The reference schema for a asset in a container.
	Asset *AssetReference `json:"asset" validate:"required"`

	// The user who published this data product version.
	PublishedBy *string `json:"published_by,omitempty"`

	// The time when this data product version was published.
	PublishedAt *strfmt.DateTime `json:"published_at,omitempty"`

	// The creator of this data product version.
	CreatedBy *string `json:"created_by" validate:"required"`

	// The time when this data product version was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// Metadata properties on data products.
	Properties map[string]interface{} `json:"properties,omitempty"`

	// Errors encountered during the visualization creation process.
	VisualizationErrors []DataAssetRelationship `json:"visualization_errors,omitempty"`
}

DataProductRelease : Data Product version release.

type DataProductReleaseCollection

type DataProductReleaseCollection struct {
	// Set a limit on the number of results returned.
	Limit *int64 `json:"limit" validate:"required"`

	// First page in the collection.
	First *FirstPage `json:"first" validate:"required"`

	// Next page in the collection.
	Next *NextPage `json:"next,omitempty"`

	// Indicates the total number of results returned.
	TotalResults *int64 `json:"total_results,omitempty"`

	// Collection of data product releases.
	Releases []DataProductReleaseSummary `json:"releases" validate:"required"`
}

DataProductReleaseCollection : A collection of data product release summaries.

func (*DataProductReleaseCollection) GetNextStart

func (resp *DataProductReleaseCollection) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type DataProductReleaseDataProduct

type DataProductReleaseDataProduct struct {
	// Data product identifier.
	ID *string `json:"id" validate:"required"`

	// A data product draft version object.
	Release *DataProductDraftVersionRelease `json:"release,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`
}

DataProductReleaseDataProduct : Data product reference.

type DataProductReleaseSummary

type DataProductReleaseSummary struct {
	// The data product version number.
	Version *string `json:"version" validate:"required"`

	// The state of the data product version.
	State *string `json:"state" validate:"required"`

	// Data product reference.
	DataProduct *DataProductReleaseSummaryDataProduct `json:"data_product" validate:"required"`

	// The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or periods.
	// Names are mutable and reusable.
	Name *string `json:"name" validate:"required"`

	// The description of the data product version.
	Description *string `json:"description" validate:"required"`

	// Tags on the data product.
	Tags []string `json:"tags,omitempty"`

	// A list of use cases associated with the data product version.
	UseCases []UseCase `json:"use_cases,omitempty"`

	// Types of parts on the data product.
	Types []string `json:"types" validate:"required"`

	// Contract terms binding various aspects of the data product.
	ContractTerms []ContractTerms `json:"contract_terms" validate:"required"`

	// Domain that the data product version belongs to. If this is the first version of a data product, this field is
	// required. If this is a new version of an existing data product, the domain will default to the domain of the
	// previous version of the data product.
	Domain *Domain `json:"domain,omitempty"`

	// The outgoing parts of this data product version to be delivered to consumers. If this is the first version of a data
	// product, this field defaults to an empty list. If this is a new version of an existing data product, the data
	// product parts will default to the parts list from the previous version of the data product.
	PartsOut []DataProductPart `json:"parts_out,omitempty"`

	// The workflows associated with the data product version.
	Workflows *DataProductWorkflows `json:"workflows,omitempty"`

	// Indicates whether the dataView has enabled for data product.
	DataviewEnabled *bool `json:"dataview_enabled,omitempty"`

	// Comments by a producer that are provided either at the time of data product version creation or retiring.
	Comments *string `json:"comments,omitempty"`

	// Access control object.
	AccessControl *AssetListAccessControl `json:"access_control,omitempty"`

	// Timestamp of last asset update.
	LastUpdatedAt *strfmt.DateTime `json:"last_updated_at,omitempty"`

	// Timestamp of createddate.
	CreatedDate *strfmt.DateTime `json:"created_date,omitempty"`

	// The identity schema for a IBM knowledge catalog container (catalog/project/space).
	SubContainer *ContainerIdentity `json:"sub_container,omitempty"`

	// Indicates whether the data product is restricted or not. A restricted data product indicates that orders of the data
	// product requires explicit approval before data is delivered.
	IsRestricted *bool `json:"is_restricted" validate:"required"`

	// The identifier of the data product version.
	ID *string `json:"id" validate:"required"`

	// The reference schema for a asset in a container.
	Asset *AssetReference `json:"asset" validate:"required"`
}

DataProductReleaseSummary : Summary of Data Product Version object.

type DataProductReleaseSummaryDataProduct

type DataProductReleaseSummaryDataProduct struct {
	// Data product identifier.
	ID *string `json:"id" validate:"required"`

	// A data product draft version object.
	Release *DataProductDraftVersionRelease `json:"release,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`
}

DataProductReleaseSummaryDataProduct : Data product reference.

type DataProductReleasesPager

type DataProductReleasesPager struct {
	// contains filtered or unexported fields
}

DataProductReleasesPager can be used to simplify the use of the "ListDataProductReleases" method.

func (*DataProductReleasesPager) GetAll

func (pager *DataProductReleasesPager) GetAll() (allItems []DataProductReleaseSummary, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*DataProductReleasesPager) GetAllWithContext

func (pager *DataProductReleasesPager) GetAllWithContext(ctx context.Context) (allItems []DataProductReleaseSummary, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*DataProductReleasesPager) GetNext

func (pager *DataProductReleasesPager) GetNext() (page []DataProductReleaseSummary, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*DataProductReleasesPager) GetNextWithContext

func (pager *DataProductReleasesPager) GetNextWithContext(ctx context.Context) (page []DataProductReleaseSummary, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*DataProductReleasesPager) HasNext

func (pager *DataProductReleasesPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type DataProductSummary

type DataProductSummary struct {
	// Data product identifier.
	ID *string `json:"id" validate:"required"`

	// A data product draft version object.
	Release *DataProductDraftVersionRelease `json:"release,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`

	// Data product name.
	Name *string `json:"name,omitempty"`
}

DataProductSummary : Data Product Summary.

type DataProductVersionCollection

type DataProductVersionCollection struct {
	// Set a limit on the number of results returned.
	Limit *int64 `json:"limit" validate:"required"`

	// First page in the collection.
	First *FirstPage `json:"first" validate:"required"`

	// Next page in the collection.
	Next *NextPage `json:"next,omitempty"`

	// Indicates the total number of results returned.
	TotalResults *int64 `json:"total_results,omitempty"`

	// Collection of data product versions.
	DataProductVersions []DataProductVersionSummary `json:"data_product_versions" validate:"required"`
}

DataProductVersionCollection : A collection of data product version summaries.

type DataProductVersionSummary

type DataProductVersionSummary struct {
	// The data product version number.
	Version *string `json:"version" validate:"required"`

	// The state of the data product version.
	State *string `json:"state" validate:"required"`

	// Data product reference.
	DataProduct *DataProductVersionSummaryDataProduct `json:"data_product" validate:"required"`

	// The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or periods.
	// Names are mutable and reusable.
	Name *string `json:"name" validate:"required"`

	// The description of the data product version.
	Description *string `json:"description" validate:"required"`

	// Tags on the data product.
	Tags []string `json:"tags,omitempty"`

	// A list of use cases associated with the data product version.
	UseCases []UseCase `json:"use_cases,omitempty"`

	// Types of parts on the data product.
	Types []string `json:"types" validate:"required"`

	// Contract terms binding various aspects of the data product.
	ContractTerms []ContractTerms `json:"contract_terms" validate:"required"`

	// Domain that the data product version belongs to. If this is the first version of a data product, this field is
	// required. If this is a new version of an existing data product, the domain will default to the domain of the
	// previous version of the data product.
	Domain *Domain `json:"domain,omitempty"`

	// The outgoing parts of this data product version to be delivered to consumers. If this is the first version of a data
	// product, this field defaults to an empty list. If this is a new version of an existing data product, the data
	// product parts will default to the parts list from the previous version of the data product.
	PartsOut []DataProductPart `json:"parts_out,omitempty"`

	// The workflows associated with the data product version.
	Workflows *DataProductWorkflows `json:"workflows,omitempty"`

	// Indicates whether the dataView has enabled for data product.
	DataviewEnabled *bool `json:"dataview_enabled,omitempty"`

	// Comments by a producer that are provided either at the time of data product version creation or retiring.
	Comments *string `json:"comments,omitempty"`

	// Access control object.
	AccessControl *AssetListAccessControl `json:"access_control,omitempty"`

	// Timestamp of last asset update.
	LastUpdatedAt *strfmt.DateTime `json:"last_updated_at,omitempty"`

	// Timestamp of createddate.
	CreatedDate *strfmt.DateTime `json:"created_date,omitempty"`

	// The identity schema for a IBM knowledge catalog container (catalog/project/space).
	SubContainer *ContainerIdentity `json:"sub_container,omitempty"`

	// Indicates whether the data product is restricted or not. A restricted data product indicates that orders of the data
	// product requires explicit approval before data is delivered.
	IsRestricted *bool `json:"is_restricted" validate:"required"`

	// The identifier of the data product version.
	ID *string `json:"id" validate:"required"`

	// The reference schema for a asset in a container.
	Asset *AssetReference `json:"asset" validate:"required"`
}

DataProductVersionSummary : Summary of Data Product Version object.

type DataProductVersionSummaryDataProduct

type DataProductVersionSummaryDataProduct struct {
	// Data product identifier.
	ID *string `json:"id" validate:"required"`

	// A data product draft version object.
	Release *DataProductDraftVersionRelease `json:"release,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`
}

DataProductVersionSummaryDataProduct : Data product reference.

type DataProductWorkflows

type DataProductWorkflows struct {
	// The approval workflows associated with the data product version.
	OrderAccessRequest *DataProductOrderAccessRequest `json:"order_access_request,omitempty"`
}

DataProductWorkflows : The workflows associated with the data product version.

type DataProductsPager

type DataProductsPager struct {
	// contains filtered or unexported fields
}

DataProductsPager can be used to simplify the use of the "ListDataProducts" method.

func (*DataProductsPager) GetAll

func (pager *DataProductsPager) GetAll() (allItems []DataProductSummary, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*DataProductsPager) GetAllWithContext

func (pager *DataProductsPager) GetAllWithContext(ctx context.Context) (allItems []DataProductSummary, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*DataProductsPager) GetNext

func (pager *DataProductsPager) GetNext() (page []DataProductSummary, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*DataProductsPager) GetNextWithContext

func (pager *DataProductsPager) GetNextWithContext(ctx context.Context) (page []DataProductSummary, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*DataProductsPager) HasNext

func (pager *DataProductsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type DeleteDataProductContractTemplateOptions

type DeleteDataProductContractTemplateOptions struct {
	// Data Product Contract Template id.
	ContractTemplateID *string `json:"contract_template_id" validate:"required,ne="`

	// Container ID of the data product catalog.
	ContainerID *string `json:"container.id" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteDataProductContractTemplateOptions : The DeleteDataProductContractTemplate options.

func (*DeleteDataProductContractTemplateOptions) SetContainerID

SetContainerID : Allow user to set ContainerID

func (*DeleteDataProductContractTemplateOptions) SetContractTemplateID

func (_options *DeleteDataProductContractTemplateOptions) SetContractTemplateID(contractTemplateID string) *DeleteDataProductContractTemplateOptions

SetContractTemplateID : Allow user to set ContractTemplateID

func (*DeleteDataProductContractTemplateOptions) SetHeaders

SetHeaders : Allow user to set Headers

type DeleteDataProductDraftOptions

type DeleteDataProductDraftOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteDataProductDraftOptions : The DeleteDataProductDraft options.

func (*DeleteDataProductDraftOptions) SetDataProductID

func (_options *DeleteDataProductDraftOptions) SetDataProductID(dataProductID string) *DeleteDataProductDraftOptions

SetDataProductID : Allow user to set DataProductID

func (*DeleteDataProductDraftOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*DeleteDataProductDraftOptions) SetHeaders

SetHeaders : Allow user to set Headers

type DeleteDeliveryMethodOptions added in v4.2.0

type DeleteDeliveryMethodOptions struct {
	// The catalog ID where delivery method is stored.
	CatalogID *string `json:"catalog_id" validate:"required"`

	// The ID of the delivery method to remove.
	DeliveryMethodID *string `json:"delivery_method_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteDeliveryMethodOptions : The DeleteDeliveryMethod options.

func (*DeleteDeliveryMethodOptions) SetCatalogID added in v4.2.0

func (_options *DeleteDeliveryMethodOptions) SetCatalogID(catalogID string) *DeleteDeliveryMethodOptions

SetCatalogID : Allow user to set CatalogID

func (*DeleteDeliveryMethodOptions) SetDeliveryMethodID added in v4.2.0

func (_options *DeleteDeliveryMethodOptions) SetDeliveryMethodID(deliveryMethodID string) *DeleteDeliveryMethodOptions

SetDeliveryMethodID : Allow user to set DeliveryMethodID

func (*DeleteDeliveryMethodOptions) SetHeaders added in v4.2.0

func (options *DeleteDeliveryMethodOptions) SetHeaders(param map[string]string) *DeleteDeliveryMethodOptions

SetHeaders : Allow user to set Headers

type DeleteDomainOptions

type DeleteDomainOptions struct {
	// Domain id.
	DomainID *string `json:"domain_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteDomainOptions : The DeleteDomain options.

func (*DeleteDomainOptions) SetDomainID

func (_options *DeleteDomainOptions) SetDomainID(domainID string) *DeleteDomainOptions

SetDomainID : Allow user to set DomainID

func (*DeleteDomainOptions) SetHeaders

func (options *DeleteDomainOptions) SetHeaders(param map[string]string) *DeleteDomainOptions

SetHeaders : Allow user to set Headers

type DeleteDraftContractTermsDocumentOptions

type DeleteDraftContractTermsDocumentOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// Document id.
	DocumentID *string `json:"document_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteDraftContractTermsDocumentOptions : The DeleteDraftContractTermsDocument options.

func (*DeleteDraftContractTermsDocumentOptions) SetContractTermsID

func (_options *DeleteDraftContractTermsDocumentOptions) SetContractTermsID(contractTermsID string) *DeleteDraftContractTermsDocumentOptions

SetContractTermsID : Allow user to set ContractTermsID

func (*DeleteDraftContractTermsDocumentOptions) SetDataProductID

SetDataProductID : Allow user to set DataProductID

func (*DeleteDraftContractTermsDocumentOptions) SetDocumentID

SetDocumentID : Allow user to set DocumentID

func (*DeleteDraftContractTermsDocumentOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*DeleteDraftContractTermsDocumentOptions) SetHeaders

SetHeaders : Allow user to set Headers

type DeliveryMethod

type DeliveryMethod struct {
	// The ID of the delivery method.
	ID *string `json:"id" validate:"required"`

	// Container reference.
	Container *ContainerReference `json:"container" validate:"required"`

	// The propertiess of the delivery method.
	Getproperties *DeliveryMethodPropertiesModel `json:"getproperties,omitempty"`
}

DeliveryMethod : DeliveryMethod struct

type DeliveryMethodConfig added in v4.2.0

type DeliveryMethodConfig struct {
	// Delivery method configurations.
	DeliveryMethods []map[string]interface{} `json:"delivery_methods" validate:"required"`

	// Whether to persist consumer connection information for reuse across deliveries.
	PersistConsumerConnection *bool `json:"persist_consumer_connection,omitempty"`
}

DeliveryMethodConfig : Delivery method configuration.

type DeliveryMethodPropertiesModel

type DeliveryMethodPropertiesModel struct {
	// Parameters for delivery that are set by a data product producer.
	ProducerInput *ProducerInputModel `json:"producer_input,omitempty"`
}

DeliveryMethodPropertiesModel : The propertiess of the delivery method.

type DeliveryMethodRes added in v4.2.0

type DeliveryMethodRes struct {
	// The name of the delivery method.
	Name *string `json:"name" validate:"required"`

	// The unique resource key of the delivery method.
	ResourceKey *string `json:"resource_key" validate:"required"`

	// The description of the delivery method.
	Description *string `json:"description" validate:"required"`

	// The status of the delivery method.
	Status *string `json:"status" validate:"required"`

	// List of asset types supported by this delivery method.
	SupportedAssetTypes []string `json:"supported_asset_types,omitempty"`

	// List of authentication methods supported by this delivery method.
	SupportedAuthMethods []string `json:"supported_auth_methods,omitempty"`

	// List of authentication methods supported by this delivery method in CPD.
	SupportedAuthMethodsCpd []string `json:"supported_auth_methods_cpd,omitempty"`

	// List of data source IDs supported by this delivery method.
	SupportedDataSources []string `json:"supported_data_sources,omitempty"`

	// Whether the delivery method supports redelivery.
	SupportsRedelivery *bool `json:"supports_redelivery,omitempty"`

	// Indicates if the delivery method is restricted.
	IsRestricted *bool `json:"is_restricted,omitempty"`

	// Whether the delivery method supports retry on failure.
	SupportsRetryOnFailure *bool `json:"supports_retry_on_failure,omitempty"`

	// Whether the delivery method supports revoke access.
	SupportsRevokeAccess *bool `json:"supports_revoke_access,omitempty"`

	// Whether the delivery method supports column selection.
	SupportsColumnSelection *bool `json:"supports_column_selection,omitempty"`

	// Whether the delivery method supports adding to project.
	SupportsAddToProject *bool `json:"supports_add_to_project,omitempty"`

	// Input fields required from the data product producer.
	ProducerInput []map[string]interface{} `json:"producer_input,omitempty"`

	// Input fields required from the data consumer.
	ConsumerInput []map[string]interface{} `json:"consumer_input,omitempty"`

	// Output format specifications for the delivery.
	OutputFormat []map[string]interface{} `json:"output_format,omitempty"`

	// Whether the delivery method automatically marks deliveries as delivered.
	AutoMarkDelivered *bool `json:"auto_mark_delivered,omitempty"`

	// Whether the delivery method uses functional credentials for delivery.
	DeliveryUsesFunctionalCredentials *bool `json:"delivery_uses_functional_credentials,omitempty"`

	// The ID of the delivery method.
	ID *string `json:"id" validate:"required"`

	// The type of the delivery method.
	Type *string `json:"type,omitempty"`

	// The delivery mode of the delivery method.
	DeliveryMode *string `json:"delivery_mode,omitempty"`

	// The delivery type of the delivery method.
	DeliveryType *string `json:"delivery_type,omitempty"`

	// The origin country of the delivery method.
	OriginCountry *string `json:"origin_country,omitempty"`

	// The creator ID of the delivery method.
	CreatorID *string `json:"creator_id,omitempty"`

	// The catalog ID of the delivery method.
	CatalogID *string `json:"catalog_id,omitempty"`

	// The asset state of the delivery method.
	AssetState *string `json:"asset_state,omitempty"`

	// The version of the delivery method.
	Version *string `json:"version,omitempty"`

	// The ROV configuration of the delivery method.
	Rov map[string]interface{} `json:"rov,omitempty"`

	// Localized name of the delivery method.
	LocalizedName map[string]interface{} `json:"localized_name,omitempty"`

	// Localized description of the delivery method.
	LocalizedDescription map[string]interface{} `json:"localized_description,omitempty"`

	// Delivery method configuration.
	DeliveryMethodConfig *DeliveryMethodConfig `json:"delivery_method_config,omitempty"`
}

DeliveryMethodRes : Delivery method response model containing complete delivery method configuration and metadata.

type DeliveryMethodResCollection added in v4.2.0

type DeliveryMethodResCollection struct {
	// Set a limit on the number of results returned.
	Limit *int64 `json:"limit" validate:"required"`

	// First page in the collection.
	First *FirstPage `json:"first" validate:"required"`

	// Next page in the collection.
	Next *NextPage `json:"next,omitempty"`

	// Indicates the total number of results returned.
	TotalResults *int64 `json:"total_results,omitempty"`

	// Collection of delivery methods.
	DeliveryMethods []DeliveryMethodRes `json:"delivery_methods" validate:"required"`
}

DeliveryMethodResCollection : A collection of delivery methods.

type Description

type Description struct {
	// Intended purpose for the provided data.
	Purpose *string `json:"purpose,omitempty"`

	// Technical, compliance, and legal limitations for data use.
	Limitations *string `json:"limitations,omitempty"`

	// Recommended usage of the data.
	Usage *string `json:"usage,omitempty"`

	// List of links to sources that provide more details on the dataset; examples would be a link to privacy statement,
	// terms and conditions, license agreements, data catalog, or another tool.
	AuthoritativeDefinitions []ContractAuthoritativeDefinition `json:"authoritative_definitions,omitempty"`

	// Custom properties that are not part of the standard.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`
}

Description : Description details of a data contract.

type Domain

type Domain struct {
	// The ID of the domain.
	ID *string `json:"id" validate:"required"`

	// The display name of the domain.
	Name *string `json:"name,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container,omitempty"`
}

Domain : Domain that the data product version belongs to. If this is the first version of a data product, this field is required. If this is a new version of an existing data product, the domain will default to the domain of the previous version of the data product.

type DqCheckResult added in v4.2.0

type DqCheckResult struct {
	// Dataset information for data quality check.
	Dataset *DqDataset `json:"dataset" validate:"required"`

	// Data quality rule information.
	DataQualityRule *DqRule `json:"data_quality_rule" validate:"required"`

	// Status of the data quality check.
	Status *string `json:"status" validate:"required"`

	// Log entries for this check.
	Logs []DqLogEntry `json:"logs,omitempty"`

	// Start time of the check in ISO 8601 format.
	Start *strfmt.DateTime `json:"start" validate:"required"`

	// End time of the check in ISO 8601 format.
	End *strfmt.DateTime `json:"end" validate:"required"`
}

DqCheckResult : Data quality check result for a specific dataset and rule.

type DqConnection added in v4.2.0

type DqConnection struct {
	// Unique identifier of the connection.
	ID *string `json:"id" validate:"required"`
}

DqConnection : Connection information for data quality test.

type DqContract added in v4.2.0

type DqContract struct {
	// Unique identifier of the contract.
	ID *string `json:"id" validate:"required"`

	// Name of the contract.
	Name *string `json:"name" validate:"required"`

	// Version of the contract.
	Version *string `json:"version" validate:"required"`
}

DqContract : Contract information for data quality test.

type DqDataset added in v4.2.0

type DqDataset struct {
	// Name of the dataset.
	Name *string `json:"name" validate:"required"`
}

DqDataset : Dataset information for data quality check.

type DqLogEntry added in v4.2.0

type DqLogEntry struct {
	// Log level indicating severity.
	Level *string `json:"level" validate:"required"`

	// Log message content.
	Message *string `json:"message" validate:"required"`

	// Timestamp of the log entry in ISO 8601 format.
	Timestamp *strfmt.DateTime `json:"timestamp,omitempty"`
}

DqLogEntry : Log entry for data quality check.

type DqRule added in v4.2.0

type DqRule struct {
	// Unique identifier of the data quality rule.
	ID *string `json:"id" validate:"required"`

	// Name of the data quality rule.
	Name *string `json:"name" validate:"required"`
}

DqRule : Data quality rule information.

type DqServerMapping added in v4.2.0

type DqServerMapping struct {
	// Server name as defined in the contract.
	Server *string `json:"server" validate:"required"`

	// Connection information for data quality test.
	Connection *DqConnection `json:"connection" validate:"required"`
}

DqServerMapping : Server mapping with connection information for data quality test.

type EngineDetailsModel

type EngineDetailsModel struct {
	// The name of the engine defined by the data product producer.
	DisplayName *string `json:"display_name,omitempty"`

	// The id of the engine defined by the data product producer.
	EngineID *string `json:"engine_id,omitempty"`

	// The port of the engine defined by the data product producer.
	EnginePort *string `json:"engine_port,omitempty"`

	// The host of the engine defined by the data product producer.
	EngineHost *string `json:"engine_host,omitempty"`

	// The type of the engine (eg: Presto/Spark).
	EngineType *string `json:"engine_type" validate:"required"`

	// The list of associated catalogs.
	AssociatedCatalogs []string `json:"associated_catalogs,omitempty"`
}

EngineDetailsModel : Engine details as defined by the data product producer.

type ErrorExtraResource

type ErrorExtraResource struct {
	// Error id.
	ID *string `json:"id,omitempty"`

	// Timestamp of the error.
	Timestamp *strfmt.DateTime `json:"timestamp,omitempty"`

	// Environment where the error occurred.
	EnvironmentName *string `json:"environment_name,omitempty"`

	// Http status code.
	HTTPStatus *int64 `json:"http_status,omitempty"`

	// Source cluster of the error.
	SourceCluster *int64 `json:"source_cluster,omitempty"`

	// Source component of the error.
	SourceComponent *int64 `json:"source_component,omitempty"`

	// Transaction id of the request.
	TransactionID *int64 `json:"transaction_id,omitempty"`
}

ErrorExtraResource : Detailed error information.

type ErrorMessage

type ErrorMessage struct {
	// The error code.
	Code *string `json:"code" validate:"required"`

	// The error details.
	Message *string `json:"message" validate:"required"`
}

ErrorMessage : Contains the code and details.

type ErrorModelResource

type ErrorModelResource struct {
	// Error code.
	Code *string `json:"code" validate:"required"`

	// Error message.
	Message *string `json:"message,omitempty"`

	// Detailed error information.
	Extra *ErrorExtraResource `json:"extra,omitempty"`

	// More info message.
	MoreInfo *string `json:"more_info,omitempty"`
}

ErrorModelResource : Detailed error information.

type FirstPage

type FirstPage struct {
	// Link to the first page in the collection.
	Href *string `json:"href" validate:"required"`
}

FirstPage : First page in the collection.

type GetContractTemplateOptions

type GetContractTemplateOptions struct {
	// Data Product Contract Template id.
	ContractTemplateID *string `json:"contract_template_id" validate:"required,ne="`

	// Container ID of the data product catalog.
	ContainerID *string `json:"container.id" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetContractTemplateOptions : The GetContractTemplate options.

func (*GetContractTemplateOptions) SetContainerID

func (_options *GetContractTemplateOptions) SetContainerID(containerID string) *GetContractTemplateOptions

SetContainerID : Allow user to set ContainerID

func (*GetContractTemplateOptions) SetContractTemplateID

func (_options *GetContractTemplateOptions) SetContractTemplateID(contractTemplateID string) *GetContractTemplateOptions

SetContractTemplateID : Allow user to set ContractTemplateID

func (*GetContractTemplateOptions) SetHeaders

func (options *GetContractTemplateOptions) SetHeaders(param map[string]string) *GetContractTemplateOptions

SetHeaders : Allow user to set Headers

type GetContractTemplatesByDomainOptions added in v4.2.0

type GetContractTemplatesByDomainOptions struct {
	// Domain id.
	DomainID *string `json:"domain_id" validate:"required,ne="`

	// Container ID of the data product catalog.
	ContainerID *string `json:"container.id" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetContractTemplatesByDomainOptions : The GetContractTemplatesByDomain options.

func (*GetContractTemplatesByDomainOptions) SetContainerID added in v4.2.0

SetContainerID : Allow user to set ContainerID

func (*GetContractTemplatesByDomainOptions) SetDomainID added in v4.2.0

SetDomainID : Allow user to set DomainID

func (*GetContractTemplatesByDomainOptions) SetHeaders added in v4.2.0

SetHeaders : Allow user to set Headers

type GetContractTermsInSpecifiedFormatOptions added in v4.1.0

type GetContractTermsInSpecifiedFormatOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// The format for returning contract terms. For example: odcs.
	Format *string `json:"format" validate:"required"`

	// The version of the format for returning contract terms. For example: 3.
	FormatVersion *string `json:"format_version" validate:"required"`

	// The type of the response: application/odcs+yaml or application/json.
	Accept *string `json:"Accept,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetContractTermsInSpecifiedFormatOptions : The GetContractTermsInSpecifiedFormat options.

func (*GetContractTermsInSpecifiedFormatOptions) SetAccept added in v4.1.0

SetAccept : Allow user to set Accept

func (*GetContractTermsInSpecifiedFormatOptions) SetContractTermsID added in v4.1.0

func (_options *GetContractTermsInSpecifiedFormatOptions) SetContractTermsID(contractTermsID string) *GetContractTermsInSpecifiedFormatOptions

SetContractTermsID : Allow user to set ContractTermsID

func (*GetContractTermsInSpecifiedFormatOptions) SetDataProductID added in v4.1.0

SetDataProductID : Allow user to set DataProductID

func (*GetContractTermsInSpecifiedFormatOptions) SetDraftID added in v4.1.0

SetDraftID : Allow user to set DraftID

func (*GetContractTermsInSpecifiedFormatOptions) SetFormat added in v4.1.0

SetFormat : Allow user to set Format

func (*GetContractTermsInSpecifiedFormatOptions) SetFormatVersion added in v4.1.0

SetFormatVersion : Allow user to set FormatVersion

func (*GetContractTermsInSpecifiedFormatOptions) SetHeaders added in v4.1.0

SetHeaders : Allow user to set Headers

type GetDataContractTestResultsOptions added in v4.2.0

type GetDataContractTestResultsOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data contract ID.
	DataContractID *string `json:"data_contract_id" validate:"required,ne="`

	// Test run ID.
	TestRunID *string `json:"test_run_id" validate:"required,ne="`

	// Project ID where the data contract exists.
	ProjectID *string `json:"project_id" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDataContractTestResultsOptions : The GetDataContractTestResults options.

func (*GetDataContractTestResultsOptions) SetDataContractID added in v4.2.0

func (_options *GetDataContractTestResultsOptions) SetDataContractID(dataContractID string) *GetDataContractTestResultsOptions

SetDataContractID : Allow user to set DataContractID

func (*GetDataContractTestResultsOptions) SetDataProductID added in v4.2.0

func (_options *GetDataContractTestResultsOptions) SetDataProductID(dataProductID string) *GetDataContractTestResultsOptions

SetDataProductID : Allow user to set DataProductID

func (*GetDataContractTestResultsOptions) SetHeaders added in v4.2.0

SetHeaders : Allow user to set Headers

func (*GetDataContractTestResultsOptions) SetProjectID added in v4.2.0

SetProjectID : Allow user to set ProjectID

func (*GetDataContractTestResultsOptions) SetTestRunID added in v4.2.0

SetTestRunID : Allow user to set TestRunID

type GetDataProductByDomainOptions

type GetDataProductByDomainOptions struct {
	// Domain id.
	DomainID *string `json:"domain_id" validate:"required,ne="`

	// Container ID of the data product catalog.
	ContainerID *string `json:"container.id" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDataProductByDomainOptions : The GetDataProductByDomain options.

func (*GetDataProductByDomainOptions) SetContainerID

func (_options *GetDataProductByDomainOptions) SetContainerID(containerID string) *GetDataProductByDomainOptions

SetContainerID : Allow user to set ContainerID

func (*GetDataProductByDomainOptions) SetDomainID

func (_options *GetDataProductByDomainOptions) SetDomainID(domainID string) *GetDataProductByDomainOptions

SetDomainID : Allow user to set DomainID

func (*GetDataProductByDomainOptions) SetHeaders

SetHeaders : Allow user to set Headers

type GetDataProductDraftContractTermsOptions

type GetDataProductDraftContractTermsOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// The type of the response: application/json or application/odcs+yaml.
	Accept *string `json:"Accept,omitempty"`

	// Set to false to exclude external contract documents (e.g., Terms and Conditions URLs) from the response. By default,
	// these are included.
	IncludeContractDocuments *bool `json:"include_contract_documents,omitempty"`

	// Set to true to autopopulate server information from connection details. Default is false.
	AutopopulateServerInformation *bool `json:"autopopulate_server_information,omitempty"`

	// Asset ID of the server used for autopopulating connection details.
	ServerID *string `json:"server_id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDataProductDraftContractTermsOptions : The GetDataProductDraftContractTerms options.

func (*GetDataProductDraftContractTermsOptions) SetAccept

SetAccept : Allow user to set Accept

func (*GetDataProductDraftContractTermsOptions) SetAutopopulateServerInformation added in v4.1.0

func (_options *GetDataProductDraftContractTermsOptions) SetAutopopulateServerInformation(autopopulateServerInformation bool) *GetDataProductDraftContractTermsOptions

SetAutopopulateServerInformation : Allow user to set AutopopulateServerInformation

func (*GetDataProductDraftContractTermsOptions) SetContractTermsID

func (_options *GetDataProductDraftContractTermsOptions) SetContractTermsID(contractTermsID string) *GetDataProductDraftContractTermsOptions

SetContractTermsID : Allow user to set ContractTermsID

func (*GetDataProductDraftContractTermsOptions) SetDataProductID

SetDataProductID : Allow user to set DataProductID

func (*GetDataProductDraftContractTermsOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*GetDataProductDraftContractTermsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*GetDataProductDraftContractTermsOptions) SetIncludeContractDocuments

func (_options *GetDataProductDraftContractTermsOptions) SetIncludeContractDocuments(includeContractDocuments bool) *GetDataProductDraftContractTermsOptions

SetIncludeContractDocuments : Allow user to set IncludeContractDocuments

func (*GetDataProductDraftContractTermsOptions) SetServerID added in v4.2.0

SetServerID : Allow user to set ServerID

type GetDataProductDraftOptions

type GetDataProductDraftOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDataProductDraftOptions : The GetDataProductDraft options.

func (*GetDataProductDraftOptions) SetDataProductID

func (_options *GetDataProductDraftOptions) SetDataProductID(dataProductID string) *GetDataProductDraftOptions

SetDataProductID : Allow user to set DataProductID

func (*GetDataProductDraftOptions) SetDraftID

func (_options *GetDataProductDraftOptions) SetDraftID(draftID string) *GetDataProductDraftOptions

SetDraftID : Allow user to set DraftID

func (*GetDataProductDraftOptions) SetHeaders

func (options *GetDataProductDraftOptions) SetHeaders(param map[string]string) *GetDataProductDraftOptions

SetHeaders : Allow user to set Headers

type GetDataProductOptions

type GetDataProductOptions struct {
	// Data product ID.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDataProductOptions : The GetDataProduct options.

func (*GetDataProductOptions) SetDataProductID

func (_options *GetDataProductOptions) SetDataProductID(dataProductID string) *GetDataProductOptions

SetDataProductID : Allow user to set DataProductID

func (*GetDataProductOptions) SetHeaders

func (options *GetDataProductOptions) SetHeaders(param map[string]string) *GetDataProductOptions

SetHeaders : Allow user to set Headers

type GetDataProductReleaseOptions

type GetDataProductReleaseOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product release id.
	ReleaseID *string `json:"release_id" validate:"required,ne="`

	// If the value is true, then it will be verfied whether the caller is present in the data access request pre-approved
	// user list.
	CheckCallerApproval *bool `json:"check_caller_approval,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDataProductReleaseOptions : The GetDataProductRelease options.

func (*GetDataProductReleaseOptions) SetCheckCallerApproval

func (_options *GetDataProductReleaseOptions) SetCheckCallerApproval(checkCallerApproval bool) *GetDataProductReleaseOptions

SetCheckCallerApproval : Allow user to set CheckCallerApproval

func (*GetDataProductReleaseOptions) SetDataProductID

func (_options *GetDataProductReleaseOptions) SetDataProductID(dataProductID string) *GetDataProductReleaseOptions

SetDataProductID : Allow user to set DataProductID

func (*GetDataProductReleaseOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*GetDataProductReleaseOptions) SetReleaseID

func (_options *GetDataProductReleaseOptions) SetReleaseID(releaseID string) *GetDataProductReleaseOptions

SetReleaseID : Allow user to set ReleaseID

type GetDeliveryConfigurationOptions added in v4.2.0

type GetDeliveryConfigurationOptions struct {
	// Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using the uid of
	// the default data product catalog.
	ContainerID *string `json:"container.id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDeliveryConfigurationOptions : The GetDeliveryConfiguration options.

func (*GetDeliveryConfigurationOptions) SetContainerID added in v4.2.0

func (_options *GetDeliveryConfigurationOptions) SetContainerID(containerID string) *GetDeliveryConfigurationOptions

SetContainerID : Allow user to set ContainerID

func (*GetDeliveryConfigurationOptions) SetHeaders added in v4.2.0

SetHeaders : Allow user to set Headers

type GetDeliveryMethodOptions added in v4.2.0

type GetDeliveryMethodOptions struct {
	// The catalog ID where delivery method is stored.
	CatalogID *string `json:"catalog_id" validate:"required"`

	// The ID of the delivery method to retrieve.
	DeliveryMethodID *string `json:"delivery_method_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDeliveryMethodOptions : The GetDeliveryMethod options.

func (*GetDeliveryMethodOptions) SetCatalogID added in v4.2.0

func (_options *GetDeliveryMethodOptions) SetCatalogID(catalogID string) *GetDeliveryMethodOptions

SetCatalogID : Allow user to set CatalogID

func (*GetDeliveryMethodOptions) SetDeliveryMethodID added in v4.2.0

func (_options *GetDeliveryMethodOptions) SetDeliveryMethodID(deliveryMethodID string) *GetDeliveryMethodOptions

SetDeliveryMethodID : Allow user to set DeliveryMethodID

func (*GetDeliveryMethodOptions) SetHeaders added in v4.2.0

func (options *GetDeliveryMethodOptions) SetHeaders(param map[string]string) *GetDeliveryMethodOptions

SetHeaders : Allow user to set Headers

type GetDomainOptions

type GetDomainOptions struct {
	// Domain id.
	DomainID *string `json:"domain_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDomainOptions : The GetDomain options.

func (*GetDomainOptions) SetDomainID

func (_options *GetDomainOptions) SetDomainID(domainID string) *GetDomainOptions

SetDomainID : Allow user to set DomainID

func (*GetDomainOptions) SetHeaders

func (options *GetDomainOptions) SetHeaders(param map[string]string) *GetDomainOptions

SetHeaders : Allow user to set Headers

type GetDraftContractTermsDocumentOptions

type GetDraftContractTermsDocumentOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// Document id.
	DocumentID *string `json:"document_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDraftContractTermsDocumentOptions : The GetDraftContractTermsDocument options.

func (*GetDraftContractTermsDocumentOptions) SetContractTermsID

func (_options *GetDraftContractTermsDocumentOptions) SetContractTermsID(contractTermsID string) *GetDraftContractTermsDocumentOptions

SetContractTermsID : Allow user to set ContractTermsID

func (*GetDraftContractTermsDocumentOptions) SetDataProductID

func (_options *GetDraftContractTermsDocumentOptions) SetDataProductID(dataProductID string) *GetDraftContractTermsDocumentOptions

SetDataProductID : Allow user to set DataProductID

func (*GetDraftContractTermsDocumentOptions) SetDocumentID

SetDocumentID : Allow user to set DocumentID

func (*GetDraftContractTermsDocumentOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*GetDraftContractTermsDocumentOptions) SetHeaders

SetHeaders : Allow user to set Headers

type GetInitializeStatusOptions

type GetInitializeStatusOptions struct {
	// Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using the uid of
	// the default data product catalog.
	ContainerID *string `json:"container.id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetInitializeStatusOptions : The GetInitializeStatus options.

func (*GetInitializeStatusOptions) SetContainerID

func (_options *GetInitializeStatusOptions) SetContainerID(containerID string) *GetInitializeStatusOptions

SetContainerID : Allow user to set ContainerID

func (*GetInitializeStatusOptions) SetHeaders

func (options *GetInitializeStatusOptions) SetHeaders(param map[string]string) *GetInitializeStatusOptions

SetHeaders : Allow user to set Headers

type GetPublishedDataProductDraftContractTermsOptions

type GetPublishedDataProductDraftContractTermsOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product release id.
	ReleaseID *string `json:"release_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// The type of the response: application/odcs+yaml or application/json.
	Accept *string `json:"Accept,omitempty"`

	// Set to false to exclude external contract documents (e.g., Terms and Conditions URLs) from the response. By default,
	// these are included.
	IncludeContractDocuments *bool `json:"include_contract_documents,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetPublishedDataProductDraftContractTermsOptions : The GetPublishedDataProductDraftContractTerms options.

func (*GetPublishedDataProductDraftContractTermsOptions) SetAccept

SetAccept : Allow user to set Accept

func (*GetPublishedDataProductDraftContractTermsOptions) SetContractTermsID

SetContractTermsID : Allow user to set ContractTermsID

func (*GetPublishedDataProductDraftContractTermsOptions) SetDataProductID

SetDataProductID : Allow user to set DataProductID

func (*GetPublishedDataProductDraftContractTermsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*GetPublishedDataProductDraftContractTermsOptions) SetIncludeContractDocuments

func (_options *GetPublishedDataProductDraftContractTermsOptions) SetIncludeContractDocuments(includeContractDocuments bool) *GetPublishedDataProductDraftContractTermsOptions

SetIncludeContractDocuments : Allow user to set IncludeContractDocuments

func (*GetPublishedDataProductDraftContractTermsOptions) SetReleaseID

SetReleaseID : Allow user to set ReleaseID

type GetReleaseContractTermsDocumentOptions

type GetReleaseContractTermsDocumentOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product release id.
	ReleaseID *string `json:"release_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// Document id.
	DocumentID *string `json:"document_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetReleaseContractTermsDocumentOptions : The GetReleaseContractTermsDocument options.

func (*GetReleaseContractTermsDocumentOptions) SetContractTermsID

func (_options *GetReleaseContractTermsDocumentOptions) SetContractTermsID(contractTermsID string) *GetReleaseContractTermsDocumentOptions

SetContractTermsID : Allow user to set ContractTermsID

func (*GetReleaseContractTermsDocumentOptions) SetDataProductID

SetDataProductID : Allow user to set DataProductID

func (*GetReleaseContractTermsDocumentOptions) SetDocumentID

SetDocumentID : Allow user to set DocumentID

func (*GetReleaseContractTermsDocumentOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*GetReleaseContractTermsDocumentOptions) SetReleaseID

SetReleaseID : Allow user to set ReleaseID

type GetRevokeAccessProcessStateOptions added in v4.1.0

type GetRevokeAccessProcessStateOptions struct {
	// Pass the data product release version id to retrieve job runs state for that specific DPV ID.
	ReleaseID *string `json:"release_id" validate:"required"`

	// Limit the number of tracking assets in the results. The maximum is 200.
	Limit *int64 `json:"limit,omitempty"`

	// Start token for pagination.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetRevokeAccessProcessStateOptions : The GetRevokeAccessProcessState options.

func (*GetRevokeAccessProcessStateOptions) SetHeaders added in v4.1.0

SetHeaders : Allow user to set Headers

func (*GetRevokeAccessProcessStateOptions) SetLimit added in v4.1.0

SetLimit : Allow user to set Limit

func (*GetRevokeAccessProcessStateOptions) SetReleaseID added in v4.1.0

SetReleaseID : Allow user to set ReleaseID

func (*GetRevokeAccessProcessStateOptions) SetStart added in v4.1.0

SetStart : Allow user to set Start

type GetS3BucketValidationOptions

type GetS3BucketValidationOptions struct {
	// Name of the bucket to validate.
	BucketName *string `json:"bucket_name" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetS3BucketValidationOptions : The GetS3BucketValidation options.

func (*GetS3BucketValidationOptions) SetBucketName

func (_options *GetS3BucketValidationOptions) SetBucketName(bucketName string) *GetS3BucketValidationOptions

SetBucketName : Allow user to set BucketName

func (*GetS3BucketValidationOptions) SetHeaders

SetHeaders : Allow user to set Headers

type GetServiceIDCredentialsOptions

type GetServiceIDCredentialsOptions struct {

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetServiceIDCredentialsOptions : The GetServiceIDCredentials options.

func (*GetServiceIDCredentialsOptions) SetHeaders

SetHeaders : Allow user to set Headers

type InitializeOptions

type InitializeOptions struct {
	// Container reference.
	Container *ContainerReference `json:"container,omitempty"`

	// List of configuration options to (re-)initialize.
	Include []string `json:"include,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

InitializeOptions : The Initialize options.

func (*InitializeOptions) SetContainer

func (_options *InitializeOptions) SetContainer(container *ContainerReference) *InitializeOptions

SetContainer : Allow user to set Container

func (*InitializeOptions) SetHeaders

func (options *InitializeOptions) SetHeaders(param map[string]string) *InitializeOptions

SetHeaders : Allow user to set Headers

func (*InitializeOptions) SetInclude

func (_options *InitializeOptions) SetInclude(include []string) *InitializeOptions

SetInclude : Allow user to set Include

type InitializeResource

type InitializeResource struct {
	// Container reference.
	Container *ContainerReference `json:"container,omitempty"`

	// Link to monitor the status of the initialize operation.
	Href *string `json:"href,omitempty"`

	// Status of the initialize operation.
	Status *string `json:"status" validate:"required"`

	// The id to trace the failed initialization operation.
	Trace *string `json:"trace,omitempty"`

	// Set of errors on the latest initialization request.
	Errors []ErrorModelResource `json:"errors,omitempty"`

	// Start time of the last initialization.
	LastStartedAt *strfmt.DateTime `json:"last_started_at,omitempty"`

	// End time of the last initialization.
	LastFinishedAt *strfmt.DateTime `json:"last_finished_at,omitempty"`

	// Initialized options.
	InitializedOptions []InitializedOption `json:"initialized_options,omitempty"`

	// Resource defining provided workflow definitions.
	Workflows *ProvidedCatalogWorkflows `json:"workflows,omitempty"`
}

InitializeResource : Resource defining initialization parameters.

type InitializeSubDomain

type InitializeSubDomain struct {
	// The name of the data product subdomain.
	Name *string `json:"name,omitempty"`

	// The identifier of the data product subdomain.
	ID *string `json:"id,omitempty"`

	// The description of the data product subdomain.
	Description *string `json:"description,omitempty"`
}

InitializeSubDomain : The subdomain for a data product domain.

type InitializedOption

type InitializedOption struct {
	// The name of the option.
	Name *string `json:"name,omitempty"`

	// The version of the option.
	Version *int64 `json:"version,omitempty"`
}

InitializedOption : List of options successfully initialized.

type JSONPatchOperation

type JSONPatchOperation struct {
	// The operation to be performed.
	Op *string `json:"op" validate:"required"`

	// The JSON Pointer that identifies the field that is the target of the operation.
	Path *string `json:"path" validate:"required"`

	// The JSON Pointer that identifies the field that is the source of the operation.
	From *string `json:"from,omitempty"`

	// The value to be used within the operation.
	Value interface{} `json:"value,omitempty"`
}

JSONPatchOperation : This model represents an individual patch operation to be performed on a JSON document, as defined by RFC 6902.

type ListDataProductContractTemplateOptions

type ListDataProductContractTemplateOptions struct {
	// Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using the uid of
	// the default data product catalog.
	ContainerID *string `json:"container.id,omitempty"`

	// Name of the data product contract template. If not supplied, the data product templates within the catalog will
	// returned.
	ContractTemplateName *string `json:"contract_template.name,omitempty"`

	// Status of the data product contract template. If not supplied, the data product templates within the catalog will
	// returned.
	ContractTemplateStatus *string `json:"contract_template.status,omitempty"`

	// Comma-separated domain IDs to filter data product contract templates. If not supplied, the data product templates
	// within the catalog will returned.
	DomainIds *string `json:"domain.ids,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListDataProductContractTemplateOptions : The ListDataProductContractTemplate options.

func (*ListDataProductContractTemplateOptions) SetContainerID

SetContainerID : Allow user to set ContainerID

func (*ListDataProductContractTemplateOptions) SetContractTemplateName

func (_options *ListDataProductContractTemplateOptions) SetContractTemplateName(contractTemplateName string) *ListDataProductContractTemplateOptions

SetContractTemplateName : Allow user to set ContractTemplateName

func (*ListDataProductContractTemplateOptions) SetContractTemplateStatus added in v4.2.0

func (_options *ListDataProductContractTemplateOptions) SetContractTemplateStatus(contractTemplateStatus string) *ListDataProductContractTemplateOptions

SetContractTemplateStatus : Allow user to set ContractTemplateStatus

func (*ListDataProductContractTemplateOptions) SetDomainIds added in v4.1.0

SetDomainIds : Allow user to set DomainIds

func (*ListDataProductContractTemplateOptions) SetHeaders

SetHeaders : Allow user to set Headers

type ListDataProductDomainsOptions

type ListDataProductDomainsOptions struct {
	// Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using the uid of
	// the default data product catalog.
	ContainerID *string `json:"container.id,omitempty"`

	// Include subdomains in the response.
	IncludeSubdomains *bool `json:"include_subdomains,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListDataProductDomainsOptions : The ListDataProductDomains options.

func (*ListDataProductDomainsOptions) SetContainerID

func (_options *ListDataProductDomainsOptions) SetContainerID(containerID string) *ListDataProductDomainsOptions

SetContainerID : Allow user to set ContainerID

func (*ListDataProductDomainsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ListDataProductDomainsOptions) SetIncludeSubdomains added in v4.1.0

func (_options *ListDataProductDomainsOptions) SetIncludeSubdomains(includeSubdomains bool) *ListDataProductDomainsOptions

SetIncludeSubdomains : Allow user to set IncludeSubdomains

type ListDataProductDraftsOptions

type ListDataProductDraftsOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Filter the list of data product drafts by container id.
	AssetContainerID *string `json:"asset.container.id,omitempty"`

	// Filter the list of data product drafts by version number.
	Version *string `json:"version,omitempty"`

	// Limit the number of data product drafts in the results. The maximum limit is 200.
	Limit *int64 `json:"limit,omitempty"`

	// Start token for pagination.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListDataProductDraftsOptions : The ListDataProductDrafts options.

func (*ListDataProductDraftsOptions) SetAssetContainerID

func (_options *ListDataProductDraftsOptions) SetAssetContainerID(assetContainerID string) *ListDataProductDraftsOptions

SetAssetContainerID : Allow user to set AssetContainerID

func (*ListDataProductDraftsOptions) SetDataProductID

func (_options *ListDataProductDraftsOptions) SetDataProductID(dataProductID string) *ListDataProductDraftsOptions

SetDataProductID : Allow user to set DataProductID

func (*ListDataProductDraftsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ListDataProductDraftsOptions) SetLimit

SetLimit : Allow user to set Limit

func (*ListDataProductDraftsOptions) SetStart

SetStart : Allow user to set Start

func (*ListDataProductDraftsOptions) SetVersion

func (_options *ListDataProductDraftsOptions) SetVersion(version string) *ListDataProductDraftsOptions

SetVersion : Allow user to set Version

type ListDataProductReleasesOptions

type ListDataProductReleasesOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Filter the list of data product releases by container id.
	AssetContainerID *string `json:"asset.container.id,omitempty"`

	// Filter the list of data product versions by state. States are: available and retired. Default is
	// "available","retired".
	State []string `json:"state,omitempty"`

	// Filter the list of data product releases by version number.
	Version *string `json:"version,omitempty"`

	// Limit the number of data product releases in the results. The maximum is 200.
	Limit *int64 `json:"limit,omitempty"`

	// Start token for pagination.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListDataProductReleasesOptions : The ListDataProductReleases options.

func (*ListDataProductReleasesOptions) SetAssetContainerID

func (_options *ListDataProductReleasesOptions) SetAssetContainerID(assetContainerID string) *ListDataProductReleasesOptions

SetAssetContainerID : Allow user to set AssetContainerID

func (*ListDataProductReleasesOptions) SetDataProductID

func (_options *ListDataProductReleasesOptions) SetDataProductID(dataProductID string) *ListDataProductReleasesOptions

SetDataProductID : Allow user to set DataProductID

func (*ListDataProductReleasesOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ListDataProductReleasesOptions) SetLimit

SetLimit : Allow user to set Limit

func (*ListDataProductReleasesOptions) SetStart

SetStart : Allow user to set Start

func (*ListDataProductReleasesOptions) SetState

SetState : Allow user to set State

func (*ListDataProductReleasesOptions) SetVersion

SetVersion : Allow user to set Version

type ListDataProductsOptions

type ListDataProductsOptions struct {
	// Limit the number of data products in the results. The maximum limit is 200.
	Limit *int64 `json:"limit,omitempty"`

	// Start token for pagination.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListDataProductsOptions : The ListDataProducts options.

func (*ListDataProductsOptions) SetHeaders

func (options *ListDataProductsOptions) SetHeaders(param map[string]string) *ListDataProductsOptions

SetHeaders : Allow user to set Headers

func (*ListDataProductsOptions) SetLimit

func (_options *ListDataProductsOptions) SetLimit(limit int64) *ListDataProductsOptions

SetLimit : Allow user to set Limit

func (*ListDataProductsOptions) SetStart

func (_options *ListDataProductsOptions) SetStart(start string) *ListDataProductsOptions

SetStart : Allow user to set Start

type ListDeliveryMethodsOptions added in v4.2.0

type ListDeliveryMethodsOptions struct {
	// The catalog ID where delivery methods are stored.
	CatalogID *string `json:"catalog_id" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListDeliveryMethodsOptions : The ListDeliveryMethods options.

func (*ListDeliveryMethodsOptions) SetCatalogID added in v4.2.0

func (_options *ListDeliveryMethodsOptions) SetCatalogID(catalogID string) *ListDeliveryMethodsOptions

SetCatalogID : Allow user to set CatalogID

func (*ListDeliveryMethodsOptions) SetHeaders added in v4.2.0

func (options *ListDeliveryMethodsOptions) SetHeaders(param map[string]string) *ListDeliveryMethodsOptions

SetHeaders : Allow user to set Headers

type ListRetiredDataProductReleasesLatestOptions added in v4.2.0

type ListRetiredDataProductReleasesLatestOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Filter the list of data product releases by container id.
	AssetContainerID *string `json:"asset.container.id,omitempty"`

	// Limit the number of data product releases in the results. The maximum is 200.
	Limit *int64 `json:"limit,omitempty"`

	// Start token for pagination.
	Start *string `json:"start,omitempty"`

	// Page number for pagination (1-based). If provided, fetches all data and returns the specified page.
	Page *int64 `json:"page,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListRetiredDataProductReleasesLatestOptions : The ListRetiredDataProductReleasesLatest options.

func (*ListRetiredDataProductReleasesLatestOptions) SetAssetContainerID added in v4.2.0

SetAssetContainerID : Allow user to set AssetContainerID

func (*ListRetiredDataProductReleasesLatestOptions) SetDataProductID added in v4.2.0

SetDataProductID : Allow user to set DataProductID

func (*ListRetiredDataProductReleasesLatestOptions) SetHeaders added in v4.2.0

SetHeaders : Allow user to set Headers

func (*ListRetiredDataProductReleasesLatestOptions) SetLimit added in v4.2.0

SetLimit : Allow user to set Limit

func (*ListRetiredDataProductReleasesLatestOptions) SetPage added in v4.2.0

SetPage : Allow user to set Page

func (*ListRetiredDataProductReleasesLatestOptions) SetStart added in v4.2.0

SetStart : Allow user to set Start

type ManageAPIKeysOptions

type ManageAPIKeysOptions struct {

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ManageAPIKeysOptions : The ManageAPIKeys options.

func (*ManageAPIKeysOptions) SetHeaders

func (options *ManageAPIKeysOptions) SetHeaders(param map[string]string) *ManageAPIKeysOptions

SetHeaders : Allow user to set Headers

type MemberRolesSchema

type MemberRolesSchema struct {
	// User id.
	UserIamID *string `json:"user_iam_id,omitempty"`

	// Roles of the given user.
	Roles []string `json:"roles,omitempty"`
}

MemberRolesSchema : Member roles of a corresponding asset.

type NextPage

type NextPage struct {
	// Link to the next page in the collection.
	Href *string `json:"href" validate:"required"`

	// Start token for pagination to the next page in the collection.
	Start *string `json:"start" validate:"required"`
}

NextPage : Next page in the collection.

type Overview

type Overview struct {
	// The API version of the contract.
	APIVersion *string `json:"api_version,omitempty"`

	// The kind of contract.
	Kind *string `json:"kind,omitempty"`

	// Status of the contract test (pass or fail).
	Status *string `json:"status,omitempty"`

	// The name of the contract.
	Name *string `json:"name,omitempty"`

	// The version of the contract.
	Version *string `json:"version" validate:"required"`

	// Domain that the data product version belongs to. If this is the first version of a data product, this field is
	// required. If this is a new version of an existing data product, the domain will default to the domain of the
	// previous version of the data product.
	Domain *Domain `json:"domain,omitempty"`

	// List of links to sources that provide more details on the data contract.
	AuthoritativeDefinitions []ContractAuthoritativeDefinition `json:"authoritative_definitions,omitempty"`

	// A unique identifier used to reduce the risk of dataset name collisions, such as a UUID.
	ID *string `json:"id" validate:"required"`

	// Indicates the property the data is primarily associated with. Value is case insensitive.
	Tenant *string `json:"tenant,omitempty"`

	// Name of the data product.
	DataProduct *string `json:"data_product,omitempty"`

	// Timestamp in UTC of when the data contract was created (ISO 8601 format).
	ContractCreatedTs *strfmt.DateTime `json:"contract_created_ts,omitempty"`

	// Tags associated with the data contract.
	Tags []string `json:"tags,omitempty"`
}

Overview : Overview details of a data contract.

type Pricing

type Pricing struct {
	// Unique identifier for pricing.
	ID *string `json:"id,omitempty"`

	// The amount for the contract pricing.
	Amount *string `json:"amount,omitempty"`

	// The currency for the pricing amount.
	Currency *string `json:"currency,omitempty"`

	// The unit associated with the pricing.
	Unit *string `json:"unit,omitempty"`
}

Pricing : Represents the pricing details of the contract.

type ProducerInputModel

type ProducerInputModel struct {
	// Engine details as defined by the data product producer.
	EngineDetails *EngineDetailsModel `json:"engine_details,omitempty"`

	// List of engines defined by the data product producer.
	Engines []EngineDetailsModel `json:"engines,omitempty"`
}

ProducerInputModel : Parameters for delivery that are set by a data product producer.

type PropertiesSchema

type PropertiesSchema struct {
	// Value of the property object.
	Value *string `json:"value,omitempty"`
}

PropertiesSchema : Properties of the corresponding asset.

type ProvidedCatalogWorkflows

type ProvidedCatalogWorkflows struct {
	// A reference to a workflow definition.
	DataAccess *ProvidedWorkflowResource `json:"data_access,omitempty"`

	// A reference to a workflow definition.
	RequestNewProduct *ProvidedWorkflowResource `json:"request_new_product,omitempty"`
}

ProvidedCatalogWorkflows : Resource defining provided workflow definitions.

type ProvidedWorkflowResource

type ProvidedWorkflowResource struct {
	// Reference to a workflow definition.
	Definition *WorkflowDefinitionReference `json:"definition,omitempty"`
}

ProvidedWorkflowResource : A reference to a workflow definition.

type PublishDataProductDraftOptions

type PublishDataProductDraftOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

PublishDataProductDraftOptions : The PublishDataProductDraft options.

func (*PublishDataProductDraftOptions) SetDataProductID

func (_options *PublishDataProductDraftOptions) SetDataProductID(dataProductID string) *PublishDataProductDraftOptions

SetDataProductID : Allow user to set DataProductID

func (*PublishDataProductDraftOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*PublishDataProductDraftOptions) SetHeaders

SetHeaders : Allow user to set Headers

type ReinitiateDataAssetVisualizationOptions

type ReinitiateDataAssetVisualizationOptions struct {
	// Data product hub asset and it's related part asset.
	Assets []DataAssetRelationship `json:"assets,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ReinitiateDataAssetVisualizationOptions : The ReinitiateDataAssetVisualization options.

func (*ReinitiateDataAssetVisualizationOptions) SetAssets

SetAssets : Allow user to set Assets

func (*ReinitiateDataAssetVisualizationOptions) SetHeaders

SetHeaders : Allow user to set Headers

type ReplaceDataProductDraftContractTermsOptions

type ReplaceDataProductDraftContractTermsOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// The reference schema for a asset in a container.
	Asset *AssetReference `json:"asset,omitempty"`

	// ID of the contract terms.
	ID *string `json:"id,omitempty"`

	// Collection of contract terms documents.
	Documents []ContractTermsDocument `json:"documents,omitempty"`

	// An error message, if existing, relating to the contract terms.
	ErrorMsg *string `json:"error_msg,omitempty"`

	// Overview details of a data contract.
	Overview *Overview `json:"overview,omitempty"`

	// Description details of a data contract.
	Description *Description `json:"description,omitempty"`

	// Represents a team with members and their roles in the contract.
	Team *ContractTermsTeam `json:"team,omitempty"`

	// List of roles associated with the contract.
	Roles []Roles `json:"roles,omitempty"`

	// Represents the pricing details of the contract.
	Price *Pricing `json:"price,omitempty"`

	// Represents the SLA details of the contract.
	SLA *ContractTemplateSLA `json:"sla,omitempty"`

	// Support and communication details for the contract.
	Support []ContractTemplateSupportAndCommunication `json:"support,omitempty"`

	// Custom properties that are not part of the standard contract.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`

	// Contains the contract test status and related metadata.
	ContractTest *ContractTest `json:"contract_test,omitempty"`

	// List of server definitions.
	Servers []ContractServer `json:"servers,omitempty"`

	// Schema details of the data asset.
	Schema []ContractSchema `json:"schema,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ReplaceDataProductDraftContractTermsOptions : The ReplaceDataProductDraftContractTerms options.

func (*ReplaceDataProductDraftContractTermsOptions) SetAsset

SetAsset : Allow user to set Asset

func (*ReplaceDataProductDraftContractTermsOptions) SetContractTermsID

SetContractTermsID : Allow user to set ContractTermsID

func (*ReplaceDataProductDraftContractTermsOptions) SetContractTest

SetContractTest : Allow user to set ContractTest

func (*ReplaceDataProductDraftContractTermsOptions) SetCustomProperties

SetCustomProperties : Allow user to set CustomProperties

func (*ReplaceDataProductDraftContractTermsOptions) SetDataProductID

SetDataProductID : Allow user to set DataProductID

func (*ReplaceDataProductDraftContractTermsOptions) SetDescription

SetDescription : Allow user to set Description

func (*ReplaceDataProductDraftContractTermsOptions) SetDocuments

SetDocuments : Allow user to set Documents

func (*ReplaceDataProductDraftContractTermsOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*ReplaceDataProductDraftContractTermsOptions) SetErrorMsg

SetErrorMsg : Allow user to set ErrorMsg

func (*ReplaceDataProductDraftContractTermsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ReplaceDataProductDraftContractTermsOptions) SetID

SetID : Allow user to set ID

func (*ReplaceDataProductDraftContractTermsOptions) SetOverview

SetOverview : Allow user to set Overview

func (*ReplaceDataProductDraftContractTermsOptions) SetPrice

SetPrice : Allow user to set Price

func (*ReplaceDataProductDraftContractTermsOptions) SetRoles

SetRoles : Allow user to set Roles

func (*ReplaceDataProductDraftContractTermsOptions) SetSLA

SetSLA : Allow user to set SLA

func (*ReplaceDataProductDraftContractTermsOptions) SetSchema

SetSchema : Allow user to set Schema

func (*ReplaceDataProductDraftContractTermsOptions) SetServers added in v4.1.0

SetServers : Allow user to set Servers

func (*ReplaceDataProductDraftContractTermsOptions) SetSupport added in v4.2.0

SetSupport : Allow user to set Support

func (*ReplaceDataProductDraftContractTermsOptions) SetTeam added in v4.2.0

SetTeam : Allow user to set Team

type RetireDataProductReleaseOptions

type RetireDataProductReleaseOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product release id.
	ReleaseID *string `json:"release_id" validate:"required,ne="`

	// Revoke's Access from all the Subscriptions of the Data Product. No user's can able to see the subscribed assets
	// anymore.
	RevokeAccess *bool `json:"revoke_access,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

RetireDataProductReleaseOptions : The RetireDataProductRelease options.

func (*RetireDataProductReleaseOptions) SetDataProductID

func (_options *RetireDataProductReleaseOptions) SetDataProductID(dataProductID string) *RetireDataProductReleaseOptions

SetDataProductID : Allow user to set DataProductID

func (*RetireDataProductReleaseOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*RetireDataProductReleaseOptions) SetReleaseID

func (_options *RetireDataProductReleaseOptions) SetReleaseID(releaseID string) *RetireDataProductReleaseOptions

SetReleaseID : Allow user to set ReleaseID

func (*RetireDataProductReleaseOptions) SetRevokeAccess

func (_options *RetireDataProductReleaseOptions) SetRevokeAccess(revokeAccess bool) *RetireDataProductReleaseOptions

SetRevokeAccess : Allow user to set RevokeAccess

type RetiredDataProductReleasesLatestPager added in v4.2.0

type RetiredDataProductReleasesLatestPager struct {
	// contains filtered or unexported fields
}

RetiredDataProductReleasesLatestPager can be used to simplify the use of the "ListRetiredDataProductReleasesLatest" method.

func (*RetiredDataProductReleasesLatestPager) GetAll added in v4.2.0

func (pager *RetiredDataProductReleasesLatestPager) GetAll() (allItems []DataProductReleaseSummary, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*RetiredDataProductReleasesLatestPager) GetAllWithContext added in v4.2.0

func (pager *RetiredDataProductReleasesLatestPager) GetAllWithContext(ctx context.Context) (allItems []DataProductReleaseSummary, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*RetiredDataProductReleasesLatestPager) GetNext added in v4.2.0

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*RetiredDataProductReleasesLatestPager) GetNextWithContext added in v4.2.0

func (pager *RetiredDataProductReleasesLatestPager) GetNextWithContext(ctx context.Context) (page []DataProductReleaseSummary, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*RetiredDataProductReleasesLatestPager) HasNext added in v4.2.0

HasNext returns true if there are potentially more results to be retrieved.

type RevokeAccessResponse added in v4.1.0

type RevokeAccessResponse struct {
	// Response message of revoke access.
	Message *string `json:"message,omitempty"`
}

RevokeAccessResponse : This class holds the response message from the revoke access operation.

type RevokeAccessStateResponse added in v4.1.0

type RevokeAccessStateResponse struct {
	// Holds revoke access state.
	Results []Asset `json:"results,omitempty"`

	// Total number of rows available.
	TotalCount *int64 `json:"total_count,omitempty"`

	// Pagination information for the next page of results.
	Next *SearchAssetPaginationInfo `json:"next,omitempty"`
}

RevokeAccessStateResponse : Revoke access states with pagination support.

type Roles

type Roles struct {
	// Unique identifier for the role.
	ID *string `json:"id,omitempty"`

	// The role associated with the contract.
	Role *string `json:"role" validate:"required"`

	// Access level for the role.
	Access *string `json:"access,omitempty"`

	// First level approvers for the role.
	FirstLevelApprovers *string `json:"first_level_approvers,omitempty"`

	// Second level approvers for the role.
	SecondLevelApprovers *string `json:"second_level_approvers,omitempty"`

	// Description of the role.
	Description *string `json:"description,omitempty"`

	// List of custom properties for the role.
	CustomProperties []ContractTemplateCustomProperty `json:"custom_properties,omitempty"`
}

Roles : Represents a role associated with the contract.

type SearchAssetPaginationInfo added in v4.1.0

type SearchAssetPaginationInfo struct {
	// Search query for filtering results.
	Query *string `json:"query,omitempty"`

	// Number of items per page.
	Limit *int64 `json:"limit,omitempty"`

	// Bookmark for pagination.
	Bookmark *string `json:"bookmark,omitempty"`

	// What to include in the results.
	Include *string `json:"include,omitempty"`

	// Number of items to skip.
	Skip *int64 `json:"skip,omitempty"`
}

SearchAssetPaginationInfo : Pagination information for the next page of results.

type ServerMapping added in v4.2.0

type ServerMapping struct {
	// Server name for the connection.
	ServerName *string `json:"server_name" validate:"required"`

	// Connection Id of the data asset.
	ConnectionID *string `json:"connection_id" validate:"required"`
}

ServerMapping : Server mapping that maps the server name in the contract with the connection ID.

type ServiceIDCredentials

type ServiceIDCredentials struct {
	// Name of the api key of the service id.
	Name *string `json:"name,omitempty"`

	// Created date of the api key of the service id.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
}

ServiceIDCredentials : Service id credentials.

type UpdateDataProductContractTemplateOptions

type UpdateDataProductContractTemplateOptions struct {
	// Data Product Contract Template id.
	ContractTemplateID *string `json:"contract_template_id" validate:"required,ne="`

	// Container ID of the data product catalog.
	ContainerID *string `json:"container.id" validate:"required"`

	// A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
	JSONPatchInstructions []JSONPatchOperation `json:"jsonPatchInstructions" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateDataProductContractTemplateOptions : The UpdateDataProductContractTemplate options.

func (*UpdateDataProductContractTemplateOptions) SetContainerID

SetContainerID : Allow user to set ContainerID

func (*UpdateDataProductContractTemplateOptions) SetContractTemplateID

func (_options *UpdateDataProductContractTemplateOptions) SetContractTemplateID(contractTemplateID string) *UpdateDataProductContractTemplateOptions

SetContractTemplateID : Allow user to set ContractTemplateID

func (*UpdateDataProductContractTemplateOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateDataProductContractTemplateOptions) SetJSONPatchInstructions

func (_options *UpdateDataProductContractTemplateOptions) SetJSONPatchInstructions(jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductContractTemplateOptions

SetJSONPatchInstructions : Allow user to set JSONPatchInstructions

type UpdateDataProductDomainOptions

type UpdateDataProductDomainOptions struct {
	// Domain id.
	DomainID *string `json:"domain_id" validate:"required,ne="`

	// Container ID of the data product catalog.
	ContainerID *string `json:"container.id" validate:"required"`

	// A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
	JSONPatchInstructions []JSONPatchOperation `json:"jsonPatchInstructions" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateDataProductDomainOptions : The UpdateDataProductDomain options.

func (*UpdateDataProductDomainOptions) SetContainerID

func (_options *UpdateDataProductDomainOptions) SetContainerID(containerID string) *UpdateDataProductDomainOptions

SetContainerID : Allow user to set ContainerID

func (*UpdateDataProductDomainOptions) SetDomainID

func (_options *UpdateDataProductDomainOptions) SetDomainID(domainID string) *UpdateDataProductDomainOptions

SetDomainID : Allow user to set DomainID

func (*UpdateDataProductDomainOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateDataProductDomainOptions) SetJSONPatchInstructions

func (_options *UpdateDataProductDomainOptions) SetJSONPatchInstructions(jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductDomainOptions

SetJSONPatchInstructions : Allow user to set JSONPatchInstructions

type UpdateDataProductDraftContractTermsOptions

type UpdateDataProductDraftContractTermsOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
	JSONPatchInstructions []JSONPatchOperation `json:"jsonPatchInstructions" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateDataProductDraftContractTermsOptions : The UpdateDataProductDraftContractTerms options.

func (*UpdateDataProductDraftContractTermsOptions) SetContractTermsID

SetContractTermsID : Allow user to set ContractTermsID

func (*UpdateDataProductDraftContractTermsOptions) SetDataProductID

SetDataProductID : Allow user to set DataProductID

func (*UpdateDataProductDraftContractTermsOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*UpdateDataProductDraftContractTermsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateDataProductDraftContractTermsOptions) SetJSONPatchInstructions

func (_options *UpdateDataProductDraftContractTermsOptions) SetJSONPatchInstructions(jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductDraftContractTermsOptions

SetJSONPatchInstructions : Allow user to set JSONPatchInstructions

type UpdateDataProductDraftOptions

type UpdateDataProductDraftOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
	JSONPatchInstructions []JSONPatchOperation `json:"jsonPatchInstructions" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateDataProductDraftOptions : The UpdateDataProductDraft options.

func (*UpdateDataProductDraftOptions) SetDataProductID

func (_options *UpdateDataProductDraftOptions) SetDataProductID(dataProductID string) *UpdateDataProductDraftOptions

SetDataProductID : Allow user to set DataProductID

func (*UpdateDataProductDraftOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*UpdateDataProductDraftOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateDataProductDraftOptions) SetJSONPatchInstructions

func (_options *UpdateDataProductDraftOptions) SetJSONPatchInstructions(jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductDraftOptions

SetJSONPatchInstructions : Allow user to set JSONPatchInstructions

type UpdateDataProductReleaseOptions

type UpdateDataProductReleaseOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product release id.
	ReleaseID *string `json:"release_id" validate:"required,ne="`

	// A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
	JSONPatchInstructions []JSONPatchOperation `json:"jsonPatchInstructions" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateDataProductReleaseOptions : The UpdateDataProductRelease options.

func (*UpdateDataProductReleaseOptions) SetDataProductID

func (_options *UpdateDataProductReleaseOptions) SetDataProductID(dataProductID string) *UpdateDataProductReleaseOptions

SetDataProductID : Allow user to set DataProductID

func (*UpdateDataProductReleaseOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateDataProductReleaseOptions) SetJSONPatchInstructions

func (_options *UpdateDataProductReleaseOptions) SetJSONPatchInstructions(jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductReleaseOptions

SetJSONPatchInstructions : Allow user to set JSONPatchInstructions

func (*UpdateDataProductReleaseOptions) SetReleaseID

func (_options *UpdateDataProductReleaseOptions) SetReleaseID(releaseID string) *UpdateDataProductReleaseOptions

SetReleaseID : Allow user to set ReleaseID

type UpdateDeliveryConfigurationOptions added in v4.2.0

type UpdateDeliveryConfigurationOptions struct {
	// Container ID of the data product catalog.
	ContainerID *string `json:"container.id" validate:"required"`

	// JSON array of patch operations as defined in RFC 6902. Only the 'enabled' attribute can be modified. Supported
	// operations: add, remove, replace. <br/><br/>Common paths: <br/><br/> - /delivery_methods <br/>-
	// /persist_consumer_connection <br/>.
	JSONPatchOperation []JSONPatchOperation `json:"JsonPatchOperation" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateDeliveryConfigurationOptions : The UpdateDeliveryConfiguration options.

func (*UpdateDeliveryConfigurationOptions) SetContainerID added in v4.2.0

func (_options *UpdateDeliveryConfigurationOptions) SetContainerID(containerID string) *UpdateDeliveryConfigurationOptions

SetContainerID : Allow user to set ContainerID

func (*UpdateDeliveryConfigurationOptions) SetHeaders added in v4.2.0

SetHeaders : Allow user to set Headers

func (*UpdateDeliveryConfigurationOptions) SetJSONPatchOperation added in v4.2.0

func (_options *UpdateDeliveryConfigurationOptions) SetJSONPatchOperation(jsonPatchOperation []JSONPatchOperation) *UpdateDeliveryConfigurationOptions

SetJSONPatchOperation : Allow user to set JSONPatchOperation

type UpdateDeliveryMethodOptions added in v4.2.0

type UpdateDeliveryMethodOptions struct {
	// The catalog ID where delivery method is stored.
	CatalogID *string `json:"catalog_id" validate:"required"`

	// The ID of the delivery method to update.
	DeliveryMethodID *string `json:"delivery_method_id" validate:"required,ne="`

	// JSON array of patch operations as defined in RFC 6902. Supported operations: add, remove, replace. <br/><br/>Common
	// paths: <br/><br/> - /description <br/>- /status <br/>- /localized_name <br/>- /localized_description <br/>-
	// /output_format <br/>- /consumer_input <br/> - /supported_asset_types <br/>- /is_restricted <br/>-
	// /supports_redelivery <br/>- /supports_add_to_project <br/>- /supports_column_selection <br/>-
	// /supported_data_sources <br/>- /producer_input <br/>- /auto_mark_delivered [this is only supported for 'external'
	// delivery method].
	JSONPatchOperation []JSONPatchOperation `json:"JsonPatchOperation" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateDeliveryMethodOptions : The UpdateDeliveryMethod options.

func (*UpdateDeliveryMethodOptions) SetCatalogID added in v4.2.0

func (_options *UpdateDeliveryMethodOptions) SetCatalogID(catalogID string) *UpdateDeliveryMethodOptions

SetCatalogID : Allow user to set CatalogID

func (*UpdateDeliveryMethodOptions) SetDeliveryMethodID added in v4.2.0

func (_options *UpdateDeliveryMethodOptions) SetDeliveryMethodID(deliveryMethodID string) *UpdateDeliveryMethodOptions

SetDeliveryMethodID : Allow user to set DeliveryMethodID

func (*UpdateDeliveryMethodOptions) SetHeaders added in v4.2.0

func (options *UpdateDeliveryMethodOptions) SetHeaders(param map[string]string) *UpdateDeliveryMethodOptions

SetHeaders : Allow user to set Headers

func (*UpdateDeliveryMethodOptions) SetJSONPatchOperation added in v4.2.0

func (_options *UpdateDeliveryMethodOptions) SetJSONPatchOperation(jsonPatchOperation []JSONPatchOperation) *UpdateDeliveryMethodOptions

SetJSONPatchOperation : Allow user to set JSONPatchOperation

type UpdateDraftContractTermsDocumentOptions

type UpdateDraftContractTermsDocumentOptions struct {
	// Data product ID. Use '-' to skip specifying the data product ID explicitly.
	DataProductID *string `json:"data_product_id" validate:"required,ne="`

	// Data product draft id.
	DraftID *string `json:"draft_id" validate:"required,ne="`

	// Contract terms id.
	ContractTermsID *string `json:"contract_terms_id" validate:"required,ne="`

	// Document id.
	DocumentID *string `json:"document_id" validate:"required,ne="`

	// A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information.
	JSONPatchInstructions []JSONPatchOperation `json:"jsonPatchInstructions" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateDraftContractTermsDocumentOptions : The UpdateDraftContractTermsDocument options.

func (*UpdateDraftContractTermsDocumentOptions) SetContractTermsID

func (_options *UpdateDraftContractTermsDocumentOptions) SetContractTermsID(contractTermsID string) *UpdateDraftContractTermsDocumentOptions

SetContractTermsID : Allow user to set ContractTermsID

func (*UpdateDraftContractTermsDocumentOptions) SetDataProductID

SetDataProductID : Allow user to set DataProductID

func (*UpdateDraftContractTermsDocumentOptions) SetDocumentID

SetDocumentID : Allow user to set DocumentID

func (*UpdateDraftContractTermsDocumentOptions) SetDraftID

SetDraftID : Allow user to set DraftID

func (*UpdateDraftContractTermsDocumentOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateDraftContractTermsDocumentOptions) SetJSONPatchInstructions

func (_options *UpdateDraftContractTermsDocumentOptions) SetJSONPatchInstructions(jsonPatchInstructions []JSONPatchOperation) *UpdateDraftContractTermsDocumentOptions

SetJSONPatchInstructions : Allow user to set JSONPatchInstructions

type UseCase

type UseCase struct {
	// The id of the use case associated with the data product.
	ID *string `json:"id" validate:"required"`

	// The display name of the use case associated with the data product.
	Name *string `json:"name,omitempty"`

	// Container reference.
	Container *ContainerReference `json:"container,omitempty"`
}

UseCase : UseCase struct

type ValidateContractTemplateYamlOptions added in v4.2.0

type ValidateContractTemplateYamlOptions struct {
	// YAML content to validate against ODCS v3.1.0 standard.
	Body *string `json:"body" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ValidateContractTemplateYamlOptions : The ValidateContractTemplateYaml options.

func (*ValidateContractTemplateYamlOptions) SetBody added in v4.2.0

SetBody : Allow user to set Body

func (*ValidateContractTemplateYamlOptions) SetHeaders added in v4.2.0

SetHeaders : Allow user to set Headers

type Visualization

type Visualization struct {
	// Visualization identifier.
	ID *string `json:"id,omitempty"`

	// Visualization name.
	Name *string `json:"name,omitempty"`
}

Visualization : Data members for visualization.

type WorkflowDefinitionReference

type WorkflowDefinitionReference struct {
	// ID of a workflow definition.
	ID *string `json:"id,omitempty"`
}

WorkflowDefinitionReference : Reference to a workflow definition.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL