rangeapplicationsv1

package
v0.46.1 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 9 Imported by: 5

Documentation

Overview

Package rangeapplicationsv1 : Operations and models for the RangeApplicationsV1 service

Index

Constants

View Source 
const (
	CreateRangeAppOptions_ProxyProtocol_Off    = "off"
	CreateRangeAppOptions_ProxyProtocol_Simple = "simple"
	CreateRangeAppOptions_ProxyProtocol_V1     = "v1"
	CreateRangeAppOptions_ProxyProtocol_V2     = "v2"
)

Constants associated with the CreateRangeAppOptions.ProxyProtocol property. Allows for the true client IP to be passed to the service.

View Source 
const (
	CreateRangeAppOptions_TrafficType_Direct = "direct"
	CreateRangeAppOptions_TrafficType_Http   = "http"
	CreateRangeAppOptions_TrafficType_Https  = "https"
)

Constants associated with the CreateRangeAppOptions.TrafficType property. Configure how traffic is handled at the edge. If set to "direct" traffic is passed through to the service. In the case of "http" or "https" HTTP/s features at the edge are applied ot this traffic.

View Source 
const (
	CreateRangeAppOptions_Tls_Flexible = "flexible"
	CreateRangeAppOptions_Tls_Full     = "full"
	CreateRangeAppOptions_Tls_Off      = "off"
	CreateRangeAppOptions_Tls_Strict   = "strict"
)

Constants associated with the CreateRangeAppOptions.Tls property. Configure if and how TLS connections are terminated at the edge.

View Source 
const (
	ListRangeAppsOptions_Order_AppID      = "app_id"
	ListRangeAppsOptions_Order_CreatedOn  = "created_on"
	ListRangeAppsOptions_Order_Dns        = "dns"
	ListRangeAppsOptions_Order_ModifiedOn = "modified_on"
	ListRangeAppsOptions_Order_Protocol   = "protocol"
)

Constants associated with the ListRangeAppsOptions.Order property. Field by which to order the list of Range applications.

View Source 
const (
	ListRangeAppsOptions_Direction_Asc  = "asc"
	ListRangeAppsOptions_Direction_Desc = "desc"
)

Constants associated with the ListRangeAppsOptions.Direction property. Direction in which to order results [ascending/descending order].

View Source 
const (
	RangeAppReqEdgeIps_Connectivity_All  = "all"
	RangeAppReqEdgeIps_Connectivity_Ipv4 = "ipv4"
	RangeAppReqEdgeIps_Connectivity_Ipv6 = "ipv6"
)

Constants associated with the RangeAppReqEdgeIps.Connectivity property. Specifies the IP version (or all).

View Source 
const (
	RangeApplicationObjectEdgeIps_Connectivity_All  = "all"
	RangeApplicationObjectEdgeIps_Connectivity_Ipv4 = "ipv4"
	RangeApplicationObjectEdgeIps_Connectivity_Ipv6 = "ipv6"
)

Constants associated with the RangeApplicationObjectEdgeIps.Connectivity property. Specifies the IP version (or all).

View Source 
const (
	UpdateRangeAppOptions_ProxyProtocol_Off    = "off"
	UpdateRangeAppOptions_ProxyProtocol_Simple = "simple"
	UpdateRangeAppOptions_ProxyProtocol_V1     = "v1"
	UpdateRangeAppOptions_ProxyProtocol_V2     = "v2"
)

Constants associated with the UpdateRangeAppOptions.ProxyProtocol property. Allows for the true client IP to be passed to the service.

View Source 
const (
	UpdateRangeAppOptions_TrafficType_Direct = "direct"
	UpdateRangeAppOptions_TrafficType_Http   = "http"
	UpdateRangeAppOptions_TrafficType_Https  = "https"
)

Constants associated with the UpdateRangeAppOptions.TrafficType property. Configure how traffic is handled at the edge. If set to "direct" traffic is passed through to the service. In the case of "http" or "https" HTTP/s features at the edge are applied ot this traffic.

View Source 
const (
	UpdateRangeAppOptions_Tls_Flexible = "flexible"
	UpdateRangeAppOptions_Tls_Full     = "full"
	UpdateRangeAppOptions_Tls_Off      = "off"
	UpdateRangeAppOptions_Tls_Strict   = "strict"
)

