ibmcloudfunctionsnamespaceapiv1

package
v0.0.0-...-ac3e7db Latest Latest
Warning

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

Go to latest
Published: Feb 1, 2021 License: MPL-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package ibmcloudfunctionsnamespaceapiv1 : Operations and models for the ibmcloudfunctionsnamespaceapiv1 service

Package ibmcloudfunctionsnamespaceapiv1 : Operations and models for the ibmcloudfunctionsnamespaceapiv1 service

Package ibmcloudfunctionsnamespaceapiv1 : Operations and models for the ibmcloudfunctionsnamespaceapiv1 service

Index

Constants

View Source
const (
	ContentType         = "Content-Type"
	FormEncodeHeaderURL = "application/x-www-form-urlencoded"
)

common headers

View Source
const (
	NamespaceTypeCFBased     = 1
	NamespaceTypeIamMigrated = 2
	NamespaceTypeIamBased    = 3
)

const ..

View Source
const DefaultServiceName = "ibm_cloud_functions_namespace_API"

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

View Source
const DefaultServiceURL = "https://gateway.watsonplatform.net/servicebroker/API/v1"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateNamespaceOptions

type CreateNamespaceOptions struct {

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

	// Resourcegroupid of resource group the namespace resource should be placed in. Use 'ibmcloud resource groups' to
	// query your resources groups and their ids.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// Resourceplanid to use, e.g. 'functions-base-plan'.
	ResourcePlanID *string `json:"resource_plan_id" validate:"required"`

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

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

CreateNamespaceOptions : The CreateNamespace options.

func (*CreateNamespaceOptions) SetDescription

func (options *CreateNamespaceOptions) SetDescription(description string) *CreateNamespaceOptions

SetDescription : Allow user to set Description

func (*CreateNamespaceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateNamespaceOptions) SetName

func (options *CreateNamespaceOptions) SetName(name string) *CreateNamespaceOptions

SetName : Allow user to set Name

func (*CreateNamespaceOptions) SetResourceGroupID

func (options *CreateNamespaceOptions) SetResourceGroupID(resourceGroupID string) *CreateNamespaceOptions

SetResourceGroupID : Allow user to set ResourceGroupID

func (*CreateNamespaceOptions) SetResourcePlanID

func (options *CreateNamespaceOptions) SetResourcePlanID(resourcePlanID string) *CreateNamespaceOptions

SetResourcePlanID : Allow user to set ResourcePlanID

type DeleteNamespaceOptions

type DeleteNamespaceOptions struct {

	// The id of the namespace to delete.
	ID *string `json:"id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

DeleteNamespaceOptions : The DeleteNamespace options.

func (*DeleteNamespaceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteNamespaceOptions) SetID

SetID : Allow user to set ID

type FunctionsNamespaceListResource

type FunctionsNamespaceListResource interface {
	GetNamespaces() []NamespaceResource
}

FunctionsNamespaceListResource ..

type FunctionsNamespaceResourceList

type FunctionsNamespaceResourceList []NamespaceResource

FunctionsNamespaceResourceList ..

type GetNamespaceOptions

type GetNamespaceOptions struct {

	// The id of the namespace to retrieve.
	ID *string `json:"id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

GetNamespaceOptions : The GetNamespace options.

func (*GetNamespaceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetNamespaceOptions) SetID

func (options *GetNamespaceOptions) SetID(ID string) *GetNamespaceOptions

SetID : Allow user to set ID

type GetNamespacesOptions

type GetNamespacesOptions struct {

	// The maximum number of namespaces to return. Default 100. Maximum 200.
	Limit *int64 `json:"limit,omitempty"`

	// The number of namespaces to skip. Default 0.
	Offset *int64 `json:"offset,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

GetNamespacesOptions : The GetNamespaces options.

func (*GetNamespacesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetNamespacesOptions) SetLimit

func (options *GetNamespacesOptions) SetLimit(limit int64) *GetNamespacesOptions

SetLimit : Allow user to set Limit

func (*GetNamespacesOptions) SetOffset

func (options *GetNamespacesOptions) SetOffset(offset int64) *GetNamespacesOptions

SetOffset : Allow user to set Offset

type IbmCloudFunctionsNamespaceAPIV1

type IbmCloudFunctionsNamespaceAPIV1 struct {
	Service *core.BaseService
}

IbmCloudFunctionsNamespaceAPIV1 : The purpose is to provide an API to manage IBM Cloud Functions namespaces

Version: 1.0

func NewIbmCloudFunctionsNamespaceAPIV1

func NewIbmCloudFunctionsNamespaceAPIV1(options *IbmCloudFunctionsNamespaceOptions) (service *IbmCloudFunctionsNamespaceAPIV1, err error)

NewIbmCloudFunctionsNamespaceAPIV1 : constructs an instance of IbmCloudFunctionsNamespaceAPIV1 with passed in options.

func NewIbmCloudFunctionsNamespaceAPIV1UsingExternalConfig

func NewIbmCloudFunctionsNamespaceAPIV1UsingExternalConfig(options *IbmCloudFunctionsNamespaceOptions) (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1, err error)

NewIbmCloudFunctionsNamespaceAPIV1UsingExternalConfig : constructs an instance of IbmCloudFunctionsNamespaceAPIV1 with passed in options and external configuration.

func (*IbmCloudFunctionsNamespaceAPIV1) CreateNamespace

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) CreateNamespace(createNamespaceOptions *CreateNamespaceOptions) (result *NamespaceCreateResponse, response *core.DetailedResponse, err error)

CreateNamespace : Create an IBM Cloud Functions namespace The IBM Cloud artefacts created for the namespace can be inspected with following commands: 1. IBM Cloud Namespace service instance <br/>ibmcloud resource service-instances<br/><br/> In addition the following IBM Cloud artefacts will be created and MUST NOT BE DELETED 2. IBM Cloud Namespace ServiceID. All actions defined in this namespace will run with this ServiceID. <br/>ibmcloud iam service-ids 3. API key for the serviceID: Used to authenticate the ServiceID <br/>ibmcloud iam service-API-keys SERVICEID.

func (*IbmCloudFunctionsNamespaceAPIV1) DeleteNamespace

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) DeleteNamespace(deleteNamespaceOptions *DeleteNamespaceOptions) (response *core.DetailedResponse, err error)

DeleteNamespace : Delete an IBM Cloud Functions namespace Delete an IBM Cloud Functions namespace.

func (*IbmCloudFunctionsNamespaceAPIV1) GetCloudFoundaryNamespaces

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) GetCloudFoundaryNamespaces(getNamespacesOptions *GetNamespacesOptions) (result *NamespaceResponseList, response *core.DetailedResponse, err error)

GetCloudFoundaryNamespaces : Retrieve all IBM Cloud Functions namespaces (Only classic) Compatibility: If passing basic authorization instead of an IAM access token the classic namespace associated with these authorization credentials is returned.

func (*IbmCloudFunctionsNamespaceAPIV1) GetNamespace

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) GetNamespace(getNamespaceOptions *GetNamespaceOptions) (result *NamespaceResponse, response *core.DetailedResponse, err error)

GetNamespace : Retrieve an IBM Cloud Functions namespace Retrieve an IBM Cloud Functions namespace.

func (*IbmCloudFunctionsNamespaceAPIV1) GetNamespaces

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) GetNamespaces(getNamespacesOptions *GetNamespacesOptions) (result *NamespaceResponseList, response *core.DetailedResponse, err error)

GetNamespaces : Retrieve all IBM Cloud Functions namespaces (classic and IAM) Compatibility: If passing basic authorization instead of an IAM access token the classic namespace associated with these authorization credentials is returned.

func (*IbmCloudFunctionsNamespaceAPIV1) MigrateNamespace

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) MigrateNamespace(migrateNamespaceOptions *MigrateNamespaceOptions) (result *NamespaceCreateResponse, response *core.DetailedResponse, err error)

MigrateNamespace : Migrate a classic namespace and create an IAM enabled IBM Cloud Functions namespace A classic namespace can be migrated only once.

func (*IbmCloudFunctionsNamespaceAPIV1) NewCreateNamespaceOptions

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) NewCreateNamespaceOptions(name string, resourceGroupID string, resourcePlanID string) *CreateNamespaceOptions

NewCreateNamespaceOptions : Instantiate CreateNamespaceOptions

func (*IbmCloudFunctionsNamespaceAPIV1) NewDeleteNamespaceOptions

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) NewDeleteNamespaceOptions(ID string) *DeleteNamespaceOptions

NewDeleteNamespaceOptions : Instantiate DeleteNamespaceOptions

func (*IbmCloudFunctionsNamespaceAPIV1) NewGetNamespaceOptions

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) NewGetNamespaceOptions(ID string) *GetNamespaceOptions

NewGetNamespaceOptions : Instantiate GetNamespaceOptions

func (*IbmCloudFunctionsNamespaceAPIV1) NewGetNamespacesOptions

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) NewGetNamespacesOptions() *GetNamespacesOptions

NewGetNamespacesOptions : Instantiate GetNamespacesOptions

func (*IbmCloudFunctionsNamespaceAPIV1) NewMigrateNamespaceOptions

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) NewMigrateNamespaceOptions(ID string, name string, resourceGroupID string, resourcePlanID string) *MigrateNamespaceOptions

NewMigrateNamespaceOptions : Instantiate MigrateNamespaceOptions

func (*IbmCloudFunctionsNamespaceAPIV1) NewUpdateNamespaceAPIKeyOptions

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) NewUpdateNamespaceAPIKeyOptions(ID string) *UpdateNamespaceAPIKeyOptions

NewUpdateNamespaceAPIKeyOptions : Instantiate UpdateNamespaceAPIKeyOptions

func (*IbmCloudFunctionsNamespaceAPIV1) NewUpdateNamespaceOptions

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) NewUpdateNamespaceOptions(ID string) *UpdateNamespaceOptions

NewUpdateNamespaceOptions : Instantiate UpdateNamespaceOptions

func (*IbmCloudFunctionsNamespaceAPIV1) SetServiceURL

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*IbmCloudFunctionsNamespaceAPIV1) UpdateNamespace

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) UpdateNamespace(updateNamespaceOptions *UpdateNamespaceOptions) (result *NamespaceResponse, response *core.DetailedResponse, err error)

UpdateNamespace : Update an IBM Cloud Functions namespace Update an IBM Cloud Functions namespace.

func (*IbmCloudFunctionsNamespaceAPIV1) UpdateNamespaceAPIKey

func (ibmCloudFunctionsNamespaceAPI *IbmCloudFunctionsNamespaceAPIV1) UpdateNamespaceAPIKey(updateNamespaceAPIKeyOptions *UpdateNamespaceAPIKeyOptions) (result *NamespaceResponse, response *core.DetailedResponse, err error)

UpdateNamespaceAPIKey : Update an IBM Cloud Functions namespace API key If a serviceid is passed this serviceid will be used to generate the API key. The serviceid will get the name of the namespace and the description will get the namespace id. Finally the serviceid will be locked.

type IbmCloudFunctionsNamespaceOptions

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

IbmCloudFunctionsNamespaceOptions : Service options

type MigrateNamespaceOptions

type MigrateNamespaceOptions struct {

	// The id of the classic namespace to migrate.
	ID *string `json:"id" validate:"required"`

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

	// Resourcegroupid of resource group the namespace resource should be placed in. Use 'ibmcloud resource groups' to
	// query your resources groups and their ids.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// Resourceplanid to use, e.g. 'functions-base-plan'.
	ResourcePlanID *string `json:"resource_plan_id" validate:"required"`

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

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

MigrateNamespaceOptions : The MigrateNamespace options.

func (*MigrateNamespaceOptions) SetDescription

func (options *MigrateNamespaceOptions) SetDescription(description string) *MigrateNamespaceOptions

SetDescription : Allow user to set Description

func (*MigrateNamespaceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*MigrateNamespaceOptions) SetID

SetID : Allow user to set ID

func (*MigrateNamespaceOptions) SetName

func (options *MigrateNamespaceOptions) SetName(name string) *MigrateNamespaceOptions

SetName : Allow user to set Name

func (*MigrateNamespaceOptions) SetResourceGroupID

func (options *MigrateNamespaceOptions) SetResourceGroupID(resourceGroupID string) *MigrateNamespaceOptions

SetResourceGroupID : Allow user to set ResourceGroupID

func (*MigrateNamespaceOptions) SetResourcePlanID

func (options *MigrateNamespaceOptions) SetResourcePlanID(resourcePlanID string) *MigrateNamespaceOptions

SetResourcePlanID : Allow user to set ResourcePlanID

type NamespaceCreateResponse

type NamespaceCreateResponse struct {

	// Time the API key was created.
	APIKeyCreated *strfmt.DateTime `json:"API_key_created" validate:"required"`

	// ID of API key used by the namespace.
	APIKeyID *string `json:"API_key_id" validate:"required"`

	// Cloud Foundry space GUID - present if it was a classic namespace.
	ClassicSpaceguid *string `json:"classic_spaceguid,omitempty"`

	// ClassicType <br/> This attribute will be absent for an IAM namespace, a namespace which is IAM-enabled and not
	// associated with any CF space. <br/> 1 : Classic - A namespace which is associated with a CF space.  <br/> Such
	// namespace is NOT IAM-enabled and can only be used by using the legacy API key ('entitlement key'). <br/> 2 : Classic
	// IAM enabled - A namespace which is associated with a CF space and which is IAM-enabled.  <br/> It accepts IMA token
	// and legacy API key ('entitlement key') for authorization.<br/> 3 : IAM migration complete - A namespace which was/is
	// associated with a CF space, which is IAM-enabled.  <br/> It accepts only an IAM token for authorization.<br/>.
	ClassicType *int64 `json:"classic_type,omitempty"`

	// CRN of namespace.
	Crn *string `json:"crn" validate:"required"`

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

	// UUID of namespace.
	ID *string `json:"id" validate:"required"`

	// Location of the resource.
	Location *string `json:"location" validate:"required"`

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

	// Resourcegroupid of resource group the namespace resource was placed in.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// Resourceplanid used.
	ResourcePlanID *string `json:"resource_plan_id" validate:"required"`

	// Serviceid used by the namespace.
	ServiceID *string `json:"service_id" validate:"required"`
}

NamespaceCreateResponse : NamespaceCreateResponse - create/get response.

type NamespaceDeleteResponse

type NamespaceDeleteResponse struct {

	// UUID of deleted namespace.
	ID *string `json:"id" validate:"required"`
}

NamespaceDeleteResponse : NamespaceDeleteResponse - delete response.

type NamespaceResource

type NamespaceResource interface {
	GetID() string
	GetLocation() string
	GetName() string
	GetUUID() string
	GetKey() string
	IsIamEnabled() bool
	IsCf() bool
}

NamespaceResource ..

type NamespaceResponse

type NamespaceResponse struct {

	// Time the API key was activated.
	APIKeyCreated *strfmt.DateTime `json:"API_key_created,omitempty"`

	// ID of API key used by the namespace.
	APIKeyID *string `json:"API_key_id,omitempty"`

	// CF space GUID of classic namespace - present if it is or was a classic namespace.
	ClassicSpaceguid *string `json:"classic_spaceguid,omitempty"`

	// ClassicType <br/> This attribute will be absent for an IAM namespace, a namespace which is IAM-enabled and not
	// associated with any CF space. <br/> 1 : Classic - A namespace which is associated with a CF space.  <br/> Such
	// namespace is NOT IAM-enabled and can only be used by using the legacy API key ('entitlement key'). <br/> 2 : Classic
	// IAM enabled - A namespace which is associated with a CF space and which is IAM-enabled.  <br/> It accepts IMA token
	// and legacy API key ('entitlement key') for authorization.<br/> 3 : IAM migration complete - A namespace which was/is
	// associated with a CF space, which is IAM-enabled.  <br/> It accepts only an IAM token for authorization.<br/>.
	ClassicType *int64 `json:"classic_type,omitempty"`

	// CRN of namespace - absent if namespace is NOT IAM-enabled.
	Crn *string `json:"crn,omitempty"`

	// Description - absent if namespace is NOT IAM-enabled.
	Description *string `json:"description,omitempty"`

	// UUID of namespace.
	ID *string `json:"id" validate:"required"`

	// Location of the resource.
	Location *string `json:"location" validate:"required"`

	// Name - absent if namespace is NOT IAM-enabled.
	Name *string `json:"name,omitempty"`

	// Resourceplanid used - absent if namespace is NOT IAM-enabled.
	ResourcePlanID *string `json:"resource_plan_id,omitempty"`

	// Resourcegrpid used - absent if namespace is NOT IAM-enabled.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// Serviceid used by the namespace - absent if namespace is NOT IAM-enabled.
	ServiceID *string `json:"service_id,omitempty"`

	// Key used by the cf based namespace.
	Key string `json:"key,omitempty"`

	// UUID used by the cf based namespace.
	UUID string `json:"uuid,omitempty"`
}

NamespaceResponse : NamespaceResponse - create/get response.

func (*NamespaceResponse) GetID

func (ns *NamespaceResponse) GetID() string

GetID ..

func (*NamespaceResponse) GetKey

func (ns *NamespaceResponse) GetKey() string

GetKey ..

func (*NamespaceResponse) GetLocation

func (ns *NamespaceResponse) GetLocation() string

GetLocation ..

func (*NamespaceResponse) GetName

func (ns *NamespaceResponse) GetName() string

GetName ..

func (*NamespaceResponse) GetUUID

func (ns *NamespaceResponse) GetUUID() string

GetUUID ..

func (*NamespaceResponse) IsCf

func (ns *NamespaceResponse) IsCf() bool

IsCf ..

func (*NamespaceResponse) IsIamEnabled

func (ns *NamespaceResponse) IsIamEnabled() bool

IsIamEnabled ..

type NamespaceResponseList

type NamespaceResponseList struct {

	// Maximum number of namespaces to return.
	Limit *int64 `json:"limit" validate:"required"`

	// List of namespaces.
	Namespaces []NamespaceResponse `json:"namespaces" validate:"required"`

	// Number of namespaces to skip.
	Offset *int64 `json:"offset" validate:"required"`

	// Total number of namespaces available.
	TotalCount *int64 `json:"total_count" validate:"required"`
}

NamespaceResponseList : NamespaceResponseList -.

func (*NamespaceResponseList) GetNamespaces

func (nsl *NamespaceResponseList) GetNamespaces() []NamespaceResource

GetNamespaces ..

type UpdateNamespaceAPIKeyOptions

type UpdateNamespaceAPIKeyOptions struct {

	// The id of the namespace to update the API key.
	ID *string `json:"id" validate:"required"`

	// If passed this serviceid will replace the current used serviceid Note: Serviceid will get the name of the namespace.
	// Description will get the namespace id. Finally the serviceid will locked.
	ServiceID *string `json:"service_id,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

UpdateNamespaceAPIKeyOptions : The UpdateNamespaceAPIKey options.

func (*UpdateNamespaceAPIKeyOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateNamespaceAPIKeyOptions) SetID

SetID : Allow user to set ID

func (*UpdateNamespaceAPIKeyOptions) SetServiceID

func (options *UpdateNamespaceAPIKeyOptions) SetServiceID(serviceID string) *UpdateNamespaceAPIKeyOptions

SetServiceID : Allow user to set ServiceID

type UpdateNamespaceOptions

type UpdateNamespaceOptions struct {

	// The id of the namespace to update.
	ID *string `json:"id" validate:"required"`

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

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

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

UpdateNamespaceOptions : The UpdateNamespace options.

func (*UpdateNamespaceOptions) SetDescription

func (options *UpdateNamespaceOptions) SetDescription(description string) *UpdateNamespaceOptions

SetDescription : Allow user to set Description

func (*UpdateNamespaceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateNamespaceOptions) SetID

SetID : Allow user to set ID

func (*UpdateNamespaceOptions) SetName

func (options *UpdateNamespaceOptions) SetName(name string) *UpdateNamespaceOptions

SetName : Allow user to set Name

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL