dpxv1

package
v0.0.6 Latest Latest
Warning

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

 Go to latest Published: Mar 13, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package dpxv1 : Operations and models for the DpxV1 service

Index

Constants

View Source 
const (
	ContractTermsDocument_Type_Sla                = "sla"
	ContractTermsDocument_Type_TermsAndConditions = "terms_and_conditions"
)

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

View Source 
const (
	CreateDataProductDraftOptions_State_Available = "available"
	CreateDataProductDraftOptions_State_Draft     = "draft"
	CreateDataProductDraftOptions_State_Retired   = "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 (
	CreateDataProductDraftOptions_Types_Code = "code"
	CreateDataProductDraftOptions_Types_Data = "data"
)

Constants associated with the CreateDataProductDraftOptions.Types property.

View Source 
const (
	CreateDraftContractTermsDocumentOptions_Type_Sla                = "sla"
	CreateDraftContractTermsDocumentOptions_Type_TermsAndConditions = "terms_and_conditions"
)

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

View Source 
const (
	DataProductVersion_State_Available = "available"
	DataProductVersion_State_Draft     = "draft"
	DataProductVersion_State_Retired   = "retired"
)

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

View Source 
const (
	DataProductVersion_Types_Code = "code"
	DataProductVersion_Types_Data = "data"
)

Constants associated with the DataProductVersion.Types property.

View Source 
const (
	DataProductVersionPrototype_State_Available = "available"
	DataProductVersionPrototype_State_Draft     = "draft"
	DataProductVersionPrototype_State_Retired   = "retired"
)

Constants associated with the DataProductVersionPrototype.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 (
	DataProductVersionPrototype_Types_Code = "code"
	DataProductVersionPrototype_Types_Data = "data"
)

Constants associated with the DataProductVersionPrototype.Types property.

View Source 
const (
	DataProductVersionSummary_State_Available = "available"
	DataProductVersionSummary_State_Draft     = "draft"
	DataProductVersionSummary_State_Retired   = "retired"
)

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

View Source 
const (
	ErrorModelResource_Code_AlreadyExists          = "already_exists"
	ErrorModelResource_Code_ConfigurationError     = "configuration_error"
	ErrorModelResource_Code_Conflict               = "conflict"
	ErrorModelResource_Code_ConstraintViolation    = "constraint_violation"
	ErrorModelResource_Code_CreateError            = "create_error"
	ErrorModelResource_Code_DataError              = "data_error"
	ErrorModelResource_Code_DatabaseError          = "database_error"
	ErrorModelResource_Code_DatabaseQueryError     = "database_query_error"
	ErrorModelResource_Code_DatabaseUsageLimits    = "database_usage_limits"
	ErrorModelResource_Code_DeleteError            = "delete_error"
	ErrorModelResource_Code_Deleted                = "deleted"
	ErrorModelResource_Code_DependentServiceError  = "dependent_service_error"
	ErrorModelResource_Code_DoesNotExist           = "does_not_exist"
	ErrorModelResource_Code_EntitlementEnforcement = "entitlement_enforcement"
	ErrorModelResource_Code_FetchError             = "fetch_error"
	ErrorModelResource_Code_Forbidden              = "forbidden"
	ErrorModelResource_Code_GovernancePolicyDenial = "governance_policy_denial"
	ErrorModelResource_Code_InactiveUser           = "inactive_user"
	ErrorModelResource_Code_InvalidParameter       = "invalid_parameter"
	ErrorModelResource_Code_MissingRequiredValue   = "missing_required_value"
	ErrorModelResource_Code_NotAuthenticated       = "not_authenticated"
	ErrorModelResource_Code_NotAuthorized          = "not_authorized"
	ErrorModelResource_Code_NotImplemented         = "not_implemented"
	ErrorModelResource_Code_RequestBodyError       = "request_body_error"
	ErrorModelResource_Code_TooManyRequests        = "too_many_requests"
	ErrorModelResource_Code_UnableToPerform        = "unable_to_perform"
	ErrorModelResource_Code_UnexpectedException    = "unexpected_exception"
	ErrorModelResource_Code_UpdateError            = "update_error"
)

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

View Source 
const (
	InitializeOptions_Include_DataProductSamples   = "data_product_samples"
	InitializeOptions_Include_DeliveryMethods      = "delivery_methods"
	InitializeOptions_Include_DomainsMultiIndustry = "domains_multi_industry"
	InitializeOptions_Include_Workflows            = "workflows"
)

Constants associated with the InitializeOptions.Include property.

View Source 
const (
	InitializeResource_Status_Failed     = "failed"
	InitializeResource_Status_InProgress = "in_progress"
	InitializeResource_Status_NotStarted = "not_started"
	InitializeResource_Status_Succeeded  = "succeeded"
)

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

View Source 
const (
	JSONPatchOperation_Op_Add     = "add"
	JSONPatchOperation_Op_Copy    = "copy"
	JSONPatchOperation_Op_Move    = "move"
	JSONPatchOperation_Op_Remove  = "remove"
	JSONPatchOperation_Op_Replace = "replace"
	JSONPatchOperation_Op_Test    = "test"
)

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

View Source 
const (
	ListDataProductReleasesOptions_State_Available = "available"
	ListDataProductReleasesOptions_State_Retired   = "retired"
)

Constants associated with the ListDataProductReleasesOptions.State property.

View Source 
const (
	ContainerReference_Type_Catalog = "catalog"
)

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

View Source 
const DefaultServiceName = "dpx"

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

View Source 
const DefaultServiceURL = "https://api.dataplatform.dev.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

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 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 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 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 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 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 UnmarshalDataProductContractTerms 

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

UnmarshalDataProductContractTerms unmarshals an instance of DataProductContractTerms 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 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 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 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 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 UnmarshalDataProductSummaryCollection 

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

UnmarshalDataProductSummaryCollection unmarshals an instance of DataProductSummaryCollection from the specified map of raw messages.

func UnmarshalDataProductVersion 

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

UnmarshalDataProductVersion unmarshals an instance of DataProductVersion from the specified map of raw messages.

func UnmarshalDataProductVersionPrototype 

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

UnmarshalDataProductVersionPrototype unmarshals an instance of DataProductVersionPrototype 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 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 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 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 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 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 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.

Types

type AssetPartReference 

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

	// Data product exchange container.
	Container *ContainerReference `json:"container" validate:"required"`

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

AssetPartReference : The asset represented in this part.

type AssetReference 

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

	// Data product exchange container.
	Container *ContainerReference `json:"container" validate:"required"`
}

AssetReference : The asset referenced by the data product version.

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 

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

SetContractTermsID : Allow user to set ContractTermsID

func (*CompleteDraftContractTermsDocumentOptions) SetDataProductID 

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

SetDataProductID : Allow user to set DataProductID

func (*CompleteDraftContractTermsDocumentOptions) SetDocumentID 

func (_options *CompleteDraftContractTermsDocumentOptions) SetDocumentID(documentID string) *CompleteDraftContractTermsDocumentOptions

SetDocumentID : Allow user to set DocumentID

func (*CompleteDraftContractTermsDocumentOptions) SetDraftID 

func (_options *CompleteDraftContractTermsDocumentOptions) SetDraftID(draftID string) *CompleteDraftContractTermsDocumentOptions

SetDraftID : Allow user to set DraftID

func (*CompleteDraftContractTermsDocumentOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

type ContainerReference 

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

	// Container type.
	Type *string `json:"type,omitempty"`
}

ContainerReference : Data product exchange container.

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 CreateDataProductDraftOptions 

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

	// The asset referenced by the data product version.
	Asset *AssetReference `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 new data product version. If this is the first version of a data product, tags defaults to an empty
	// list. If this is a new version of an existing data product, tags will default to the list of tags on the previous
	// version of the data product.
	Tags []string `json:"tags,omitempty"`

	// Use cases that the data product version serves. If this is the first version of a data product, use cases defaults
	// to an empty list. If this is a new version of an existing data product, use cases will default to the list of use
	// cases on the previous version of the data product.
	UseCases []UseCase `json:"use_cases,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 types of the parts included in this data product version. 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 types will default to the
	// types of the previous version of the data product.
	Types []string `json:"types,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 contract terms that bind interactions with this data product version.
	ContractTerms []DataProductContractTerms `json:"contract_terms,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) SetAsset 

func (_options *CreateDataProductDraftOptions) SetAsset(asset *AssetReference) *CreateDataProductDraftOptions

SetAsset : Allow user to set Asset

func (*CreateDataProductDraftOptions) SetContractTerms 

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

SetContractTerms : Allow user to set ContractTerms

func (*CreateDataProductDraftOptions) SetDataProduct 

func (_options *CreateDataProductDraftOptions) SetDataProduct(dataProduct *DataProductIdentity) *CreateDataProductDraftOptions

SetDataProduct : Allow user to set DataProduct

func (*CreateDataProductDraftOptions) SetDataProductID 

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

SetDataProductID : Allow user to set DataProductID

func (*CreateDataProductDraftOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*CreateDataProductDraftOptions) SetDomain 

func (_options *CreateDataProductDraftOptions) SetDomain(domain *Domain) *CreateDataProductDraftOptions

SetDomain : Allow user to set Domain

func (*CreateDataProductDraftOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateDataProductDraftOptions) SetIsRestricted 

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

SetIsRestricted : Allow user to set IsRestricted

func (*CreateDataProductDraftOptions) SetName 

func (_options *CreateDataProductDraftOptions) SetName(name string) *CreateDataProductDraftOptions

SetName : Allow user to set Name

func (*CreateDataProductDraftOptions) SetPartsOut 

func (_options *CreateDataProductDraftOptions) SetPartsOut(partsOut []DataProductPart) *CreateDataProductDraftOptions

SetPartsOut : Allow user to set PartsOut

func (*CreateDataProductDraftOptions) SetState 

func (_options *CreateDataProductDraftOptions) SetState(state string) *CreateDataProductDraftOptions

SetState : Allow user to set State

func (*CreateDataProductDraftOptions) SetTags 

func (_options *CreateDataProductDraftOptions) SetTags(tags []string) *CreateDataProductDraftOptions

SetTags : Allow user to set Tags

func (*CreateDataProductDraftOptions) SetTypes 

func (_options *CreateDataProductDraftOptions) SetTypes(types []string) *CreateDataProductDraftOptions

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 

func (_options *CreateDataProductDraftOptions) SetVersion(version string) *CreateDataProductDraftOptions

SetVersion : Allow user to set Version

type CreateDataProductOptions 

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

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