Constants associated with the UpdateRangeAppOptions.Tls property. Configure if and how TLS connections are terminated at the edge.

View Source 
const (
	RangeApplicationObject_ProxyProtocol_Off    = "off"
	RangeApplicationObject_ProxyProtocol_Simple = "simple"
	RangeApplicationObject_ProxyProtocol_V1     = "v1"
	RangeApplicationObject_ProxyProtocol_V2     = "v2"
)

Constants associated with the RangeApplicationObject.ProxyProtocol property. Allows for the true client IP to be passed to the service.

View Source 
const (
	RangeApplicationObject_Tls_Flexible = "flexible"
	RangeApplicationObject_Tls_Full     = "full"
	RangeApplicationObject_Tls_Off      = "off"
	RangeApplicationObject_Tls_Strict   = "strict"
)

Constants associated with the RangeApplicationObject.Tls property. Specifies the TLS termination at the edge.

View Source 
const (
	RangeApplicationObject_TrafficType_Direct = "direct"
	RangeApplicationObject_TrafficType_Http   = "http"
	RangeApplicationObject_TrafficType_Https  = "https"
)

Constants associated with the RangeApplicationObject.TrafficType property. Configure how traffic is handled at the edge. If set to "direct" traffic is passed through to the service. In the case of "http" or "https" HTTP/s features at the edge are applied ot this traffic.

View Source 
const DefaultServiceName = "range_applications"

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

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

DefaultServiceURL is the default URL to make service requests to.

View Source 
const (
	RangeAppReqEdgeIps_Type_Dynamic = "dynamic"
)

Constants associated with the RangeAppReqEdgeIps.Type property. The type of edge IP configuration.

View Source 
const (
	RangeApplicationObjectDns_Type_Cname = "CNAME"
)

Constants associated with the RangeApplicationObjectDns.Type property. The type of DNS record associated with the application.

View Source 
const (
	RangeApplicationObjectEdgeIps_Type_Dynamic = "dynamic"
)

Constants associated with the RangeApplicationObjectEdgeIps.Type property. The type of edge IP configuration.

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.12.1 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalRangeAppReqDns 

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

UnmarshalRangeAppReqDns unmarshals an instance of RangeAppReqDns from the specified map of raw messages.

func UnmarshalRangeAppReqEdgeIps 

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

UnmarshalRangeAppReqEdgeIps unmarshals an instance of RangeAppReqEdgeIps from the specified map of raw messages.

func UnmarshalRangeAppReqOriginDns 

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

UnmarshalRangeAppReqOriginDns unmarshals an instance of RangeAppReqOriginDns from the specified map of raw messages.

func UnmarshalRangeApplicationObject 

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

UnmarshalRangeApplicationObject unmarshals an instance of RangeApplicationObject from the specified map of raw messages.

func UnmarshalRangeApplicationObjectDns 

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

UnmarshalRangeApplicationObjectDns unmarshals an instance of RangeApplicationObjectDns from the specified map of raw messages.

func UnmarshalRangeApplicationObjectEdgeIps 

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

UnmarshalRangeApplicationObjectEdgeIps unmarshals an instance of RangeApplicationObjectEdgeIps from the specified map of raw messages.

func UnmarshalRangeApplicationResp 

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

UnmarshalRangeApplicationResp unmarshals an instance of RangeApplicationResp from the specified map of raw messages.

func UnmarshalRangeApplications 

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

UnmarshalRangeApplications unmarshals an instance of RangeApplications from the specified map of raw messages.

Types

type CreateRangeAppOptions 

type CreateRangeAppOptions struct {
	// Defines the protocol and port for this application.
	Protocol *string `json:"protocol" validate:"required"`

	// Name and type of the DNS record for this application.
	Dns *RangeAppReqDns `json:"dns" validate:"required"`

	// IP address and port of the origin for this Range application. If configuring a load balancer, use 'origin_dns' and
	// 'origin_port'. This can not be combined with 'origin_dns' and 'origin_port'.
	OriginDirect []string `json:"origin_direct,omitempty"`

	// DNS record pointing to the origin for this Range application. This is used for configuring a load balancer. When
	// specifying an individual IP address, use 'origin_direct'. This requires 'origin_port' and can not be combined with
	// 'origin_direct'.
	OriginDns *RangeAppReqOriginDns `json:"origin_dns,omitempty"`

	// Port at the origin that listens to traffic from this Range application. Requires 'origin_dns' and can not be
	// combined with 'origin_direct'.
	OriginPort *int64 `json:"origin_port,omitempty"`

	// Enables the IP Firewall for this application. Only available for TCP applications.
	IpFirewall *bool `json:"ip_firewall,omitempty"`

	// Allows for the true client IP to be passed to the service.
	ProxyProtocol *string `json:"proxy_protocol,omitempty"`

	// Configures IP version for the hostname of this application. Default is {"type":"dynamic", "connectivity":"all"}.
	EdgeIps *RangeAppReqEdgeIps `json:"edge_ips,omitempty"`

	// Configure how traffic is handled at the edge. If set to "direct" traffic is passed through to the service. In the
	// case of "http" or "https" HTTP/s features at the edge are applied ot this traffic.
	TrafficType *string `json:"traffic_type,omitempty"`

	// Configure if and how TLS connections are terminated at the edge.
	Tls *string `json:"tls,omitempty"`

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

CreateRangeAppOptions : The CreateRangeApp options.

func (*CreateRangeAppOptions) SetDns 

func (options *CreateRangeAppOptions) SetDns(dns *RangeAppReqDns) *CreateRangeAppOptions

SetDns : Allow user to set Dns

func (*CreateRangeAppOptions) SetEdgeIps 

func (options *CreateRangeAppOptions) SetEdgeIps(edgeIps *RangeAppReqEdgeIps) *CreateRangeAppOptions

SetEdgeIps : Allow user to set EdgeIps

func (*CreateRangeAppOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateRangeAppOptions) SetIpFirewall 

func (options *CreateRangeAppOptions) SetIpFirewall(ipFirewall bool) *CreateRangeAppOptions

SetIpFirewall : Allow user to set IpFirewall

func (*CreateRangeAppOptions) SetOriginDirect 

func (options *CreateRangeAppOptions) SetOriginDirect(originDirect []string) *CreateRangeAppOptions

SetOriginDirect : Allow user to set OriginDirect

func (*CreateRangeAppOptions) SetOriginDns 

func (options *CreateRangeAppOptions) SetOriginDns(originDns *RangeAppReqOriginDns) *CreateRangeAppOptions

SetOriginDns : Allow user to set OriginDns

func (*CreateRangeAppOptions) SetOriginPort 

func (options *CreateRangeAppOptions) SetOriginPort(originPort int64) *CreateRangeAppOptions

SetOriginPort : Allow user to set OriginPort

func (*CreateRangeAppOptions) SetProtocol 

func (options *CreateRangeAppOptions) SetProtocol(protocol string) *CreateRangeAppOptions

SetProtocol : Allow user to set Protocol

func (*CreateRangeAppOptions) SetProxyProtocol 

func (options *CreateRangeAppOptions) SetProxyProtocol(proxyProtocol string) *CreateRangeAppOptions

SetProxyProtocol : Allow user to set ProxyProtocol

func (*CreateRangeAppOptions) SetTls 

func (options *CreateRangeAppOptions) SetTls(tls string) *CreateRangeAppOptions

SetTls : Allow user to set Tls

func (*CreateRangeAppOptions) SetTrafficType 

func (options *CreateRangeAppOptions) SetTrafficType(trafficType string) *CreateRangeAppOptions

SetTrafficType : Allow user to set TrafficType

type DeleteRangeAppOptions 

type DeleteRangeAppOptions struct {
	// application identifier.
	AppIdentifier *string `json:"app_identifier" validate:"required,ne="`

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

DeleteRangeAppOptions : The DeleteRangeApp options.

func (*DeleteRangeAppOptions) SetAppIdentifier 

func (options *DeleteRangeAppOptions) SetAppIdentifier(appIdentifier string) *DeleteRangeAppOptions

SetAppIdentifier : Allow user to set AppIdentifier

func (*DeleteRangeAppOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

type GetRangeAppOptions 

type GetRangeAppOptions struct {
	// application identifier.
	AppIdentifier *string `json:"app_identifier" validate:"required,ne="`

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

GetRangeAppOptions : The GetRangeApp options.

func (*GetRangeAppOptions) SetAppIdentifier 

func (options *GetRangeAppOptions) SetAppIdentifier(appIdentifier string) *GetRangeAppOptions

SetAppIdentifier : Allow user to set AppIdentifier

func (*GetRangeAppOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

type ListRangeAppsOptions 

type ListRangeAppsOptions struct {
	// Page number of paginated results.
	Page *int64 `json:"page,omitempty"`

	// Maximum number of Range applications per page.
	PerPage *int64 `json:"per_page,omitempty"`

	// Field by which to order the list of Range applications.
	Order *string `json:"order,omitempty"`

	// Direction in which to order results [ascending/descending order].
	Direction *string `json:"direction,omitempty"`

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

ListRangeAppsOptions : The ListRangeApps options.

func (*ListRangeAppsOptions) SetDirection 

func (options *ListRangeAppsOptions) SetDirection(direction string) *ListRangeAppsOptions

SetDirection : Allow user to set Direction

func (*ListRangeAppsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListRangeAppsOptions) SetOrder 

func (options *ListRangeAppsOptions) SetOrder(order string) *ListRangeAppsOptions

SetOrder : Allow user to set Order

func (*ListRangeAppsOptions) SetPage 

func (options *ListRangeAppsOptions) SetPage(page int64) *ListRangeAppsOptions

SetPage : Allow user to set Page

func (*ListRangeAppsOptions) SetPerPage 

func (options *ListRangeAppsOptions) SetPerPage(perPage int64) *ListRangeAppsOptions

SetPerPage : Allow user to set PerPage

type RangeAppReqDns 

type RangeAppReqDns struct {
	// DNS record type.
	Type *string `json:"type,omitempty"`

	// DNS record name.
	Name *string `json:"name,omitempty"`
}

RangeAppReqDns : Name and type of the DNS record for this application.

type RangeAppReqEdgeIps 

type RangeAppReqEdgeIps struct {
	// The type of edge IP configuration.
	Type *string `json:"type,omitempty"`

	// Specifies the IP version (or all).
	Connectivity *string `json:"connectivity,omitempty"`
}

RangeAppReqEdgeIps : Configures IP version for the hostname of this application. Default is {"type":"dynamic", "connectivity":"all"}.

type RangeAppReqOriginDns 

type RangeAppReqOriginDns struct {
	// Name of the origin.
	Name *string `json:"name" validate:"required"`
}

RangeAppReqOriginDns : DNS record pointing to the origin for this Range application. This is used for configuring a load balancer. When specifying an individual IP address, use 'origin_direct'. This requires 'origin_port' and can not be combined with 'origin_direct'.

type RangeApplicationObject 

type RangeApplicationObject struct {
	// Application identifier.
	ID *string `json:"id,omitempty"`

	// Port configuration.
	Protocol *string `json:"protocol,omitempty"`

	// The name and type of DNS record for the Range application.
	Dns *RangeApplicationObjectDns `json:"dns,omitempty"`

	// A list of destination addresses to the origin.
	OriginDirect []string `json:"origin_direct,omitempty"`

	// Enables the IP Firewall for this application.
	IpFirewall *bool `json:"ip_firewall,omitempty"`

	// Allows for the true client IP to be passed to the service.
	ProxyProtocol *string `json:"proxy_protocol,omitempty"`

	// Configures IP version for the hostname of this application.
	EdgeIps *RangeApplicationObjectEdgeIps `json:"edge_ips,omitempty"`

	// Specifies the TLS termination at the edge.
	Tls *string `json:"tls,omitempty"`

	// Configure how traffic is handled at the edge. If set to "direct" traffic is passed through to the service. In the
	// case of "http" or "https" HTTP/s features at the edge are applied ot this traffic.
	TrafficType *string `json:"traffic_type,omitempty"`

	// When the Application was created.
	CreatedOn *strfmt.DateTime `json:"created_on,omitempty"`

	// When the Application was last modified.
	ModifiedOn *strfmt.DateTime `json:"modified_on,omitempty"`
}

RangeApplicationObject : range application object.

type RangeApplicationObjectDns 

type RangeApplicationObjectDns struct {
	// The type of DNS record associated with the application.
	Type *string `json:"type,omitempty"`

	// The name of the DNS record associated with the application.
	Name *string `json:"name,omitempty"`
}

RangeApplicationObjectDns : The name and type of DNS record for the Range application.

type RangeApplicationObjectEdgeIps 

type RangeApplicationObjectEdgeIps struct {
	// The type of edge IP configuration.
	Type *string `json:"type,omitempty"`

	// Specifies the IP version (or all).
	Connectivity *string `json:"connectivity,omitempty"`
}

RangeApplicationObjectEdgeIps : Configures IP version for the hostname of this application.

type RangeApplicationResp 

type RangeApplicationResp struct {
	// Was the get successful.
	Success *bool `json:"success" validate:"required"`

	// errors.
	Errors [][]string `json:"errors" validate:"required"`

	// messages.
	Messages [][]string `json:"messages" validate:"required"`

	// range application object.
	Result *RangeApplicationObject `json:"result" validate:"required"`
}

RangeApplicationResp : range application response.

type RangeApplications 

type RangeApplications struct {
	// Was the get successful.
	Success *bool `json:"success" validate:"required"`

	// errors.
	Errors [][]string `json:"errors" validate:"required"`

	// messages.
	Messages [][]string `json:"messages" validate:"required"`

	// Container for Range application objects.
	Result []RangeApplicationObject `json:"result" validate:"required"`
}

RangeApplications : range application.

type RangeApplicationsV1 

type RangeApplicationsV1 struct {
	Service *core.BaseService

	// Full url-encoded cloud resource name (CRN) of resource instance.
	Crn *string

	// zone identifier.
	ZoneIdentifier *string
}

RangeApplicationsV1 : Range Applications

Version: 1.0.0

func NewRangeApplicationsV1 

func NewRangeApplicationsV1(options *RangeApplicationsV1Options) (service *RangeApplicationsV1, err error)

NewRangeApplicationsV1 : constructs an instance of RangeApplicationsV1 with passed in options.

func NewRangeApplicationsV1UsingExternalConfig 

func NewRangeApplicationsV1UsingExternalConfig(options *RangeApplicationsV1Options) (rangeApplications *RangeApplicationsV1, err error)

NewRangeApplicationsV1UsingExternalConfig : constructs an instance of RangeApplicationsV1 with passed in options and external configuration.

func (*RangeApplicationsV1) Clone added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) Clone() *RangeApplicationsV1

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

func (*RangeApplicationsV1) CreateRangeApp 

func (rangeApplications *RangeApplicationsV1) CreateRangeApp(createRangeAppOptions *CreateRangeAppOptions) (result *RangeApplicationResp, response *core.DetailedResponse, err error)

CreateRangeApp : Create Range Application Create a Range Applications inside a zone.

func (*RangeApplicationsV1) CreateRangeAppWithContext added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) CreateRangeAppWithContext(ctx context.Context, createRangeAppOptions *CreateRangeAppOptions) (result *RangeApplicationResp, response *core.DetailedResponse, err error)

CreateRangeAppWithContext is an alternate form of the CreateRangeApp method which supports a Context parameter

func (*RangeApplicationsV1) DeleteRangeApp 

func (rangeApplications *RangeApplicationsV1) DeleteRangeApp(deleteRangeAppOptions *DeleteRangeAppOptions) (result *RangeApplicationResp, response *core.DetailedResponse, err error)

DeleteRangeApp : Delete range application Delete a specific application configuration.

func (*RangeApplicationsV1) DeleteRangeAppWithContext added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) DeleteRangeAppWithContext(ctx context.Context, deleteRangeAppOptions *DeleteRangeAppOptions) (result *RangeApplicationResp, response *core.DetailedResponse, err error)

DeleteRangeAppWithContext is an alternate form of the DeleteRangeApp method which supports a Context parameter

func (*RangeApplicationsV1) DisableRetries added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) DisableRetries()

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

func (*RangeApplicationsV1) EnableRetries added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) 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 (*RangeApplicationsV1) GetEnableGzipCompression added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*RangeApplicationsV1) GetRangeApp 

