db2saasv1

package
v0.0.0-...-40a65de Latest Latest
Warning

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

 Go to latest Published: Dec 6, 2024 License: Apache-2.0 Imports: 8 Imported by: 2

Documentation

Overview

Package db2saasv1 : Operations and models for the Db2saasV1 service

Index

Constants

View Source 
const (
	PostDb2SaasUserOptions_Role_Bluadmin = "bluadmin"
	PostDb2SaasUserOptions_Role_Bluuser  = "bluuser"
)

Constants associated with the PostDb2SaasUserOptions.Role property. Role of the User.

View Source 
const (
	PostDb2SaasUserOptions_Locked_No  = "no"
	PostDb2SaasUserOptions_Locked_Yes = "yes"
)

Constants associated with the PostDb2SaasUserOptions.Locked property. Indicates if the account is locked.

View Source 
const (
	PutDb2SaasAutoscaleOptions_AutoScalingEnabled_False = "false"
	PutDb2SaasAutoscaleOptions_AutoScalingEnabled_True  = "true"
)

Constants associated with the PutDb2SaasAutoscaleOptions.AutoScalingEnabled property. Indicates if automatic scaling is enabled or not.

View Source 
const (
	PutDb2SaasAutoscaleOptions_AutoScalingAllowPlanLimit_No  = "NO"
	PutDb2SaasAutoscaleOptions_AutoScalingAllowPlanLimit_Yes = "YES"
)

Constants associated with the PutDb2SaasAutoscaleOptions.AutoScalingAllowPlanLimit property. Indicates the maximum number of scaling actions that are allowed within a specified time period.

View Source 
const (
	SuccessGetUserByID_Role_Bluadmin = "bluadmin"
	SuccessGetUserByID_Role_Bluuser  = "bluuser"
)

Constants associated with the SuccessGetUserByID.Role property. Role assigned to the user.

View Source 
const (
	SuccessGetUserByID_Locked_No  = "no"
	SuccessGetUserByID_Locked_Yes = "yes"
)

Constants associated with the SuccessGetUserByID.Locked property. Account lock status for the user.

View Source 
const (
	SuccessGetUserInfoResourcesItem_Role_Bluadmin = "bluadmin"
	SuccessGetUserInfoResourcesItem_Role_Bluuser  = "bluuser"
)

Constants associated with the SuccessGetUserInfoResourcesItem.Role property. Role assigned to the user.

View Source 
const (
	SuccessGetUserInfoResourcesItem_Locked_No  = "no"
	SuccessGetUserInfoResourcesItem_Locked_Yes = "yes"
)

Constants associated with the SuccessGetUserInfoResourcesItem.Locked property. Account lock status for the user.

View Source 
const (
	SuccessUserResponse_Role_Bluadmin = "bluadmin"
	SuccessUserResponse_Role_Bluuser  = "bluuser"
)

Constants associated with the SuccessUserResponse.Role property. Role assigned to the user.

View Source 
const (
	SuccessUserResponse_Locked_No  = "no"
	SuccessUserResponse_Locked_Yes = "yes"
)

Constants associated with the SuccessUserResponse.Locked property. Account lock status for the user.

View Source 
const DefaultServiceName = "db2saas"

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

View Source 
const DefaultServiceURL = "https://us-south.db2.saas.ibm.com/dbapi/v4"

DefaultServiceURL is the default URL to make service requests to.

View Source 
const ParameterizedServiceURL = "https://{region}.db2.saas.ibm.com/dbapi/v4"

Variables

This section is empty.

Functions

func ConstructServiceURL 

func ConstructServiceURL(providedUrlVariables map[string]string) (string, error)

ConstructServiceURL constructs a service URL from the parameterized URL.

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalCreateUserAuthentication 

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

UnmarshalCreateUserAuthentication unmarshals an instance of CreateUserAuthentication from the specified map of raw messages.

func UnmarshalIpAddress 

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

UnmarshalIpAddress unmarshals an instance of IpAddress from the specified map of raw messages.

func UnmarshalSuccessAutoScaling 

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

UnmarshalSuccessAutoScaling unmarshals an instance of SuccessAutoScaling from the specified map of raw messages.

func UnmarshalSuccessConnectionInfo 

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

UnmarshalSuccessConnectionInfo unmarshals an instance of SuccessConnectionInfo from the specified map of raw messages.

func UnmarshalSuccessConnectionInfoPrivate 

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

UnmarshalSuccessConnectionInfoPrivate unmarshals an instance of SuccessConnectionInfoPrivate from the specified map of raw messages.

func UnmarshalSuccessConnectionInfoPublic 

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

UnmarshalSuccessConnectionInfoPublic unmarshals an instance of SuccessConnectionInfoPublic from the specified map of raw messages.

func UnmarshalSuccessGetUserByID 

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

UnmarshalSuccessGetUserByID unmarshals an instance of SuccessGetUserByID from the specified map of raw messages.

func UnmarshalSuccessGetUserByIDAuthentication 

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

UnmarshalSuccessGetUserByIDAuthentication unmarshals an instance of SuccessGetUserByIDAuthentication from the specified map of raw messages.

func UnmarshalSuccessGetUserInfo 

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