CreateDataProductOptions : The CreateDataProduct options.

func (*CreateDataProductOptions) SetDrafts 

func (_options *CreateDataProductOptions) SetDrafts(drafts []DataProductVersionPrototype) *CreateDataProductOptions

SetDrafts : Allow user to set Drafts

func (*CreateDataProductOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

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"`

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

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

	// 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"`

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

CreateDraftContractTermsDocumentOptions : The CreateDraftContractTermsDocument options.

func (*CreateDraftContractTermsDocumentOptions) SetAttachment 

func (_options *CreateDraftContractTermsDocumentOptions) SetAttachment(attachment *ContractTermsDocumentAttachment) *CreateDraftContractTermsDocumentOptions

SetAttachment : Allow user to set Attachment

func (*CreateDraftContractTermsDocumentOptions) SetContractTermsID 

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

SetContractTermsID : Allow user to set ContractTermsID

func (*CreateDraftContractTermsDocumentOptions) SetDataProductID 

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

SetDataProductID : Allow user to set DataProductID

func (*CreateDraftContractTermsDocumentOptions) SetDraftID 

func (_options *CreateDraftContractTermsDocumentOptions) SetDraftID(draftID string) *CreateDraftContractTermsDocumentOptions

SetDraftID : Allow user to set DraftID

func (*CreateDraftContractTermsDocumentOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateDraftContractTermsDocumentOptions) SetID 

func (_options *CreateDraftContractTermsDocumentOptions) SetID(id string) *CreateDraftContractTermsDocumentOptions

SetID : Allow user to set ID

func (*CreateDraftContractTermsDocumentOptions) SetName 

func (_options *CreateDraftContractTermsDocumentOptions) SetName(name string) *CreateDraftContractTermsDocumentOptions

SetName : Allow user to set Name

func (*CreateDraftContractTermsDocumentOptions) SetType 

func (_options *CreateDraftContractTermsDocumentOptions) SetType(typeVar string) *CreateDraftContractTermsDocumentOptions

SetType : Allow user to set Type

func (*CreateDraftContractTermsDocumentOptions) SetURL 

func (_options *CreateDraftContractTermsDocumentOptions) SetURL(url string) *CreateDraftContractTermsDocumentOptions

SetURL : Allow user to set URL

func (*CreateDraftContractTermsDocumentOptions) SetUploadURL 

func (_options *CreateDraftContractTermsDocumentOptions) SetUploadURL(uploadURL string) *CreateDraftContractTermsDocumentOptions

SetUploadURL : Allow user to set UploadURL

type DataProduct 

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

	// Data product exchange container.
	Container *ContainerReference `json:"container" validate:"required"`

	// 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 DataProductContractTerms 

type DataProductContractTerms struct {
	// The asset referenced by the data product version.
	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"`
}

DataProductContractTerms : DataProductContractTerms struct

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"`

	// Collection of data product drafts.
	Drafts []DataProductVersionSummary `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 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 []DataProductVersionSummary, err error)

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

func (*DataProductDraftsPager) GetAllWithContext 

func (pager *DataProductDraftsPager) GetAllWithContext(ctx context.Context) (allItems []DataProductVersionSummary, 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 []DataProductVersionSummary, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*DataProductDraftsPager) GetNextWithContext 

func (pager *DataProductDraftsPager) GetNextWithContext(ctx context.Context) (page []DataProductVersionSummary, 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 DataProductIdentity 

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

DataProductIdentity : Data product identifier.

type DataProductPart 

type DataProductPart struct {
	// The asset represented in this part.
	Asset *AssetPartReference `json:"asset" validate:"required"`

	// The revision number of the asset represented in this part.
	Revision *int64 `json:"revision,omitempty"`

	// The time for when the part was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Delivery methods describing the delivery options available for this part.
	DeliveryMethods []DeliveryMethod `json:"delivery_methods,omitempty"`
}

DataProductPart : DataProductPart struct

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"`

	// Collection of data product releases.
	Releases []DataProductVersionSummary `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 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 []DataProductVersionSummary, err error)

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

func (*DataProductReleasesPager) GetAllWithContext 

func (pager *DataProductReleasesPager) GetAllWithContext(ctx context.Context) (allItems []DataProductVersionSummary, 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 []DataProductVersionSummary, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*DataProductReleasesPager) GetNextWithContext 

func (pager *DataProductReleasesPager) GetNextWithContext(ctx context.Context) (page []DataProductVersionSummary, 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"`

	// Data product exchange container.
	Container *ContainerReference `json:"container" validate:"required"`
}

DataProductSummary : Data Product Summary.

type DataProductSummaryCollection 

type DataProductSummaryCollection 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"`

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

DataProductSummaryCollection : A collection of data product summaries.

func (*DataProductSummaryCollection) GetNextStart 

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

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

type DataProductVersion 

type DataProductVersion 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 identifier.
	DataProduct *DataProductIdentity `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"`

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

	// The asset referenced by the data product version.
	Asset *AssetReference `json:"asset" 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"`

	// 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"`

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

	// Outgoing parts of a data product used to deliver the data product to consumers.
	PartsOut []DataProductPart `json:"parts_out" 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"`

	// Contract terms binding various aspects of the data product.
	ContractTerms []DataProductContractTerms `json:"contract_terms,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"`

	// 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"`
}

DataProductVersion : Data Product version.

type DataProductVersionPrototype 