func (rangeApplications *RangeApplicationsV1) GetRangeApp(getRangeAppOptions *GetRangeAppOptions) (result *RangeApplicationResp, response *core.DetailedResponse, err error)

GetRangeApp : Get range application a zone Get the application configuration of a specific application inside a zone.

func (*RangeApplicationsV1) GetRangeAppWithContext added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) GetRangeAppWithContext(ctx context.Context, getRangeAppOptions *GetRangeAppOptions) (result *RangeApplicationResp, response *core.DetailedResponse, err error)

GetRangeAppWithContext is an alternate form of the GetRangeApp method which supports a Context parameter

func (*RangeApplicationsV1) GetServiceURL added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*RangeApplicationsV1) ListRangeApps 

func (rangeApplications *RangeApplicationsV1) ListRangeApps(listRangeAppsOptions *ListRangeAppsOptions) (result *RangeApplications, response *core.DetailedResponse, err error)

ListRangeApps : List range applications Get a list of currently existing Range Applications inside a zone.

func (*RangeApplicationsV1) ListRangeAppsWithContext added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) ListRangeAppsWithContext(ctx context.Context, listRangeAppsOptions *ListRangeAppsOptions) (result *RangeApplications, response *core.DetailedResponse, err error)

ListRangeAppsWithContext is an alternate form of the ListRangeApps method which supports a Context parameter

