globalcatalogv1

package
v0.72.0 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2024 License: Apache-2.0 Imports: 10 Imported by: 5

Documentation

Overview

Package globalcatalogv1 : Operations and models for the GlobalCatalogV1 service

Index

Constants

View Source 
const (
	CatalogEntryKindDashboardConst = "dashboard"
	CatalogEntryKindServiceConst   = "service"
	CatalogEntryKindTemplateConst  = "template"
)

Constants associated with the CatalogEntry.Kind property. The type of catalog entry, **service**, **template**, **dashboard**, which determines the type and shape of the object.

View Source 
const (
	CreateCatalogEntryOptionsKindDashboardConst = "dashboard"
	CreateCatalogEntryOptionsKindServiceConst   = "service"
	CreateCatalogEntryOptionsKindTemplateConst  = "template"
)

Constants associated with the CreateCatalogEntryOptions.Kind property. The type of catalog entry, **service**, **template**, **dashboard**, which determines the type and shape of the object.

View Source 
const (
	UpdateCatalogEntryOptionsKindDashboardConst = "dashboard"
	UpdateCatalogEntryOptionsKindServiceConst   = "service"
	UpdateCatalogEntryOptionsKindTemplateConst  = "template"
)

Constants associated with the UpdateCatalogEntryOptions.Kind property. The type of catalog entry, **service**, **template**, **dashboard**, which determines the type and shape of the object.

View Source 
const DefaultServiceName = "global_catalog"

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

View Source 
const DefaultServiceURL = "https://globalcatalog.cloud.ibm.com/api/v1"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.17.1 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalAliasMetaData 

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

UnmarshalAliasMetaData unmarshals an instance of AliasMetaData from the specified map of raw messages.

func UnmarshalAmount 

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

UnmarshalAmount unmarshals an instance of Amount from the specified map of raw messages.

func UnmarshalArtifact 

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

UnmarshalArtifact unmarshals an instance of Artifact from the specified map of raw messages.

func UnmarshalArtifacts 

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

UnmarshalArtifacts unmarshals an instance of Artifacts from the specified map of raw messages.

func UnmarshalAuditSearchResult 

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

UnmarshalAuditSearchResult unmarshals an instance of AuditSearchResult from the specified map of raw messages.

func UnmarshalBroker 

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

UnmarshalBroker unmarshals an instance of Broker from the specified map of raw messages.

func UnmarshalBullets 

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

UnmarshalBullets unmarshals an instance of Bullets from the specified map of raw messages.

func UnmarshalCallbacks 

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

UnmarshalCallbacks unmarshals an instance of Callbacks from the specified map of raw messages.

func UnmarshalCatalogEntry 

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

UnmarshalCatalogEntry unmarshals an instance of CatalogEntry from the specified map of raw messages.

func UnmarshalCatalogEntryMetadata 

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

UnmarshalCatalogEntryMetadata unmarshals an instance of CatalogEntryMetadata from the specified map of raw messages.

func UnmarshalCatalogEntryMetadataDeployment 

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

UnmarshalCatalogEntryMetadataDeployment unmarshals an instance of CatalogEntryMetadataDeployment from the specified map of raw messages.

func UnmarshalCatalogEntryMetadataPricing 

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

UnmarshalCatalogEntryMetadataPricing unmarshals an instance of CatalogEntryMetadataPricing from the specified map of raw messages.

func UnmarshalCfMetaData added in v0.17.1 

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

UnmarshalCfMetaData unmarshals an instance of CfMetaData from the specified map of raw messages.

func UnmarshalDeploymentBase 

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

UnmarshalDeploymentBase unmarshals an instance of DeploymentBase from the specified map of raw messages.

func UnmarshalDrMetaData added in v0.17.1 

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

UnmarshalDrMetaData unmarshals an instance of DrMetaData from the specified map of raw messages.

func UnmarshalEntrySearchResult 

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

UnmarshalEntrySearchResult unmarshals an instance of EntrySearchResult from the specified map of raw messages.

func UnmarshalImage 

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

UnmarshalImage unmarshals an instance of Image from the specified map of raw messages.

func UnmarshalMessage 

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

UnmarshalMessage unmarshals an instance of Message from the specified map of raw messages.

func UnmarshalMetrics 

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

UnmarshalMetrics unmarshals an instance of Metrics from the specified map of raw messages.

func UnmarshalObjectMetadataSet 

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

UnmarshalObjectMetadataSet unmarshals an instance of ObjectMetadataSet from the specified map of raw messages.

func UnmarshalOverview 

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

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

func UnmarshalPlanMetaData 

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

UnmarshalPlanMetaData unmarshals an instance of PlanMetaData from the specified map of raw messages.

func UnmarshalPrice 

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

UnmarshalPrice unmarshals an instance of Price from the specified map of raw messages.

func UnmarshalPricingGet 

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

UnmarshalPricingGet unmarshals an instance of PricingGet from the specified map of raw messages.

func UnmarshalPricingSearchResult added in v0.37.1 

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

UnmarshalPricingSearchResult unmarshals an instance of PricingSearchResult from the specified map of raw messages.

func UnmarshalPricingSet 

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

UnmarshalPricingSet unmarshals an instance of PricingSet from the specified map of raw messages.

func UnmarshalProvider 

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

UnmarshalProvider unmarshals an instance of Provider from the specified map of raw messages.

func UnmarshalSLAMetaData 

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

UnmarshalSLAMetaData unmarshals an instance of SLAMetaData from the specified map of raw messages.

func UnmarshalSourceMetaData 

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

UnmarshalSourceMetaData unmarshals an instance of SourceMetaData from the specified map of raw messages.

func UnmarshalStartingPrice 

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

UnmarshalStartingPrice unmarshals an instance of StartingPrice from the specified map of raw messages.

func UnmarshalStrings 

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

UnmarshalStrings unmarshals an instance of Strings from the specified map of raw messages.

func UnmarshalTemplateMetaData 

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

UnmarshalTemplateMetaData unmarshals an instance of TemplateMetaData from the specified map of raw messages.

func UnmarshalUIMediaSourceMetaData added in v0.37.1 

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

UnmarshalUIMediaSourceMetaData unmarshals an instance of UIMediaSourceMetaData from the specified map of raw messages.

func UnmarshalUIMetaData 

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

UnmarshalUIMetaData unmarshals an instance of UIMetaData from the specified map of raw messages.

func UnmarshalUIMetaMedia 

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

UnmarshalUIMetaMedia unmarshals an instance of UIMetaMedia from the specified map of raw messages.

func UnmarshalUrls added in v0.17.1 

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

UnmarshalUrls unmarshals an instance of Urls from the specified map of raw messages.

func UnmarshalVisibility 

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

UnmarshalVisibility unmarshals an instance of Visibility from the specified map of raw messages.

func UnmarshalVisibilityDetail 

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

UnmarshalVisibilityDetail unmarshals an instance of VisibilityDetail from the specified map of raw messages.

func UnmarshalVisibilityDetailAccounts 

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

UnmarshalVisibilityDetailAccounts unmarshals an instance of VisibilityDetailAccounts from the specified map of raw messages.

Types

type AliasMetaData 

type AliasMetaData struct {
	// Type of alias.
	Type *string `json:"type,omitempty"`

	// Points to the plan that this object is an alias for.
	PlanID *string `json:"plan_id,omitempty"`
}

AliasMetaData : Alias-related metadata.

type Amount 

type Amount struct {
	// Country.
	Country *string `json:"country,omitempty"`

	// Currency.
	Currency *string `json:"currency,omitempty"`

	// See Price for nested fields.
	Prices []Price `json:"prices,omitempty"`
}

Amount : Country-specific pricing information.

type Artifact 

type Artifact struct {
	// The name of the artifact.
	Name *string `json:"name,omitempty"`

	// The timestamp of the last update to the artifact.
	Updated *strfmt.DateTime `json:"updated,omitempty"`

	// The url for the artifact.
	URL *string `json:"url,omitempty"`

	// The etag of the artifact.
	Etag *string `json:"etag,omitempty"`

	// The content length of the artifact.
	Size *int64 `json:"size,omitempty"`
}

Artifact : Artifact Details.

type Artifacts 

type Artifacts struct {
	// The total number of artifacts.
	Count *int64 `json:"count,omitempty"`

	// The list of artifacts.
	Resources []Artifact `json:"resources,omitempty"`
}

Artifacts : Artifacts List.

type AuditSearchResult 

type AuditSearchResult struct {
	// The offset (origin 0) of the first resource in this page of search results.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of resources returned in each page of search results.
	Limit *int64 `json:"limit,omitempty"`

	// The overall total number of resources in the search result set.
	Count *int64 `json:"count,omitempty"`

	// The number of resources returned in this page of search results.
	ResourceCount *int64 `json:"resource_count,omitempty"`

	// A URL for retrieving the first page of search results.
	First *string `json:"first,omitempty"`

	// A URL for retrieving the last page of search results.
	Last *string `json:"last,omitempty"`

	// A URL for retrieving the previous page of search results.
	Prev *string `json:"prev,omitempty"`

	// A URL for retrieving the next page of search results.
	Next *string `json:"next,omitempty"`

	// The resources (audit messages) contained in this page of search results.
	Resources []Message `json:"resources,omitempty"`
}

AuditSearchResult : A paginated search result containing audit logs.

type Broker 

type Broker struct {
	// Broker name.
	Name *string `json:"name,omitempty"`

	// Broker guid.
	GUID *string `json:"guid,omitempty"`
}

Broker : The broker associated with a catalog entry.

type Bullets 

type Bullets struct {
	// The bullet title.
	Title *string `json:"title,omitempty"`

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

	// The icon to use for rendering the bullet.
	Icon *string `json:"icon,omitempty"`

	// The bullet quantity.
	Quantity *int64 `json:"quantity,omitempty"`
}

Bullets : Information related to list delimiters.

type Callbacks 

type Callbacks struct {
	// The URL of the deployment controller.
	ControllerURL *string `json:"controller_url,omitempty"`

	// The URL of the deployment broker.
	BrokerURL *string `json:"broker_url,omitempty"`

	// The URL of the deployment broker SC proxy.
	BrokerProxyURL *string `json:"broker_proxy_url,omitempty"`

	// The URL of dashboard callback.
	DashboardURL *string `json:"dashboard_url,omitempty"`

	// The URL of dashboard data.
	DashboardDataURL *string `json:"dashboard_data_url,omitempty"`

	// The URL of the dashboard detail tab.
	DashboardDetailTabURL *string `json:"dashboard_detail_tab_url,omitempty"`

	// The URL of the dashboard detail tab extension.
	DashboardDetailTabExtURL *string `json:"dashboard_detail_tab_ext_url,omitempty"`

	// Service monitor API URL.
	ServiceMonitorAPI *string `json:"service_monitor_api,omitempty"`

	// Service monitor app URL.
	ServiceMonitorApp *string `json:"service_monitor_app,omitempty"`

	// API endpoint.
	APIEndpoint map[string]string `json:"api_endpoint,omitempty"`
}

Callbacks : Callback-related information associated with a catalog entry.

type CatalogEntry 