UnmarshalSuccessGetUserInfo unmarshals an instance of SuccessGetUserInfo from the specified map of raw messages.

func UnmarshalSuccessGetUserInfoResourcesItem 

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

UnmarshalSuccessGetUserInfoResourcesItem unmarshals an instance of SuccessGetUserInfoResourcesItem from the specified map of raw messages.

func UnmarshalSuccessGetUserInfoResourcesItemAuthentication 

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

UnmarshalSuccessGetUserInfoResourcesItemAuthentication unmarshals an instance of SuccessGetUserInfoResourcesItemAuthentication from the specified map of raw messages.

func UnmarshalSuccessGetWhitelistIPs 

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

UnmarshalSuccessGetWhitelistIPs unmarshals an instance of SuccessGetWhitelistIPs from the specified map of raw messages.

func UnmarshalSuccessPostWhitelistIPs 

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

UnmarshalSuccessPostWhitelistIPs unmarshals an instance of SuccessPostWhitelistIPs from the specified map of raw messages.

func UnmarshalSuccessUpdateAutoScale 

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

UnmarshalSuccessUpdateAutoScale unmarshals an instance of SuccessUpdateAutoScale from the specified map of raw messages.

func UnmarshalSuccessUserResponse 

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

UnmarshalSuccessUserResponse unmarshals an instance of SuccessUserResponse from the specified map of raw messages.

func UnmarshalSuccessUserResponseAuthentication 

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

UnmarshalSuccessUserResponseAuthentication unmarshals an instance of SuccessUserResponseAuthentication from the specified map of raw messages.

Types

type CreateUserAuthentication 

type CreateUserAuthentication struct {
	// Authentication method.
	Method *string `json:"method" validate:"required"`

	// Authentication policy ID.
	PolicyID *string `json:"policy_id" validate:"required"`
}

CreateUserAuthentication : CreateUserAuthentication struct

type Db2saasV1 

type Db2saasV1 struct {
	Service *core.BaseService
}

Db2saasV1 : Manage lifecycle of your Db2 on Cloud resources using the APIs.

API Version: 1.0.0

func NewDb2saasV1 

func NewDb2saasV1(options *Db2saasV1Options) (service *Db2saasV1, err error)

NewDb2saasV1 : constructs an instance of Db2saasV1 with passed in options.

func NewDb2saasV1UsingExternalConfig 

func NewDb2saasV1UsingExternalConfig(options *Db2saasV1Options) (db2saas *Db2saasV1, err error)

NewDb2saasV1UsingExternalConfig : constructs an instance of Db2saasV1 with passed in options and external configuration.

func (*Db2saasV1) Clone 

func (db2saas *Db2saasV1) Clone() *Db2saasV1

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

func (*Db2saasV1) DeleteDb2SaasUser 

func (db2saas *Db2saasV1) DeleteDb2SaasUser(deleteDb2SaasUserOptions *DeleteDb2SaasUserOptions) (result map[string]interface{}, response *core.DetailedResponse, err error)

DeleteDb2SaasUser : Delete a user (only platform admin)

func (*Db2saasV1) DeleteDb2SaasUserWithContext 

func (db2saas *Db2saasV1) DeleteDb2SaasUserWithContext(ctx context.Context, deleteDb2SaasUserOptions *DeleteDb2SaasUserOptions) (result map[string]interface{}, response *core.DetailedResponse, err error)

DeleteDb2SaasUserWithContext is an alternate form of the DeleteDb2SaasUser method which supports a Context parameter

func (*Db2saasV1) DisableRetries 

func (db2saas *Db2saasV1) DisableRetries()

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

func (*Db2saasV1) EnableRetries 

func (db2saas *Db2saasV1) 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 (*Db2saasV1) GetDb2SaasAutoscale 

func (db2saas *Db2saasV1) GetDb2SaasAutoscale(getDb2SaasAutoscaleOptions *GetDb2SaasAutoscaleOptions) (result *SuccessAutoScaling, response *core.DetailedResponse, err error)

GetDb2SaasAutoscale : Get auto scaling info

func (*Db2saasV1) GetDb2SaasAutoscaleWithContext 

func (db2saas *Db2saasV1) GetDb2SaasAutoscaleWithContext(ctx context.Context, getDb2SaasAutoscaleOptions *GetDb2SaasAutoscaleOptions) (result *SuccessAutoScaling, response *core.DetailedResponse, err error)

GetDb2SaasAutoscaleWithContext is an alternate form of the GetDb2SaasAutoscale method which supports a Context parameter

func (*Db2saasV1) GetDb2SaasConnectionInfo 

func (db2saas *Db2saasV1) GetDb2SaasConnectionInfo(getDb2SaasConnectionInfoOptions *GetDb2SaasConnectionInfoOptions) (result *SuccessConnectionInfo, response *core.DetailedResponse, err error)

GetDb2SaasConnectionInfo : Get Db2 connection information

func (*Db2saasV1) GetDb2SaasConnectionInfoWithContext 

func (db2saas *Db2saasV1) GetDb2SaasConnectionInfoWithContext(ctx context.Context, getDb2SaasConnectionInfoOptions *GetDb2SaasConnectionInfoOptions) (result *SuccessConnectionInfo, response *core.DetailedResponse, err error)