func (*RangeApplicationsV1) NewCreateRangeAppOptions 

func (*RangeApplicationsV1) NewCreateRangeAppOptions(protocol string, dns *RangeAppReqDns) *CreateRangeAppOptions

NewCreateRangeAppOptions : Instantiate CreateRangeAppOptions

func (*RangeApplicationsV1) NewDeleteRangeAppOptions 

func (*RangeApplicationsV1) NewDeleteRangeAppOptions(appIdentifier string) *DeleteRangeAppOptions

NewDeleteRangeAppOptions : Instantiate DeleteRangeAppOptions

func (*RangeApplicationsV1) NewGetRangeAppOptions 

func (*RangeApplicationsV1) NewGetRangeAppOptions(appIdentifier string) *GetRangeAppOptions

NewGetRangeAppOptions : Instantiate GetRangeAppOptions

func (*RangeApplicationsV1) NewListRangeAppsOptions 

func (*RangeApplicationsV1) NewListRangeAppsOptions() *ListRangeAppsOptions

NewListRangeAppsOptions : Instantiate ListRangeAppsOptions

func (*RangeApplicationsV1) NewRangeAppReqOriginDns 

func (*RangeApplicationsV1) NewRangeAppReqOriginDns(name string) (model *RangeAppReqOriginDns, err error)