type CatalogEntry struct {
	// Programmatic name for this catalog entry, which must be formatted like a CRN segment. See the display name in
	// OverviewUI for a user-readable name.
	Name *string `json:"name" validate:"required"`

	// The type of catalog entry, **service**, **template**, **dashboard**, which determines the type and shape of the
	// object.
	Kind *string `json:"kind" validate:"required"`

	// Overview is nested in the top level. The key value pair is `[_language_]overview_ui`.
	OverviewUI map[string]Overview `json:"overview_ui" validate:"required"`

	// Image annotation for this catalog entry. The image is a URL.
	Images *Image `json:"images" validate:"required"`

	// The ID of the parent catalog entry if it exists.
	ParentID *string `json:"parent_id,omitempty"`

	// Boolean value that determines the global visibility for the catalog entry, and its children. If it is not enabled,
	// all plans are disabled.
	Disabled *bool `json:"disabled" validate:"required"`

	// A list of tags. For example, IBM, 3rd Party, Beta, GA, and Single Tenant.
	Tags []string `json:"tags" validate:"required"`

	// Boolean value that determines whether the catalog entry is a group.
	Group *bool `json:"group,omitempty"`

	// Information related to the provider associated with a catalog entry.
	Provider *Provider `json:"provider" validate:"required"`

	// Boolean value that describes whether the service is active.
	Active *bool `json:"active,omitempty"`

	// Model used to describe metadata object returned.
	Metadata *CatalogEntryMetadata `json:"metadata,omitempty"`

	// Catalog entry's unique ID. It's the same across all catalog instances.
	ID *string `json:"id,omitempty"`

	// The CRN associated with the catalog entry.
	CatalogCRN *string `json:"catalog_crn,omitempty"`

	// URL to get details about this object.
	URL *string `json:"url,omitempty"`

	// URL to get details about children of this object.
	ChildrenURL *string `json:"children_url,omitempty"`

	// tags to indicate the locations this service is deployable to.
	GeoTags []string `json:"geo_tags,omitempty"`

	// tags to indicate the type of pricing plans this service supports.
	PricingTags []string `json:"pricing_tags,omitempty"`

	// Date created.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// Date last updated.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

CatalogEntry : An entry in the global catalog.

type CatalogEntryMetadata 

type CatalogEntryMetadata struct {
	// Boolean value that describes whether the service is compatible with the Resource Controller.
	RcCompatible *bool `json:"rc_compatible,omitempty"`

	// Service-related metadata.
	Service *CfMetaData `json:"service,omitempty"`

	// Plan-related metadata.
	Plan *PlanMetaData `json:"plan,omitempty"`

	// Alias-related metadata.
	Alias *AliasMetaData `json:"alias,omitempty"`

	// Template-related metadata.
	Template *TemplateMetaData `json:"template,omitempty"`

	// Information related to the UI presentation associated with a catalog entry.
	UI *UIMetaData `json:"ui,omitempty"`

	// Compliance information for HIPAA and PCI.
	Compliance []string `json:"compliance,omitempty"`

	// Service Level Agreement related metadata.
	SLA *SLAMetaData `json:"sla,omitempty"`

	// Callback-related information associated with a catalog entry.
	Callbacks *Callbacks `json:"callbacks,omitempty"`

	// The original name of the object.
	OriginalName *string `json:"original_name,omitempty"`

	// Optional version of the object.
	Version *string `json:"version,omitempty"`

	// Additional information.
	Other map[string]interface{} `json:"other,omitempty"`

	// Pricing-related information.
	Pricing *CatalogEntryMetadataPricing `json:"pricing,omitempty"`

	// Deployment-related metadata.
	Deployment *CatalogEntryMetadataDeployment `json:"deployment,omitempty"`
}

CatalogEntryMetadata : Model used to describe metadata object returned.

type CatalogEntryMetadataDeployment 

type CatalogEntryMetadataDeployment struct {
	// Describes the region where the service is located.
	Location *string `json:"location,omitempty"`

	// Pointer to the location resource in the catalog.
	LocationURL *string `json:"location_url,omitempty"`

	// Original service location.
	OriginalLocation *string `json:"original_location,omitempty"`

	// A CRN that describes the deployment. crn:v1:[cname]:[ctype]:[location]:[scope]::[resource-type]:[resource].
	TargetCRN *string `json:"target_crn,omitempty"`

	// CRN for the service.
	ServiceCRN *string `json:"service_crn,omitempty"`

	// ID for MCCP.
	MccpID *string `json:"mccp_id,omitempty"`

	// The broker associated with a catalog entry.
	Broker *Broker `json:"broker,omitempty"`

	// This deployment not only supports RC but is ready to migrate and support the RC broker for a location.
	SupportsRcMigration *bool `json:"supports_rc_migration,omitempty"`

	// network to use during deployment.
	TargetNetwork *string `json:"target_network,omitempty"`
}

CatalogEntryMetadataDeployment : Deployment-related metadata.

type CatalogEntryMetadataPricing 

type CatalogEntryMetadataPricing struct {
	// Type of plan. Valid values are `free`, `trial`, `paygo`, `bluemix-subscription`, and `ibm-subscription`.
	Type *string `json:"type,omitempty"`

	// Defines where the pricing originates.
	Origin *string `json:"origin,omitempty"`

	// Plan-specific starting price information.
	StartingPrice *StartingPrice `json:"starting_price,omitempty"`

	// The deployment object id this pricing is from. Only set if object kind is deployment.
	DeploymentID *string `json:"deployment_id,omitempty"`

	// The deployment location this pricing is from. Only set if object kind is deployment.
	DeploymentLocation *string `json:"deployment_location,omitempty"`

	// Is the location price not available. Only set in api /pricing/deployment and only set if true. This means for the
	// given deployment object there was no pricing set in pricing catalog.
	DeploymentLocationNoPriceAvailable *bool `json:"deployment_location_no_price_available,omitempty"`

	// Plan-specific cost metric structure.
	Metrics []Metrics `json:"metrics,omitempty"`
}

CatalogEntryMetadataPricing : Pricing-related information.

type CfMetaData added in v0.17.1 

type CfMetaData struct {
	// Type of service.
	Type *string `json:"type,omitempty"`

	// Boolean value that describes whether the service is compatible with Identity and Access Management.
	IamCompatible *bool `json:"iam_compatible,omitempty"`

	// Boolean value that describes whether the service has a unique API key.
	UniqueAPIKey *bool `json:"unique_api_key,omitempty"`

	// Boolean value that describes whether the service is provisionable or not. You may need sales or support to create
	// this service.
	Provisionable *bool `json:"provisionable,omitempty"`

	// Boolean value that describes whether you can create bindings for this service.
	Bindable *bool `json:"bindable,omitempty"`

	// Boolean value that describes whether the service supports asynchronous provisioning.
	AsyncProvisioningSupported *bool `json:"async_provisioning_supported,omitempty"`

	// Boolean value that describes whether the service supports asynchronous unprovisioning.
	AsyncUnprovisioningSupported *bool `json:"async_unprovisioning_supported,omitempty"`

	// Service dependencies.
	Requires []string `json:"requires,omitempty"`

	// Boolean value that describes whether the service supports upgrade or downgrade for some plans.
	PlanUpdateable *bool `json:"plan_updateable,omitempty"`

	// String that describes whether the service is active or inactive.
	State *string `json:"state,omitempty"`

	// Boolean value that describes whether the service check is enabled.
	ServiceCheckEnabled *bool `json:"service_check_enabled,omitempty"`

	// Test check interval.
	TestCheckInterval *int64 `json:"test_check_interval,omitempty"`

	// Boolean value that describes whether the service supports service keys.
	ServiceKeySupported *bool `json:"service_key_supported,omitempty"`

	// If the field is imported from Cloud Foundry, the Cloud Foundry region's GUID. This is a required field. For example,
	// `us-south=123`.
	CfGUID map[string]string `json:"cf_guid,omitempty"`
}

CfMetaData : Service-related metadata.

type CreateCatalogEntryOptions 

type CreateCatalogEntryOptions struct {
	// Programmatic name for this catalog entry, which must be formatted like a CRN segment. See the display name in
	// OverviewUI for a user-readable name.
	Name *string `json:"name" validate:"required"`

	// The type of catalog entry, **service**, **template**, **dashboard**, which determines the type and shape of the
	// object.
	Kind *string `json:"kind" validate:"required"`

	// Overview is nested in the top level. The key value pair is `[_language_]overview_ui`.
	OverviewUI map[string]Overview `json:"overview_ui" validate:"required"`

	// Image annotation for this catalog entry. The image is a URL.
	Images *Image `json:"images" validate:"required"`

	// Boolean value that determines the global visibility for the catalog entry, and its children. If it is not enabled,
	// all plans are disabled.
	Disabled *bool `json:"disabled" validate:"required"`

	// A list of tags. For example, IBM, 3rd Party, Beta, GA, and Single Tenant.
	Tags []string `json:"tags" validate:"required"`

	// Information related to the provider associated with a catalog entry.
	Provider *Provider `json:"provider" validate:"required"`

	// Catalog entry's unique ID. It's the same across all catalog instances.
	ID *string `json:"id" validate:"required"`

	// The ID of the parent catalog entry if it exists.
	ParentID *string `json:"parent_id,omitempty"`

	// Boolean value that determines whether the catalog entry is a group.
	Group *bool `json:"group,omitempty"`

	// Boolean value that describes whether the service is active.
	Active *bool `json:"active,omitempty"`

	// Model used to describe metadata object that can be set.
	Metadata *ObjectMetadataSet `json:"metadata,omitempty"`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

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

CreateCatalogEntryOptions : The CreateCatalogEntry options.

func (*CreateCatalogEntryOptions) SetAccount 

func (_options *CreateCatalogEntryOptions) SetAccount(account string) *CreateCatalogEntryOptions

SetAccount : Allow user to set Account

func (*CreateCatalogEntryOptions) SetActive 

func (_options *CreateCatalogEntryOptions) SetActive(active bool) *CreateCatalogEntryOptions

SetActive : Allow user to set Active

func (*CreateCatalogEntryOptions) SetDisabled 

func (_options *CreateCatalogEntryOptions) SetDisabled(disabled bool) *CreateCatalogEntryOptions

SetDisabled : Allow user to set Disabled

func (*CreateCatalogEntryOptions) SetGroup 

func (_options *CreateCatalogEntryOptions) SetGroup(group bool) *CreateCatalogEntryOptions

SetGroup : Allow user to set Group

func (*CreateCatalogEntryOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateCatalogEntryOptions) SetID 

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

SetID : Allow user to set ID

func (*CreateCatalogEntryOptions) SetImages 

func (_options *CreateCatalogEntryOptions) SetImages(images *Image) *CreateCatalogEntryOptions

SetImages : Allow user to set Images

func (*CreateCatalogEntryOptions) SetKind 

func (_options *CreateCatalogEntryOptions) SetKind(kind string) *CreateCatalogEntryOptions

SetKind : Allow user to set Kind

func (*CreateCatalogEntryOptions) SetMetadata 

func (_options *CreateCatalogEntryOptions) SetMetadata(metadata *ObjectMetadataSet) *CreateCatalogEntryOptions

SetMetadata : Allow user to set Metadata

func (*CreateCatalogEntryOptions) SetName 

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

SetName : Allow user to set Name

func (*CreateCatalogEntryOptions) SetOverviewUI added in v0.17.2 

func (_options *CreateCatalogEntryOptions) SetOverviewUI(overviewUI map[string]Overview) *CreateCatalogEntryOptions

SetOverviewUI : Allow user to set OverviewUI

func (*CreateCatalogEntryOptions) SetParentID 

func (_options *CreateCatalogEntryOptions) SetParentID(parentID string) *CreateCatalogEntryOptions

SetParentID : Allow user to set ParentID

func (*CreateCatalogEntryOptions) SetProvider 

func (_options *CreateCatalogEntryOptions) SetProvider(provider *Provider) *CreateCatalogEntryOptions

SetProvider : Allow user to set Provider

func (*CreateCatalogEntryOptions) SetTags 

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

SetTags : Allow user to set Tags

type DeleteArtifactOptions 

type DeleteArtifactOptions struct {
	// The object's unique ID.
	ObjectID *string `json:"object_id" validate:"required,ne="`

	// The artifact's ID.
	ArtifactID *string `json:"artifact_id" validate:"required,ne="`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

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

DeleteArtifactOptions : The DeleteArtifact options.

func (*DeleteArtifactOptions) SetAccount 

func (_options *DeleteArtifactOptions) SetAccount(account string) *DeleteArtifactOptions

SetAccount : Allow user to set Account

func (*DeleteArtifactOptions) SetArtifactID 

func (_options *DeleteArtifactOptions) SetArtifactID(artifactID string) *DeleteArtifactOptions

SetArtifactID : Allow user to set ArtifactID

func (*DeleteArtifactOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteArtifactOptions) SetObjectID 

func (_options *DeleteArtifactOptions) SetObjectID(objectID string) *DeleteArtifactOptions

SetObjectID : Allow user to set ObjectID

type DeleteCatalogEntryOptions 

type DeleteCatalogEntryOptions struct {
	// The object's unique ID.
	ID *string `json:"id" validate:"required,ne="`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

	// This will cause entry to be deleted fully. By default it is archived for two weeks, so that it can be restored if
	// necessary.
	Force *bool `json:"force,omitempty"`

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

DeleteCatalogEntryOptions : The DeleteCatalogEntry options.

func (*DeleteCatalogEntryOptions) SetAccount 

func (_options *DeleteCatalogEntryOptions) SetAccount(account string) *DeleteCatalogEntryOptions

SetAccount : Allow user to set Account

func (*DeleteCatalogEntryOptions) SetForce 

func (_options *DeleteCatalogEntryOptions) SetForce(force bool) *DeleteCatalogEntryOptions

SetForce : Allow user to set Force

func (*DeleteCatalogEntryOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteCatalogEntryOptions) SetID 

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

SetID : Allow user to set ID

type DeploymentBase 

type DeploymentBase struct {
	// Describes the region where the service is located.
	Location *string `json:"location,omitempty"`

	// URL of deployment.
	LocationURL *string `json:"location_url,omitempty"`

	// Original service location.
	OriginalLocation *string `json:"original_location,omitempty"`

	// A CRN that describes the deployment. crn:v1:[cname]:[ctype]:[location]:[scope]::[resource-type]:[resource].
	TargetCRN *string `json:"target_crn,omitempty"`

	// CRN for the service.
	ServiceCRN *string `json:"service_crn,omitempty"`

	// ID for MCCP.
	MccpID *string `json:"mccp_id,omitempty"`

	// The broker associated with a catalog entry.
	Broker *Broker `json:"broker,omitempty"`

	// This deployment not only supports RC but is ready to migrate and support the RC broker for a location.
	SupportsRcMigration *bool `json:"supports_rc_migration,omitempty"`

	// network to use during deployment.
	TargetNetwork *string `json:"target_network,omitempty"`
}

DeploymentBase : Deployment-related metadata.

type DrMetaData added in v0.17.1 

type DrMetaData struct {
	// Required boolean value that describes whether disaster recovery is on.
	Dr *bool `json:"dr,omitempty"`

	// Description of the disaster recovery implementation.
	Description *string `json:"description,omitempty"`
}

DrMetaData : SLA Disaster Recovery-related metadata.

type EntrySearchResult 

type EntrySearchResult struct {
	// The offset (origin 0) of the first resource in this page of search results.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of resources returned in each page of search results.
	Limit *int64 `json:"limit,omitempty"`

	// The overall total number of resources in the search result set.
	Count *int64 `json:"count,omitempty"`

	// The number of resources returned in this page of search results.
	ResourceCount *int64 `json:"resource_count,omitempty"`

	// A URL for retrieving the first page of search results.
	First *string `json:"first,omitempty"`

	// A URL for retrieving the last page of search results.
	Last *string `json:"last,omitempty"`

	// A URL for retrieving the previous page of search results.
	Prev *string `json:"prev,omitempty"`

	// A URL for retrieving the next page of search results.
	Next *string `json:"next,omitempty"`

	// The resources (catalog entries) contained in this page of search results.
	Resources []CatalogEntry `json:"resources,omitempty"`
}

EntrySearchResult : A paginated search result containing catalog entries.

type GetArtifactOptions 

type GetArtifactOptions struct {
	// The object's unique ID.
	ObjectID *string `json:"object_id" validate:"required,ne="`

	// The artifact's ID.
	ArtifactID *string `json:"artifact_id" validate:"required,ne="`

	// The type of the response:  or *_/_*.
	Accept *string `json:"Accept,omitempty"`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

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

GetArtifactOptions : The GetArtifact options.

func (*GetArtifactOptions) SetAccept 

func (_options *GetArtifactOptions) SetAccept(accept string) *GetArtifactOptions

SetAccept : Allow user to set Accept

func (*GetArtifactOptions) SetAccount 

func (_options *GetArtifactOptions) SetAccount(account string) *GetArtifactOptions

SetAccount : Allow user to set Account

func (*GetArtifactOptions) SetArtifactID 

func (_options *GetArtifactOptions) SetArtifactID(artifactID string) *GetArtifactOptions

SetArtifactID : Allow user to set ArtifactID

func (*GetArtifactOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetArtifactOptions) SetObjectID 

func (_options *GetArtifactOptions) SetObjectID(objectID string) *GetArtifactOptions

SetObjectID : Allow user to set ObjectID

type GetAuditLogsOptions 

type GetAuditLogsOptions struct {
	// The object's unique ID.
	ID *string `json:"id" validate:"required,ne="`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

	// Sets the sort order. False is descending.
	Ascending *string `json:"ascending,omitempty"`

	// Starting time for the logs. If it's descending then the entries will be equal or earlier. The default is latest. For
	// ascending it will entries equal or later. The default is earliest. It can be either a number or a string. If a
	// number then it is in the format of Unix timestamps. If it is a string then it is a date in the format
	// YYYY-MM-DDTHH:MM:SSZ  and the time is UTC. The T and the Z are required. For example: 2017-12-24T12:00:00Z for Noon
	// UTC on Dec 24, 2017.
	Startat *string `json:"startat,omitempty"`

	// Count of number of log entries to skip before returning logs. The default is zero.
	Offset *int64 `json:"_offset,omitempty"`

	// Count of number of entries to return. The default is fifty. The maximum value is two hundred.
	Limit *int64 `json:"_limit,omitempty"`

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

GetAuditLogsOptions : The GetAuditLogs options.

func (*GetAuditLogsOptions) SetAccount 

func (_options *GetAuditLogsOptions) SetAccount(account string) *GetAuditLogsOptions

SetAccount : Allow user to set Account

func (*GetAuditLogsOptions) SetAscending 

func (_options *GetAuditLogsOptions) SetAscending(ascending string) *GetAuditLogsOptions

SetAscending : Allow user to set Ascending

func (*GetAuditLogsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetAuditLogsOptions) SetID 

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

SetID : Allow user to set ID

func (*GetAuditLogsOptions) SetLimit 

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

SetLimit : Allow user to set Limit

func (*GetAuditLogsOptions) SetOffset 

func (_options *GetAuditLogsOptions) SetOffset(offset int64) *GetAuditLogsOptions

SetOffset : Allow user to set Offset

func (*GetAuditLogsOptions) SetStartat 

func (_options *GetAuditLogsOptions) SetStartat(startat string) *GetAuditLogsOptions

SetStartat : Allow user to set Startat

type GetCatalogEntryOptions 

type GetCatalogEntryOptions struct {
	// The catalog entry's unique ID.
	ID *string `json:"id" validate:"required,ne="`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

	// A GET call by default returns a basic set of properties. To include other properties, you must add this parameter. A
	// wildcard (`*`) includes all properties for an object, for example `GET /id?include=*`. To include specific metadata
	// fields, separate each field with a colon (:), for example `GET /id?include=metadata.ui:metadata.pricing`.
	Include *string `json:"include,omitempty"`

	// Return the data strings in the specified language. By default the strings returned are of the language preferred by
	// your browser through the Accept-Language header, which allows an override of the header. Languages are specified in
	// standard form, such as `en-us`. To include all languages use a wildcard (*).
	Languages *string `json:"languages,omitempty"`

	// Returns all available fields for all languages. Use the value `?complete=true` as shortcut for
	// ?include=*&languages=*.
	Complete *bool `json:"complete,omitempty"`

	// Return the children down to the requested depth. Use * to include the entire children tree. If there are more
	// children than the maximum permitted an error will be returned. Be judicious with this as it can cause a large number
	// of database accesses and can result in a large amount of data returned.
	Depth *int64 `json:"depth,omitempty"`

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

GetCatalogEntryOptions : The GetCatalogEntry options.

func (*GetCatalogEntryOptions) SetAccount 

func (_options *GetCatalogEntryOptions) SetAccount(account string) *GetCatalogEntryOptions

SetAccount : Allow user to set Account

func (*GetCatalogEntryOptions) SetComplete 

func (_options *GetCatalogEntryOptions) SetComplete(complete bool) *GetCatalogEntryOptions

SetComplete : Allow user to set Complete

func (*GetCatalogEntryOptions) SetDepth 

func (_options *GetCatalogEntryOptions) SetDepth(depth int64) *GetCatalogEntryOptions

SetDepth : Allow user to set Depth

func (*GetCatalogEntryOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetCatalogEntryOptions) SetID 

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

SetID : Allow user to set ID

func (*GetCatalogEntryOptions) SetInclude 

func (_options *GetCatalogEntryOptions) SetInclude(include string) *GetCatalogEntryOptions

SetInclude : Allow user to set Include

func (*GetCatalogEntryOptions) SetLanguages 

func (_options *GetCatalogEntryOptions) SetLanguages(languages string) *GetCatalogEntryOptions

SetLanguages : Allow user to set Languages

type GetChildObjectsOptions 

type GetChildObjectsOptions struct {
	// The parent catalog entry's ID.
	ID *string `json:"id" validate:"required,ne="`

	// The **kind** of child catalog entries to search for. A wildcard (*) includes all child catalog entries for all
	// kinds, for example `GET /service_name/_*`.
	Kind *string `json:"kind" validate:"required,ne="`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

	// A colon (:) separated list of properties to include. A GET call by defaults return a limited set of properties. To
	// include other properties, you must add the include parameter.  A wildcard (*) includes all properties.
	Include *string `json:"include,omitempty"`

	// A query filter, for example, `q=kind:iaas IBM`  will filter on entries of **kind** iaas that has `IBM` in their
	// name, display name, or description.
	Q *string `json:"q,omitempty"`

	// The field on which to sort the output. By default by name. Available fields are **name**, **kind**, and
	// **provider**.
	SortBy *string `json:"sort-by,omitempty"`

	// The sort order. The default is false, which is ascending.
	Descending *string `json:"descending,omitempty"`

	// Return the data strings in the specified language. By default the strings returned are of the language preferred by
	// your browser through the Accept-Language header. This allows an override of the header. Languages are specified in
	// standard form, such as `en-us`. To include all languages use the wildcard (*).
	Languages *string `json:"languages,omitempty"`

	// Use the value `?complete=true` as shortcut for ?include=*&languages=*.
	Complete *bool `json:"complete,omitempty"`

	// Useful for pagination, specifies index (origin 0) of first item to return in response.
	Offset *int64 `json:"_offset,omitempty"`

	// Useful for pagination, specifies the maximum number of items to return in the response.
	Limit *int64 `json:"_limit,omitempty"`

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

GetChildObjectsOptions : The GetChildObjects options.

func (*GetChildObjectsOptions) SetAccount 

func (_options *GetChildObjectsOptions) SetAccount(account string) *GetChildObjectsOptions

SetAccount : Allow user to set Account

func (*GetChildObjectsOptions) SetComplete 

func (_options *GetChildObjectsOptions) SetComplete(complete bool) *GetChildObjectsOptions

SetComplete : Allow user to set Complete

func (*GetChildObjectsOptions) SetDescending 

func (_options *GetChildObjectsOptions) SetDescending(descending string) *GetChildObjectsOptions

SetDescending : Allow user to set Descending

func (*GetChildObjectsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetChildObjectsOptions) SetID 

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

SetID : Allow user to set ID

func (*GetChildObjectsOptions) SetInclude 

func (_options *GetChildObjectsOptions) SetInclude(include string) *GetChildObjectsOptions

SetInclude : Allow user to set Include

func (*GetChildObjectsOptions) SetKind 

func (_options *GetChildObjectsOptions) SetKind(kind string) *GetChildObjectsOptions

SetKind : Allow user to set Kind

func (*GetChildObjectsOptions) SetLanguages 

func (_options *GetChildObjectsOptions) SetLanguages(languages string) *GetChildObjectsOptions

SetLanguages : Allow user to set Languages

func (*GetChildObjectsOptions) SetLimit added in v0.17.10 

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

SetLimit : Allow user to set Limit

func (*GetChildObjectsOptions) SetOffset added in v0.17.10 

func (_options *GetChildObjectsOptions) SetOffset(offset int64) *GetChildObjectsOptions

SetOffset : Allow user to set Offset

func (*GetChildObjectsOptions) SetQ 

func (_options *GetChildObjectsOptions) SetQ(q string) *GetChildObjectsOptions

SetQ : Allow user to set Q

func (*GetChildObjectsOptions) SetSortBy 

func (_options *GetChildObjectsOptions) SetSortBy(sortBy string) *GetChildObjectsOptions

SetSortBy : Allow user to set SortBy

type GetPricingDeploymentsOptions added in v0.37.1 

type GetPricingDeploymentsOptions struct {
	// The object's unique ID.
	ID *string `json:"id" validate:"required,ne="`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

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

GetPricingDeploymentsOptions : The GetPricingDeployments options.

func (*GetPricingDeploymentsOptions) SetAccount added in v0.37.1 

func (_options *GetPricingDeploymentsOptions) SetAccount(account string) *GetPricingDeploymentsOptions

SetAccount : Allow user to set Account

func (*GetPricingDeploymentsOptions) SetHeaders added in v0.37.1 

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

SetHeaders : Allow user to set Headers

func (*GetPricingDeploymentsOptions) SetID added in v0.37.1 

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

SetID : Allow user to set ID

type GetPricingOptions 

type GetPricingOptions struct {
	// The object's unique ID.
	ID *string `json:"id" validate:"required,ne="`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

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

GetPricingOptions : The GetPricing options.

func (*GetPricingOptions) SetAccount 

func (_options *GetPricingOptions) SetAccount(account string) *GetPricingOptions

SetAccount : Allow user to set Account

func (*GetPricingOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetPricingOptions) SetID 

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

SetID : Allow user to set ID

type GetVisibilityOptions 

type GetVisibilityOptions struct {
	// The object's unique ID.
	ID *string `json:"id" validate:"required,ne="`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

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

GetVisibilityOptions : The GetVisibility options.

func (*GetVisibilityOptions) SetAccount 

func (_options *GetVisibilityOptions) SetAccount(account string) *GetVisibilityOptions

SetAccount : Allow user to set Account

func (*GetVisibilityOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetVisibilityOptions) SetID 

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

SetID : Allow user to set ID

type GlobalCatalogV1 

type GlobalCatalogV1 struct {
	Service *core.BaseService
}

GlobalCatalogV1 : The catalog service manages offerings across geographies as the system of record. The catalog supports a RESTful API where users can retrieve information about existing offerings and create, manage, and delete their offerings. Start with the base URL and use the endpoints to retrieve metadata about services in the catalog and manage service visbility. Depending on the kind of object, the metadata can include information about pricing, provisioning, regions, and more. For more information, see the [catalog documentation](https://cloud.ibm.com/docs/overview/catalog.html#global-catalog-overview).

API Version: 1.0.3

func NewGlobalCatalogV1 

func NewGlobalCatalogV1(options *GlobalCatalogV1Options) (service *GlobalCatalogV1, err error)

NewGlobalCatalogV1 : constructs an instance of GlobalCatalogV1 with passed in options.

func NewGlobalCatalogV1UsingExternalConfig 

func NewGlobalCatalogV1UsingExternalConfig(options *GlobalCatalogV1Options) (globalCatalog *GlobalCatalogV1, err error)

NewGlobalCatalogV1UsingExternalConfig : constructs an instance of GlobalCatalogV1 with passed in options and external configuration.

func (*GlobalCatalogV1) Clone added in v0.17.1 

func (globalCatalog *GlobalCatalogV1) Clone() *GlobalCatalogV1

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

func (*GlobalCatalogV1) CreateCatalogEntry 

func (globalCatalog *GlobalCatalogV1) CreateCatalogEntry(createCatalogEntryOptions *CreateCatalogEntryOptions) (result *CatalogEntry, response *core.DetailedResponse, err error)

CreateCatalogEntry : Create a catalog entry The created catalog entry is restricted by default. You must have an administrator or editor role in the scope of the provided token. This API will return an ETag that can be used for standard ETag processing, except when depth query is used.

func (*GlobalCatalogV1) CreateCatalogEntryWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) CreateCatalogEntryWithContext(ctx context.Context, createCatalogEntryOptions *CreateCatalogEntryOptions) (result *CatalogEntry, response *core.DetailedResponse, err error)

CreateCatalogEntryWithContext is an alternate form of the CreateCatalogEntry method which supports a Context parameter

func (*GlobalCatalogV1) DeleteArtifact 

func (globalCatalog *GlobalCatalogV1) DeleteArtifact(deleteArtifactOptions *DeleteArtifactOptions) (response *core.DetailedResponse, err error)

DeleteArtifact : Delete artifact This endpoint deletes an artifact. Only administrators and editors can delete artifacts.

func (*GlobalCatalogV1) DeleteArtifactWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) DeleteArtifactWithContext(ctx context.Context, deleteArtifactOptions *DeleteArtifactOptions) (response *core.DetailedResponse, err error)

DeleteArtifactWithContext is an alternate form of the DeleteArtifact method which supports a Context parameter

func (*GlobalCatalogV1) DeleteCatalogEntry 

func (globalCatalog *GlobalCatalogV1) DeleteCatalogEntry(deleteCatalogEntryOptions *DeleteCatalogEntryOptions) (response *core.DetailedResponse, err error)

DeleteCatalogEntry : Delete a catalog entry Delete a catalog entry. This will archive the catalog entry for a minimum of two weeks. While archived, it can be restored using the PUT restore API. After two weeks, it will be deleted and cannot be restored. You must have administrator role in the scope of the provided token to modify it. This endpoint is ETag enabled.

func (*GlobalCatalogV1) DeleteCatalogEntryWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) DeleteCatalogEntryWithContext(ctx context.Context, deleteCatalogEntryOptions *DeleteCatalogEntryOptions) (response *core.DetailedResponse, err error)

DeleteCatalogEntryWithContext is an alternate form of the DeleteCatalogEntry method which supports a Context parameter

func (*GlobalCatalogV1) DisableRetries added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) DisableRetries()

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

func (*GlobalCatalogV1) EnableRetries added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) 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 (*GlobalCatalogV1) GetArtifact 

func (globalCatalog *GlobalCatalogV1) GetArtifact(getArtifactOptions *GetArtifactOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetArtifact : Get artifact This endpoint returns the binary of an artifact.

func (*GlobalCatalogV1) GetArtifactWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) GetArtifactWithContext(ctx context.Context, getArtifactOptions *GetArtifactOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetArtifactWithContext is an alternate form of the GetArtifact method which supports a Context parameter

func (*GlobalCatalogV1) GetAuditLogs 

func (globalCatalog *GlobalCatalogV1) GetAuditLogs(getAuditLogsOptions *GetAuditLogsOptions) (result *AuditSearchResult, response *core.DetailedResponse, err error)

GetAuditLogs : Get the audit logs for an object This endpoint returns the audit logs for an object. Only administrators and editors can get logs.

func (*GlobalCatalogV1) GetAuditLogsWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) GetAuditLogsWithContext(ctx context.Context, getAuditLogsOptions *GetAuditLogsOptions) (result *AuditSearchResult, response *core.DetailedResponse, err error)

GetAuditLogsWithContext is an alternate form of the GetAuditLogs method which supports a Context parameter

func (*GlobalCatalogV1) GetCatalogEntry 

func (globalCatalog *GlobalCatalogV1) GetCatalogEntry(getCatalogEntryOptions *GetCatalogEntryOptions) (result *CatalogEntry, response *core.DetailedResponse, err error)

GetCatalogEntry : Get a specific catalog object This endpoint returns a specific catalog entry using the object's unique identifier, for example `/_*service_name*?complete=true`. This endpoint is ETag enabled. This can be used by an unauthenticated user for publicly available services.

func (*GlobalCatalogV1) GetCatalogEntryWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) GetCatalogEntryWithContext(ctx context.Context, getCatalogEntryOptions *GetCatalogEntryOptions) (result *CatalogEntry, response *core.DetailedResponse, err error)

GetCatalogEntryWithContext is an alternate form of the GetCatalogEntry method which supports a Context parameter

func (*GlobalCatalogV1) GetChildObjects 

func (globalCatalog *GlobalCatalogV1) GetChildObjects(getChildObjectsOptions *GetChildObjectsOptions) (result *EntrySearchResult, response *core.DetailedResponse, err error)

GetChildObjects : Get child catalog entries of a specific kind Fetch child catalog entries for a catalog entry with a specific id. This endpoint is ETag enabled. This can be used by an unauthenticated user for publicly available services.

func (*GlobalCatalogV1) GetChildObjectsWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) GetChildObjectsWithContext(ctx context.Context, getChildObjectsOptions *GetChildObjectsOptions) (result *EntrySearchResult, response *core.DetailedResponse, err error)

GetChildObjectsWithContext is an alternate form of the GetChildObjects method which supports a Context parameter

func (*GlobalCatalogV1) GetEnableGzipCompression added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*GlobalCatalogV1) GetPricing 

func (globalCatalog *GlobalCatalogV1) GetPricing(getPricingOptions *GetPricingOptions) (result *PricingGet, response *core.DetailedResponse, err error)

GetPricing : Get the pricing for an object This endpoint returns the pricing for an object. Static pricing is defined in the catalog. Dynamic pricing is stored in IBM Cloud Pricing Catalog. This can be used by an unauthenticated user for publicly available services.

func (*GlobalCatalogV1) GetPricingDeployments added in v0.37.1 

func (globalCatalog *GlobalCatalogV1) GetPricingDeployments(getPricingDeploymentsOptions *GetPricingDeploymentsOptions) (result *PricingSearchResult, response *core.DetailedResponse, err error)

GetPricingDeployments : Get the pricing deployments for a plan This endpoint returns the deployment pricing for a plan. For a plan it returns a pricing for each visible child deployment object. Static pricing is defined in the catalog. Dynamic pricing is stored in IBM Cloud Pricing Catalog. This can be used by an unauthenticated user for publicly available services.

func (*GlobalCatalogV1) GetPricingDeploymentsWithContext added in v0.37.1 

func (globalCatalog *GlobalCatalogV1) GetPricingDeploymentsWithContext(ctx context.Context, getPricingDeploymentsOptions *GetPricingDeploymentsOptions) (result *PricingSearchResult, response *core.DetailedResponse, err error)

GetPricingDeploymentsWithContext is an alternate form of the GetPricingDeployments method which supports a Context parameter

func (*GlobalCatalogV1) GetPricingWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) GetPricingWithContext(ctx context.Context, getPricingOptions *GetPricingOptions) (result *PricingGet, response *core.DetailedResponse, err error)

GetPricingWithContext is an alternate form of the GetPricing method which supports a Context parameter

func (*GlobalCatalogV1) GetServiceURL added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*GlobalCatalogV1) GetVisibility 

func (globalCatalog *GlobalCatalogV1) GetVisibility(getVisibilityOptions *GetVisibilityOptions) (result *Visibility, response *core.DetailedResponse, err error)

GetVisibility : Get the visibility constraints for an object This endpoint returns the visibility rules for this object. Overall visibility is determined by the parent objects and any further restrictions on this object. You must have an administrator role in the scope of the provided token. This endpoint is ETag enabled.

func (*GlobalCatalogV1) GetVisibilityWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) GetVisibilityWithContext(ctx context.Context, getVisibilityOptions *GetVisibilityOptions) (result *Visibility, response *core.DetailedResponse, err error)

GetVisibilityWithContext is an alternate form of the GetVisibility method which supports a Context parameter

func (*GlobalCatalogV1) ListArtifacts 

func (globalCatalog *GlobalCatalogV1) ListArtifacts(listArtifactsOptions *ListArtifactsOptions) (result *Artifacts, response *core.DetailedResponse, err error)

ListArtifacts : Get artifacts This endpoint returns a list of artifacts for an object.

func (*GlobalCatalogV1) ListArtifactsWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) ListArtifactsWithContext(ctx context.Context, listArtifactsOptions *ListArtifactsOptions) (result *Artifacts, response *core.DetailedResponse, err error)