GetDb2SaasConnectionInfoWithContext is an alternate form of the GetDb2SaasConnectionInfo method which supports a Context parameter

func (*Db2saasV1) GetDb2SaasUser 

func (db2saas *Db2saasV1) GetDb2SaasUser(getDb2SaasUserOptions *GetDb2SaasUserOptions) (result *SuccessGetUserInfo, response *core.DetailedResponse, err error)

GetDb2SaasUser : Get the list of Users

func (*Db2saasV1) GetDb2SaasUserWithContext 

func (db2saas *Db2saasV1) GetDb2SaasUserWithContext(ctx context.Context, getDb2SaasUserOptions *GetDb2SaasUserOptions) (result *SuccessGetUserInfo, response *core.DetailedResponse, err error)

GetDb2SaasUserWithContext is an alternate form of the GetDb2SaasUser method which supports a Context parameter

func (*Db2saasV1) GetDb2SaasWhitelist 

func (db2saas *Db2saasV1) GetDb2SaasWhitelist(getDb2SaasWhitelistOptions *GetDb2SaasWhitelistOptions) (result *SuccessGetWhitelistIPs, response *core.DetailedResponse, err error)

GetDb2SaasWhitelist : Get whitelisted IPs

func (*Db2saasV1) GetDb2SaasWhitelistWithContext 

func (db2saas *Db2saasV1) GetDb2SaasWhitelistWithContext(ctx context.Context, getDb2SaasWhitelistOptions *GetDb2SaasWhitelistOptions) (result *SuccessGetWhitelistIPs, response *core.DetailedResponse, err error)

GetDb2SaasWhitelistWithContext is an alternate form of the GetDb2SaasWhitelist method which supports a Context parameter

func (*Db2saasV1) GetEnableGzipCompression 

func (db2saas *Db2saasV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*Db2saasV1) GetServiceURL 

func (db2saas *Db2saasV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*Db2saasV1) GetbyidDb2SaasUser 

func (db2saas *Db2saasV1) GetbyidDb2SaasUser(getbyidDb2SaasUserOptions *GetbyidDb2SaasUserOptions) (result *SuccessGetUserByID, response *core.DetailedResponse, err error)

GetbyidDb2SaasUser : Get specific user by Id

func (*Db2saasV1) GetbyidDb2SaasUserWithContext 

func (db2saas *Db2saasV1) GetbyidDb2SaasUserWithContext(ctx context.Context, getbyidDb2SaasUserOptions *GetbyidDb2SaasUserOptions) (result *SuccessGetUserByID, response *core.DetailedResponse, err error)

GetbyidDb2SaasUserWithContext is an alternate form of the GetbyidDb2SaasUser method which supports a Context parameter

func (*Db2saasV1) NewCreateUserAuthentication 

func (*Db2saasV1) NewCreateUserAuthentication(method string, policyID string) (_model *CreateUserAuthentication, err error)

NewCreateUserAuthentication : Instantiate CreateUserAuthentication (Generic Model Constructor)

func (*Db2saasV1) NewDeleteDb2SaasUserOptions 

func (*Db2saasV1) NewDeleteDb2SaasUserOptions(xDeploymentID string, id string) *DeleteDb2SaasUserOptions

NewDeleteDb2SaasUserOptions : Instantiate DeleteDb2SaasUserOptions

func (*Db2saasV1) NewGetDb2SaasAutoscaleOptions 

func (*Db2saasV1) NewGetDb2SaasAutoscaleOptions(xDbProfile string) *GetDb2SaasAutoscaleOptions

NewGetDb2SaasAutoscaleOptions : Instantiate GetDb2SaasAutoscaleOptions

func (*Db2saasV1) NewGetDb2SaasConnectionInfoOptions 

func (*Db2saasV1) NewGetDb2SaasConnectionInfoOptions(deploymentID string, xDeploymentID string) *GetDb2SaasConnectionInfoOptions

NewGetDb2SaasConnectionInfoOptions : Instantiate GetDb2SaasConnectionInfoOptions

func (*Db2saasV1) NewGetDb2SaasUserOptions 

func (*Db2saasV1) NewGetDb2SaasUserOptions(xDeploymentID string) *GetDb2SaasUserOptions

NewGetDb2SaasUserOptions : Instantiate GetDb2SaasUserOptions

func (*Db2saasV1) NewGetDb2SaasWhitelistOptions 

func (*Db2saasV1) NewGetDb2SaasWhitelistOptions(xDeploymentID string) *GetDb2SaasWhitelistOptions

NewGetDb2SaasWhitelistOptions : Instantiate GetDb2SaasWhitelistOptions

func (*Db2saasV1) NewGetbyidDb2SaasUserOptions 

func (*Db2saasV1) NewGetbyidDb2SaasUserOptions(xDeploymentID string) *GetbyidDb2SaasUserOptions

NewGetbyidDb2SaasUserOptions : Instantiate GetbyidDb2SaasUserOptions

func (*Db2saasV1) NewIpAddress 