NewRangeAppReqOriginDns : Instantiate RangeAppReqOriginDns (Generic Model Constructor)

func (*RangeApplicationsV1) NewUpdateRangeAppOptions 

func (*RangeApplicationsV1) NewUpdateRangeAppOptions(appIdentifier string, protocol string, dns *RangeAppReqDns) *UpdateRangeAppOptions

NewUpdateRangeAppOptions : Instantiate UpdateRangeAppOptions

func (*RangeApplicationsV1) SetDefaultHeaders added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*RangeApplicationsV1) SetEnableGzipCompression added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*RangeApplicationsV1) SetServiceURL 

func (rangeApplications *RangeApplicationsV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*RangeApplicationsV1) UpdateRangeApp 

func (rangeApplications *RangeApplicationsV1) UpdateRangeApp(updateRangeAppOptions *UpdateRangeAppOptions) (result *RangeApplicationResp, response *core.DetailedResponse, err error)

UpdateRangeApp : Update range application Update a Range Application inside a zone.

func (*RangeApplicationsV1) UpdateRangeAppWithContext added in v0.12.1 

func (rangeApplications *RangeApplicationsV1) UpdateRangeAppWithContext(ctx context.Context, updateRangeAppOptions *UpdateRangeAppOptions) (result *RangeApplicationResp, response *core.DetailedResponse, err error)

UpdateRangeAppWithContext is an alternate form of the UpdateRangeApp method which supports a Context parameter

type RangeApplicationsV1Options 

type RangeApplicationsV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Full url-encoded cloud resource name (CRN) of resource instance.
	Crn *string `validate:"required"`

	// zone identifier.
	ZoneIdentifier *string `validate:"required"`
}

RangeApplicationsV1Options : Service options

type UpdateRangeAppOptions 