ListArtifactsWithContext is an alternate form of the ListArtifacts method which supports a Context parameter

func (*GlobalCatalogV1) ListCatalogEntries 

func (globalCatalog *GlobalCatalogV1) ListCatalogEntries(listCatalogEntriesOptions *ListCatalogEntriesOptions) (result *EntrySearchResult, response *core.DetailedResponse, err error)

ListCatalogEntries : Returns parent catalog entries Includes key information, such as ID, name, kind, CRN, tags, and provider. This endpoint is ETag enabled.

func (*GlobalCatalogV1) ListCatalogEntriesWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) ListCatalogEntriesWithContext(ctx context.Context, listCatalogEntriesOptions *ListCatalogEntriesOptions) (result *EntrySearchResult, response *core.DetailedResponse, err error)

ListCatalogEntriesWithContext is an alternate form of the ListCatalogEntries method which supports a Context parameter

func (*GlobalCatalogV1) NewCreateCatalogEntryOptions 

func (*GlobalCatalogV1) NewCreateCatalogEntryOptions(name string, kind string, overviewUI map[string]Overview, images *Image, disabled bool, tags []string, provider *Provider, id string) *CreateCatalogEntryOptions

NewCreateCatalogEntryOptions : Instantiate CreateCatalogEntryOptions