func (*Db2saasV1) NewIpAddress(address string, description string) (_model *IpAddress, err error)

NewIpAddress : Instantiate IpAddress (Generic Model Constructor)

func (*Db2saasV1) NewPostDb2SaasUserOptions 

func (*Db2saasV1) NewPostDb2SaasUserOptions(xDeploymentID string, id string, iam bool, ibmid string, name string, password string, role string, email string, locked string, authentication *CreateUserAuthentication) *PostDb2SaasUserOptions

NewPostDb2SaasUserOptions : Instantiate PostDb2SaasUserOptions

func (*Db2saasV1) NewPostDb2SaasWhitelistOptions 

func (*Db2saasV1) NewPostDb2SaasWhitelistOptions(xDeploymentID string, ipAddresses []IpAddress) *PostDb2SaasWhitelistOptions

NewPostDb2SaasWhitelistOptions : Instantiate PostDb2SaasWhitelistOptions

func (*Db2saasV1) NewPutDb2SaasAutoscaleOptions 

func (*Db2saasV1) NewPutDb2SaasAutoscaleOptions(xDbProfile string) *PutDb2SaasAutoscaleOptions

NewPutDb2SaasAutoscaleOptions : Instantiate PutDb2SaasAutoscaleOptions

func (*Db2saasV1) PostDb2SaasUser 

func (db2saas *Db2saasV1) PostDb2SaasUser(postDb2SaasUserOptions *PostDb2SaasUserOptions) (result *SuccessUserResponse, response *core.DetailedResponse, err error)

PostDb2SaasUser : Create new user ( available only for platform users)

func (*Db2saasV1) PostDb2SaasUserWithContext 

func (db2saas *Db2saasV1) PostDb2SaasUserWithContext(ctx context.Context, postDb2SaasUserOptions *PostDb2SaasUserOptions) (result *SuccessUserResponse, response *core.DetailedResponse, err error)

PostDb2SaasUserWithContext is an alternate form of the PostDb2SaasUser method which supports a Context parameter

func (*Db2saasV1) PostDb2SaasWhitelist 

func (db2saas *Db2saasV1) PostDb2SaasWhitelist(postDb2SaasWhitelistOptions *PostDb2SaasWhitelistOptions) (result *SuccessPostWhitelistIPs, response *core.DetailedResponse, err error)

PostDb2SaasWhitelist : Whitelisting of new IPs

func (*Db2saasV1) PostDb2SaasWhitelistWithContext 

func (db2saas *Db2saasV1) PostDb2SaasWhitelistWithContext(ctx context.Context, postDb2SaasWhitelistOptions *PostDb2SaasWhitelistOptions) (result *SuccessPostWhitelistIPs, response *core.DetailedResponse, err error)

PostDb2SaasWhitelistWithContext is an alternate form of the PostDb2SaasWhitelist method which supports a Context parameter

func (*Db2saasV1) PutDb2SaasAutoscale 

func (db2saas *Db2saasV1) PutDb2SaasAutoscale(putDb2SaasAutoscaleOptions *PutDb2SaasAutoscaleOptions) (result *SuccessUpdateAutoScale, response *core.DetailedResponse, err error)

PutDb2SaasAutoscale : Update auto scaling configuration

func (*Db2saasV1) PutDb2SaasAutoscaleWithContext 

func (db2saas *Db2saasV1) PutDb2SaasAutoscaleWithContext(ctx context.Context, putDb2SaasAutoscaleOptions *PutDb2SaasAutoscaleOptions) (result *SuccessUpdateAutoScale, response *core.DetailedResponse, err error)

PutDb2SaasAutoscaleWithContext is an alternate form of the PutDb2SaasAutoscale method which supports a Context parameter

func (*Db2saasV1) SetDefaultHeaders 

func (db2saas *Db2saasV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*Db2saasV1) SetEnableGzipCompression 

func (db2saas *Db2saasV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*Db2saasV1) SetServiceURL 