type UpdateRangeAppOptions struct {
	// application identifier.
	AppIdentifier *string `json:"app_identifier" validate:"required,ne="`

	// Defines the protocol and port for this application.
	Protocol *string `json:"protocol" validate:"required"`

	// Name and type of the DNS record for this application.
	Dns *RangeAppReqDns `json:"dns" validate:"required"`

	// IP address and port of the origin for this Range application. If configuring a load balancer, use 'origin_dns' and
	// 'origin_port'. This can not be combined with 'origin_dns' and 'origin_port'.
	OriginDirect []string `json:"origin_direct,omitempty"`

	// DNS record pointing to the origin for this Range application. This is used for configuring a load balancer. When
	// specifying an individual IP address, use 'origin_direct'. This requires 'origin_port' and can not be combined with
	// 'origin_direct'.
	OriginDns *RangeAppReqOriginDns `json:"origin_dns,omitempty"`

	// Port at the origin that listens to traffic from this Range application. Requires 'origin_dns' and can not be
	// combined with 'origin_direct'.
	OriginPort *int64 `json:"origin_port,omitempty"`

	// Enables the IP Firewall for this application. Only available for TCP applications.
	IpFirewall *bool `json:"ip_firewall,omitempty"`

	// Allows for the true client IP to be passed to the service.
	ProxyProtocol *string `json:"proxy_protocol,omitempty"`

	// Configures IP version for the hostname of this application. Default is {"type":"dynamic", "connectivity":"all"}.
	EdgeIps *RangeAppReqEdgeIps `json:"edge_ips,omitempty"`

	// Configure how traffic is handled at the edge. If set to "direct" traffic is passed through to the service. In the
	// case of "http" or "https" HTTP/s features at the edge are applied ot this traffic.
	TrafficType *string `json:"traffic_type,omitempty"`

	// Configure if and how TLS connections are terminated at the edge.
	Tls *string `json:"tls,omitempty"`

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

UpdateRangeAppOptions : The UpdateRangeApp options.

func (*UpdateRangeAppOptions) SetAppIdentifier 

func (options *UpdateRangeAppOptions) SetAppIdentifier(appIdentifier string) *UpdateRangeAppOptions

SetAppIdentifier : Allow user to set AppIdentifier

func (*UpdateRangeAppOptions) SetDns 

func (options *UpdateRangeAppOptions) SetDns(dns *RangeAppReqDns) *UpdateRangeAppOptions

SetDns : Allow user to set Dns

func (*UpdateRangeAppOptions) SetEdgeIps 

func (options *UpdateRangeAppOptions) SetEdgeIps(edgeIps *RangeAppReqEdgeIps) *UpdateRangeAppOptions

SetEdgeIps : Allow user to set EdgeIps

func (*UpdateRangeAppOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateRangeAppOptions) SetIpFirewall 

func (options *UpdateRangeAppOptions) SetIpFirewall(ipFirewall bool) *UpdateRangeAppOptions

SetIpFirewall : Allow user to set IpFirewall

func (*UpdateRangeAppOptions) SetOriginDirect 

func (options *UpdateRangeAppOptions) SetOriginDirect(originDirect []string) *UpdateRangeAppOptions

SetOriginDirect : Allow user to set OriginDirect

func (*UpdateRangeAppOptions) SetOriginDns 

func (options *UpdateRangeAppOptions) SetOriginDns(originDns *RangeAppReqOriginDns) *UpdateRangeAppOptions

SetOriginDns : Allow user to set OriginDns

func (*UpdateRangeAppOptions) SetOriginPort 

func (options *UpdateRangeAppOptions) SetOriginPort(originPort int64) *UpdateRangeAppOptions

SetOriginPort : Allow user to set OriginPort

func (*UpdateRangeAppOptions) SetProtocol 

func (options *UpdateRangeAppOptions) SetProtocol(protocol string) *UpdateRangeAppOptions

SetProtocol : Allow user to set Protocol

func (*UpdateRangeAppOptions) SetProxyProtocol 

func (options *UpdateRangeAppOptions) SetProxyProtocol(proxyProtocol string) *UpdateRangeAppOptions

SetProxyProtocol : Allow user to set ProxyProtocol

func (*UpdateRangeAppOptions) SetTls 

func (options *UpdateRangeAppOptions) SetTls(tls string) *UpdateRangeAppOptions

SetTls : Allow user to set Tls

func (*UpdateRangeAppOptions) SetTrafficType 

func (options *UpdateRangeAppOptions) SetTrafficType(trafficType string) *UpdateRangeAppOptions

SetTrafficType : Allow user to set TrafficType

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.