func (*GlobalCatalogV1) NewDeleteArtifactOptions 

func (*GlobalCatalogV1) NewDeleteArtifactOptions(objectID string, artifactID string) *DeleteArtifactOptions

NewDeleteArtifactOptions : Instantiate DeleteArtifactOptions

func (*GlobalCatalogV1) NewDeleteCatalogEntryOptions 

func (*GlobalCatalogV1) NewDeleteCatalogEntryOptions(id string) *DeleteCatalogEntryOptions

NewDeleteCatalogEntryOptions : Instantiate DeleteCatalogEntryOptions

func (*GlobalCatalogV1) NewGetArtifactOptions 

func (*GlobalCatalogV1) NewGetArtifactOptions(objectID string, artifactID string) *GetArtifactOptions

NewGetArtifactOptions : Instantiate GetArtifactOptions

func (*GlobalCatalogV1) NewGetAuditLogsOptions 

func (*GlobalCatalogV1) NewGetAuditLogsOptions(id string) *GetAuditLogsOptions

NewGetAuditLogsOptions : Instantiate GetAuditLogsOptions

func (*GlobalCatalogV1) NewGetCatalogEntryOptions 

func (*GlobalCatalogV1) NewGetCatalogEntryOptions(id string) *GetCatalogEntryOptions