func (db2saas *Db2saasV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type Db2saasV1Options 

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

Db2saasV1Options : Service options

type DeleteDb2SaasUserOptions 

type DeleteDb2SaasUserOptions struct {
	// CRN deployment id.
	XDeploymentID *string `json:"x-deployment-id" validate:"required"`

	// id of the user.
	ID *string `json:"id" validate:"required,ne="`

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

DeleteDb2SaasUserOptions : The DeleteDb2SaasUser options.

func (*DeleteDb2SaasUserOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteDb2SaasUserOptions) SetID 

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

SetID : Allow user to set ID

func (*DeleteDb2SaasUserOptions) SetXDeploymentID 

func (_options *DeleteDb2SaasUserOptions) SetXDeploymentID(xDeploymentID string) *DeleteDb2SaasUserOptions

SetXDeploymentID : Allow user to set XDeploymentID

type GetDb2SaasAutoscaleOptions 

type GetDb2SaasAutoscaleOptions struct {
	// CRN deployment id.
	XDbProfile *string `json:"x-db-profile" validate:"required"`

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

GetDb2SaasAutoscaleOptions : The GetDb2SaasAutoscale options.

func (*GetDb2SaasAutoscaleOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetDb2SaasAutoscaleOptions) SetXDbProfile 

func (_options *GetDb2SaasAutoscaleOptions) SetXDbProfile(xDbProfile string) *GetDb2SaasAutoscaleOptions

SetXDbProfile : Allow user to set XDbProfile

type GetDb2SaasConnectionInfoOptions 

type GetDb2SaasConnectionInfoOptions struct {
	// Encoded CRN deployment id.
	DeploymentID *string `json:"deployment_id" validate:"required,ne="`

	// CRN deployment id.
	XDeploymentID *string `json:"x-deployment-id" validate:"required"`

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

GetDb2SaasConnectionInfoOptions : The GetDb2SaasConnectionInfo options.

func (*GetDb2SaasConnectionInfoOptions) SetDeploymentID 

func (_options *GetDb2SaasConnectionInfoOptions) SetDeploymentID(deploymentID string) *GetDb2SaasConnectionInfoOptions

SetDeploymentID : Allow user to set DeploymentID

func (*GetDb2SaasConnectionInfoOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetDb2SaasConnectionInfoOptions) SetXDeploymentID 

func (_options *GetDb2SaasConnectionInfoOptions) SetXDeploymentID(xDeploymentID string) *GetDb2SaasConnectionInfoOptions

SetXDeploymentID : Allow user to set XDeploymentID

type GetDb2SaasUserOptions 

type GetDb2SaasUserOptions struct {
	// CRN deployment id.
	XDeploymentID *string `json:"x-deployment-id" validate:"required"`

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

GetDb2SaasUserOptions : The GetDb2SaasUser options.

func (*GetDb2SaasUserOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetDb2SaasUserOptions) SetXDeploymentID 

func (_options *GetDb2SaasUserOptions) SetXDeploymentID(xDeploymentID string) *GetDb2SaasUserOptions

SetXDeploymentID : Allow user to set XDeploymentID

type GetDb2SaasWhitelistOptions 

type GetDb2SaasWhitelistOptions struct {
	// CRN deployment id.
	XDeploymentID *string `json:"x-deployment-id" validate:"required"`

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

GetDb2SaasWhitelistOptions : The GetDb2SaasWhitelist options.

func (*GetDb2SaasWhitelistOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetDb2SaasWhitelistOptions) SetXDeploymentID 

func (_options *GetDb2SaasWhitelistOptions) SetXDeploymentID(xDeploymentID string) *GetDb2SaasWhitelistOptions

SetXDeploymentID : Allow user to set XDeploymentID

type GetbyidDb2SaasUserOptions 

type GetbyidDb2SaasUserOptions struct {
	// CRN deployment id.
	XDeploymentID *string `json:"x-deployment-id" validate:"required"`

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

GetbyidDb2SaasUserOptions : The GetbyidDb2SaasUser options.

func (*GetbyidDb2SaasUserOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetbyidDb2SaasUserOptions) SetXDeploymentID 

func (_options *GetbyidDb2SaasUserOptions) SetXDeploymentID(xDeploymentID string) *GetbyidDb2SaasUserOptions

SetXDeploymentID : Allow user to set XDeploymentID

type IpAddress 

type IpAddress struct {
	// The IP address, in IPv4/ipv6 format.
	Address *string `json:"address" validate:"required"`

	// Description of the IP address.
	Description *string `json:"description" validate:"required"`
}

IpAddress : Details of an IP address.

type PostDb2SaasUserOptions 

type PostDb2SaasUserOptions struct {
	// CRN deployment id.
	XDeploymentID *string `json:"x-deployment-id" validate:"required"`

	// The id of the User.
	ID *string `json:"id" validate:"required"`

	// Indicates if IAM is enabled.
	Iam *bool `json:"iam" validate:"required"`

	// IBM ID of the User.
	Ibmid *string `json:"ibmid" validate:"required"`

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

	// Password of the User.
	Password *string `json:"password" validate:"required"`

	// Role of the User.
	Role *string `json:"role" validate:"required"`

	// Email of the User.
	Email *string `json:"email" validate:"required"`

	// Indicates if the account is locked.
	Locked *string `json:"locked" validate:"required"`

	Authentication *CreateUserAuthentication `json:"authentication" validate:"required"`

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

PostDb2SaasUserOptions : The PostDb2SaasUser options.

func (*PostDb2SaasUserOptions) SetAuthentication 

func (_options *PostDb2SaasUserOptions) SetAuthentication(authentication *CreateUserAuthentication) *PostDb2SaasUserOptions

SetAuthentication : Allow user to set Authentication

func (*PostDb2SaasUserOptions) SetEmail 

func (_options *PostDb2SaasUserOptions) SetEmail(email string) *PostDb2SaasUserOptions

SetEmail : Allow user to set Email

func (*PostDb2SaasUserOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*PostDb2SaasUserOptions) SetID 

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

SetID : Allow user to set ID

func (*PostDb2SaasUserOptions) SetIam 

func (_options *PostDb2SaasUserOptions) SetIam(iam bool) *PostDb2SaasUserOptions

SetIam : Allow user to set Iam

func (*PostDb2SaasUserOptions) SetIbmid 

func (_options *PostDb2SaasUserOptions) SetIbmid(ibmid string) *PostDb2SaasUserOptions

SetIbmid : Allow user to set Ibmid

func (*PostDb2SaasUserOptions) SetLocked 

func (_options *PostDb2SaasUserOptions) SetLocked(locked string) *PostDb2SaasUserOptions

SetLocked : Allow user to set Locked

func (*PostDb2SaasUserOptions) SetName 

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

SetName : Allow user to set Name

func (*PostDb2SaasUserOptions) SetPassword 

func (_options *PostDb2SaasUserOptions) SetPassword(password string) *PostDb2SaasUserOptions

SetPassword : Allow user to set Password

func (*PostDb2SaasUserOptions) SetRole 

func (_options *PostDb2SaasUserOptions) SetRole(role string) *PostDb2SaasUserOptions

SetRole : Allow user to set Role

func (*PostDb2SaasUserOptions) SetXDeploymentID 

func (_options *PostDb2SaasUserOptions) SetXDeploymentID(xDeploymentID string) *PostDb2SaasUserOptions

SetXDeploymentID : Allow user to set XDeploymentID

type PostDb2SaasWhitelistOptions 

type PostDb2SaasWhitelistOptions struct {
	// CRN deployment id.
	XDeploymentID *string `json:"x-deployment-id" validate:"required"`

	// List of IP addresses.
	IpAddresses []IpAddress `json:"ip_addresses" validate:"required"`

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

PostDb2SaasWhitelistOptions : The PostDb2SaasWhitelist options.

func (*PostDb2SaasWhitelistOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*PostDb2SaasWhitelistOptions) SetIpAddresses 

func (_options *PostDb2SaasWhitelistOptions) SetIpAddresses(ipAddresses []IpAddress) *PostDb2SaasWhitelistOptions

SetIpAddresses : Allow user to set IpAddresses

func (*PostDb2SaasWhitelistOptions) SetXDeploymentID 

func (_options *PostDb2SaasWhitelistOptions) SetXDeploymentID(xDeploymentID string) *PostDb2SaasWhitelistOptions

SetXDeploymentID : Allow user to set XDeploymentID

type PutDb2SaasAutoscaleOptions 

type PutDb2SaasAutoscaleOptions struct {
	// CRN deployment id.
	XDbProfile *string `json:"x-db-profile" validate:"required"`

	// Indicates if automatic scaling is enabled or not.
	AutoScalingEnabled *string `json:"auto_scaling_enabled,omitempty"`

	// Specifies the resource utilization level that triggers an auto-scaling.
	AutoScalingThreshold *int64 `json:"auto_scaling_threshold,omitempty"`

	// Defines the time period over which auto-scaling adjustments are monitored and applied.
	AutoScalingOverTimePeriod *float64 `json:"auto_scaling_over_time_period,omitempty"`

	// Specifies the duration to pause auto-scaling actions after a scaling event has occurred.
	AutoScalingPauseLimit *int64 `json:"auto_scaling_pause_limit,omitempty"`

	// Indicates the maximum number of scaling actions that are allowed within a specified time period.
	AutoScalingAllowPlanLimit *string `json:"auto_scaling_allow_plan_limit,omitempty"`

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

PutDb2SaasAutoscaleOptions : The PutDb2SaasAutoscale options.

func (*PutDb2SaasAutoscaleOptions) SetAutoScalingAllowPlanLimit 

func (_options *PutDb2SaasAutoscaleOptions) SetAutoScalingAllowPlanLimit(autoScalingAllowPlanLimit string) *PutDb2SaasAutoscaleOptions

SetAutoScalingAllowPlanLimit : Allow user to set AutoScalingAllowPlanLimit

func (*PutDb2SaasAutoscaleOptions) SetAutoScalingEnabled 

func (_options *PutDb2SaasAutoscaleOptions) SetAutoScalingEnabled(autoScalingEnabled string) *PutDb2SaasAutoscaleOptions

SetAutoScalingEnabled : Allow user to set AutoScalingEnabled

func (*PutDb2SaasAutoscaleOptions) SetAutoScalingOverTimePeriod 

func (_options *PutDb2SaasAutoscaleOptions) SetAutoScalingOverTimePeriod(autoScalingOverTimePeriod float64) *PutDb2SaasAutoscaleOptions

SetAutoScalingOverTimePeriod : Allow user to set AutoScalingOverTimePeriod

func (*PutDb2SaasAutoscaleOptions) SetAutoScalingPauseLimit 

func (_options *PutDb2SaasAutoscaleOptions) SetAutoScalingPauseLimit(autoScalingPauseLimit int64) *PutDb2SaasAutoscaleOptions

SetAutoScalingPauseLimit : Allow user to set AutoScalingPauseLimit

func (*PutDb2SaasAutoscaleOptions) SetAutoScalingThreshold 

func (_options *PutDb2SaasAutoscaleOptions) SetAutoScalingThreshold(autoScalingThreshold int64) *PutDb2SaasAutoscaleOptions

SetAutoScalingThreshold : Allow user to set AutoScalingThreshold

func (*PutDb2SaasAutoscaleOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*PutDb2SaasAutoscaleOptions) SetXDbProfile 

func (_options *PutDb2SaasAutoscaleOptions) SetXDbProfile(xDbProfile string) *PutDb2SaasAutoscaleOptions

SetXDbProfile : Allow user to set XDbProfile

type SuccessAutoScaling 

type SuccessAutoScaling struct {
	// Indicates the maximum number of scaling actions that are allowed within a specified time period.
	AutoScalingAllowPlanLimit *bool `json:"auto_scaling_allow_plan_limit" validate:"required"`

	// Indicates if automatic scaling is enabled or not.
	AutoScalingEnabled *bool `json:"auto_scaling_enabled" validate:"required"`

	// The maximum limit for automatically increasing storage capacity to handle growing data needs.
	AutoScalingMaxStorage *int64 `json:"auto_scaling_max_storage" validate:"required"`

	// Defines the time period over which auto-scaling adjustments are monitored and applied.
	AutoScalingOverTimePeriod *int64 `json:"auto_scaling_over_time_period" validate:"required"`

	// Specifies the duration to pause auto-scaling actions after a scaling event has occurred.
	AutoScalingPauseLimit *int64 `json:"auto_scaling_pause_limit" validate:"required"`

	// Specifies the resource utilization level that triggers an auto-scaling.
	AutoScalingThreshold *int64 `json:"auto_scaling_threshold" validate:"required"`

	// Specifies the unit of measurement for storage capacity.
	StorageUnit *string `json:"storage_unit" validate:"required"`

	// Represents the percentage of total storage capacity currently in use.
	StorageUtilizationPercentage *int64 `json:"storage_utilization_percentage" validate:"required"`

	// Indicates whether a system or service can automatically adjust resources based on demand.
	SupportAutoScaling *bool `json:"support_auto_scaling" validate:"required"`
}

SuccessAutoScaling : The details of the autoscale.

type SuccessConnectionInfo 

type SuccessConnectionInfo struct {
	Public *SuccessConnectionInfoPublic `json:"public,omitempty"`

	Private *SuccessConnectionInfoPrivate `json:"private,omitempty"`
}

SuccessConnectionInfo : Responds with JSON of the connection information for the Db2 SaaS Instance.

type SuccessConnectionInfoPrivate 

type SuccessConnectionInfoPrivate struct {
	Hostname *string `json:"hostname,omitempty"`

	DatabaseName *string `json:"databaseName,omitempty"`

	SslPort *string `json:"sslPort,omitempty"`

	Ssl *bool `json:"ssl,omitempty"`

	DatabaseVersion *string `json:"databaseVersion,omitempty"`

	PrivateServiceName *string `json:"private_serviceName,omitempty"`

	CloudServiceOffering *string `json:"cloud_service_offering,omitempty"`

	VpeServiceCrn *string `json:"vpe_service_crn,omitempty"`

	DbVpcEndpointService *string `json:"db_vpc_endpoint_service,omitempty"`
}

SuccessConnectionInfoPrivate : SuccessConnectionInfoPrivate struct

type SuccessConnectionInfoPublic 

type SuccessConnectionInfoPublic struct {
	Hostname *string `json:"hostname,omitempty"`

	DatabaseName *string `json:"databaseName,omitempty"`

	SslPort *string `json:"sslPort,omitempty"`

	Ssl *bool `json:"ssl,omitempty"`

	DatabaseVersion *string `json:"databaseVersion,omitempty"`
}

SuccessConnectionInfoPublic : SuccessConnectionInfoPublic struct

type SuccessGetUserByID 

type SuccessGetUserByID struct {
	// User's DV role.
	DvRole *string `json:"dvRole" validate:"required"`

	// Metadata associated with the user.
	Metadata map[string]interface{} `json:"metadata" validate:"required"`

	// Formatted IBM ID.
	FormatedIbmid *string `json:"formatedIbmid" validate:"required"`

	// Role assigned to the user.
	Role *string `json:"role" validate:"required"`

	// IAM ID for the user.
	Iamid *string `json:"iamid" validate:"required"`

	// List of allowed actions of the user.
	PermittedActions []string `json:"permittedActions" validate:"required"`

	// Indicates if the user account has no issues.
	AllClean *bool `json:"allClean" validate:"required"`

	// User's password.
	Password *string `json:"password" validate:"required"`

	// Indicates if IAM is enabled or not.
	Iam *bool `json:"iam" validate:"required"`

	// The display name of the user.
	Name *string `json:"name" validate:"required"`

	// IBM ID of the user.
	Ibmid *string `json:"ibmid" validate:"required"`

	// Unique identifier for the user.
	ID *string `json:"id" validate:"required"`

	// Account lock status for the user.
	Locked *string `json:"locked" validate:"required"`

	// Initial error message.
	InitErrorMsg *string `json:"initErrorMsg" validate:"required"`

	// Email address of the user.
	Email *string `json:"email" validate:"required"`

	// Authentication details for the user.
	Authentication *SuccessGetUserByIDAuthentication `json:"authentication" validate:"required"`
}

SuccessGetUserByID : The details of the users.

type SuccessGetUserByIDAuthentication 

type SuccessGetUserByIDAuthentication struct {
	// Authentication method.
	Method *string `json:"method" validate:"required"`

	// Policy ID of authentication.
	PolicyID *string `json:"policy_id" validate:"required"`
}

SuccessGetUserByIDAuthentication : Authentication details for the user.

type SuccessGetUserInfo 

type SuccessGetUserInfo struct {
	// The total number of resources.
	Count *int64 `json:"count" validate:"required"`

	// A list of user resource.
	Resources []SuccessGetUserInfoResourcesItem `json:"resources" validate:"required"`
}

SuccessGetUserInfo : Success response of get user.

type SuccessGetUserInfoResourcesItem 

type SuccessGetUserInfoResourcesItem struct {
	// User's DV role.
	DvRole *string `json:"dvRole,omitempty"`

	// Metadata associated with the user.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Formatted IBM ID.
	FormatedIbmid *string `json:"formatedIbmid,omitempty"`

	// Role assigned to the user.
	Role *string `json:"role,omitempty"`

	// IAM ID for the user.
	Iamid *string `json:"iamid,omitempty"`

	// List of allowed actions of the user.
	PermittedActions []string `json:"permittedActions,omitempty"`

	// Indicates if the user account has no issues.
	AllClean *bool `json:"allClean,omitempty"`

	// User's password.
	Password *string `json:"password,omitempty"`

	// Indicates if IAM is enabled or not.
	Iam *bool `json:"iam,omitempty"`

	// The display name of the user.
	Name *string `json:"name,omitempty"`

	// IBM ID of the user.
	Ibmid *string `json:"ibmid,omitempty"`

	// Unique identifier for the user.
	ID *string `json:"id,omitempty"`

	// Account lock status for the user.
	Locked *string `json:"locked,omitempty"`

	// Initial error message.
	InitErrorMsg *string `json:"initErrorMsg,omitempty"`

	// Email address of the user.
	Email *string `json:"email,omitempty"`

	// Authentication details for the user.
	Authentication *SuccessGetUserInfoResourcesItemAuthentication `json:"authentication,omitempty"`
}

SuccessGetUserInfoResourcesItem : SuccessGetUserInfoResourcesItem struct

type SuccessGetUserInfoResourcesItemAuthentication 

type SuccessGetUserInfoResourcesItemAuthentication struct {
	// Authentication method.
	Method *string `json:"method" validate:"required"`

	// Policy ID of authentication.
	PolicyID *string `json:"policy_id" validate:"required"`
}

SuccessGetUserInfoResourcesItemAuthentication : Authentication details for the user.

type SuccessGetWhitelistIPs 

type SuccessGetWhitelistIPs struct {
	// List of IP addresses.
	IpAddresses []IpAddress `json:"ip_addresses" validate:"required"`
}

SuccessGetWhitelistIPs : Success response of get whitelist IPs.

type SuccessPostWhitelistIPs 

type SuccessPostWhitelistIPs struct {
	// status of the post whitelist IPs request.
	Status *string `json:"status" validate:"required"`
}

SuccessPostWhitelistIPs : Success response of post whitelist IPs.

type SuccessUpdateAutoScale 

type SuccessUpdateAutoScale struct {
	// Indicates the message of the updation.
	Message *string `json:"message" validate:"required"`
}

SuccessUpdateAutoScale : Response of successful updation of scaling configurations.

type SuccessUserResponse 

type SuccessUserResponse struct {
	// User's DV role.
	DvRole *string `json:"dvRole" validate:"required"`

	// Metadata associated with the user.
	Metadata map[string]interface{} `json:"metadata" validate:"required"`

	// Formatted IBM ID.
	FormatedIbmid *string `json:"formatedIbmid" validate:"required"`

	// Role assigned to the user.
	Role *string `json:"role" validate:"required"`

	// IAM ID for the user.
	Iamid *string `json:"iamid" validate:"required"`

	// List of allowed actions of the user.
	PermittedActions []string `json:"permittedActions" validate:"required"`

	// Indicates if the user account has no issues.
	AllClean *bool `json:"allClean" validate:"required"`

	// User's password.
	Password *string `json:"password" validate:"required"`

	// Indicates if IAM is enabled or not.
	Iam *bool `json:"iam" validate:"required"`

	// The display name of the user.
	Name *string `json:"name" validate:"required"`

	// IBM ID of the user.
	Ibmid *string `json:"ibmid" validate:"required"`

	// Unique identifier for the user.
	ID *string `json:"id" validate:"required"`

	// Account lock status for the user.
	Locked *string `json:"locked" validate:"required"`

	// Initial error message.
	InitErrorMsg *string `json:"initErrorMsg" validate:"required"`

	// Email address of the user.
	Email *string `json:"email" validate:"required"`

	// Authentication details for the user.
	Authentication *SuccessUserResponseAuthentication `json:"authentication" validate:"required"`
}

SuccessUserResponse : The details of the users.

type SuccessUserResponseAuthentication 

type SuccessUserResponseAuthentication struct {
	// Authentication method.
	Method *string `json:"method" validate:"required"`

	// Policy ID of authentication.
	PolicyID *string `json:"policy_id" validate:"required"`
}

SuccessUserResponseAuthentication : Authentication details for the user.

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.