type DataProductVersionPrototype 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"`

	// The asset referenced by the data product version.
	Asset *AssetReference `json:"asset" validate:"required"`

	// Tags on the new data product version. If this is the first version of a data product, tags defaults to an empty
	// list. If this is a new version of an existing data product, tags will default to the list of tags on the previous
	// version of the data product.
	Tags []string `json:"tags,omitempty"`

	// Use cases that the data product version serves. If this is the first version of a data product, use cases defaults
	// to an empty list. If this is a new version of an existing data product, use cases will default to the list of use
	// cases on the previous version of the data product.
	UseCases []UseCase `json:"use_cases,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 types of the parts included in this data product version. 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 types will default to the
	// types of the previous version of the data product.
	Types []string `json:"types,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 contract terms that bind interactions with this data product version.
	ContractTerms []DataProductContractTerms `json:"contract_terms,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"`
}

DataProductVersionPrototype : New data product version input properties.

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 identifier.
	DataProduct *DataProductIdentity `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"`

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

	// The asset referenced by the data product version.
	Asset *AssetReference `json:"asset" validate:"required"`
}

DataProductVersionSummary : Summary of Data Product Version object.

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

func (_options *DeleteDataProductDraftOptions) SetDraftID(draftID string) *DeleteDataProductDraftOptions

SetDraftID : Allow user to set DraftID

func (*DeleteDataProductDraftOptions) SetHeaders 

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

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 

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

SetDataProductID : Allow user to set DataProductID

func (*DeleteDraftContractTermsDocumentOptions) SetDocumentID 

func (_options *DeleteDraftContractTermsDocumentOptions) SetDocumentID(documentID string) *DeleteDraftContractTermsDocumentOptions

SetDocumentID : Allow user to set DocumentID

func (*DeleteDraftContractTermsDocumentOptions) SetDraftID 

func (_options *DeleteDraftContractTermsDocumentOptions) SetDraftID(draftID string) *DeleteDraftContractTermsDocumentOptions

SetDraftID : Allow user to set DraftID

func (*DeleteDraftContractTermsDocumentOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

type DeliveryMethod 

type DeliveryMethod struct {
	// The ID of the delivery method.
	ID *string `json:"id" validate:"required"`

	// Data product exchange container.
	Container *ContainerReference `json:"container" validate:"required"`
}

DeliveryMethod : DeliveryMethod struct

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"`

	// Data product exchange container.
	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 DpxV1 

type DpxV1 struct {
	Service *core.BaseService
}

DpxV1 : Data Product Exchange API Service

API Version: 1.0.0

func NewDpxV1 

func NewDpxV1(options *DpxV1Options) (service *DpxV1, err error)

NewDpxV1 : constructs an instance of DpxV1 with passed in options.

func NewDpxV1UsingExternalConfig 

func NewDpxV1UsingExternalConfig(options *DpxV1Options) (dpx *DpxV1, err error)

NewDpxV1UsingExternalConfig : constructs an instance of DpxV1 with passed in options and external configuration.

func (*DpxV1) Clone 

func (dpx *DpxV1) Clone() *DpxV1

Clone makes a copy of "dpx" suitable for processing requests.

func (*DpxV1) CompleteDraftContractTermsDocument 

func (dpx *DpxV1) 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. - 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 (*DpxV1) CompleteDraftContractTermsDocumentWithContext 

func (dpx *DpxV1) 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 (*DpxV1) CreateDataProduct 

func (dpx *DpxV1) 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 (*DpxV1) CreateDataProductDraft 

func (dpx *DpxV1) CreateDataProductDraft(createDataProductDraftOptions *CreateDataProductDraftOptions) (result *DataProductVersion, 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 (*DpxV1) CreateDataProductDraftWithContext 

func (dpx *DpxV1) CreateDataProductDraftWithContext(ctx context.Context, createDataProductDraftOptions *CreateDataProductDraftOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

CreateDataProductDraftWithContext is an alternate form of the CreateDataProductDraft method which supports a Context parameter

func (*DpxV1) CreateDataProductWithContext 

func (dpx *DpxV1) 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 (*DpxV1) CreateDraftContractTermsDocument 

func (dpx *DpxV1) 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.

- 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 (*DpxV1) CreateDraftContractTermsDocumentWithContext 

func (dpx *DpxV1) 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 (*DpxV1) DeleteDataProductDraft 

func (dpx *DpxV1) 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.

func (*DpxV1) DeleteDataProductDraftWithContext 

func (dpx *DpxV1) 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 (*DpxV1) DeleteDraftContractTermsDocument 

func (dpx *DpxV1) 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.

func (*DpxV1) DeleteDraftContractTermsDocumentWithContext 

func (dpx *DpxV1) 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 (*DpxV1) DisableRetries 

func (dpx *DpxV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*DpxV1) EnableRetries 

func (dpx *DpxV1) 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 (*DpxV1) GetDataProduct 

func (dpx *DpxV1) 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 (*DpxV1) GetDataProductDraft 

func (dpx *DpxV1) GetDataProductDraft(getDataProductDraftOptions *GetDataProductDraftOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

GetDataProductDraft : Get a draft of an existing data product Get a draft of an existing data product.

func (*DpxV1) GetDataProductDraftWithContext 

func (dpx *DpxV1) GetDataProductDraftWithContext(ctx context.Context, getDataProductDraftOptions *GetDataProductDraftOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

GetDataProductDraftWithContext is an alternate form of the GetDataProductDraft method which supports a Context parameter

func (*DpxV1) GetDataProductRelease 

func (dpx *DpxV1) GetDataProductRelease(getDataProductReleaseOptions *GetDataProductReleaseOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

GetDataProductRelease : Get a release of an existing data product Get a release of an existing data product.

func (*DpxV1) GetDataProductReleaseWithContext 

func (dpx *DpxV1) GetDataProductReleaseWithContext(ctx context.Context, getDataProductReleaseOptions *GetDataProductReleaseOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

GetDataProductReleaseWithContext is an alternate form of the GetDataProductRelease method which supports a Context parameter

func (*DpxV1) GetDataProductWithContext 

func (dpx *DpxV1) 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 (*DpxV1) GetDraftContractTermsDocument 

func (dpx *DpxV1) 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.

func (*DpxV1) GetDraftContractTermsDocumentWithContext 

func (dpx *DpxV1) 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 (*DpxV1) GetEnableGzipCompression 

func (dpx *DpxV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*DpxV1) GetInitializeStatus 

func (dpx *DpxV1) 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 Exchange.<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 (*DpxV1) GetInitializeStatusWithContext 

func (dpx *DpxV1) 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 (*DpxV1) GetReleaseContractTermsDocument 

func (dpx *DpxV1) 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.

func (*DpxV1) GetReleaseContractTermsDocumentWithContext 

func (dpx *DpxV1) 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 (*DpxV1) GetServiceURL 

func (dpx *DpxV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*DpxV1) Initialize 

func (dpx *DpxV1) Initialize(initializeOptions *InitializeOptions) (result *InitializeResource, response *core.DetailedResponse, err error)

Initialize : Initialize resources Use this API to initialize default assets for data product exchange. <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 exchange</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 exchange</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 exchange 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 exchange 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 (*DpxV1) InitializeWithContext 

func (dpx *DpxV1) 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 (*DpxV1) ListDataProductDrafts 

func (dpx *DpxV1) 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.

func (*DpxV1) ListDataProductDraftsWithContext 

func (dpx *DpxV1) 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 (*DpxV1) ListDataProductReleases 

func (dpx *DpxV1) 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.

func (*DpxV1) ListDataProductReleasesWithContext 

func (dpx *DpxV1) 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 (*DpxV1) ListDataProducts 

func (dpx *DpxV1) ListDataProducts(listDataProductsOptions *ListDataProductsOptions) (result *DataProductSummaryCollection, response *core.DetailedResponse, err error)

ListDataProducts : Retrieve a list of data products Retrieve a list of data products.

func (*DpxV1) ListDataProductsWithContext 

func (dpx *DpxV1) ListDataProductsWithContext(ctx context.Context, listDataProductsOptions *ListDataProductsOptions) (result *DataProductSummaryCollection, response *core.DetailedResponse, err error)

ListDataProductsWithContext is an alternate form of the ListDataProducts method which supports a Context parameter

func (*DpxV1) ManageApiKeys 

func (dpx *DpxV1) ManageApiKeys(manageApiKeysOptions *ManageApiKeysOptions) (response *core.DetailedResponse, err error)

ManageApiKeys : Rotate credentials for a Data Product Exchange instance Use this API to rotate credentials for a Data Product Exchange instance.

func (*DpxV1) ManageApiKeysWithContext 

func (dpx *DpxV1) 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 (*DpxV1) NewAssetPartReference 

func (*DpxV1) NewAssetPartReference(container *ContainerReference) (_model *AssetPartReference, err error)

NewAssetPartReference : Instantiate AssetPartReference (Generic Model Constructor)

func (*DpxV1) NewAssetReference 

func (*DpxV1) NewAssetReference(container *ContainerReference) (_model *AssetReference, err error)

NewAssetReference : Instantiate AssetReference (Generic Model Constructor)

func (*DpxV1) NewCompleteDraftContractTermsDocumentOptions 

func (*DpxV1) NewCompleteDraftContractTermsDocumentOptions(dataProductID string, draftID string, contractTermsID string, documentID string) *CompleteDraftContractTermsDocumentOptions

NewCompleteDraftContractTermsDocumentOptions : Instantiate CompleteDraftContractTermsDocumentOptions

func (*DpxV1) NewContainerReference 

func (*DpxV1) NewContainerReference(id string) (_model *ContainerReference, err error)

NewContainerReference : Instantiate ContainerReference (Generic Model Constructor)

func (*DpxV1) NewContractTermsDocument 

func (*DpxV1) NewContractTermsDocument(typeVar string, name string, id string) (_model *ContractTermsDocument, err error)

NewContractTermsDocument : Instantiate ContractTermsDocument (Generic Model Constructor)

func (*DpxV1) NewContractTermsDocumentPatch 

func (*DpxV1) NewContractTermsDocumentPatch(contractTermsDocument *ContractTermsDocument) (_patch []JSONPatchOperation)

func (*DpxV1) NewCreateDataProductDraftOptions 

func (*DpxV1) NewCreateDataProductDraftOptions(dataProductID string, asset *AssetReference) *CreateDataProductDraftOptions

NewCreateDataProductDraftOptions : Instantiate CreateDataProductDraftOptions

func (*DpxV1) NewCreateDataProductOptions 

func (*DpxV1) NewCreateDataProductOptions(drafts []DataProductVersionPrototype) *CreateDataProductOptions

NewCreateDataProductOptions : Instantiate CreateDataProductOptions

func (*DpxV1) NewCreateDraftContractTermsDocumentOptions 

func (*DpxV1) NewCreateDraftContractTermsDocumentOptions(dataProductID string, draftID string, contractTermsID string, typeVar string, name string, id string, url string) *CreateDraftContractTermsDocumentOptions

NewCreateDraftContractTermsDocumentOptions : Instantiate CreateDraftContractTermsDocumentOptions

func (*DpxV1) NewDataProductDraftsPager 

func (dpx *DpxV1) NewDataProductDraftsPager(options *ListDataProductDraftsOptions) (pager *DataProductDraftsPager, err error)

NewDataProductDraftsPager returns a new DataProductDraftsPager instance.

func (*DpxV1) NewDataProductIdentity 

func (*DpxV1) NewDataProductIdentity(id string) (_model *DataProductIdentity, err error)

NewDataProductIdentity : Instantiate DataProductIdentity (Generic Model Constructor)

func (*DpxV1) NewDataProductPart 

func (*DpxV1) NewDataProductPart(asset *AssetPartReference) (_model *DataProductPart, err error)

NewDataProductPart : Instantiate DataProductPart (Generic Model Constructor)

func (*DpxV1) NewDataProductReleasesPager 

func (dpx *DpxV1) NewDataProductReleasesPager(options *ListDataProductReleasesOptions) (pager *DataProductReleasesPager, err error)

NewDataProductReleasesPager returns a new DataProductReleasesPager instance.

func (*DpxV1) NewDataProductVersionPatch 

func (*DpxV1) NewDataProductVersionPatch(dataProductVersion *DataProductVersion) (_patch []JSONPatchOperation)

func (*DpxV1) NewDataProductVersionPrototype 

func (*DpxV1) NewDataProductVersionPrototype(asset *AssetReference) (_model *DataProductVersionPrototype, err error)

NewDataProductVersionPrototype : Instantiate DataProductVersionPrototype (Generic Model Constructor)

func (*DpxV1) NewDataProductsPager 

func (dpx *DpxV1) NewDataProductsPager(options *ListDataProductsOptions) (pager *DataProductsPager, err error)

NewDataProductsPager returns a new DataProductsPager instance.

func (*DpxV1) NewDeleteDataProductDraftOptions 

func (*DpxV1) NewDeleteDataProductDraftOptions(dataProductID string, draftID string) *DeleteDataProductDraftOptions

NewDeleteDataProductDraftOptions : Instantiate DeleteDataProductDraftOptions

func (*DpxV1) NewDeleteDraftContractTermsDocumentOptions 

func (*DpxV1) NewDeleteDraftContractTermsDocumentOptions(dataProductID string, draftID string, contractTermsID string, documentID string) *DeleteDraftContractTermsDocumentOptions

NewDeleteDraftContractTermsDocumentOptions : Instantiate DeleteDraftContractTermsDocumentOptions

func (*DpxV1) NewDeliveryMethod 

func (*DpxV1) NewDeliveryMethod(id string, container *ContainerReference) (_model *DeliveryMethod, err error)

NewDeliveryMethod : Instantiate DeliveryMethod (Generic Model Constructor)

func (*DpxV1) NewDomain 

func (*DpxV1) NewDomain(id string) (_model *Domain, err error)

NewDomain : Instantiate Domain (Generic Model Constructor)

func (*DpxV1) NewGetDataProductDraftOptions 

func (*DpxV1) NewGetDataProductDraftOptions(dataProductID string, draftID string) *GetDataProductDraftOptions

NewGetDataProductDraftOptions : Instantiate GetDataProductDraftOptions

func (*DpxV1) NewGetDataProductOptions 

func (*DpxV1) NewGetDataProductOptions(dataProductID string) *GetDataProductOptions

NewGetDataProductOptions : Instantiate GetDataProductOptions

func (*DpxV1) NewGetDataProductReleaseOptions 

func (*DpxV1) NewGetDataProductReleaseOptions(dataProductID string, releaseID string) *GetDataProductReleaseOptions

NewGetDataProductReleaseOptions : Instantiate GetDataProductReleaseOptions

func (*DpxV1) NewGetDraftContractTermsDocumentOptions 

func (*DpxV1) NewGetDraftContractTermsDocumentOptions(dataProductID string, draftID string, contractTermsID string, documentID string) *GetDraftContractTermsDocumentOptions

NewGetDraftContractTermsDocumentOptions : Instantiate GetDraftContractTermsDocumentOptions

func (*DpxV1) NewGetInitializeStatusOptions 

func (*DpxV1) NewGetInitializeStatusOptions() *GetInitializeStatusOptions

NewGetInitializeStatusOptions : Instantiate GetInitializeStatusOptions

func (*DpxV1) NewGetReleaseContractTermsDocumentOptions 

func (*DpxV1) NewGetReleaseContractTermsDocumentOptions(dataProductID string, releaseID string, contractTermsID string, documentID string) *GetReleaseContractTermsDocumentOptions

NewGetReleaseContractTermsDocumentOptions : Instantiate GetReleaseContractTermsDocumentOptions

func (*DpxV1) NewInitializeOptions 

func (*DpxV1) NewInitializeOptions() *InitializeOptions

NewInitializeOptions : Instantiate InitializeOptions

func (*DpxV1) NewJSONPatchOperation 

func (*DpxV1) NewJSONPatchOperation(op string, path string) (_model *JSONPatchOperation, err error)

NewJSONPatchOperation : Instantiate JSONPatchOperation (Generic Model Constructor)

func (*DpxV1) NewListDataProductDraftsOptions 

func (*DpxV1) NewListDataProductDraftsOptions(dataProductID string) *ListDataProductDraftsOptions

NewListDataProductDraftsOptions : Instantiate ListDataProductDraftsOptions

func (*DpxV1) NewListDataProductReleasesOptions 

func (*DpxV1) NewListDataProductReleasesOptions(dataProductID string) *ListDataProductReleasesOptions

NewListDataProductReleasesOptions : Instantiate ListDataProductReleasesOptions

func (*DpxV1) NewListDataProductsOptions 

func (*DpxV1) NewListDataProductsOptions() *ListDataProductsOptions

NewListDataProductsOptions : Instantiate ListDataProductsOptions

func (*DpxV1) NewManageApiKeysOptions 

func (*DpxV1) NewManageApiKeysOptions() *ManageApiKeysOptions

NewManageApiKeysOptions : Instantiate ManageApiKeysOptions

func (*DpxV1) NewPublishDataProductDraftOptions 

func (*DpxV1) NewPublishDataProductDraftOptions(dataProductID string, draftID string) *PublishDataProductDraftOptions

NewPublishDataProductDraftOptions : Instantiate PublishDataProductDraftOptions

func (*DpxV1) NewRetireDataProductReleaseOptions 

func (*DpxV1) NewRetireDataProductReleaseOptions(dataProductID string, releaseID string) *RetireDataProductReleaseOptions

NewRetireDataProductReleaseOptions : Instantiate RetireDataProductReleaseOptions

func (*DpxV1) NewUpdateDataProductDraftOptions 

func (*DpxV1) NewUpdateDataProductDraftOptions(dataProductID string, draftID string, jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductDraftOptions

NewUpdateDataProductDraftOptions : Instantiate UpdateDataProductDraftOptions

func (*DpxV1) NewUpdateDataProductReleaseOptions 

func (*DpxV1) NewUpdateDataProductReleaseOptions(dataProductID string, releaseID string, jsonPatchInstructions []JSONPatchOperation) *UpdateDataProductReleaseOptions

NewUpdateDataProductReleaseOptions : Instantiate UpdateDataProductReleaseOptions

func (*DpxV1) NewUpdateDraftContractTermsDocumentOptions 

func (*DpxV1) NewUpdateDraftContractTermsDocumentOptions(dataProductID string, draftID string, contractTermsID string, documentID string, jsonPatchInstructions []JSONPatchOperation) *UpdateDraftContractTermsDocumentOptions

NewUpdateDraftContractTermsDocumentOptions : Instantiate UpdateDraftContractTermsDocumentOptions

func (*DpxV1) NewUseCase 

func (*DpxV1) NewUseCase(id string) (_model *UseCase, err error)

NewUseCase : Instantiate UseCase (Generic Model Constructor)

func (*DpxV1) PublishDataProductDraft 

func (dpx *DpxV1) PublishDataProductDraft(publishDataProductDraftOptions *PublishDataProductDraftOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

PublishDataProductDraft : Publish a draft of an existing data product Publish a draft of an existing data product.

func (*DpxV1) PublishDataProductDraftWithContext 

func (dpx *DpxV1) PublishDataProductDraftWithContext(ctx context.Context, publishDataProductDraftOptions *PublishDataProductDraftOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

PublishDataProductDraftWithContext is an alternate form of the PublishDataProductDraft method which supports a Context parameter

func (*DpxV1) RetireDataProductRelease 

func (dpx *DpxV1) RetireDataProductRelease(retireDataProductReleaseOptions *RetireDataProductReleaseOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

RetireDataProductRelease : Retire a release of an existing data product Retire a release of an existing data product.

func (*DpxV1) RetireDataProductReleaseWithContext 

func (dpx *DpxV1) RetireDataProductReleaseWithContext(ctx context.Context, retireDataProductReleaseOptions *RetireDataProductReleaseOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

RetireDataProductReleaseWithContext is an alternate form of the RetireDataProductRelease method which supports a Context parameter

func (*DpxV1) SetDefaultHeaders 

func (dpx *DpxV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*DpxV1) SetEnableGzipCompression 

func (dpx *DpxV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*DpxV1) SetServiceURL 

func (dpx *DpxV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*DpxV1) UpdateDataProductDraft 

func (dpx *DpxV1) UpdateDataProductDraft(updateDataProductDraftOptions *UpdateDataProductDraftOptions) (result *DataProductVersion, 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.<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 (*DpxV1) UpdateDataProductDraftWithContext 

func (dpx *DpxV1) UpdateDataProductDraftWithContext(ctx context.Context, updateDataProductDraftOptions *UpdateDataProductDraftOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

UpdateDataProductDraftWithContext is an alternate form of the UpdateDataProductDraft method which supports a Context parameter

func (*DpxV1) UpdateDataProductRelease 

func (dpx *DpxV1) UpdateDataProductRelease(updateDataProductReleaseOptions *UpdateDataProductReleaseOptions) (result *DataProductVersion, 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.<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 (*DpxV1) UpdateDataProductReleaseWithContext 

func (dpx *DpxV1) UpdateDataProductReleaseWithContext(ctx context.Context, updateDataProductReleaseOptions *UpdateDataProductReleaseOptions) (result *DataProductVersion, response *core.DetailedResponse, err error)

UpdateDataProductReleaseWithContext is an alternate form of the UpdateDataProductRelease method which supports a Context parameter

func (*DpxV1) UpdateDraftContractTermsDocument 

func (dpx *DpxV1) 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.

func (*DpxV1) UpdateDraftContractTermsDocumentWithContext 

func (dpx *DpxV1) 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

type DpxV1Options 

type DpxV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

DpxV1Options : Service options

type ErrorModelResource 

type ErrorModelResource struct {
	// Error code.
	Code *string `json:"code,omitempty"`

	// Error message.
	Message *string `json:"message,omitempty"`

	// Extra information about the error.
	Extra map[string]interface{} `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 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="`

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

GetDataProductReleaseOptions : The GetDataProductRelease options.

func (*GetDataProductReleaseOptions) SetDataProductID 

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

SetDataProductID : Allow user to set DataProductID

func (*GetDataProductReleaseOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetDataProductReleaseOptions) SetReleaseID 

func (_options *GetDataProductReleaseOptions) SetReleaseID(releaseID string) *GetDataProductReleaseOptions

SetReleaseID : Allow user to set ReleaseID

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 

func (_options *GetDraftContractTermsDocumentOptions) SetDocumentID(documentID string) *GetDraftContractTermsDocumentOptions

SetDocumentID : Allow user to set DocumentID

func (*GetDraftContractTermsDocumentOptions) SetDraftID 

func (_options *GetDraftContractTermsDocumentOptions) SetDraftID(draftID string) *GetDraftContractTermsDocumentOptions

SetDraftID : Allow user to set DraftID

func (*GetDraftContractTermsDocumentOptions) SetHeaders 

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

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

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

SetDataProductID : Allow user to set DataProductID

func (*GetReleaseContractTermsDocumentOptions) SetDocumentID 

func (_options *GetReleaseContractTermsDocumentOptions) SetDocumentID(documentID string) *GetReleaseContractTermsDocumentOptions

SetDocumentID : Allow user to set DocumentID

func (*GetReleaseContractTermsDocumentOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetReleaseContractTermsDocumentOptions) SetReleaseID 

func (_options *GetReleaseContractTermsDocumentOptions) SetReleaseID(releaseID string) *GetReleaseContractTermsDocumentOptions

SetReleaseID : Allow user to set ReleaseID

type InitializeOptions 

type InitializeOptions struct {
	// Data product exchange container.
	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 {
	// Data product exchange container.
	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,omitempty"`

	// 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"`
}

InitializeResource : Resource defining initialization parameters.

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

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

SetHeaders : Allow user to set Headers

func (*ListDataProductDraftsOptions) SetLimit 

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

SetLimit : Allow user to set Limit

func (*ListDataProductDraftsOptions) SetStart 

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

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 

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

SetHeaders : Allow user to set Headers

func (*ListDataProductReleasesOptions) SetLimit 

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

SetLimit : Allow user to set Limit

func (*ListDataProductReleasesOptions) SetStart 

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

SetStart : Allow user to set Start

func (*ListDataProductReleasesOptions) SetState 

func (_options *ListDataProductReleasesOptions) SetState(state []string) *ListDataProductReleasesOptions

SetState : Allow user to set State

func (*ListDataProductReleasesOptions) SetVersion 

func (_options *ListDataProductReleasesOptions) SetVersion(version string) *ListDataProductReleasesOptions

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

func (_options *PublishDataProductDraftOptions) SetDraftID(draftID string) *PublishDataProductDraftOptions

SetDraftID : Allow user to set DraftID

func (*PublishDataProductDraftOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

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="`

	// 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 

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

SetHeaders : Allow user to set Headers

func (*RetireDataProductReleaseOptions) SetReleaseID 

func (_options *RetireDataProductReleaseOptions) SetReleaseID(releaseID string) *RetireDataProductReleaseOptions

SetReleaseID : Allow user to set ReleaseID

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 

func (_options *UpdateDataProductDraftOptions) SetDraftID(draftID string) *UpdateDataProductDraftOptions

SetDraftID : Allow user to set DraftID

func (*UpdateDataProductDraftOptions) SetHeaders 

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

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 

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

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

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

SetDataProductID : Allow user to set DataProductID

func (*UpdateDraftContractTermsDocumentOptions) SetDocumentID 

func (_options *UpdateDraftContractTermsDocumentOptions) SetDocumentID(documentID string) *UpdateDraftContractTermsDocumentOptions

SetDocumentID : Allow user to set DocumentID

func (*UpdateDraftContractTermsDocumentOptions) SetDraftID 

func (_options *UpdateDraftContractTermsDocumentOptions) SetDraftID(draftID string) *UpdateDraftContractTermsDocumentOptions

SetDraftID : Allow user to set DraftID

func (*UpdateDraftContractTermsDocumentOptions) SetHeaders 

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

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"`

	// Data product exchange container.
	Container *ContainerReference `json:"container,omitempty"`
}

UseCase : UseCase struct

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.