NewGetCatalogEntryOptions : Instantiate GetCatalogEntryOptions

func (*GlobalCatalogV1) NewGetChildObjectsOptions 

func (*GlobalCatalogV1) NewGetChildObjectsOptions(id string, kind string) *GetChildObjectsOptions

NewGetChildObjectsOptions : Instantiate GetChildObjectsOptions

func (*GlobalCatalogV1) NewGetPricingDeploymentsOptions added in v0.37.1 

func (*GlobalCatalogV1) NewGetPricingDeploymentsOptions(id string) *GetPricingDeploymentsOptions

NewGetPricingDeploymentsOptions : Instantiate GetPricingDeploymentsOptions

func (*GlobalCatalogV1) NewGetPricingOptions 

func (*GlobalCatalogV1) NewGetPricingOptions(id string) *GetPricingOptions

NewGetPricingOptions : Instantiate GetPricingOptions

func (*GlobalCatalogV1) NewGetVisibilityOptions 

func (*GlobalCatalogV1) NewGetVisibilityOptions(id string) *GetVisibilityOptions

NewGetVisibilityOptions : Instantiate GetVisibilityOptions

func (*GlobalCatalogV1) NewImage 

func (*GlobalCatalogV1) NewImage(image string) (_model *Image, err error)

NewImage : Instantiate Image (Generic Model Constructor)

func (*GlobalCatalogV1) NewListArtifactsOptions 

func (*GlobalCatalogV1) NewListArtifactsOptions(objectID string) *ListArtifactsOptions

NewListArtifactsOptions : Instantiate ListArtifactsOptions

func (*GlobalCatalogV1) NewListCatalogEntriesOptions 

func (*GlobalCatalogV1) NewListCatalogEntriesOptions() *ListCatalogEntriesOptions

NewListCatalogEntriesOptions : Instantiate ListCatalogEntriesOptions

func (*GlobalCatalogV1) NewOverview 

func (*GlobalCatalogV1) NewOverview(displayName string, longDescription string, description string) (_model *Overview, err error)

NewOverview : Instantiate Overview (Generic Model Constructor)

func (*GlobalCatalogV1) NewProvider 

func (*GlobalCatalogV1) NewProvider(email string, name string) (_model *Provider, err error)

NewProvider : Instantiate Provider (Generic Model Constructor)

func (*GlobalCatalogV1) NewRestoreCatalogEntryOptions 

func (*GlobalCatalogV1) NewRestoreCatalogEntryOptions(id string) *RestoreCatalogEntryOptions

NewRestoreCatalogEntryOptions : Instantiate RestoreCatalogEntryOptions

func (*GlobalCatalogV1) NewUpdateCatalogEntryOptions 

func (*GlobalCatalogV1) NewUpdateCatalogEntryOptions(id string, name string, kind string, overviewUI map[string]Overview, images *Image, disabled bool, tags []string, provider *Provider) *UpdateCatalogEntryOptions

NewUpdateCatalogEntryOptions : Instantiate UpdateCatalogEntryOptions

func (*GlobalCatalogV1) NewUpdateVisibilityOptions 

func (*GlobalCatalogV1) NewUpdateVisibilityOptions(id string) *UpdateVisibilityOptions

NewUpdateVisibilityOptions : Instantiate UpdateVisibilityOptions

func (*GlobalCatalogV1) NewUploadArtifactOptions 

func (*GlobalCatalogV1) NewUploadArtifactOptions(objectID string, artifactID string) *UploadArtifactOptions

NewUploadArtifactOptions : Instantiate UploadArtifactOptions

func (*GlobalCatalogV1) NewVisibilityDetail 

func (*GlobalCatalogV1) NewVisibilityDetail(accounts *VisibilityDetailAccounts) (_model *VisibilityDetail, err error)

NewVisibilityDetail : Instantiate VisibilityDetail (Generic Model Constructor)

func (*GlobalCatalogV1) RestoreCatalogEntry 

func (globalCatalog *GlobalCatalogV1) RestoreCatalogEntry(restoreCatalogEntryOptions *RestoreCatalogEntryOptions) (response *core.DetailedResponse, err error)

RestoreCatalogEntry : Restore archived catalog entry Restore an archived catalog entry. You must have an administrator role in the scope of the provided token.

func (*GlobalCatalogV1) RestoreCatalogEntryWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) RestoreCatalogEntryWithContext(ctx context.Context, restoreCatalogEntryOptions *RestoreCatalogEntryOptions) (response *core.DetailedResponse, err error)

RestoreCatalogEntryWithContext is an alternate form of the RestoreCatalogEntry method which supports a Context parameter

func (*GlobalCatalogV1) SetDefaultHeaders added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*GlobalCatalogV1) SetEnableGzipCompression added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*GlobalCatalogV1) SetServiceURL 

func (globalCatalog *GlobalCatalogV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*GlobalCatalogV1) UpdateCatalogEntry 

func (globalCatalog *GlobalCatalogV1) UpdateCatalogEntry(updateCatalogEntryOptions *UpdateCatalogEntryOptions) (result *CatalogEntry, response *core.DetailedResponse, err error)

UpdateCatalogEntry : Update a catalog entry Update a catalog entry. The visibility of the catalog entry cannot be modified with this endpoint. You must be an administrator or editor in the scope of the provided token. This endpoint is ETag enabled.

func (*GlobalCatalogV1) UpdateCatalogEntryWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) UpdateCatalogEntryWithContext(ctx context.Context, updateCatalogEntryOptions *UpdateCatalogEntryOptions) (result *CatalogEntry, response *core.DetailedResponse, err error)

UpdateCatalogEntryWithContext is an alternate form of the UpdateCatalogEntry method which supports a Context parameter

func (*GlobalCatalogV1) UpdateVisibility 

func (globalCatalog *GlobalCatalogV1) UpdateVisibility(updateVisibilityOptions *UpdateVisibilityOptions) (response *core.DetailedResponse, err error)

UpdateVisibility : Update visibility Update an Object's Visibility. You must have an administrator role in the scope of the provided token. This endpoint is ETag enabled.

func (*GlobalCatalogV1) UpdateVisibilityWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) UpdateVisibilityWithContext(ctx context.Context, updateVisibilityOptions *UpdateVisibilityOptions) (response *core.DetailedResponse, err error)

UpdateVisibilityWithContext is an alternate form of the UpdateVisibility method which supports a Context parameter

func (*GlobalCatalogV1) UploadArtifact 

func (globalCatalog *GlobalCatalogV1) UploadArtifact(uploadArtifactOptions *UploadArtifactOptions) (response *core.DetailedResponse, err error)

UploadArtifact : Upload artifact This endpoint uploads the binary for an artifact. Only administrators and editors can upload artifacts.

func (*GlobalCatalogV1) UploadArtifactWithContext added in v0.12.2 

func (globalCatalog *GlobalCatalogV1) UploadArtifactWithContext(ctx context.Context, uploadArtifactOptions *UploadArtifactOptions) (response *core.DetailedResponse, err error)

UploadArtifactWithContext is an alternate form of the UploadArtifact method which supports a Context parameter

type GlobalCatalogV1Options 

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

GlobalCatalogV1Options : Service options

type Image 

type Image struct {
	// URL for the large, default image.
	Image *string `json:"image" validate:"required"`

	// URL for a small image.
	SmallImage *string `json:"small_image,omitempty"`

	// URL for a medium image.
	MediumImage *string `json:"medium_image,omitempty"`

	// URL for a featured image.
	FeatureImage *string `json:"feature_image,omitempty"`
}

Image : Image annotation for this catalog entry. The image is a URL.

type ListArtifactsOptions 

type ListArtifactsOptions struct {
	// The object's unique ID.
	ObjectID *string `json:"object_id" validate:"required,ne="`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

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

ListArtifactsOptions : The ListArtifacts options.

func (*ListArtifactsOptions) SetAccount 

func (_options *ListArtifactsOptions) SetAccount(account string) *ListArtifactsOptions

SetAccount : Allow user to set Account

func (*ListArtifactsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListArtifactsOptions) SetObjectID 

func (_options *ListArtifactsOptions) SetObjectID(objectID string) *ListArtifactsOptions

SetObjectID : Allow user to set ObjectID

type ListCatalogEntriesOptions 

type ListCatalogEntriesOptions struct {
	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

	// A GET call by default returns a basic set of properties. To include other properties, you must add this parameter. A
	// wildcard (`*`) includes all properties for an object, for example `GET /?include=*`. To include specific metadata
	// fields, separate each field with a colon (:), for example `GET /?include=metadata.ui:metadata.pricing`.
	Include *string `json:"include,omitempty"`

	// Searches the catalog entries for keywords. Add filters to refine your search. A query filter, for example,
	// `q=kind:iaas service_name rc:true`, filters entries of kind iaas with metadata.service.rc_compatible set to true and
	//  have a service name is in their name, display name, or description.  Valid tags are **kind**:<string>,
	// **tag**:<strging>, **rc**:[true|false], **iam**:[true|false], **active**:[true|false], **geo**:<string>, and
	// **price**:<string>.
	Q *string `json:"q,omitempty"`

	// The field on which the output is sorted. Sorts by default by **name** property. Available fields are **name**,
	// **displayname** (overview_ui.display_name), **kind**, **provider** (provider.name), **sbsindex**
	// (metadata.ui.side_by_side_index), and the time **created**, and **updated**.
	SortBy *string `json:"sort-by,omitempty"`

	// Sets the sort order. The default is false, which is ascending.
	Descending *string `json:"descending,omitempty"`

	// Return the data strings in a specified language. By default, the strings returned are of the language preferred by
	// your browser through the Accept-Language header, which allows an override of the header. Languages are specified in
	// standard form, such as `en-us`. To include all languages use a wildcard (*).
	Languages *string `json:"languages,omitempty"`

	// Checks to see if a catalog's object is visible, or if it's filtered by service, plan, deployment, or region. Use the
	// value `?catalog=true`. If a `200` code is returned, the object is visible. If a `403` code is returned, the object
	// is not visible for the user.
	Catalog *bool `json:"catalog,omitempty"`

	// Returns all available fields for all languages. Use the value `?complete=true` as shortcut for
	// ?include=*&languages=*.
	Complete *bool `json:"complete,omitempty"`

	// Useful for pagination, specifies index (origin 0) of first item to return in response.
	Offset *int64 `json:"_offset,omitempty"`

	// Useful for pagination, specifies the maximum number of items to return in the response.
	Limit *int64 `json:"_limit,omitempty"`

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

ListCatalogEntriesOptions : The ListCatalogEntries options.

func (*ListCatalogEntriesOptions) SetAccount 

func (_options *ListCatalogEntriesOptions) SetAccount(account string) *ListCatalogEntriesOptions

SetAccount : Allow user to set Account

func (*ListCatalogEntriesOptions) SetCatalog added in v0.17.10 

func (_options *ListCatalogEntriesOptions) SetCatalog(catalog bool) *ListCatalogEntriesOptions

SetCatalog : Allow user to set Catalog

func (*ListCatalogEntriesOptions) SetComplete 

func (_options *ListCatalogEntriesOptions) SetComplete(complete bool) *ListCatalogEntriesOptions

SetComplete : Allow user to set Complete

func (*ListCatalogEntriesOptions) SetDescending 

func (_options *ListCatalogEntriesOptions) SetDescending(descending string) *ListCatalogEntriesOptions

SetDescending : Allow user to set Descending

func (*ListCatalogEntriesOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListCatalogEntriesOptions) SetInclude 

func (_options *ListCatalogEntriesOptions) SetInclude(include string) *ListCatalogEntriesOptions

SetInclude : Allow user to set Include

func (*ListCatalogEntriesOptions) SetLanguages 

func (_options *ListCatalogEntriesOptions) SetLanguages(languages string) *ListCatalogEntriesOptions

SetLanguages : Allow user to set Languages

func (*ListCatalogEntriesOptions) SetLimit added in v0.17.10 

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

SetLimit : Allow user to set Limit

func (*ListCatalogEntriesOptions) SetOffset added in v0.17.10 

func (_options *ListCatalogEntriesOptions) SetOffset(offset int64) *ListCatalogEntriesOptions

SetOffset : Allow user to set Offset

func (*ListCatalogEntriesOptions) SetQ 

func (_options *ListCatalogEntriesOptions) SetQ(q string) *ListCatalogEntriesOptions

SetQ : Allow user to set Q

func (*ListCatalogEntriesOptions) SetSortBy 

func (_options *ListCatalogEntriesOptions) SetSortBy(sortBy string) *ListCatalogEntriesOptions

SetSortBy : Allow user to set SortBy

type Message 

type Message struct {
	// id of catalog entry.
	ID *string `json:"id,omitempty"`

	// Information related to the visibility of a catalog entry.
	Effective *Visibility `json:"effective,omitempty"`

	// time of action.
	Time *strfmt.DateTime `json:"time,omitempty"`

	// user ID of person who did action.
	WhoID *string `json:"who_id,omitempty"`

	// name of person who did action.
	WhoName *string `json:"who_name,omitempty"`

	// user email of person who did action.
	WhoEmail *string `json:"who_email,omitempty"`

	// Global catalog instance where this occured.
	Instance *string `json:"instance,omitempty"`

	// transaction id associatd with action.
	Gid *string `json:"gid,omitempty"`

	// type of action taken.
	Type *string `json:"type,omitempty"`

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

	// An object containing details on changes made to object data.
	Data map[string]interface{} `json:"data,omitempty"`
}

Message : log object describing who did what.

type Metrics 

type Metrics struct {
	// The part reference.
	PartRef *string `json:"part_ref,omitempty"`

	// The metric ID or part number.
	MetricID *string `json:"metric_id,omitempty"`

	// The tier model.
	TierModel *string `json:"tier_model,omitempty"`

	// The unit to charge.
	ChargeUnit *string `json:"charge_unit,omitempty"`

	// The charge unit name.
	ChargeUnitName *string `json:"charge_unit_name,omitempty"`

	// The charge unit quantity.
	ChargeUnitQuantity *int64 `json:"charge_unit_quantity,omitempty"`

	// Display name of the resource.
	ResourceDisplayName *string `json:"resource_display_name,omitempty"`

	// Display name of the charge unit.
	ChargeUnitDisplayName *string `json:"charge_unit_display_name,omitempty"`

	// Usage limit for the metric.
	UsageCapQty *int64 `json:"usage_cap_qty,omitempty"`

	// Display capacity.
	DisplayCap *int64 `json:"display_cap,omitempty"`

	// Effective from time.
	EffectiveFrom *strfmt.DateTime `json:"effective_from,omitempty"`

	// Effective until time.
	EffectiveUntil *strfmt.DateTime `json:"effective_until,omitempty"`

	// The pricing per metric by country and currency.
	Amounts []Amount `json:"amounts,omitempty"`
}

Metrics : Plan-specific cost metrics information.

type ObjectMetadataSet 

type ObjectMetadataSet struct {
	// Boolean value that describes whether the service is compatible with the Resource Controller.
	RcCompatible *bool `json:"rc_compatible,omitempty"`

	// Service-related metadata.
	Service *CfMetaData `json:"service,omitempty"`

	// Plan-related metadata.
	Plan *PlanMetaData `json:"plan,omitempty"`

	// Alias-related metadata.
	Alias *AliasMetaData `json:"alias,omitempty"`

	// Template-related metadata.
	Template *TemplateMetaData `json:"template,omitempty"`

	// Information related to the UI presentation associated with a catalog entry.
	UI *UIMetaData `json:"ui,omitempty"`

	// Compliance information for HIPAA and PCI.
	Compliance []string `json:"compliance,omitempty"`

	// Service Level Agreement related metadata.
	SLA *SLAMetaData `json:"sla,omitempty"`

	// Callback-related information associated with a catalog entry.
	Callbacks *Callbacks `json:"callbacks,omitempty"`

	// The original name of the object.
	OriginalName *string `json:"original_name,omitempty"`

	// Optional version of the object.
	Version *string `json:"version,omitempty"`

	// Additional information.
	Other map[string]interface{} `json:"other,omitempty"`

	// Pricing-related information.
	Pricing *PricingSet `json:"pricing,omitempty"`

	// Deployment-related metadata.
	Deployment *DeploymentBase `json:"deployment,omitempty"`
}

ObjectMetadataSet : Model used to describe metadata object that can be set.

type Overview 

type Overview struct {
	// The translated display name.
	DisplayName *string `json:"display_name" validate:"required"`

	// The translated long description.
	LongDescription *string `json:"long_description" validate:"required"`

	// The translated description.
	Description *string `json:"description" validate:"required"`

	// The translated description that will be featured.
	FeaturedDescription *string `json:"featured_description,omitempty"`
}

Overview : Overview is nested in the top level. The key value pair is `[_language_]overview_ui`.

type PlanMetaData 

type PlanMetaData struct {
	// Boolean value that describes whether the service can be bound to an application.
	Bindable *bool `json:"bindable,omitempty"`

	// Boolean value that describes whether the service can be reserved.
	Reservable *bool `json:"reservable,omitempty"`

	// Boolean value that describes whether the service can be used internally.
	AllowInternalUsers *bool `json:"allow_internal_users,omitempty"`

	// Boolean value that describes whether the service can be provisioned asynchronously.
	AsyncProvisioningSupported *bool `json:"async_provisioning_supported,omitempty"`

	// Boolean value that describes whether the service can be unprovisioned asynchronously.
	AsyncUnprovisioningSupported *bool `json:"async_unprovisioning_supported,omitempty"`

	// Test check interval.
	TestCheckInterval *int64 `json:"test_check_interval,omitempty"`

	// Single scope instance.
	SingleScopeInstance *string `json:"single_scope_instance,omitempty"`

	// Boolean value that describes whether the service check is enabled.
	ServiceCheckEnabled *bool `json:"service_check_enabled,omitempty"`

	// If the field is imported from Cloud Foundry, the Cloud Foundry region's GUID. This is a required field. For example,
	// `us-south=123`.
	CfGUID map[string]string `json:"cf_guid,omitempty"`
}

PlanMetaData : Plan-related metadata.

type Price 

type Price struct {
	// Pricing tier.
	QuantityTier *int64 `json:"quantity_tier,omitempty"`

	// Price in the selected currency.
	Price *float64 `json:"Price,omitempty"`
}

Price : Pricing-related information.

type PricingGet 

type PricingGet struct {
	// The deployment object id this pricing is from. Only set if object kind is deployment.
	DeploymentID *string `json:"deployment_id,omitempty"`

	// The deployment location this pricing is from. Only set if object kind is deployment.
	DeploymentLocation *string `json:"deployment_location,omitempty"`

	// Is the location price not available. Only set in api /pricing/deployment and only set if true. This means for the
	// given deployment object there was no pricing set in pricing catalog.
	DeploymentLocationNoPriceAvailable *bool `json:"deployment_location_no_price_available,omitempty"`

	// Type of plan. Valid values are `free`, `trial`, `paygo`, `bluemix-subscription`, and `ibm-subscription`.
	Type *string `json:"type,omitempty"`

	// Defines where the pricing originates.
	Origin *string `json:"origin,omitempty"`

	// Plan-specific starting price information.
	StartingPrice *StartingPrice `json:"starting_price,omitempty"`

	// Plan-specific cost metric structure.
	Metrics []Metrics `json:"metrics,omitempty"`
}

PricingGet : Pricing-related information.

type PricingSearchResult added in v0.37.1 

type PricingSearchResult struct {
	// The offset (origin 0) of the first resource in this page of search results.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of resources returned in each page of search results.
	Limit *int64 `json:"limit,omitempty"`

	// The overall total number of resources in the search result set.
	Count *int64 `json:"count,omitempty"`

	// The number of resources returned in this page of search results.
	ResourceCount *int64 `json:"resource_count,omitempty"`

	// A URL for retrieving the first page of search results.
	First *string `json:"first,omitempty"`

	// A URL for retrieving the last page of search results.
	Last *string `json:"last,omitempty"`

	// A URL for retrieving the previous page of search results.
	Prev *string `json:"prev,omitempty"`

	// A URL for retrieving the next page of search results.
	Next *string `json:"next,omitempty"`

	// The resources (prices) contained in this page of search results.
	Resources []PricingGet `json:"resources,omitempty"`
}

PricingSearchResult : A paginated result containing pricing entries.

type PricingSet 

type PricingSet struct {
	// Type of plan. Valid values are `free`, `trial`, `paygo`, `bluemix-subscription`, and `ibm-subscription`.
	Type *string `json:"type,omitempty"`

	// Defines where the pricing originates.
	Origin *string `json:"origin,omitempty"`

	// Plan-specific starting price information.
	StartingPrice *StartingPrice `json:"starting_price,omitempty"`
}

PricingSet : Pricing-related information.

type Provider 

type Provider struct {
	// Provider's email address for this catalog entry.
	Email *string `json:"email" validate:"required"`

	// Provider's name, for example, IBM.
	Name *string `json:"name" validate:"required"`

	// Provider's contact name.
	Contact *string `json:"contact,omitempty"`

	// Provider's support email.
	SupportEmail *string `json:"support_email,omitempty"`

	// Provider's contact phone.
	Phone *string `json:"phone,omitempty"`
}

Provider : Information related to the provider associated with a catalog entry.

type RestoreCatalogEntryOptions 

type RestoreCatalogEntryOptions struct {
	// The catalog entry's unique ID.
	ID *string `json:"id" validate:"required,ne="`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

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

RestoreCatalogEntryOptions : The RestoreCatalogEntry options.

func (*RestoreCatalogEntryOptions) SetAccount 

func (_options *RestoreCatalogEntryOptions) SetAccount(account string) *RestoreCatalogEntryOptions

SetAccount : Allow user to set Account

func (*RestoreCatalogEntryOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*RestoreCatalogEntryOptions) SetID 

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

SetID : Allow user to set ID

type SLAMetaData 

type SLAMetaData struct {
	// Required Service License Agreement Terms of Use.
	Terms *string `json:"terms,omitempty"`

	// Required deployment type. Valid values are dedicated, local, or public. It can be Single or Multi tennancy, more
	// specifically on a Server, VM, Physical, or Pod.
	Tenancy *string `json:"tenancy,omitempty"`

	// Provisioning reliability, for example, 99.95.
	Provisioning *float64 `json:"provisioning,omitempty"`

	// Uptime reliability of the service, for example, 99.95.
	Responsiveness *float64 `json:"responsiveness,omitempty"`

	// SLA Disaster Recovery-related metadata.
	Dr *DrMetaData `json:"dr,omitempty"`
}

SLAMetaData : Service Level Agreement related metadata.

type SourceMetaData 

type SourceMetaData struct {
	// Path to your application.
	Path *string `json:"path,omitempty"`

	// Type of source, for example, git.
	Type *string `json:"type,omitempty"`

	// URL to source.
	URL *string `json:"url,omitempty"`
}

SourceMetaData : Location of your applications source files.

type StartingPrice 

type StartingPrice struct {
	// ID of the plan the starting price is calculated.
	PlanID *string `json:"plan_id,omitempty"`

	// ID of the deployment the starting price is calculated.
	DeploymentID *string `json:"deployment_id,omitempty"`

	// Pricing unit.
	Unit *string `json:"unit,omitempty"`

	// The pricing per metric by country and currency.
	Amount []Amount `json:"amount,omitempty"`
}

StartingPrice : Plan-specific starting price information.

type Strings 

type Strings struct {
	// Presentation information related to list delimiters.
	Bullets []Bullets `json:"bullets,omitempty"`

	// Media-related metadata.
	Media []UIMetaMedia `json:"media,omitempty"`

	// Warning that a message is not creatable.
	NotCreatableMsg *string `json:"not_creatable_msg,omitempty"`

	// Warning that a robot message is not creatable.
	NotCreatableRobotMsg *string `json:"not_creatable__robot_msg,omitempty"`

	// Warning for deprecation.
	DeprecationWarning *string `json:"deprecation_warning,omitempty"`

	// Popup warning message.
	PopupWarningMessage *string `json:"popup_warning_message,omitempty"`

	// Instructions for UI strings.
	Instruction *string `json:"instruction,omitempty"`
}

Strings : Information related to a translated text message.

type TemplateMetaData 

type TemplateMetaData struct {
	// List of required offering or plan IDs.
	Services []string `json:"services,omitempty"`

	// Cloud Foundry instance memory value.
	DefaultMemory *int64 `json:"default_memory,omitempty"`

	// Start Command.
	StartCmd *string `json:"start_cmd,omitempty"`

	// Location of your applications source files.
	Source *SourceMetaData `json:"source,omitempty"`

	// ID of the runtime.
	RuntimeCatalogID *string `json:"runtime_catalog_id,omitempty"`

	// ID of the Cloud Foundry runtime.
	CfRuntimeID *string `json:"cf_runtime_id,omitempty"`

	// ID of the boilerplate or template.
	TemplateID *string `json:"template_id,omitempty"`

	// File path to the executable file for the template.
	ExecutableFile *string `json:"executable_file,omitempty"`

	// ID of the buildpack used by the template.
	Buildpack *string `json:"buildpack,omitempty"`

	// Environment variables (key/value pairs) for the template.
	EnvironmentVariables map[string]string `json:"environment_variables,omitempty"`
}

TemplateMetaData : Template-related metadata.

type UIMediaSourceMetaData added in v0.37.1 

type UIMediaSourceMetaData struct {
	// Type of source, for example, git.
	Type *string `json:"type,omitempty"`

	// URL to source.
	URL *string `json:"url,omitempty"`
}

UIMediaSourceMetaData : Location of your applications media source files.

type UIMetaData 

type UIMetaData struct {
	// Language specific translation of translation properties, like label and description.
	Strings map[string]Strings `json:"strings,omitempty"`

	// UI based URLs.
	Urls *Urls `json:"urls,omitempty"`

	// Describes how the embeddable dashboard is rendered.
	EmbeddableDashboard *string `json:"embeddable_dashboard,omitempty"`

	// Describes whether the embeddable dashboard is rendered at the full width.
	EmbeddableDashboardFullWidth *bool `json:"embeddable_dashboard_full_width,omitempty"`

	// Defines the order of information presented.
	NavigationOrder []string `json:"navigation_order,omitempty"`

	// Describes whether this entry is able to be created from the UI element or CLI.
	NotCreatable *bool `json:"not_creatable,omitempty"`

	// ID of the primary offering for a group.
	PrimaryOfferingID *string `json:"primary_offering_id,omitempty"`

	// Alert to ACE to allow instance UI to be accessible while the provisioning state of instance is in progress.
	AccessibleDuringProvision *bool `json:"accessible_during_provision,omitempty"`

	// Specifies a side by side ordering weight to the UI.
	SideBySideIndex *int64 `json:"side_by_side_index,omitempty"`

	// Date and time the service will no longer be available.
	EndOfServiceTime *strfmt.DateTime `json:"end_of_service_time,omitempty"`

	// Denotes visibility.
	Hidden *bool `json:"hidden,omitempty"`

	// Denotes lite metering visibility.
	HideLiteMetering *bool `json:"hide_lite_metering,omitempty"`

	// Denotes whether an upgrade should occur.
	NoUpgradeNextStep *bool `json:"no_upgrade_next_step,omitempty"`
}

UIMetaData : Information related to the UI presentation associated with a catalog entry.

type UIMetaMedia 

type UIMetaMedia struct {
	// Caption for an image.
	Caption *string `json:"caption,omitempty"`

	// URL for thumbnail image.
	ThumbnailURL *string `json:"thumbnail_url,omitempty"`

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

	// URL for media.
	URL *string `json:"URL,omitempty"`

	// UI media source data for for UI media data.
	Source []UIMediaSourceMetaData `json:"source,omitempty"`
}

UIMetaMedia : Media-related metadata.

type UpdateCatalogEntryOptions 

type UpdateCatalogEntryOptions struct {
	// The object's unique ID.
	ID *string `json:"id" validate:"required,ne="`

	// Programmatic name for this catalog entry, which must be formatted like a CRN segment. See the display name in
	// OverviewUI for a user-readable name.
	Name *string `json:"name" validate:"required"`

	// The type of catalog entry, **service**, **template**, **dashboard**, which determines the type and shape of the
	// object.
	Kind *string `json:"kind" validate:"required"`

	// Overview is nested in the top level. The key value pair is `[_language_]overview_ui`.
	OverviewUI map[string]Overview `json:"overview_ui" validate:"required"`

	// Image annotation for this catalog entry. The image is a URL.
	Images *Image `json:"images" validate:"required"`

	// Boolean value that determines the global visibility for the catalog entry, and its children. If it is not enabled,
	// all plans are disabled.
	Disabled *bool `json:"disabled" validate:"required"`

	// A list of tags. For example, IBM, 3rd Party, Beta, GA, and Single Tenant.
	Tags []string `json:"tags" validate:"required"`

	// Information related to the provider associated with a catalog entry.
	Provider *Provider `json:"provider" validate:"required"`

	// The ID of the parent catalog entry if it exists.
	ParentID *string `json:"parent_id,omitempty"`

	// Boolean value that determines whether the catalog entry is a group.
	Group *bool `json:"group,omitempty"`

	// Boolean value that describes whether the service is active.
	Active *bool `json:"active,omitempty"`

	// Model used to describe metadata object that can be set.
	Metadata *ObjectMetadataSet `json:"metadata,omitempty"`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

	// Reparenting object. In the body set the parent_id to a different parent. Or remove the parent_id field to reparent
	// to the root of the catalog. If this is not set to 'true' then changing the parent_id in the body of the request will
	// not be permitted. If this is 'true' and no change to parent_id then this is also error. This is to prevent
	// accidental changing of parent.
	Move *string `json:"move,omitempty"`

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

UpdateCatalogEntryOptions : The UpdateCatalogEntry options.

func (*UpdateCatalogEntryOptions) SetAccount 

func (_options *UpdateCatalogEntryOptions) SetAccount(account string) *UpdateCatalogEntryOptions

SetAccount : Allow user to set Account

func (*UpdateCatalogEntryOptions) SetActive 

func (_options *UpdateCatalogEntryOptions) SetActive(active bool) *UpdateCatalogEntryOptions

SetActive : Allow user to set Active

func (*UpdateCatalogEntryOptions) SetDisabled 

func (_options *UpdateCatalogEntryOptions) SetDisabled(disabled bool) *UpdateCatalogEntryOptions

SetDisabled : Allow user to set Disabled

func (*UpdateCatalogEntryOptions) SetGroup 

func (_options *UpdateCatalogEntryOptions) SetGroup(group bool) *UpdateCatalogEntryOptions

SetGroup : Allow user to set Group

func (*UpdateCatalogEntryOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateCatalogEntryOptions) SetID 

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

SetID : Allow user to set ID

func (*UpdateCatalogEntryOptions) SetImages 

func (_options *UpdateCatalogEntryOptions) SetImages(images *Image) *UpdateCatalogEntryOptions

SetImages : Allow user to set Images

func (*UpdateCatalogEntryOptions) SetKind 

func (_options *UpdateCatalogEntryOptions) SetKind(kind string) *UpdateCatalogEntryOptions

SetKind : Allow user to set Kind

func (*UpdateCatalogEntryOptions) SetMetadata 

func (_options *UpdateCatalogEntryOptions) SetMetadata(metadata *ObjectMetadataSet) *UpdateCatalogEntryOptions

SetMetadata : Allow user to set Metadata

func (*UpdateCatalogEntryOptions) SetMove 

func (_options *UpdateCatalogEntryOptions) SetMove(move string) *UpdateCatalogEntryOptions

SetMove : Allow user to set Move

func (*UpdateCatalogEntryOptions) SetName 

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

SetName : Allow user to set Name

func (*UpdateCatalogEntryOptions) SetOverviewUI added in v0.17.2 

func (_options *UpdateCatalogEntryOptions) SetOverviewUI(overviewUI map[string]Overview) *UpdateCatalogEntryOptions

SetOverviewUI : Allow user to set OverviewUI

func (*UpdateCatalogEntryOptions) SetParentID 

func (_options *UpdateCatalogEntryOptions) SetParentID(parentID string) *UpdateCatalogEntryOptions

SetParentID : Allow user to set ParentID

func (*UpdateCatalogEntryOptions) SetProvider 

func (_options *UpdateCatalogEntryOptions) SetProvider(provider *Provider) *UpdateCatalogEntryOptions

SetProvider : Allow user to set Provider

func (*UpdateCatalogEntryOptions) SetTags 

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

SetTags : Allow user to set Tags

type UpdateVisibilityOptions 

type UpdateVisibilityOptions struct {
	// The object's unique ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows the visibility to be extenable.
	Extendable *bool `json:"extendable,omitempty"`

	// Visibility details related to a catalog entry.
	Include *VisibilityDetail `json:"include,omitempty"`

	// Visibility details related to a catalog entry.
	Exclude *VisibilityDetail `json:"exclude,omitempty"`

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

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

UpdateVisibilityOptions : The UpdateVisibility options.

func (*UpdateVisibilityOptions) SetAccount 

func (_options *UpdateVisibilityOptions) SetAccount(account string) *UpdateVisibilityOptions

SetAccount : Allow user to set Account

func (*UpdateVisibilityOptions) SetExclude 

func (_options *UpdateVisibilityOptions) SetExclude(exclude *VisibilityDetail) *UpdateVisibilityOptions

SetExclude : Allow user to set Exclude

func (*UpdateVisibilityOptions) SetExtendable 

func (_options *UpdateVisibilityOptions) SetExtendable(extendable bool) *UpdateVisibilityOptions

SetExtendable : Allow user to set Extendable

func (*UpdateVisibilityOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateVisibilityOptions) SetID 

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

SetID : Allow user to set ID

func (*UpdateVisibilityOptions) SetInclude 

func (_options *UpdateVisibilityOptions) SetInclude(include *VisibilityDetail) *UpdateVisibilityOptions

SetInclude : Allow user to set Include

type UploadArtifactOptions 

type UploadArtifactOptions struct {
	// The object's unique ID.
	ObjectID *string `json:"object_id" validate:"required,ne="`

	// The artifact's ID.
	ArtifactID *string `json:"artifact_id" validate:"required,ne="`

	Artifact io.ReadCloser `json:"artifact,omitempty"`

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

	// This changes the scope of the request regardless of the authorization header. Example scopes are `account` and
	// `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example
	// `GET /?account=global`.
	Account *string `json:"account,omitempty"`

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

UploadArtifactOptions : The UploadArtifact options.

func (*UploadArtifactOptions) SetAccount 

func (_options *UploadArtifactOptions) SetAccount(account string) *UploadArtifactOptions

SetAccount : Allow user to set Account

func (*UploadArtifactOptions) SetArtifact 

func (_options *UploadArtifactOptions) SetArtifact(artifact io.ReadCloser) *UploadArtifactOptions

SetArtifact : Allow user to set Artifact

func (*UploadArtifactOptions) SetArtifactID 

func (_options *UploadArtifactOptions) SetArtifactID(artifactID string) *UploadArtifactOptions

SetArtifactID : Allow user to set ArtifactID

func (*UploadArtifactOptions) SetContentType 

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

SetContentType : Allow user to set ContentType

func (*UploadArtifactOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UploadArtifactOptions) SetObjectID 

func (_options *UploadArtifactOptions) SetObjectID(objectID string) *UploadArtifactOptions

SetObjectID : Allow user to set ObjectID

type Urls added in v0.17.1 

type Urls struct {
	// URL for documentation.
	DocURL *string `json:"doc_url,omitempty"`

	// URL for usage instructions.
	InstructionsURL *string `json:"instructions_url,omitempty"`

	// API URL.
	APIURL *string `json:"api_url,omitempty"`

	// URL Creation UI / API.
	CreateURL *string `json:"create_url,omitempty"`

	// URL to downlaod an SDK.
	SdkDownloadURL *string `json:"sdk_download_url,omitempty"`

	// URL to the terms of use for your service.
	TermsURL *string `json:"terms_url,omitempty"`

	// URL to the custom create page for your serivce.
	CustomCreatePageURL *string `json:"custom_create_page_url,omitempty"`

	// URL to the catalog details page for your serivce.
	CatalogDetailsURL *string `json:"catalog_details_url,omitempty"`

	// URL for deprecation documentation.
	DeprecationDocURL *string `json:"deprecation_doc_url,omitempty"`

	// URL for dashboard.
	DashboardURL *string `json:"dashboard_url,omitempty"`

	// URL for registration.
	RegistrationURL *string `json:"registration_url,omitempty"`

	// URL for API documentation.
	Apidocsurl *string `json:"apidocsurl,omitempty"`
}

Urls : UI based URLs.

type Visibility 

type Visibility struct {
	// This controls the overall visibility. It is an enum of *public*, *ibm_only*, and *private*. public means it is
	// visible to all. ibm_only means it is visible to all IBM unless their account is explicitly excluded. private means
	// it is visible only to the included accounts.
	Restrictions *string `json:"restrictions,omitempty"`

	// IAM Scope-related information associated with a catalog entry.
	Owner *string `json:"owner,omitempty"`

	// Allows the visibility to be extenable.
	Extendable *bool `json:"extendable,omitempty"`

	// Visibility details related to a catalog entry.
	Include *VisibilityDetail `json:"include,omitempty"`

	// Visibility details related to a catalog entry.
	Exclude *VisibilityDetail `json:"exclude,omitempty"`

	// Determines whether the owning account has full control over the visibility of the entry such as adding non-IBM
	// accounts to the whitelist and making entries `private`, `ibm_only` or `public`.
	Approved *bool `json:"approved,omitempty"`
}

Visibility : Information related to the visibility of a catalog entry.

type VisibilityDetail 

type VisibilityDetail struct {
	// Information related to the accounts for which a catalog entry is visible.
	Accounts *VisibilityDetailAccounts `json:"accounts" validate:"required"`
}

VisibilityDetail : Visibility details related to a catalog entry.

type VisibilityDetailAccounts 

type VisibilityDetailAccounts struct {
	// (_accountid_) is the GUID of the account and the value is the scope of who set it. For setting visibility use "" as
	// the value. It is replaced with the owner scope when saved.
	Accountid *string `json:"_accountid_,omitempty"`
}

VisibilityDetailAccounts : Information related to the accounts for which a catalog entry is visible.

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.