v1

package
v0.1.62 Latest Latest
Warning

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

Go to latest
Published: Nov 28, 2019 License: Apache-2.0 Imports: 13 Imported by: 219

Documentation ¶

Index ¶

Constants ¶

View Source
const AddOnKind = "AddOn"

AddOnKind is the name of the type used to represent objects of type 'add_on'.

View Source
const AddOnLinkKind = "AddOnLink"

AddOnLinkKind is the name of the type used to represent links to objects of type 'add_on'.

View Source
const AddOnListKind = "AddOnList"

AddOnListKind is the name of the type used to represent list of objects of type 'add_on'.

View Source
const AddOnListLinkKind = "AddOnListLink"

AddOnListLinkKind is the name of the type used to represent links to list of objects of type 'add_on'.

View Source
const AddOnListNilKind = "AddOnListNil"

AddOnNilKind is the name of the type used to nil lists of objects of type 'add_on'.

View Source
const AddOnNilKind = "AddOnNil"

AddOnNilKind is the name of the type used to nil references to objects of type 'add_on'.

View Source
const CloudProviderKind = "CloudProvider"

CloudProviderKind is the name of the type used to represent objects of type 'cloud_provider'.

View Source
const CloudProviderLinkKind = "CloudProviderLink"

CloudProviderLinkKind is the name of the type used to represent links to objects of type 'cloud_provider'.

View Source
const CloudProviderListKind = "CloudProviderList"

CloudProviderListKind is the name of the type used to represent list of objects of type 'cloud_provider'.

View Source
const CloudProviderListLinkKind = "CloudProviderListLink"

CloudProviderListLinkKind is the name of the type used to represent links to list of objects of type 'cloud_provider'.

View Source
const CloudProviderListNilKind = "CloudProviderListNil"

CloudProviderNilKind is the name of the type used to nil lists of objects of type 'cloud_provider'.

View Source
const CloudProviderNilKind = "CloudProviderNil"

CloudProviderNilKind is the name of the type used to nil references to objects of type 'cloud_provider'.

View Source
const CloudRegionKind = "CloudRegion"

CloudRegionKind is the name of the type used to represent objects of type 'cloud_region'.

View Source
const CloudRegionLinkKind = "CloudRegionLink"

CloudRegionLinkKind is the name of the type used to represent links to objects of type 'cloud_region'.

View Source
const CloudRegionListKind = "CloudRegionList"

CloudRegionListKind is the name of the type used to represent list of objects of type 'cloud_region'.

View Source
const CloudRegionListLinkKind = "CloudRegionListLink"

CloudRegionListLinkKind is the name of the type used to represent links to list of objects of type 'cloud_region'.

View Source
const CloudRegionListNilKind = "CloudRegionListNil"

CloudRegionNilKind is the name of the type used to nil lists of objects of type 'cloud_region'.

View Source
const CloudRegionNilKind = "CloudRegionNil"

CloudRegionNilKind is the name of the type used to nil references to objects of type 'cloud_region'.

View Source
const ClusterCredentialsKind = "ClusterCredentials"

ClusterCredentialsKind is the name of the type used to represent objects of type 'cluster_credentials'.

View Source
const ClusterCredentialsLinkKind = "ClusterCredentialsLink"

ClusterCredentialsLinkKind is the name of the type used to represent links to objects of type 'cluster_credentials'.

View Source
const ClusterCredentialsListKind = "ClusterCredentialsList"

ClusterCredentialsListKind is the name of the type used to represent list of objects of type 'cluster_credentials'.

View Source
const ClusterCredentialsListLinkKind = "ClusterCredentialsListLink"

ClusterCredentialsListLinkKind is the name of the type used to represent links to list of objects of type 'cluster_credentials'.

View Source
const ClusterCredentialsListNilKind = "ClusterCredentialsListNil"

ClusterCredentialsNilKind is the name of the type used to nil lists of objects of type 'cluster_credentials'.

View Source
const ClusterCredentialsNilKind = "ClusterCredentialsNil"

ClusterCredentialsNilKind is the name of the type used to nil references to objects of type 'cluster_credentials'.

View Source
const ClusterKind = "Cluster"

ClusterKind is the name of the type used to represent objects of type 'cluster'.

View Source
const ClusterLinkKind = "ClusterLink"

ClusterLinkKind is the name of the type used to represent links to objects of type 'cluster'.

View Source
const ClusterListKind = "ClusterList"

ClusterListKind is the name of the type used to represent list of objects of type 'cluster'.

View Source
const ClusterListLinkKind = "ClusterListLink"

ClusterListLinkKind is the name of the type used to represent links to list of objects of type 'cluster'.

View Source
const ClusterListNilKind = "ClusterListNil"

ClusterNilKind is the name of the type used to nil lists of objects of type 'cluster'.

View Source
const ClusterNilKind = "ClusterNil"

ClusterNilKind is the name of the type used to nil references to objects of type 'cluster'.

View Source
const ClusterStatusKind = "ClusterStatus"

ClusterStatusKind is the name of the type used to represent objects of type 'cluster_status'.

View Source
const ClusterStatusLinkKind = "ClusterStatusLink"

ClusterStatusLinkKind is the name of the type used to represent links to objects of type 'cluster_status'.

View Source
const ClusterStatusListKind = "ClusterStatusList"

ClusterStatusListKind is the name of the type used to represent list of objects of type 'cluster_status'.

View Source
const ClusterStatusListLinkKind = "ClusterStatusListLink"

ClusterStatusListLinkKind is the name of the type used to represent links to list of objects of type 'cluster_status'.

View Source
const ClusterStatusListNilKind = "ClusterStatusListNil"

ClusterStatusNilKind is the name of the type used to nil lists of objects of type 'cluster_status'.

View Source
const ClusterStatusNilKind = "ClusterStatusNil"

ClusterStatusNilKind is the name of the type used to nil references to objects of type 'cluster_status'.

View Source
const DashboardKind = "Dashboard"

DashboardKind is the name of the type used to represent objects of type 'dashboard'.

View Source
const DashboardLinkKind = "DashboardLink"

DashboardLinkKind is the name of the type used to represent links to objects of type 'dashboard'.

View Source
const DashboardListKind = "DashboardList"

DashboardListKind is the name of the type used to represent list of objects of type 'dashboard'.

View Source
const DashboardListLinkKind = "DashboardListLink"

DashboardListLinkKind is the name of the type used to represent links to list of objects of type 'dashboard'.

View Source
const DashboardListNilKind = "DashboardListNil"

DashboardNilKind is the name of the type used to nil lists of objects of type 'dashboard'.

View Source
const DashboardNilKind = "DashboardNil"

DashboardNilKind is the name of the type used to nil references to objects of type 'dashboard'.

View Source
const (
	// Can't create cluster, the given external identifier is already in use.
	DuplicatedExternalIDError = 1001
)
View Source
const FlavourKind = "Flavour"

FlavourKind is the name of the type used to represent objects of type 'flavour'.

View Source
const FlavourLinkKind = "FlavourLink"

FlavourLinkKind is the name of the type used to represent links to objects of type 'flavour'.

View Source
const FlavourListKind = "FlavourList"

FlavourListKind is the name of the type used to represent list of objects of type 'flavour'.

View Source
const FlavourListLinkKind = "FlavourListLink"

FlavourListLinkKind is the name of the type used to represent links to list of objects of type 'flavour'.

View Source
const FlavourListNilKind = "FlavourListNil"

FlavourNilKind is the name of the type used to nil lists of objects of type 'flavour'.

View Source
const FlavourNilKind = "FlavourNil"

FlavourNilKind is the name of the type used to nil references to objects of type 'flavour'.

View Source
const GroupKind = "Group"

GroupKind is the name of the type used to represent objects of type 'group'.

View Source
const GroupLinkKind = "GroupLink"

GroupLinkKind is the name of the type used to represent links to objects of type 'group'.

View Source
const GroupListKind = "GroupList"

GroupListKind is the name of the type used to represent list of objects of type 'group'.

View Source
const GroupListLinkKind = "GroupListLink"

GroupListLinkKind is the name of the type used to represent links to list of objects of type 'group'.

View Source
const GroupListNilKind = "GroupListNil"

GroupNilKind is the name of the type used to nil lists of objects of type 'group'.

View Source
const GroupNilKind = "GroupNil"

GroupNilKind is the name of the type used to nil references to objects of type 'group'.

View Source
const IdentityProviderKind = "IdentityProvider"

IdentityProviderKind is the name of the type used to represent objects of type 'identity_provider'.

View Source
const IdentityProviderLinkKind = "IdentityProviderLink"

IdentityProviderLinkKind is the name of the type used to represent links to objects of type 'identity_provider'.

View Source
const IdentityProviderListKind = "IdentityProviderList"

IdentityProviderListKind is the name of the type used to represent list of objects of type 'identity_provider'.

View Source
const IdentityProviderListLinkKind = "IdentityProviderListLink"

IdentityProviderListLinkKind is the name of the type used to represent links to list of objects of type 'identity_provider'.

View Source
const IdentityProviderListNilKind = "IdentityProviderListNil"

IdentityProviderNilKind is the name of the type used to nil lists of objects of type 'identity_provider'.

View Source
const IdentityProviderNilKind = "IdentityProviderNil"

IdentityProviderNilKind is the name of the type used to nil references to objects of type 'identity_provider'.

View Source
const LogKind = "Log"

LogKind is the name of the type used to represent objects of type 'log'.

View Source
const LogLinkKind = "LogLink"

LogLinkKind is the name of the type used to represent links to objects of type 'log'.

View Source
const LogListKind = "LogList"

LogListKind is the name of the type used to represent list of objects of type 'log'.

View Source
const LogListLinkKind = "LogListLink"

LogListLinkKind is the name of the type used to represent links to list of objects of type 'log'.

View Source
const LogListNilKind = "LogListNil"

LogNilKind is the name of the type used to nil lists of objects of type 'log'.

View Source
const LogNilKind = "LogNil"

LogNilKind is the name of the type used to nil references to objects of type 'log'.

View Source
const SubscriptionKind = "Subscription"

SubscriptionKind is the name of the type used to represent objects of type 'subscription'.

View Source
const SubscriptionLinkKind = "SubscriptionLink"

SubscriptionLinkKind is the name of the type used to represent links to objects of type 'subscription'.

View Source
const SubscriptionListKind = "SubscriptionList"

SubscriptionListKind is the name of the type used to represent list of objects of type 'subscription'.

View Source
const SubscriptionListLinkKind = "SubscriptionListLink"

SubscriptionListLinkKind is the name of the type used to represent links to list of objects of type 'subscription'.

View Source
const SubscriptionListNilKind = "SubscriptionListNil"

SubscriptionNilKind is the name of the type used to nil lists of objects of type 'subscription'.

View Source
const SubscriptionNilKind = "SubscriptionNil"

SubscriptionNilKind is the name of the type used to nil references to objects of type 'subscription'.

View Source
const UserKind = "User"

UserKind is the name of the type used to represent objects of type 'user'.

View Source
const UserLinkKind = "UserLink"

UserLinkKind is the name of the type used to represent links to objects of type 'user'.

View Source
const UserListKind = "UserList"

UserListKind is the name of the type used to represent list of objects of type 'user'.

View Source
const UserListLinkKind = "UserListLink"

UserListLinkKind is the name of the type used to represent links to list of objects of type 'user'.

View Source
const UserListNilKind = "UserListNil"

UserNilKind is the name of the type used to nil lists of objects of type 'user'.

View Source
const UserNilKind = "UserNil"

UserNilKind is the name of the type used to nil references to objects of type 'user'.

View Source
const VersionKind = "Version"

VersionKind is the name of the type used to represent objects of type 'version'.

View Source
const VersionLinkKind = "VersionLink"

VersionLinkKind is the name of the type used to represent links to objects of type 'version'.

View Source
const VersionListKind = "VersionList"

VersionListKind is the name of the type used to represent list of objects of type 'version'.

View Source
const VersionListLinkKind = "VersionListLink"

VersionListLinkKind is the name of the type used to represent links to list of objects of type 'version'.

View Source
const VersionListNilKind = "VersionListNil"

VersionNilKind is the name of the type used to nil lists of objects of type 'version'.

View Source
const VersionNilKind = "VersionNil"

VersionNilKind is the name of the type used to nil references to objects of type 'version'.

Variables ¶

View Source
var OpenAPI = []byte{}/* 113233 elements not displayed */

OpenAPI contains the OpenAPI specification of the service in JSON.

Functions ¶

func Dispatch ¶

func Dispatch(w http.ResponseWriter, r *http.Request, server Server, segments []string)

Dispatch navigates the servers tree rooted at the given server till it finds one that matches the given set of path segments, and then invokes the corresponding server.

func MarshalAWS ¶

func MarshalAWS(object *AWS, target interface{}) error

MarshalAWS writes a value of the 'AWS' to the given target, which can be a writer or a JSON encoder.

func MarshalAddOn ¶

func MarshalAddOn(object *AddOn, target interface{}) error

MarshalAddOn writes a value of the 'add_on' to the given target, which can be a writer or a JSON encoder.

func MarshalAdminCredentials ¶

func MarshalAdminCredentials(object *AdminCredentials, target interface{}) error

MarshalAdminCredentials writes a value of the 'admin_credentials' to the given target, which can be a writer or a JSON encoder.

func MarshalCPUTotalNodeRoleOSMetricNode ¶

func MarshalCPUTotalNodeRoleOSMetricNode(object *CPUTotalNodeRoleOSMetricNode, target interface{}) error

MarshalCPUTotalNodeRoleOSMetricNode writes a value of the 'CPU_total_node_role_OS_metric_node' to the given target, which can be a writer or a JSON encoder.

func MarshalCPUTotalsNodeRoleOSMetricNode ¶

func MarshalCPUTotalsNodeRoleOSMetricNode(object *CPUTotalsNodeRoleOSMetricNode, target interface{}) error

MarshalCPUTotalsNodeRoleOSMetricNode writes a value of the 'CPU_totals_node_role_OS_metric_node' to the given target, which can be a writer or a JSON encoder.

func MarshalCloudProvider ¶

func MarshalCloudProvider(object *CloudProvider, target interface{}) error

MarshalCloudProvider writes a value of the 'cloud_provider' to the given target, which can be a writer or a JSON encoder.

func MarshalCloudRegion ¶

func MarshalCloudRegion(object *CloudRegion, target interface{}) error

MarshalCloudRegion writes a value of the 'cloud_region' to the given target, which can be a writer or a JSON encoder.

func MarshalCluster ¶

func MarshalCluster(object *Cluster, target interface{}) error

MarshalCluster writes a value of the 'cluster' to the given target, which can be a writer or a JSON encoder.

func MarshalClusterAPI ¶

func MarshalClusterAPI(object *ClusterAPI, target interface{}) error

MarshalClusterAPI writes a value of the 'cluster_API' to the given target, which can be a writer or a JSON encoder.

func MarshalClusterConsole ¶

func MarshalClusterConsole(object *ClusterConsole, target interface{}) error

MarshalClusterConsole writes a value of the 'cluster_console' to the given target, which can be a writer or a JSON encoder.

func MarshalClusterCredentials ¶

func MarshalClusterCredentials(object *ClusterCredentials, target interface{}) error

MarshalClusterCredentials writes a value of the 'cluster_credentials' to the given target, which can be a writer or a JSON encoder.

func MarshalClusterMetric ¶

func MarshalClusterMetric(object *ClusterMetric, target interface{}) error

MarshalClusterMetric writes a value of the 'cluster_metric' to the given target, which can be a writer or a JSON encoder.

func MarshalClusterMetrics ¶

func MarshalClusterMetrics(object *ClusterMetrics, target interface{}) error

MarshalClusterMetrics writes a value of the 'cluster_metrics' to the given target, which can be a writer or a JSON encoder.

func MarshalClusterNodes ¶

func MarshalClusterNodes(object *ClusterNodes, target interface{}) error

MarshalClusterNodes writes a value of the 'cluster_nodes' to the given target, which can be a writer or a JSON encoder.

func MarshalClusterRegistration ¶

func MarshalClusterRegistration(object *ClusterRegistration, target interface{}) error

MarshalClusterRegistration writes a value of the 'cluster_registration' to the given target, which can be a writer or a JSON encoder.

func MarshalClusterStatus ¶

func MarshalClusterStatus(object *ClusterStatus, target interface{}) error

MarshalClusterStatus writes a value of the 'cluster_status' to the given target, which can be a writer or a JSON encoder.

func MarshalDNS ¶

func MarshalDNS(object *DNS, target interface{}) error

MarshalDNS writes a value of the 'DNS' to the given target, which can be a writer or a JSON encoder.

func MarshalDashboard ¶

func MarshalDashboard(object *Dashboard, target interface{}) error

MarshalDashboard writes a value of the 'dashboard' to the given target, which can be a writer or a JSON encoder.

func MarshalFlavour ¶

func MarshalFlavour(object *Flavour, target interface{}) error

MarshalFlavour writes a value of the 'flavour' to the given target, which can be a writer or a JSON encoder.

func MarshalFlavourNodes ¶

func MarshalFlavourNodes(object *FlavourNodes, target interface{}) error

MarshalFlavourNodes writes a value of the 'flavour_nodes' to the given target, which can be a writer or a JSON encoder.

func MarshalGithubIdentityProvider ¶

func MarshalGithubIdentityProvider(object *GithubIdentityProvider, target interface{}) error

MarshalGithubIdentityProvider writes a value of the 'github_identity_provider' to the given target, which can be a writer or a JSON encoder.

func MarshalGitlabIdentityProvider ¶

func MarshalGitlabIdentityProvider(object *GitlabIdentityProvider, target interface{}) error

MarshalGitlabIdentityProvider writes a value of the 'gitlab_identity_provider' to the given target, which can be a writer or a JSON encoder.

func MarshalGoogleIdentityProvider ¶

func MarshalGoogleIdentityProvider(object *GoogleIdentityProvider, target interface{}) error

MarshalGoogleIdentityProvider writes a value of the 'google_identity_provider' to the given target, which can be a writer or a JSON encoder.

func MarshalGroup ¶

func MarshalGroup(object *Group, target interface{}) error

MarshalGroup writes a value of the 'group' to the given target, which can be a writer or a JSON encoder.

func MarshalIdentityProvider ¶

func MarshalIdentityProvider(object *IdentityProvider, target interface{}) error

MarshalIdentityProvider writes a value of the 'identity_provider' to the given target, which can be a writer or a JSON encoder.

func MarshalLDAPAttributes ¶

func MarshalLDAPAttributes(object *LDAPAttributes, target interface{}) error

MarshalLDAPAttributes writes a value of the 'LDAP_attributes' to the given target, which can be a writer or a JSON encoder.

func MarshalLDAPIdentityProvider ¶

func MarshalLDAPIdentityProvider(object *LDAPIdentityProvider, target interface{}) error

MarshalLDAPIdentityProvider writes a value of the 'LDAP_identity_provider' to the given target, which can be a writer or a JSON encoder.

func MarshalLog ¶

func MarshalLog(object *Log, target interface{}) error

MarshalLog writes a value of the 'log' to the given target, which can be a writer or a JSON encoder.

func MarshalMetadata ¶

func MarshalMetadata(object *Metadata, target interface{}) error

MarshalMetadata writes a value of the metadata type to the given target, which can be a writer or a JSON encoder.

func MarshalMetric ¶

func MarshalMetric(object *Metric, target interface{}) error

MarshalMetric writes a value of the 'metric' to the given target, which can be a writer or a JSON encoder.

func MarshalNetwork ¶

func MarshalNetwork(object *Network, target interface{}) error

MarshalNetwork writes a value of the 'network' to the given target, which can be a writer or a JSON encoder.

func MarshalOpenIDClaims ¶

func MarshalOpenIDClaims(object *OpenIDClaims, target interface{}) error

MarshalOpenIDClaims writes a value of the 'open_ID_claims' to the given target, which can be a writer or a JSON encoder.

func MarshalOpenIDIdentityProvider ¶

func MarshalOpenIDIdentityProvider(object *OpenIDIdentityProvider, target interface{}) error

MarshalOpenIDIdentityProvider writes a value of the 'open_ID_identity_provider' to the given target, which can be a writer or a JSON encoder.

func MarshalOpenIDURLs ¶ added in v0.1.32

func MarshalOpenIDURLs(object *OpenIDURLs, target interface{}) error

MarshalOpenIDURLs writes a value of the 'open_IDURLs' to the given target, which can be a writer or a JSON encoder.

func MarshalSSHCredentials ¶

func MarshalSSHCredentials(object *SSHCredentials, target interface{}) error

MarshalSSHCredentials writes a value of the 'SSH_credentials' to the given target, which can be a writer or a JSON encoder.

func MarshalSample ¶

func MarshalSample(object *Sample, target interface{}) error

MarshalSample writes a value of the 'sample' to the given target, which can be a writer or a JSON encoder.

func MarshalSocketTotalNodeRoleOSMetricNode ¶

func MarshalSocketTotalNodeRoleOSMetricNode(object *SocketTotalNodeRoleOSMetricNode, target interface{}) error

MarshalSocketTotalNodeRoleOSMetricNode writes a value of the 'socket_total_node_role_OS_metric_node' to the given target, which can be a writer or a JSON encoder.

func MarshalSocketTotalsNodeRoleOSMetricNode ¶

func MarshalSocketTotalsNodeRoleOSMetricNode(object *SocketTotalsNodeRoleOSMetricNode, target interface{}) error

MarshalSocketTotalsNodeRoleOSMetricNode writes a value of the 'socket_totals_node_role_OS_metric_node' to the given target, which can be a writer or a JSON encoder.

func MarshalSubscription ¶

func MarshalSubscription(object *Subscription, target interface{}) error

MarshalSubscription writes a value of the 'subscription' to the given target, which can be a writer or a JSON encoder.

func MarshalUser ¶

func MarshalUser(object *User, target interface{}) error

MarshalUser writes a value of the 'user' to the given target, which can be a writer or a JSON encoder.

func MarshalValue ¶

func MarshalValue(object *Value, target interface{}) error

MarshalValue writes a value of the 'value' to the given target, which can be a writer or a JSON encoder.

func MarshalVersion ¶

func MarshalVersion(object *Version, target interface{}) error

MarshalVersion writes a value of the 'version' to the given target, which can be a writer or a JSON encoder.

Types ¶

type AWS ¶

type AWS struct {
	// contains filtered or unexported fields
}

AWS represents the values of the 'AWS' type.

_Amazon Web Services_ specific settings of a cluster.

func UnmarshalAWS ¶

func UnmarshalAWS(source interface{}) (object *AWS, err error)

UnmarshalAWS reads a value of the 'AWS' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*AWS) AccessKeyID ¶

func (o *AWS) AccessKeyID() string

AccessKeyID returns the value of the 'access_key_ID' attribute, or the zero value of the type if the attribute doesn't have a value.

AWS access key identifier.

func (*AWS) Empty ¶

func (o *AWS) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*AWS) GetAccessKeyID ¶

func (o *AWS) GetAccessKeyID() (value string, ok bool)

GetAccessKeyID returns the value of the 'access_key_ID' attribute and a flag indicating if the attribute has a value.

AWS access key identifier.

func (*AWS) GetSecretAccessKey ¶

func (o *AWS) GetSecretAccessKey() (value string, ok bool)

GetSecretAccessKey returns the value of the 'secret_access_key' attribute and a flag indicating if the attribute has a value.

AWS secret access key.

func (*AWS) SecretAccessKey ¶

func (o *AWS) SecretAccessKey() string

SecretAccessKey returns the value of the 'secret_access_key' attribute, or the zero value of the type if the attribute doesn't have a value.

AWS secret access key.

type AWSBuilder ¶

type AWSBuilder struct {
	// contains filtered or unexported fields
}

AWSBuilder contains the data and logic needed to build 'AWS' objects.

_Amazon Web Services_ specific settings of a cluster.

func NewAWS ¶

func NewAWS() *AWSBuilder

NewAWS creates a new builder of 'AWS' objects.

func (*AWSBuilder) AccessKeyID ¶

func (b *AWSBuilder) AccessKeyID(value string) *AWSBuilder

AccessKeyID sets the value of the 'access_key_ID' attribute to the given value.

func (*AWSBuilder) Build ¶

func (b *AWSBuilder) Build() (object *AWS, err error)

Build creates a 'AWS' object using the configuration stored in the builder.

func (*AWSBuilder) Copy ¶

func (b *AWSBuilder) Copy(object *AWS) *AWSBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*AWSBuilder) SecretAccessKey ¶

func (b *AWSBuilder) SecretAccessKey(value string) *AWSBuilder

SecretAccessKey sets the value of the 'secret_access_key' attribute to the given value.

type AWSList ¶

type AWSList struct {
	// contains filtered or unexported fields
}

AWSList is a list of values of the 'AWS' type.

func UnmarshalAWSList ¶

func UnmarshalAWSList(source interface{}) (list *AWSList, err error)

UnmarshalAWSList reads a list of values of the 'AWS' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*AWSList) Each ¶

func (l *AWSList) Each(f func(item *AWS) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*AWSList) Empty ¶

func (l *AWSList) Empty() bool

Empty returns true if the list is empty.

func (*AWSList) Get ¶

func (l *AWSList) Get(i int) *AWS

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*AWSList) Len ¶

func (l *AWSList) Len() int

Len returns the length of the list.

func (*AWSList) Range ¶

func (l *AWSList) Range(f func(index int, item *AWS) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*AWSList) Slice ¶

func (l *AWSList) Slice() []*AWS

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type AWSListBuilder ¶

type AWSListBuilder struct {
	// contains filtered or unexported fields
}

AWSListBuilder contains the data and logic needed to build 'AWS' objects.

func NewAWSList ¶

func NewAWSList() *AWSListBuilder

NewAWSList creates a new builder of 'AWS' objects.

func (*AWSListBuilder) Build ¶

func (b *AWSListBuilder) Build() (list *AWSList, err error)

Build creates a list of 'AWS' objects using the configuration stored in the builder.

func (*AWSListBuilder) Items ¶

func (b *AWSListBuilder) Items(values ...*AWSBuilder) *AWSListBuilder

Items sets the items of the list.

type AddOn ¶

type AddOn struct {
	// contains filtered or unexported fields
}

AddOn represents the values of the 'add_on' type.

Representation of an add-on that can be installed in a cluster.

func UnmarshalAddOn ¶

func UnmarshalAddOn(source interface{}) (object *AddOn, err error)

UnmarshalAddOn reads a value of the 'add_on' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*AddOn) Description ¶

func (o *AddOn) Description() string

Description returns the value of the 'description' attribute, or the zero value of the type if the attribute doesn't have a value.

Description of the add-on.

func (*AddOn) Empty ¶

func (o *AddOn) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*AddOn) Enabled ¶

func (o *AddOn) Enabled() bool

Enabled returns the value of the 'enabled' attribute, or the zero value of the type if the attribute doesn't have a value.

Indicates if this add-on can be added to clusters.

func (*AddOn) GetDescription ¶

func (o *AddOn) GetDescription() (value string, ok bool)

GetDescription returns the value of the 'description' attribute and a flag indicating if the attribute has a value.

Description of the add-on.

func (*AddOn) GetEnabled ¶

func (o *AddOn) GetEnabled() (value bool, ok bool)

GetEnabled returns the value of the 'enabled' attribute and a flag indicating if the attribute has a value.

Indicates if this add-on can be added to clusters.

func (*AddOn) GetHREF ¶

func (o *AddOn) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*AddOn) GetID ¶

func (o *AddOn) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*AddOn) GetIcon ¶

func (o *AddOn) GetIcon() (value string, ok bool)

GetIcon returns the value of the 'icon' attribute and a flag indicating if the attribute has a value.

Base64-encoded icon representing an add-on. The icon should be in PNG format.

func (*AddOn) GetLabel ¶

func (o *AddOn) GetLabel() (value string, ok bool)

GetLabel returns the value of the 'label' attribute and a flag indicating if the attribute has a value.

Label used to attach to a cluster deployment when add-on is installed.

func (*AddOn) GetName ¶

func (o *AddOn) GetName() (value string, ok bool)

GetName returns the value of the 'name' attribute and a flag indicating if the attribute has a value.

Name of the add-on.

func (*AddOn) HREF ¶

func (o *AddOn) HREF() string

HREF returns the link to the object.

func (*AddOn) ID ¶

func (o *AddOn) ID() string

ID returns the identifier of the object.

func (*AddOn) Icon ¶

func (o *AddOn) Icon() string

Icon returns the value of the 'icon' attribute, or the zero value of the type if the attribute doesn't have a value.

Base64-encoded icon representing an add-on. The icon should be in PNG format.

func (*AddOn) Kind ¶

func (o *AddOn) Kind() string

Kind returns the name of the type of the object.

func (*AddOn) Label ¶

func (o *AddOn) Label() string

Label returns the value of the 'label' attribute, or the zero value of the type if the attribute doesn't have a value.

Label used to attach to a cluster deployment when add-on is installed.

func (o *AddOn) Link() bool

Link returns true iif this is a link.

func (*AddOn) Name ¶

func (o *AddOn) Name() string

Name returns the value of the 'name' attribute, or the zero value of the type if the attribute doesn't have a value.

Name of the add-on.

type AddOnBuilder ¶

type AddOnBuilder struct {
	// contains filtered or unexported fields
}

AddOnBuilder contains the data and logic needed to build 'add_on' objects.

Representation of an add-on that can be installed in a cluster.

func NewAddOn ¶

func NewAddOn() *AddOnBuilder

NewAddOn creates a new builder of 'add_on' objects.

func (*AddOnBuilder) Build ¶

func (b *AddOnBuilder) Build() (object *AddOn, err error)

Build creates a 'add_on' object using the configuration stored in the builder.

func (*AddOnBuilder) Copy ¶

func (b *AddOnBuilder) Copy(object *AddOn) *AddOnBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*AddOnBuilder) Description ¶

func (b *AddOnBuilder) Description(value string) *AddOnBuilder

Description sets the value of the 'description' attribute to the given value.

func (*AddOnBuilder) Enabled ¶

func (b *AddOnBuilder) Enabled(value bool) *AddOnBuilder

Enabled sets the value of the 'enabled' attribute to the given value.

func (*AddOnBuilder) HREF ¶

func (b *AddOnBuilder) HREF(value string) *AddOnBuilder

HREF sets the link to the object.

func (*AddOnBuilder) ID ¶

func (b *AddOnBuilder) ID(value string) *AddOnBuilder

ID sets the identifier of the object.

func (*AddOnBuilder) Icon ¶

func (b *AddOnBuilder) Icon(value string) *AddOnBuilder

Icon sets the value of the 'icon' attribute to the given value.

func (*AddOnBuilder) Label ¶

func (b *AddOnBuilder) Label(value string) *AddOnBuilder

Label sets the value of the 'label' attribute to the given value.

func (b *AddOnBuilder) Link(value bool) *AddOnBuilder

Link sets the flag that indicates if this is a link.

func (*AddOnBuilder) Name ¶

func (b *AddOnBuilder) Name(value string) *AddOnBuilder

Name sets the value of the 'name' attribute to the given value.

type AddOnClient ¶

type AddOnClient struct {
	// contains filtered or unexported fields
}

AddOnClient is the client of the 'add_on' resource.

Manages a specific add-on.

func NewAddOnClient ¶

func NewAddOnClient(transport http.RoundTripper, path string, metric string) *AddOnClient

NewAddOnClient creates a new client for the 'add_on' resource using the given transport to sned the requests and receive the responses.

func (*AddOnClient) Delete ¶

func (c *AddOnClient) Delete() *AddOnDeleteRequest

Delete creates a request for the 'delete' method.

Deletes the add-on.

func (*AddOnClient) Get ¶

func (c *AddOnClient) Get() *AddOnGetRequest

Get creates a request for the 'get' method.

Retrieves the details of the add-on.

func (*AddOnClient) Poll ¶

func (c *AddOnClient) Poll() *AddOnPollRequest

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

func (*AddOnClient) Update ¶

func (c *AddOnClient) Update() *AddOnUpdateRequest

Update creates a request for the 'update' method.

Updates the add-on.

type AddOnDeleteRequest ¶

type AddOnDeleteRequest struct {
	// contains filtered or unexported fields
}

AddOnDeleteRequest is the request for the 'delete' method.

func (*AddOnDeleteRequest) Header ¶

func (r *AddOnDeleteRequest) Header(name string, value interface{}) *AddOnDeleteRequest

Header adds a request header.

func (*AddOnDeleteRequest) Parameter ¶

func (r *AddOnDeleteRequest) Parameter(name string, value interface{}) *AddOnDeleteRequest

Parameter adds a query parameter.

func (*AddOnDeleteRequest) Send ¶

func (r *AddOnDeleteRequest) Send() (result *AddOnDeleteResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*AddOnDeleteRequest) SendContext ¶

func (r *AddOnDeleteRequest) SendContext(ctx context.Context) (result *AddOnDeleteResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type AddOnDeleteResponse ¶

type AddOnDeleteResponse struct {
	// contains filtered or unexported fields
}

AddOnDeleteResponse is the response for the 'delete' method.

func (*AddOnDeleteResponse) Error ¶

func (r *AddOnDeleteResponse) Error() *errors.Error

Error returns the response error.

func (*AddOnDeleteResponse) Header ¶

func (r *AddOnDeleteResponse) Header() http.Header

Header returns header of the response.

func (*AddOnDeleteResponse) Status ¶

func (r *AddOnDeleteResponse) Status() int

Status returns the response status code.

type AddOnDeleteServerRequest ¶

type AddOnDeleteServerRequest struct {
}

AddOnDeleteServerRequest is the request for the 'delete' method.

type AddOnDeleteServerResponse ¶

type AddOnDeleteServerResponse struct {
	// contains filtered or unexported fields
}

AddOnDeleteServerResponse is the response for the 'delete' method.

func (*AddOnDeleteServerResponse) Status ¶

Status sets the status code.

type AddOnGetRequest ¶

type AddOnGetRequest struct {
	// contains filtered or unexported fields
}

AddOnGetRequest is the request for the 'get' method.

func (*AddOnGetRequest) Header ¶

func (r *AddOnGetRequest) Header(name string, value interface{}) *AddOnGetRequest

Header adds a request header.

func (*AddOnGetRequest) Parameter ¶

func (r *AddOnGetRequest) Parameter(name string, value interface{}) *AddOnGetRequest

Parameter adds a query parameter.

func (*AddOnGetRequest) Send ¶

func (r *AddOnGetRequest) Send() (result *AddOnGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*AddOnGetRequest) SendContext ¶

func (r *AddOnGetRequest) SendContext(ctx context.Context) (result *AddOnGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type AddOnGetResponse ¶

type AddOnGetResponse struct {
	// contains filtered or unexported fields
}

AddOnGetResponse is the response for the 'get' method.

func (*AddOnGetResponse) Body ¶

func (r *AddOnGetResponse) Body() *AddOn

Body returns the value of the 'body' parameter.

func (*AddOnGetResponse) Error ¶

func (r *AddOnGetResponse) Error() *errors.Error

Error returns the response error.

func (*AddOnGetResponse) GetBody ¶

func (r *AddOnGetResponse) GetBody() (value *AddOn, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*AddOnGetResponse) Header ¶

func (r *AddOnGetResponse) Header() http.Header

Header returns header of the response.

func (*AddOnGetResponse) Status ¶

func (r *AddOnGetResponse) Status() int

Status returns the response status code.

type AddOnGetServerRequest ¶

type AddOnGetServerRequest struct {
}

AddOnGetServerRequest is the request for the 'get' method.

type AddOnGetServerResponse ¶

type AddOnGetServerResponse struct {
	// contains filtered or unexported fields
}

AddOnGetServerResponse is the response for the 'get' method.

func (*AddOnGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*AddOnGetServerResponse) Status ¶

Status sets the status code.

type AddOnList ¶

type AddOnList struct {
	// contains filtered or unexported fields
}

AddOnList is a list of values of the 'add_on' type.

func UnmarshalAddOnList ¶

func UnmarshalAddOnList(source interface{}) (list *AddOnList, err error)

UnmarshalAddOnList reads a list of values of the 'add_on' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*AddOnList) Each ¶

func (l *AddOnList) Each(f func(item *AddOn) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*AddOnList) Empty ¶

func (l *AddOnList) Empty() bool

Empty returns true if the list is empty.

func (*AddOnList) Get ¶

func (l *AddOnList) Get(i int) *AddOn

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*AddOnList) GetHREF ¶

func (l *AddOnList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*AddOnList) HREF ¶

func (l *AddOnList) HREF() string

HREF returns the link to the list.

func (*AddOnList) Kind ¶

func (l *AddOnList) Kind() string

Kind returns the name of the type of the object.

func (*AddOnList) Len ¶

func (l *AddOnList) Len() int

Len returns the length of the list.

func (l *AddOnList) Link() bool

Link returns true iif this is a link.

func (*AddOnList) Range ¶

func (l *AddOnList) Range(f func(index int, item *AddOn) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*AddOnList) Slice ¶

func (l *AddOnList) Slice() []*AddOn

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type AddOnListBuilder ¶

type AddOnListBuilder struct {
	// contains filtered or unexported fields
}

AddOnListBuilder contains the data and logic needed to build 'add_on' objects.

func NewAddOnList ¶

func NewAddOnList() *AddOnListBuilder

NewAddOnList creates a new builder of 'add_on' objects.

func (*AddOnListBuilder) Build ¶

func (b *AddOnListBuilder) Build() (list *AddOnList, err error)

Build creates a list of 'add_on' objects using the configuration stored in the builder.

func (*AddOnListBuilder) Items ¶

func (b *AddOnListBuilder) Items(values ...*AddOnBuilder) *AddOnListBuilder

Items sets the items of the list.

type AddOnPollRequest ¶

type AddOnPollRequest struct {
	// contains filtered or unexported fields
}

AddOnPollRequest is the request for the Poll method.

func (*AddOnPollRequest) Header ¶

func (r *AddOnPollRequest) Header(name string, value interface{}) *AddOnPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*AddOnPollRequest) Interval ¶

func (r *AddOnPollRequest) Interval(value time.Duration) *AddOnPollRequest

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*AddOnPollRequest) Parameter ¶

func (r *AddOnPollRequest) Parameter(name string, value interface{}) *AddOnPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*AddOnPollRequest) Predicate ¶

func (r *AddOnPollRequest) Predicate(value func(*AddOnGetResponse) bool) *AddOnPollRequest

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*AddOnPollRequest) StartContext ¶

func (r *AddOnPollRequest) StartContext(ctx context.Context) (response *AddOnPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*AddOnPollRequest) Status ¶

func (r *AddOnPollRequest) Status(value int) *AddOnPollRequest

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type AddOnPollResponse ¶

type AddOnPollResponse struct {
	// contains filtered or unexported fields
}

AddOnPollResponse is the response for the Poll method.

func (*AddOnPollResponse) Body ¶

func (r *AddOnPollResponse) Body() *AddOn

Body returns the value of the 'body' parameter.

func (*AddOnPollResponse) Error ¶

func (r *AddOnPollResponse) Error() *errors.Error

Error returns the response error.

func (*AddOnPollResponse) GetBody ¶

func (r *AddOnPollResponse) GetBody() (value *AddOn, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*AddOnPollResponse) Header ¶

func (r *AddOnPollResponse) Header() http.Header

Header returns header of the response.

func (*AddOnPollResponse) Status ¶

func (r *AddOnPollResponse) Status() int

Status returns the response status code.

type AddOnServer ¶

type AddOnServer interface {

	// Delete handles a request for the 'delete' method.
	//
	// Deletes the add-on.
	Delete(ctx context.Context, request *AddOnDeleteServerRequest, response *AddOnDeleteServerResponse) error

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the add-on.
	Get(ctx context.Context, request *AddOnGetServerRequest, response *AddOnGetServerResponse) error

	// Update handles a request for the 'update' method.
	//
	// Updates the add-on.
	Update(ctx context.Context, request *AddOnUpdateServerRequest, response *AddOnUpdateServerResponse) error
}

AddOnServer represents the interface the manages the 'add_on' resource.

type AddOnUpdateRequest ¶

type AddOnUpdateRequest struct {
	// contains filtered or unexported fields
}

AddOnUpdateRequest is the request for the 'update' method.

func (*AddOnUpdateRequest) Body ¶

func (r *AddOnUpdateRequest) Body(value *AddOn) *AddOnUpdateRequest

Body sets the value of the 'body' parameter.

func (*AddOnUpdateRequest) Header ¶

func (r *AddOnUpdateRequest) Header(name string, value interface{}) *AddOnUpdateRequest

Header adds a request header.

func (*AddOnUpdateRequest) Parameter ¶

func (r *AddOnUpdateRequest) Parameter(name string, value interface{}) *AddOnUpdateRequest

Parameter adds a query parameter.

func (*AddOnUpdateRequest) Send ¶

func (r *AddOnUpdateRequest) Send() (result *AddOnUpdateResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*AddOnUpdateRequest) SendContext ¶

func (r *AddOnUpdateRequest) SendContext(ctx context.Context) (result *AddOnUpdateResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type AddOnUpdateResponse ¶

type AddOnUpdateResponse struct {
	// contains filtered or unexported fields
}

AddOnUpdateResponse is the response for the 'update' method.

func (*AddOnUpdateResponse) Body ¶

func (r *AddOnUpdateResponse) Body() *AddOn

Body returns the value of the 'body' parameter.

func (*AddOnUpdateResponse) Error ¶

func (r *AddOnUpdateResponse) Error() *errors.Error

Error returns the response error.

func (*AddOnUpdateResponse) GetBody ¶

func (r *AddOnUpdateResponse) GetBody() (value *AddOn, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*AddOnUpdateResponse) Header ¶

func (r *AddOnUpdateResponse) Header() http.Header

Header returns header of the response.

func (*AddOnUpdateResponse) Status ¶

func (r *AddOnUpdateResponse) Status() int

Status returns the response status code.

type AddOnUpdateServerRequest ¶

type AddOnUpdateServerRequest struct {
	// contains filtered or unexported fields
}

AddOnUpdateServerRequest is the request for the 'update' method.

func (*AddOnUpdateServerRequest) Body ¶

func (r *AddOnUpdateServerRequest) Body() *AddOn

Body returns the value of the 'body' parameter.

func (*AddOnUpdateServerRequest) GetBody ¶

func (r *AddOnUpdateServerRequest) GetBody() (value *AddOn, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

type AddOnUpdateServerResponse ¶

type AddOnUpdateServerResponse struct {
	// contains filtered or unexported fields
}

AddOnUpdateServerResponse is the response for the 'update' method.

func (*AddOnUpdateServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*AddOnUpdateServerResponse) Status ¶

Status sets the status code.

type AddOnsAddRequest ¶

type AddOnsAddRequest struct {
	// contains filtered or unexported fields
}

AddOnsAddRequest is the request for the 'add' method.

func (*AddOnsAddRequest) Body ¶

func (r *AddOnsAddRequest) Body(value *AddOn) *AddOnsAddRequest

Body sets the value of the 'body' parameter.

Description of the add-on.

func (*AddOnsAddRequest) Header ¶

func (r *AddOnsAddRequest) Header(name string, value interface{}) *AddOnsAddRequest

Header adds a request header.

func (*AddOnsAddRequest) Parameter ¶

func (r *AddOnsAddRequest) Parameter(name string, value interface{}) *AddOnsAddRequest

Parameter adds a query parameter.

func (*AddOnsAddRequest) Send ¶

func (r *AddOnsAddRequest) Send() (result *AddOnsAddResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*AddOnsAddRequest) SendContext ¶

func (r *AddOnsAddRequest) SendContext(ctx context.Context) (result *AddOnsAddResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type AddOnsAddResponse ¶

type AddOnsAddResponse struct {
	// contains filtered or unexported fields
}

AddOnsAddResponse is the response for the 'add' method.

func (*AddOnsAddResponse) Body ¶

func (r *AddOnsAddResponse) Body() *AddOn

Body returns the value of the 'body' parameter.

Description of the add-on.

func (*AddOnsAddResponse) Error ¶

func (r *AddOnsAddResponse) Error() *errors.Error

Error returns the response error.

func (*AddOnsAddResponse) GetBody ¶

func (r *AddOnsAddResponse) GetBody() (value *AddOn, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

Description of the add-on.

func (*AddOnsAddResponse) Header ¶

func (r *AddOnsAddResponse) Header() http.Header

Header returns header of the response.

func (*AddOnsAddResponse) Status ¶

func (r *AddOnsAddResponse) Status() int

Status returns the response status code.

type AddOnsAddServerRequest ¶

type AddOnsAddServerRequest struct {
	// contains filtered or unexported fields
}

AddOnsAddServerRequest is the request for the 'add' method.

func (*AddOnsAddServerRequest) Body ¶

func (r *AddOnsAddServerRequest) Body() *AddOn

Body returns the value of the 'body' parameter.

Description of the add-on.

func (*AddOnsAddServerRequest) GetBody ¶

func (r *AddOnsAddServerRequest) GetBody() (value *AddOn, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

Description of the add-on.

type AddOnsAddServerResponse ¶

type AddOnsAddServerResponse struct {
	// contains filtered or unexported fields
}

AddOnsAddServerResponse is the response for the 'add' method.

func (*AddOnsAddServerResponse) Body ¶

Body sets the value of the 'body' parameter.

Description of the add-on.

func (*AddOnsAddServerResponse) Status ¶

Status sets the status code.

type AddOnsClient ¶

type AddOnsClient struct {
	// contains filtered or unexported fields
}

AddOnsClient is the client of the 'add_ons' resource.

Manages the collection of add-ons.

func NewAddOnsClient ¶

func NewAddOnsClient(transport http.RoundTripper, path string, metric string) *AddOnsClient

NewAddOnsClient creates a new client for the 'add_ons' resource using the given transport to sned the requests and receive the responses.

func (*AddOnsClient) Add ¶

func (c *AddOnsClient) Add() *AddOnsAddRequest

Add creates a request for the 'add' method.

Create a new add-on and add it to the collection of add-ons.

func (*AddOnsClient) Addon ¶

func (c *AddOnsClient) Addon(id string) *AddOnClient

Addon returns the target 'add_on' resource for the given identifier.

Returns a reference to the service that manages a specific add-on.

func (*AddOnsClient) List ¶

func (c *AddOnsClient) List() *AddOnsListRequest

List creates a request for the 'list' method.

Retrieves the list of add-ons.

type AddOnsListRequest ¶

type AddOnsListRequest struct {
	// contains filtered or unexported fields
}

AddOnsListRequest is the request for the 'list' method.

func (*AddOnsListRequest) Header ¶

func (r *AddOnsListRequest) Header(name string, value interface{}) *AddOnsListRequest

Header adds a request header.

func (*AddOnsListRequest) Order ¶

func (r *AddOnsListRequest) Order(value string) *AddOnsListRequest

Order sets the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the add-on instead of the names of the columns of a table. For example, in order to sort the add-ons descending by name the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*AddOnsListRequest) Page ¶

func (r *AddOnsListRequest) Page(value int) *AddOnsListRequest

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*AddOnsListRequest) Parameter ¶

func (r *AddOnsListRequest) Parameter(name string, value interface{}) *AddOnsListRequest

Parameter adds a query parameter.

func (*AddOnsListRequest) Search ¶

func (r *AddOnsListRequest) Search(value string) *AddOnsListRequest

Search sets the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of an SQL statement, but using the names of the attributes of the add-on instead of the names of the columns of a table. For example, in order to retrieve all the add-ons with a name starting with `my` the value should be:

[source,sql] ---- name like 'my%' ----

If the parameter isn't provided, or if the value is empty, then all the add-ons that the user has permission to see will be returned.

func (*AddOnsListRequest) Send ¶

func (r *AddOnsListRequest) Send() (result *AddOnsListResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*AddOnsListRequest) SendContext ¶

func (r *AddOnsListRequest) SendContext(ctx context.Context) (result *AddOnsListResponse, err error)

SendContext sends this request, waits for the response, and returns it.

func (*AddOnsListRequest) Size ¶

func (r *AddOnsListRequest) Size(value int) *AddOnsListRequest

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

type AddOnsListResponse ¶

type AddOnsListResponse struct {
	// contains filtered or unexported fields
}

AddOnsListResponse is the response for the 'list' method.

func (*AddOnsListResponse) Error ¶

func (r *AddOnsListResponse) Error() *errors.Error

Error returns the response error.

func (*AddOnsListResponse) GetItems ¶

func (r *AddOnsListResponse) GetItems() (value *AddOnList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of add-ons.

func (*AddOnsListResponse) GetPage ¶

func (r *AddOnsListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*AddOnsListResponse) GetSize ¶

func (r *AddOnsListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

func (*AddOnsListResponse) GetTotal ¶

func (r *AddOnsListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

func (*AddOnsListResponse) Header ¶

func (r *AddOnsListResponse) Header() http.Header

Header returns header of the response.

func (*AddOnsListResponse) Items ¶

func (r *AddOnsListResponse) Items() *AddOnList

Items returns the value of the 'items' parameter.

Retrieved list of add-ons.

func (*AddOnsListResponse) Page ¶

func (r *AddOnsListResponse) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*AddOnsListResponse) Size ¶

func (r *AddOnsListResponse) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

func (*AddOnsListResponse) Status ¶

func (r *AddOnsListResponse) Status() int

Status returns the response status code.

func (*AddOnsListResponse) Total ¶

func (r *AddOnsListResponse) Total() int

Total returns the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type AddOnsListServerRequest ¶

type AddOnsListServerRequest struct {
	// contains filtered or unexported fields
}

AddOnsListServerRequest is the request for the 'list' method.

func (*AddOnsListServerRequest) GetOrder ¶

func (r *AddOnsListServerRequest) GetOrder() (value string, ok bool)

GetOrder returns the value of the 'order' parameter and a flag indicating if the parameter has a value.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the add-on instead of the names of the columns of a table. For example, in order to sort the add-ons descending by name the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*AddOnsListServerRequest) GetPage ¶

func (r *AddOnsListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*AddOnsListServerRequest) GetSearch ¶

func (r *AddOnsListServerRequest) GetSearch() (value string, ok bool)

GetSearch returns the value of the 'search' parameter and a flag indicating if the parameter has a value.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of an SQL statement, but using the names of the attributes of the add-on instead of the names of the columns of a table. For example, in order to retrieve all the add-ons with a name starting with `my` the value should be:

[source,sql] ---- name like 'my%' ----

If the parameter isn't provided, or if the value is empty, then all the add-ons that the user has permission to see will be returned.

func (*AddOnsListServerRequest) GetSize ¶

func (r *AddOnsListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

func (*AddOnsListServerRequest) Order ¶

func (r *AddOnsListServerRequest) Order() string

Order returns the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the add-on instead of the names of the columns of a table. For example, in order to sort the add-ons descending by name the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*AddOnsListServerRequest) Page ¶

func (r *AddOnsListServerRequest) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*AddOnsListServerRequest) Search ¶

func (r *AddOnsListServerRequest) Search() string

Search returns the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of an SQL statement, but using the names of the attributes of the add-on instead of the names of the columns of a table. For example, in order to retrieve all the add-ons with a name starting with `my` the value should be:

[source,sql] ---- name like 'my%' ----

If the parameter isn't provided, or if the value is empty, then all the add-ons that the user has permission to see will be returned.

func (*AddOnsListServerRequest) Size ¶

func (r *AddOnsListServerRequest) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

type AddOnsListServerResponse ¶

type AddOnsListServerResponse struct {
	// contains filtered or unexported fields
}

AddOnsListServerResponse is the response for the 'list' method.

func (*AddOnsListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of add-ons.

func (*AddOnsListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*AddOnsListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

func (*AddOnsListServerResponse) Status ¶

Status sets the status code.

func (*AddOnsListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type AddOnsServer ¶

type AddOnsServer interface {

	// Add handles a request for the 'add' method.
	//
	// Create a new add-on and add it to the collection of add-ons.
	Add(ctx context.Context, request *AddOnsAddServerRequest, response *AddOnsAddServerResponse) error

	// List handles a request for the 'list' method.
	//
	// Retrieves the list of add-ons.
	List(ctx context.Context, request *AddOnsListServerRequest, response *AddOnsListServerResponse) error

	// Addon returns the target 'add_on' server for the given identifier.
	//
	// Returns a reference to the service that manages a specific add-on.
	Addon(id string) AddOnServer
}

AddOnsServer represents the interface the manages the 'add_ons' resource.

type AdminCredentials ¶

type AdminCredentials struct {
	// contains filtered or unexported fields
}

AdminCredentials represents the values of the 'admin_credentials' type.

Temporary administrator credentials generated during the installation of the cluster.

func UnmarshalAdminCredentials ¶

func UnmarshalAdminCredentials(source interface{}) (object *AdminCredentials, err error)

UnmarshalAdminCredentials reads a value of the 'admin_credentials' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*AdminCredentials) Empty ¶

func (o *AdminCredentials) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*AdminCredentials) GetPassword ¶

func (o *AdminCredentials) GetPassword() (value string, ok bool)

GetPassword returns the value of the 'password' attribute and a flag indicating if the attribute has a value.

Cluster administrator password.

func (*AdminCredentials) GetUser ¶

func (o *AdminCredentials) GetUser() (value string, ok bool)

GetUser returns the value of the 'user' attribute and a flag indicating if the attribute has a value.

Cluster administrator user name.

func (*AdminCredentials) Password ¶

func (o *AdminCredentials) Password() string

Password returns the value of the 'password' attribute, or the zero value of the type if the attribute doesn't have a value.

Cluster administrator password.

func (*AdminCredentials) User ¶

func (o *AdminCredentials) User() string

User returns the value of the 'user' attribute, or the zero value of the type if the attribute doesn't have a value.

Cluster administrator user name.

type AdminCredentialsBuilder ¶

type AdminCredentialsBuilder struct {
	// contains filtered or unexported fields
}

AdminCredentialsBuilder contains the data and logic needed to build 'admin_credentials' objects.

Temporary administrator credentials generated during the installation of the cluster.

func NewAdminCredentials ¶

func NewAdminCredentials() *AdminCredentialsBuilder

NewAdminCredentials creates a new builder of 'admin_credentials' objects.

func (*AdminCredentialsBuilder) Build ¶

func (b *AdminCredentialsBuilder) Build() (object *AdminCredentials, err error)

Build creates a 'admin_credentials' object using the configuration stored in the builder.

func (*AdminCredentialsBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*AdminCredentialsBuilder) Password ¶

Password sets the value of the 'password' attribute to the given value.

func (*AdminCredentialsBuilder) User ¶

User sets the value of the 'user' attribute to the given value.

type AdminCredentialsList ¶

type AdminCredentialsList struct {
	// contains filtered or unexported fields
}

AdminCredentialsList is a list of values of the 'admin_credentials' type.

func UnmarshalAdminCredentialsList ¶

func UnmarshalAdminCredentialsList(source interface{}) (list *AdminCredentialsList, err error)

UnmarshalAdminCredentialsList reads a list of values of the 'admin_credentials' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*AdminCredentialsList) Each ¶

func (l *AdminCredentialsList) Each(f func(item *AdminCredentials) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*AdminCredentialsList) Empty ¶

func (l *AdminCredentialsList) Empty() bool

Empty returns true if the list is empty.

func (*AdminCredentialsList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*AdminCredentialsList) Len ¶

func (l *AdminCredentialsList) Len() int

Len returns the length of the list.

func (*AdminCredentialsList) Range ¶

func (l *AdminCredentialsList) Range(f func(index int, item *AdminCredentials) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*AdminCredentialsList) Slice ¶

func (l *AdminCredentialsList) Slice() []*AdminCredentials

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type AdminCredentialsListBuilder ¶

type AdminCredentialsListBuilder struct {
	// contains filtered or unexported fields
}

AdminCredentialsListBuilder contains the data and logic needed to build 'admin_credentials' objects.

func NewAdminCredentialsList ¶

func NewAdminCredentialsList() *AdminCredentialsListBuilder

NewAdminCredentialsList creates a new builder of 'admin_credentials' objects.

func (*AdminCredentialsListBuilder) Build ¶

func (b *AdminCredentialsListBuilder) Build() (list *AdminCredentialsList, err error)

Build creates a list of 'admin_credentials' objects using the configuration stored in the builder.

func (*AdminCredentialsListBuilder) Items ¶

Items sets the items of the list.

type CPUTotalByNodeRolesOSMetricQueryClient ¶

type CPUTotalByNodeRolesOSMetricQueryClient struct {
	// contains filtered or unexported fields
}

CPUTotalByNodeRolesOSMetricQueryClient is the client of the 'CPU_total_by_node_roles_OS_metric_query' resource.

Total cpu capacity in the cluster by node role and operating system.

func NewCPUTotalByNodeRolesOSMetricQueryClient ¶

func NewCPUTotalByNodeRolesOSMetricQueryClient(transport http.RoundTripper, path string, metric string) *CPUTotalByNodeRolesOSMetricQueryClient

NewCPUTotalByNodeRolesOSMetricQueryClient creates a new client for the 'CPU_total_by_node_roles_OS_metric_query' resource using the given transport to sned the requests and receive the responses.

func (*CPUTotalByNodeRolesOSMetricQueryClient) Get ¶

Get creates a request for the 'get' method.

Retrieves the metrics.

func (*CPUTotalByNodeRolesOSMetricQueryClient) Poll ¶

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type CPUTotalByNodeRolesOSMetricQueryGetRequest ¶

type CPUTotalByNodeRolesOSMetricQueryGetRequest struct {
	// contains filtered or unexported fields
}

CPUTotalByNodeRolesOSMetricQueryGetRequest is the request for the 'get' method.

func (*CPUTotalByNodeRolesOSMetricQueryGetRequest) Header ¶

Header adds a request header.

func (*CPUTotalByNodeRolesOSMetricQueryGetRequest) Parameter ¶

Parameter adds a query parameter.

func (*CPUTotalByNodeRolesOSMetricQueryGetRequest) Send ¶

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*CPUTotalByNodeRolesOSMetricQueryGetRequest) SendContext ¶

SendContext sends this request, waits for the response, and returns it.

type CPUTotalByNodeRolesOSMetricQueryGetResponse ¶

type CPUTotalByNodeRolesOSMetricQueryGetResponse struct {
	// contains filtered or unexported fields
}

CPUTotalByNodeRolesOSMetricQueryGetResponse is the response for the 'get' method.

func (*CPUTotalByNodeRolesOSMetricQueryGetResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*CPUTotalByNodeRolesOSMetricQueryGetResponse) Error ¶

Error returns the response error.

func (*CPUTotalByNodeRolesOSMetricQueryGetResponse) GetBody ¶

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*CPUTotalByNodeRolesOSMetricQueryGetResponse) Header ¶

Header returns header of the response.

func (*CPUTotalByNodeRolesOSMetricQueryGetResponse) Status ¶

Status returns the response status code.

type CPUTotalByNodeRolesOSMetricQueryGetServerRequest ¶

type CPUTotalByNodeRolesOSMetricQueryGetServerRequest struct {
}

CPUTotalByNodeRolesOSMetricQueryGetServerRequest is the request for the 'get' method.

type CPUTotalByNodeRolesOSMetricQueryGetServerResponse ¶

type CPUTotalByNodeRolesOSMetricQueryGetServerResponse struct {
	// contains filtered or unexported fields
}

CPUTotalByNodeRolesOSMetricQueryGetServerResponse is the response for the 'get' method.

func (*CPUTotalByNodeRolesOSMetricQueryGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*CPUTotalByNodeRolesOSMetricQueryGetServerResponse) Status ¶

Status sets the status code.

type CPUTotalByNodeRolesOSMetricQueryPollRequest ¶

type CPUTotalByNodeRolesOSMetricQueryPollRequest struct {
	// contains filtered or unexported fields
}

CPUTotalByNodeRolesOSMetricQueryPollRequest is the request for the Poll method.

func (*CPUTotalByNodeRolesOSMetricQueryPollRequest) Header ¶

Header adds a request header to all the requests that will be used to retrieve the object.

func (*CPUTotalByNodeRolesOSMetricQueryPollRequest) Interval ¶

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*CPUTotalByNodeRolesOSMetricQueryPollRequest) Parameter ¶

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*CPUTotalByNodeRolesOSMetricQueryPollRequest) Predicate ¶

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*CPUTotalByNodeRolesOSMetricQueryPollRequest) StartContext ¶

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*CPUTotalByNodeRolesOSMetricQueryPollRequest) Status ¶

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type CPUTotalByNodeRolesOSMetricQueryPollResponse ¶

type CPUTotalByNodeRolesOSMetricQueryPollResponse struct {
	// contains filtered or unexported fields
}

CPUTotalByNodeRolesOSMetricQueryPollResponse is the response for the Poll method.

func (*CPUTotalByNodeRolesOSMetricQueryPollResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*CPUTotalByNodeRolesOSMetricQueryPollResponse) Error ¶

Error returns the response error.

func (*CPUTotalByNodeRolesOSMetricQueryPollResponse) GetBody ¶

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*CPUTotalByNodeRolesOSMetricQueryPollResponse) Header ¶

Header returns header of the response.

func (*CPUTotalByNodeRolesOSMetricQueryPollResponse) Status ¶

Status returns the response status code.

type CPUTotalByNodeRolesOSMetricQueryServer ¶

type CPUTotalByNodeRolesOSMetricQueryServer interface {

	// Get handles a request for the 'get' method.
	//
	// Retrieves the metrics.
	Get(ctx context.Context, request *CPUTotalByNodeRolesOSMetricQueryGetServerRequest, response *CPUTotalByNodeRolesOSMetricQueryGetServerResponse) error
}

CPUTotalByNodeRolesOSMetricQueryServer represents the interface the manages the 'CPU_total_by_node_roles_OS_metric_query' resource.

type CPUTotalNodeRoleOSMetricNode ¶

type CPUTotalNodeRoleOSMetricNode struct {
	// contains filtered or unexported fields
}

CPUTotalNodeRoleOSMetricNode represents the values of the 'CPU_total_node_role_OS_metric_node' type.

Representation of information from telemetry about a the CPU capacity by node role and OS.

func UnmarshalCPUTotalNodeRoleOSMetricNode ¶

func UnmarshalCPUTotalNodeRoleOSMetricNode(source interface{}) (object *CPUTotalNodeRoleOSMetricNode, err error)

UnmarshalCPUTotalNodeRoleOSMetricNode reads a value of the 'CPU_total_node_role_OS_metric_node' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*CPUTotalNodeRoleOSMetricNode) CPUTotal ¶

func (o *CPUTotalNodeRoleOSMetricNode) CPUTotal() float64

CPUTotal returns the value of the 'CPU_total' attribute, or the zero value of the type if the attribute doesn't have a value.

The total CPU capacity of nodes with this set of roles and operating system.

func (*CPUTotalNodeRoleOSMetricNode) Empty ¶

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*CPUTotalNodeRoleOSMetricNode) GetCPUTotal ¶

func (o *CPUTotalNodeRoleOSMetricNode) GetCPUTotal() (value float64, ok bool)

GetCPUTotal returns the value of the 'CPU_total' attribute and a flag indicating if the attribute has a value.

The total CPU capacity of nodes with this set of roles and operating system.

func (*CPUTotalNodeRoleOSMetricNode) GetNodeRoles ¶

func (o *CPUTotalNodeRoleOSMetricNode) GetNodeRoles() (value []string, ok bool)

GetNodeRoles returns the value of the 'node_roles' attribute and a flag indicating if the attribute has a value.

Representation of the node role for a cluster.

func (*CPUTotalNodeRoleOSMetricNode) GetOperatingSystem ¶

func (o *CPUTotalNodeRoleOSMetricNode) GetOperatingSystem() (value string, ok bool)

GetOperatingSystem returns the value of the 'operating_system' attribute and a flag indicating if the attribute has a value.

The operating system.

func (*CPUTotalNodeRoleOSMetricNode) GetTime ¶

func (o *CPUTotalNodeRoleOSMetricNode) GetTime() (value time.Time, ok bool)

GetTime returns the value of the 'time' attribute and a flag indicating if the attribute has a value.

func (*CPUTotalNodeRoleOSMetricNode) NodeRoles ¶

func (o *CPUTotalNodeRoleOSMetricNode) NodeRoles() []string

NodeRoles returns the value of the 'node_roles' attribute, or the zero value of the type if the attribute doesn't have a value.

Representation of the node role for a cluster.

func (*CPUTotalNodeRoleOSMetricNode) OperatingSystem ¶

func (o *CPUTotalNodeRoleOSMetricNode) OperatingSystem() string

OperatingSystem returns the value of the 'operating_system' attribute, or the zero value of the type if the attribute doesn't have a value.

The operating system.

func (*CPUTotalNodeRoleOSMetricNode) Time ¶

Time returns the value of the 'time' attribute, or the zero value of the type if the attribute doesn't have a value.

type CPUTotalNodeRoleOSMetricNodeBuilder ¶

type CPUTotalNodeRoleOSMetricNodeBuilder struct {
	// contains filtered or unexported fields
}

CPUTotalNodeRoleOSMetricNodeBuilder contains the data and logic needed to build 'CPU_total_node_role_OS_metric_node' objects.

Representation of information from telemetry about a the CPU capacity by node role and OS.

func NewCPUTotalNodeRoleOSMetricNode ¶

func NewCPUTotalNodeRoleOSMetricNode() *CPUTotalNodeRoleOSMetricNodeBuilder

NewCPUTotalNodeRoleOSMetricNode creates a new builder of 'CPU_total_node_role_OS_metric_node' objects.

func (*CPUTotalNodeRoleOSMetricNodeBuilder) Build ¶

Build creates a 'CPU_total_node_role_OS_metric_node' object using the configuration stored in the builder.

func (*CPUTotalNodeRoleOSMetricNodeBuilder) CPUTotal ¶

CPUTotal sets the value of the 'CPU_total' attribute to the given value.

func (*CPUTotalNodeRoleOSMetricNodeBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*CPUTotalNodeRoleOSMetricNodeBuilder) NodeRoles ¶

NodeRoles sets the value of the 'node_roles' attribute to the given values.

func (*CPUTotalNodeRoleOSMetricNodeBuilder) OperatingSystem ¶

OperatingSystem sets the value of the 'operating_system' attribute to the given value.

func (*CPUTotalNodeRoleOSMetricNodeBuilder) Time ¶

Time sets the value of the 'time' attribute to the given value.

type CPUTotalNodeRoleOSMetricNodeList ¶

type CPUTotalNodeRoleOSMetricNodeList struct {
	// contains filtered or unexported fields
}

CPUTotalNodeRoleOSMetricNodeList is a list of values of the 'CPU_total_node_role_OS_metric_node' type.

func UnmarshalCPUTotalNodeRoleOSMetricNodeList ¶

func UnmarshalCPUTotalNodeRoleOSMetricNodeList(source interface{}) (list *CPUTotalNodeRoleOSMetricNodeList, err error)

UnmarshalCPUTotalNodeRoleOSMetricNodeList reads a list of values of the 'CPU_total_node_role_OS_metric_node' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*CPUTotalNodeRoleOSMetricNodeList) Each ¶

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*CPUTotalNodeRoleOSMetricNodeList) Empty ¶

Empty returns true if the list is empty.

func (*CPUTotalNodeRoleOSMetricNodeList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*CPUTotalNodeRoleOSMetricNodeList) Len ¶

Len returns the length of the list.

func (*CPUTotalNodeRoleOSMetricNodeList) Range ¶

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*CPUTotalNodeRoleOSMetricNodeList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type CPUTotalNodeRoleOSMetricNodeListBuilder ¶

type CPUTotalNodeRoleOSMetricNodeListBuilder struct {
	// contains filtered or unexported fields
}

CPUTotalNodeRoleOSMetricNodeListBuilder contains the data and logic needed to build 'CPU_total_node_role_OS_metric_node' objects.

func NewCPUTotalNodeRoleOSMetricNodeList ¶

func NewCPUTotalNodeRoleOSMetricNodeList() *CPUTotalNodeRoleOSMetricNodeListBuilder

NewCPUTotalNodeRoleOSMetricNodeList creates a new builder of 'CPU_total_node_role_OS_metric_node' objects.

func (*CPUTotalNodeRoleOSMetricNodeListBuilder) Build ¶

Build creates a list of 'CPU_total_node_role_OS_metric_node' objects using the configuration stored in the builder.

func (*CPUTotalNodeRoleOSMetricNodeListBuilder) Items ¶

Items sets the items of the list.

type CPUTotalsNodeRoleOSMetricNode ¶

type CPUTotalsNodeRoleOSMetricNode struct {
	// contains filtered or unexported fields
}

CPUTotalsNodeRoleOSMetricNode represents the values of the 'CPU_totals_node_role_OS_metric_node' type.

Representation of information from telemetry about the CPU capacity by node role and OS of a cluster.

func UnmarshalCPUTotalsNodeRoleOSMetricNode ¶

func UnmarshalCPUTotalsNodeRoleOSMetricNode(source interface{}) (object *CPUTotalsNodeRoleOSMetricNode, err error)

UnmarshalCPUTotalsNodeRoleOSMetricNode reads a value of the 'CPU_totals_node_role_OS_metric_node' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*CPUTotalsNodeRoleOSMetricNode) CPUTotals ¶

CPUTotals returns the value of the 'CPU_totals' attribute, or the zero value of the type if the attribute doesn't have a value.

func (*CPUTotalsNodeRoleOSMetricNode) Empty ¶

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*CPUTotalsNodeRoleOSMetricNode) GetCPUTotals ¶

GetCPUTotals returns the value of the 'CPU_totals' attribute and a flag indicating if the attribute has a value.

type CPUTotalsNodeRoleOSMetricNodeBuilder ¶

type CPUTotalsNodeRoleOSMetricNodeBuilder struct {
	// contains filtered or unexported fields
}

CPUTotalsNodeRoleOSMetricNodeBuilder contains the data and logic needed to build 'CPU_totals_node_role_OS_metric_node' objects.

Representation of information from telemetry about the CPU capacity by node role and OS of a cluster.

func NewCPUTotalsNodeRoleOSMetricNode ¶

func NewCPUTotalsNodeRoleOSMetricNode() *CPUTotalsNodeRoleOSMetricNodeBuilder

NewCPUTotalsNodeRoleOSMetricNode creates a new builder of 'CPU_totals_node_role_OS_metric_node' objects.

func (*CPUTotalsNodeRoleOSMetricNodeBuilder) Build ¶

Build creates a 'CPU_totals_node_role_OS_metric_node' object using the configuration stored in the builder.

func (*CPUTotalsNodeRoleOSMetricNodeBuilder) CPUTotals ¶

CPUTotals sets the value of the 'CPU_totals' attribute to the given values.

func (*CPUTotalsNodeRoleOSMetricNodeBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

type CPUTotalsNodeRoleOSMetricNodeList ¶

type CPUTotalsNodeRoleOSMetricNodeList struct {
	// contains filtered or unexported fields
}

CPUTotalsNodeRoleOSMetricNodeList is a list of values of the 'CPU_totals_node_role_OS_metric_node' type.

func UnmarshalCPUTotalsNodeRoleOSMetricNodeList ¶

func UnmarshalCPUTotalsNodeRoleOSMetricNodeList(source interface{}) (list *CPUTotalsNodeRoleOSMetricNodeList, err error)

UnmarshalCPUTotalsNodeRoleOSMetricNodeList reads a list of values of the 'CPU_totals_node_role_OS_metric_node' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*CPUTotalsNodeRoleOSMetricNodeList) Each ¶

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*CPUTotalsNodeRoleOSMetricNodeList) Empty ¶

Empty returns true if the list is empty.

func (*CPUTotalsNodeRoleOSMetricNodeList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*CPUTotalsNodeRoleOSMetricNodeList) Len ¶

Len returns the length of the list.

func (*CPUTotalsNodeRoleOSMetricNodeList) Range ¶

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*CPUTotalsNodeRoleOSMetricNodeList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type CPUTotalsNodeRoleOSMetricNodeListBuilder ¶

type CPUTotalsNodeRoleOSMetricNodeListBuilder struct {
	// contains filtered or unexported fields
}

CPUTotalsNodeRoleOSMetricNodeListBuilder contains the data and logic needed to build 'CPU_totals_node_role_OS_metric_node' objects.

func NewCPUTotalsNodeRoleOSMetricNodeList ¶

func NewCPUTotalsNodeRoleOSMetricNodeList() *CPUTotalsNodeRoleOSMetricNodeListBuilder

NewCPUTotalsNodeRoleOSMetricNodeList creates a new builder of 'CPU_totals_node_role_OS_metric_node' objects.

func (*CPUTotalsNodeRoleOSMetricNodeListBuilder) Build ¶

Build creates a list of 'CPU_totals_node_role_OS_metric_node' objects using the configuration stored in the builder.

func (*CPUTotalsNodeRoleOSMetricNodeListBuilder) Items ¶

Items sets the items of the list.

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client is the client of the 'root' resource.

Root of the tree of resources of the clusters management service.

func NewClient ¶

func NewClient(transport http.RoundTripper, path string, metric string) *Client

NewClient creates a new client for the 'root' resource using the given transport to sned the requests and receive the responses.

func (*Client) Addons ¶

func (c *Client) Addons() *AddOnsClient

Addons returns the target 'add_ons' resource.

Reference to the resource that manages the collection of add-ons.

func (*Client) CloudProviders ¶

func (c *Client) CloudProviders() *CloudProvidersClient

CloudProviders returns the target 'cloud_providers' resource.

Reference to the resource that manages the collection of cloud providers.

func (*Client) Clusters ¶

func (c *Client) Clusters() *ClustersClient

Clusters returns the target 'clusters' resource.

Reference to the resource that manages the collection of clusters.

func (*Client) Dashboards ¶

func (c *Client) Dashboards() *DashboardsClient

Dashboards returns the target 'dashboards' resource.

Reference to the resource that manages the collection of dashboards.

func (*Client) Flavours ¶

func (c *Client) Flavours() *FlavoursClient

Flavours returns the target 'flavours' resource.

Reference to the service that manages the collection of flavours.

func (*Client) Get ¶

func (c *Client) Get() *MetadataRequest

Creates a new request for the method that retrieves the metadata.

func (*Client) Versions ¶

func (c *Client) Versions() *VersionsClient

Versions returns the target 'versions' resource.

Reference to the resource that manage the collection of versions.

type CloudProvider ¶

type CloudProvider struct {
	// contains filtered or unexported fields
}

CloudProvider represents the values of the 'cloud_provider' type.

Cloud provider.

func UnmarshalCloudProvider ¶

func UnmarshalCloudProvider(source interface{}) (object *CloudProvider, err error)

UnmarshalCloudProvider reads a value of the 'cloud_provider' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*CloudProvider) DisplayName ¶

func (o *CloudProvider) DisplayName() string

DisplayName returns the value of the 'display_name' attribute, or the zero value of the type if the attribute doesn't have a value.

Name of the cloud provider for display purposes. It can contain any characters, including spaces.

func (*CloudProvider) Empty ¶

func (o *CloudProvider) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*CloudProvider) GetDisplayName ¶

func (o *CloudProvider) GetDisplayName() (value string, ok bool)

GetDisplayName returns the value of the 'display_name' attribute and a flag indicating if the attribute has a value.

Name of the cloud provider for display purposes. It can contain any characters, including spaces.

func (*CloudProvider) GetHREF ¶

func (o *CloudProvider) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*CloudProvider) GetID ¶

func (o *CloudProvider) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*CloudProvider) GetName ¶

func (o *CloudProvider) GetName() (value string, ok bool)

GetName returns the value of the 'name' attribute and a flag indicating if the attribute has a value.

Human friendly identifier of the cloud provider, for example `aws`.

func (*CloudProvider) HREF ¶

func (o *CloudProvider) HREF() string

HREF returns the link to the object.

func (*CloudProvider) ID ¶

func (o *CloudProvider) ID() string

ID returns the identifier of the object.

func (*CloudProvider) Kind ¶

func (o *CloudProvider) Kind() string

Kind returns the name of the type of the object.

func (o *CloudProvider) Link() bool

Link returns true iif this is a link.

func (*CloudProvider) Name ¶

func (o *CloudProvider) Name() string

Name returns the value of the 'name' attribute, or the zero value of the type if the attribute doesn't have a value.

Human friendly identifier of the cloud provider, for example `aws`.

type CloudProviderBuilder ¶

type CloudProviderBuilder struct {
	// contains filtered or unexported fields
}

CloudProviderBuilder contains the data and logic needed to build 'cloud_provider' objects.

Cloud provider.

func NewCloudProvider ¶

func NewCloudProvider() *CloudProviderBuilder

NewCloudProvider creates a new builder of 'cloud_provider' objects.

func (*CloudProviderBuilder) Build ¶

func (b *CloudProviderBuilder) Build() (object *CloudProvider, err error)

Build creates a 'cloud_provider' object using the configuration stored in the builder.

func (*CloudProviderBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*CloudProviderBuilder) DisplayName ¶

func (b *CloudProviderBuilder) DisplayName(value string) *CloudProviderBuilder

DisplayName sets the value of the 'display_name' attribute to the given value.

func (*CloudProviderBuilder) HREF ¶

HREF sets the link to the object.

func (*CloudProviderBuilder) ID ¶

ID sets the identifier of the object.

Link sets the flag that indicates if this is a link.

func (*CloudProviderBuilder) Name ¶

Name sets the value of the 'name' attribute to the given value.

type CloudProviderClient ¶

type CloudProviderClient struct {
	// contains filtered or unexported fields
}

CloudProviderClient is the client of the 'cloud_provider' resource.

Manages a specific cloud provider.

func NewCloudProviderClient ¶

func NewCloudProviderClient(transport http.RoundTripper, path string, metric string) *CloudProviderClient

NewCloudProviderClient creates a new client for the 'cloud_provider' resource using the given transport to sned the requests and receive the responses.

func (*CloudProviderClient) Get ¶

Get creates a request for the 'get' method.

Retrieves the details of the cloud provider.

func (*CloudProviderClient) Poll ¶

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

func (*CloudProviderClient) Regions ¶

Regions returns the target 'cloud_regions' resource.

Reference to the resource that manages the collection of regions for this cloud provider.

type CloudProviderGetRequest ¶

type CloudProviderGetRequest struct {
	// contains filtered or unexported fields
}

CloudProviderGetRequest is the request for the 'get' method.

func (*CloudProviderGetRequest) Header ¶

func (r *CloudProviderGetRequest) Header(name string, value interface{}) *CloudProviderGetRequest

Header adds a request header.

func (*CloudProviderGetRequest) Parameter ¶

func (r *CloudProviderGetRequest) Parameter(name string, value interface{}) *CloudProviderGetRequest

Parameter adds a query parameter.

func (*CloudProviderGetRequest) Send ¶

func (r *CloudProviderGetRequest) Send() (result *CloudProviderGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*CloudProviderGetRequest) SendContext ¶

func (r *CloudProviderGetRequest) SendContext(ctx context.Context) (result *CloudProviderGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type CloudProviderGetResponse ¶

type CloudProviderGetResponse struct {
	// contains filtered or unexported fields
}

CloudProviderGetResponse is the response for the 'get' method.

func (*CloudProviderGetResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*CloudProviderGetResponse) Error ¶

Error returns the response error.

func (*CloudProviderGetResponse) GetBody ¶

func (r *CloudProviderGetResponse) GetBody() (value *CloudProvider, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*CloudProviderGetResponse) Header ¶

func (r *CloudProviderGetResponse) Header() http.Header

Header returns header of the response.

func (*CloudProviderGetResponse) Status ¶

func (r *CloudProviderGetResponse) Status() int

Status returns the response status code.

type CloudProviderGetServerRequest ¶

type CloudProviderGetServerRequest struct {
}

CloudProviderGetServerRequest is the request for the 'get' method.

type CloudProviderGetServerResponse ¶

type CloudProviderGetServerResponse struct {
	// contains filtered or unexported fields
}

CloudProviderGetServerResponse is the response for the 'get' method.

func (*CloudProviderGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*CloudProviderGetServerResponse) Status ¶

Status sets the status code.

type CloudProviderList ¶

type CloudProviderList struct {
	// contains filtered or unexported fields
}

CloudProviderList is a list of values of the 'cloud_provider' type.

func UnmarshalCloudProviderList ¶

func UnmarshalCloudProviderList(source interface{}) (list *CloudProviderList, err error)

UnmarshalCloudProviderList reads a list of values of the 'cloud_provider' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*CloudProviderList) Each ¶

func (l *CloudProviderList) Each(f func(item *CloudProvider) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*CloudProviderList) Empty ¶

func (l *CloudProviderList) Empty() bool

Empty returns true if the list is empty.

func (*CloudProviderList) Get ¶

func (l *CloudProviderList) Get(i int) *CloudProvider

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*CloudProviderList) GetHREF ¶

func (l *CloudProviderList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*CloudProviderList) HREF ¶

func (l *CloudProviderList) HREF() string

HREF returns the link to the list.

func (*CloudProviderList) Kind ¶

func (l *CloudProviderList) Kind() string

Kind returns the name of the type of the object.

func (*CloudProviderList) Len ¶

func (l *CloudProviderList) Len() int

Len returns the length of the list.

func (l *CloudProviderList) Link() bool

Link returns true iif this is a link.

func (*CloudProviderList) Range ¶

func (l *CloudProviderList) Range(f func(index int, item *CloudProvider) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*CloudProviderList) Slice ¶

func (l *CloudProviderList) Slice() []*CloudProvider

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type CloudProviderListBuilder ¶

type CloudProviderListBuilder struct {
	// contains filtered or unexported fields
}

CloudProviderListBuilder contains the data and logic needed to build 'cloud_provider' objects.

func NewCloudProviderList ¶

func NewCloudProviderList() *CloudProviderListBuilder

NewCloudProviderList creates a new builder of 'cloud_provider' objects.

func (*CloudProviderListBuilder) Build ¶

func (b *CloudProviderListBuilder) Build() (list *CloudProviderList, err error)

Build creates a list of 'cloud_provider' objects using the configuration stored in the builder.

func (*CloudProviderListBuilder) Items ¶

Items sets the items of the list.

type CloudProviderPollRequest ¶

type CloudProviderPollRequest struct {
	// contains filtered or unexported fields
}

CloudProviderPollRequest is the request for the Poll method.

func (*CloudProviderPollRequest) Header ¶

func (r *CloudProviderPollRequest) Header(name string, value interface{}) *CloudProviderPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*CloudProviderPollRequest) Interval ¶

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*CloudProviderPollRequest) Parameter ¶

func (r *CloudProviderPollRequest) Parameter(name string, value interface{}) *CloudProviderPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*CloudProviderPollRequest) Predicate ¶

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*CloudProviderPollRequest) StartContext ¶

func (r *CloudProviderPollRequest) StartContext(ctx context.Context) (response *CloudProviderPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*CloudProviderPollRequest) Status ¶

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type CloudProviderPollResponse ¶

type CloudProviderPollResponse struct {
	// contains filtered or unexported fields
}

CloudProviderPollResponse is the response for the Poll method.

func (*CloudProviderPollResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*CloudProviderPollResponse) Error ¶

Error returns the response error.

func (*CloudProviderPollResponse) GetBody ¶

func (r *CloudProviderPollResponse) GetBody() (value *CloudProvider, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*CloudProviderPollResponse) Header ¶

Header returns header of the response.

func (*CloudProviderPollResponse) Status ¶

func (r *CloudProviderPollResponse) Status() int

Status returns the response status code.

type CloudProviderServer ¶

type CloudProviderServer interface {

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the cloud provider.
	Get(ctx context.Context, request *CloudProviderGetServerRequest, response *CloudProviderGetServerResponse) error

	// Regions returns the target 'cloud_regions' resource.
	//
	// Reference to the resource that manages the collection of regions for
	// this cloud provider.
	Regions() CloudRegionsServer
}

CloudProviderServer represents the interface the manages the 'cloud_provider' resource.

type CloudProvidersClient ¶

type CloudProvidersClient struct {
	// contains filtered or unexported fields
}

CloudProvidersClient is the client of the 'cloud_providers' resource.

Manages the collection of cloud providers.

func NewCloudProvidersClient ¶

func NewCloudProvidersClient(transport http.RoundTripper, path string, metric string) *CloudProvidersClient

NewCloudProvidersClient creates a new client for the 'cloud_providers' resource using the given transport to sned the requests and receive the responses.

func (*CloudProvidersClient) CloudProvider ¶

func (c *CloudProvidersClient) CloudProvider(id string) *CloudProviderClient

CloudProvider returns the target 'cloud_provider' resource for the given identifier.

Returns a reference to the service that manages an specific cloud provider.

func (*CloudProvidersClient) List ¶

List creates a request for the 'list' method.

Retrieves the list of cloud providers.

type CloudProvidersListRequest ¶

type CloudProvidersListRequest struct {
	// contains filtered or unexported fields
}

CloudProvidersListRequest is the request for the 'list' method.

func (*CloudProvidersListRequest) Header ¶

func (r *CloudProvidersListRequest) Header(name string, value interface{}) *CloudProvidersListRequest

Header adds a request header.

func (*CloudProvidersListRequest) Order ¶

Order sets the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the cloud provider instead of the names of the columns of a table. For example, in order to sort the clusters descending by name identifier the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*CloudProvidersListRequest) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*CloudProvidersListRequest) Parameter ¶

func (r *CloudProvidersListRequest) Parameter(name string, value interface{}) *CloudProvidersListRequest

Parameter adds a query parameter.

func (*CloudProvidersListRequest) Search ¶

Search sets the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the cloud provider instead of the names of the columns of a table. For example, in order to retrieve all the cloud providers with a name starting with `A` the value should be:

[source,sql] ---- name like 'A%' ----

If the parameter isn't provided, or if the value is empty, then all the clusters that the user has permission to see will be returned.

func (*CloudProvidersListRequest) Send ¶

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*CloudProvidersListRequest) SendContext ¶

func (r *CloudProvidersListRequest) SendContext(ctx context.Context) (result *CloudProvidersListResponse, err error)

SendContext sends this request, waits for the response, and returns it.

func (*CloudProvidersListRequest) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

type CloudProvidersListResponse ¶

type CloudProvidersListResponse struct {
	// contains filtered or unexported fields
}

CloudProvidersListResponse is the response for the 'list' method.

func (*CloudProvidersListResponse) Error ¶

Error returns the response error.

func (*CloudProvidersListResponse) GetItems ¶

func (r *CloudProvidersListResponse) GetItems() (value *CloudProviderList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of cloud providers.

func (*CloudProvidersListResponse) GetPage ¶

func (r *CloudProvidersListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*CloudProvidersListResponse) GetSize ¶

func (r *CloudProvidersListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

func (*CloudProvidersListResponse) GetTotal ¶

func (r *CloudProvidersListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

func (*CloudProvidersListResponse) Header ¶

Header returns header of the response.

func (*CloudProvidersListResponse) Items ¶

Items returns the value of the 'items' parameter.

Retrieved list of cloud providers.

func (*CloudProvidersListResponse) Page ¶

func (r *CloudProvidersListResponse) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*CloudProvidersListResponse) Size ¶

func (r *CloudProvidersListResponse) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

func (*CloudProvidersListResponse) Status ¶

func (r *CloudProvidersListResponse) Status() int

Status returns the response status code.

func (*CloudProvidersListResponse) Total ¶

func (r *CloudProvidersListResponse) Total() int

Total returns the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type CloudProvidersListServerRequest ¶

type CloudProvidersListServerRequest struct {
	// contains filtered or unexported fields
}

CloudProvidersListServerRequest is the request for the 'list' method.

func (*CloudProvidersListServerRequest) GetOrder ¶

func (r *CloudProvidersListServerRequest) GetOrder() (value string, ok bool)

GetOrder returns the value of the 'order' parameter and a flag indicating if the parameter has a value.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the cloud provider instead of the names of the columns of a table. For example, in order to sort the clusters descending by name identifier the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*CloudProvidersListServerRequest) GetPage ¶

func (r *CloudProvidersListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*CloudProvidersListServerRequest) GetSearch ¶

func (r *CloudProvidersListServerRequest) GetSearch() (value string, ok bool)

GetSearch returns the value of the 'search' parameter and a flag indicating if the parameter has a value.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the cloud provider instead of the names of the columns of a table. For example, in order to retrieve all the cloud providers with a name starting with `A` the value should be:

[source,sql] ---- name like 'A%' ----

If the parameter isn't provided, or if the value is empty, then all the clusters that the user has permission to see will be returned.

func (*CloudProvidersListServerRequest) GetSize ¶

func (r *CloudProvidersListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

func (*CloudProvidersListServerRequest) Order ¶

Order returns the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the cloud provider instead of the names of the columns of a table. For example, in order to sort the clusters descending by name identifier the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*CloudProvidersListServerRequest) Page ¶

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*CloudProvidersListServerRequest) Search ¶

Search returns the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the cloud provider instead of the names of the columns of a table. For example, in order to retrieve all the cloud providers with a name starting with `A` the value should be:

[source,sql] ---- name like 'A%' ----

If the parameter isn't provided, or if the value is empty, then all the clusters that the user has permission to see will be returned.

func (*CloudProvidersListServerRequest) Size ¶

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

type CloudProvidersListServerResponse ¶

type CloudProvidersListServerResponse struct {
	// contains filtered or unexported fields
}

CloudProvidersListServerResponse is the response for the 'list' method.

func (*CloudProvidersListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of cloud providers.

func (*CloudProvidersListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*CloudProvidersListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

func (*CloudProvidersListServerResponse) Status ¶

Status sets the status code.

func (*CloudProvidersListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type CloudProvidersServer ¶

type CloudProvidersServer interface {

	// List handles a request for the 'list' method.
	//
	// Retrieves the list of cloud providers.
	List(ctx context.Context, request *CloudProvidersListServerRequest, response *CloudProvidersListServerResponse) error

	// CloudProvider returns the target 'cloud_provider' server for the given identifier.
	//
	// Returns a reference to the service that manages an specific cloud provider.
	CloudProvider(id string) CloudProviderServer
}

CloudProvidersServer represents the interface the manages the 'cloud_providers' resource.

type CloudRegion ¶

type CloudRegion struct {
	// contains filtered or unexported fields
}

CloudRegion represents the values of the 'cloud_region' type.

Description of a region of a cloud provider.

func UnmarshalCloudRegion ¶

func UnmarshalCloudRegion(source interface{}) (object *CloudRegion, err error)

UnmarshalCloudRegion reads a value of the 'cloud_region' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*CloudRegion) CloudProvider ¶

func (o *CloudRegion) CloudProvider() *CloudProvider

CloudProvider returns the value of the 'cloud_provider' attribute, or the zero value of the type if the attribute doesn't have a value.

Link to the cloud provider that the region belongs to.

func (*CloudRegion) DisplayName ¶

func (o *CloudRegion) DisplayName() string

DisplayName returns the value of the 'display_name' attribute, or the zero value of the type if the attribute doesn't have a value.

Name of the region for display purposes, for example `N. Virginia`.

func (*CloudRegion) Empty ¶

func (o *CloudRegion) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*CloudRegion) GetCloudProvider ¶

func (o *CloudRegion) GetCloudProvider() (value *CloudProvider, ok bool)

GetCloudProvider returns the value of the 'cloud_provider' attribute and a flag indicating if the attribute has a value.

Link to the cloud provider that the region belongs to.

func (*CloudRegion) GetDisplayName ¶

func (o *CloudRegion) GetDisplayName() (value string, ok bool)

GetDisplayName returns the value of the 'display_name' attribute and a flag indicating if the attribute has a value.

Name of the region for display purposes, for example `N. Virginia`.

func (*CloudRegion) GetHREF ¶

func (o *CloudRegion) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*CloudRegion) GetID ¶

func (o *CloudRegion) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*CloudRegion) GetName ¶

func (o *CloudRegion) GetName() (value string, ok bool)

GetName returns the value of the 'name' attribute and a flag indicating if the attribute has a value.

Human friendly identifier of the region, for example `us-east-1`.

NOTE: Currently for all cloud provideers and all regions `id` and `name` have exactly the same values.

func (*CloudRegion) HREF ¶

func (o *CloudRegion) HREF() string

HREF returns the link to the object.

func (*CloudRegion) ID ¶

func (o *CloudRegion) ID() string

ID returns the identifier of the object.

func (*CloudRegion) Kind ¶

func (o *CloudRegion) Kind() string

Kind returns the name of the type of the object.

func (o *CloudRegion) Link() bool

Link returns true iif this is a link.

func (*CloudRegion) Name ¶

func (o *CloudRegion) Name() string

Name returns the value of the 'name' attribute, or the zero value of the type if the attribute doesn't have a value.

Human friendly identifier of the region, for example `us-east-1`.

NOTE: Currently for all cloud provideers and all regions `id` and `name` have exactly the same values.

type CloudRegionBuilder ¶

type CloudRegionBuilder struct {
	// contains filtered or unexported fields
}

CloudRegionBuilder contains the data and logic needed to build 'cloud_region' objects.

Description of a region of a cloud provider.

func NewCloudRegion ¶

func NewCloudRegion() *CloudRegionBuilder

NewCloudRegion creates a new builder of 'cloud_region' objects.

func (*CloudRegionBuilder) Build ¶

func (b *CloudRegionBuilder) Build() (object *CloudRegion, err error)

Build creates a 'cloud_region' object using the configuration stored in the builder.

func (*CloudRegionBuilder) CloudProvider ¶

CloudProvider sets the value of the 'cloud_provider' attribute to the given value.

Cloud provider.

func (*CloudRegionBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*CloudRegionBuilder) DisplayName ¶

func (b *CloudRegionBuilder) DisplayName(value string) *CloudRegionBuilder

DisplayName sets the value of the 'display_name' attribute to the given value.

func (*CloudRegionBuilder) HREF ¶

HREF sets the link to the object.

func (*CloudRegionBuilder) ID ¶

ID sets the identifier of the object.

func (b *CloudRegionBuilder) Link(value bool) *CloudRegionBuilder

Link sets the flag that indicates if this is a link.

func (*CloudRegionBuilder) Name ¶

Name sets the value of the 'name' attribute to the given value.

type CloudRegionClient ¶

type CloudRegionClient struct {
	// contains filtered or unexported fields
}

CloudRegionClient is the client of the 'cloud_region' resource.

Manages a specific cloud region.

func NewCloudRegionClient ¶

func NewCloudRegionClient(transport http.RoundTripper, path string, metric string) *CloudRegionClient

NewCloudRegionClient creates a new client for the 'cloud_region' resource using the given transport to sned the requests and receive the responses.

func (*CloudRegionClient) Get ¶

Get creates a request for the 'get' method.

Retrieves the details of the region.

func (*CloudRegionClient) Poll ¶

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type CloudRegionGetRequest ¶

type CloudRegionGetRequest struct {
	// contains filtered or unexported fields
}

CloudRegionGetRequest is the request for the 'get' method.

func (*CloudRegionGetRequest) Header ¶

func (r *CloudRegionGetRequest) Header(name string, value interface{}) *CloudRegionGetRequest

Header adds a request header.

func (*CloudRegionGetRequest) Parameter ¶

func (r *CloudRegionGetRequest) Parameter(name string, value interface{}) *CloudRegionGetRequest

Parameter adds a query parameter.

func (*CloudRegionGetRequest) Send ¶

func (r *CloudRegionGetRequest) Send() (result *CloudRegionGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*CloudRegionGetRequest) SendContext ¶

func (r *CloudRegionGetRequest) SendContext(ctx context.Context) (result *CloudRegionGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type CloudRegionGetResponse ¶

type CloudRegionGetResponse struct {
	// contains filtered or unexported fields
}

CloudRegionGetResponse is the response for the 'get' method.

func (*CloudRegionGetResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*CloudRegionGetResponse) Error ¶

func (r *CloudRegionGetResponse) Error() *errors.Error

Error returns the response error.

func (*CloudRegionGetResponse) GetBody ¶

func (r *CloudRegionGetResponse) GetBody() (value *CloudRegion, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*CloudRegionGetResponse) Header ¶

func (r *CloudRegionGetResponse) Header() http.Header

Header returns header of the response.

func (*CloudRegionGetResponse) Status ¶

func (r *CloudRegionGetResponse) Status() int

Status returns the response status code.

type CloudRegionGetServerRequest ¶

type CloudRegionGetServerRequest struct {
}

CloudRegionGetServerRequest is the request for the 'get' method.

type CloudRegionGetServerResponse ¶

type CloudRegionGetServerResponse struct {
	// contains filtered or unexported fields
}

CloudRegionGetServerResponse is the response for the 'get' method.

func (*CloudRegionGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*CloudRegionGetServerResponse) Status ¶

Status sets the status code.

type CloudRegionList ¶

type CloudRegionList struct {
	// contains filtered or unexported fields
}

CloudRegionList is a list of values of the 'cloud_region' type.

func UnmarshalCloudRegionList ¶

func UnmarshalCloudRegionList(source interface{}) (list *CloudRegionList, err error)

UnmarshalCloudRegionList reads a list of values of the 'cloud_region' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*CloudRegionList) Each ¶

func (l *CloudRegionList) Each(f func(item *CloudRegion) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*CloudRegionList) Empty ¶

func (l *CloudRegionList) Empty() bool

Empty returns true if the list is empty.

func (*CloudRegionList) Get ¶

func (l *CloudRegionList) Get(i int) *CloudRegion

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*CloudRegionList) GetHREF ¶

func (l *CloudRegionList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*CloudRegionList) HREF ¶

func (l *CloudRegionList) HREF() string

HREF returns the link to the list.

func (*CloudRegionList) Kind ¶

func (l *CloudRegionList) Kind() string

Kind returns the name of the type of the object.

func (*CloudRegionList) Len ¶

func (l *CloudRegionList) Len() int

Len returns the length of the list.

func (l *CloudRegionList) Link() bool

Link returns true iif this is a link.

func (*CloudRegionList) Range ¶

func (l *CloudRegionList) Range(f func(index int, item *CloudRegion) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*CloudRegionList) Slice ¶

func (l *CloudRegionList) Slice() []*CloudRegion

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type CloudRegionListBuilder ¶

type CloudRegionListBuilder struct {
	// contains filtered or unexported fields
}

CloudRegionListBuilder contains the data and logic needed to build 'cloud_region' objects.

func NewCloudRegionList ¶

func NewCloudRegionList() *CloudRegionListBuilder

NewCloudRegionList creates a new builder of 'cloud_region' objects.

func (*CloudRegionListBuilder) Build ¶

func (b *CloudRegionListBuilder) Build() (list *CloudRegionList, err error)

Build creates a list of 'cloud_region' objects using the configuration stored in the builder.

func (*CloudRegionListBuilder) Items ¶

Items sets the items of the list.

type CloudRegionPollRequest ¶

type CloudRegionPollRequest struct {
	// contains filtered or unexported fields
}

CloudRegionPollRequest is the request for the Poll method.

func (*CloudRegionPollRequest) Header ¶

func (r *CloudRegionPollRequest) Header(name string, value interface{}) *CloudRegionPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*CloudRegionPollRequest) Interval ¶

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*CloudRegionPollRequest) Parameter ¶

func (r *CloudRegionPollRequest) Parameter(name string, value interface{}) *CloudRegionPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*CloudRegionPollRequest) Predicate ¶

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*CloudRegionPollRequest) StartContext ¶

func (r *CloudRegionPollRequest) StartContext(ctx context.Context) (response *CloudRegionPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*CloudRegionPollRequest) Status ¶

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type CloudRegionPollResponse ¶

type CloudRegionPollResponse struct {
	// contains filtered or unexported fields
}

CloudRegionPollResponse is the response for the Poll method.

func (*CloudRegionPollResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*CloudRegionPollResponse) Error ¶

func (r *CloudRegionPollResponse) Error() *errors.Error

Error returns the response error.

func (*CloudRegionPollResponse) GetBody ¶

func (r *CloudRegionPollResponse) GetBody() (value *CloudRegion, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*CloudRegionPollResponse) Header ¶

func (r *CloudRegionPollResponse) Header() http.Header

Header returns header of the response.

func (*CloudRegionPollResponse) Status ¶

func (r *CloudRegionPollResponse) Status() int

Status returns the response status code.

type CloudRegionServer ¶

type CloudRegionServer interface {

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the region.
	Get(ctx context.Context, request *CloudRegionGetServerRequest, response *CloudRegionGetServerResponse) error
}

CloudRegionServer represents the interface the manages the 'cloud_region' resource.

type CloudRegionsClient ¶

type CloudRegionsClient struct {
	// contains filtered or unexported fields
}

CloudRegionsClient is the client of the 'cloud_regions' resource.

Manages the collection of regions of a cloud provider.

func NewCloudRegionsClient ¶

func NewCloudRegionsClient(transport http.RoundTripper, path string, metric string) *CloudRegionsClient

NewCloudRegionsClient creates a new client for the 'cloud_regions' resource using the given transport to sned the requests and receive the responses.

func (*CloudRegionsClient) List ¶

List creates a request for the 'list' method.

Retrieves the list of regions of the cloud provider.

IMPORTANT: This collection doesn't currently support paging or searching, so the returned `page` will always be 1 and `size` and `total` will always be the total number of regions of the provider.

func (*CloudRegionsClient) Region ¶

Region returns the target 'cloud_region' resource for the given identifier.

Reference to the service that manages an specific region.

type CloudRegionsListRequest ¶

type CloudRegionsListRequest struct {
	// contains filtered or unexported fields
}

CloudRegionsListRequest is the request for the 'list' method.

func (*CloudRegionsListRequest) Header ¶

func (r *CloudRegionsListRequest) Header(name string, value interface{}) *CloudRegionsListRequest

Header adds a request header.

func (*CloudRegionsListRequest) Page ¶

Page sets the value of the 'page' parameter.

Index of the returned page, where one corresponds to the first page. As this collection doesn't support paging the result will always be `1`.

func (*CloudRegionsListRequest) Parameter ¶

func (r *CloudRegionsListRequest) Parameter(name string, value interface{}) *CloudRegionsListRequest

Parameter adds a query parameter.

func (*CloudRegionsListRequest) Send ¶

func (r *CloudRegionsListRequest) Send() (result *CloudRegionsListResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*CloudRegionsListRequest) SendContext ¶

func (r *CloudRegionsListRequest) SendContext(ctx context.Context) (result *CloudRegionsListResponse, err error)

SendContext sends this request, waits for the response, and returns it.

func (*CloudRegionsListRequest) Size ¶

Size sets the value of the 'size' parameter.

Number of items that will be contained in the returned page. As this collection doesn't support paging or searching the result will always be the total number of regions of the provider.

type CloudRegionsListResponse ¶

type CloudRegionsListResponse struct {
	// contains filtered or unexported fields
}

CloudRegionsListResponse is the response for the 'list' method.

func (*CloudRegionsListResponse) Error ¶

Error returns the response error.

func (*CloudRegionsListResponse) GetItems ¶

func (r *CloudRegionsListResponse) GetItems() (value *CloudRegionList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of cloud providers.

func (*CloudRegionsListResponse) GetPage ¶

func (r *CloudRegionsListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the returned page, where one corresponds to the first page. As this collection doesn't support paging the result will always be `1`.

func (*CloudRegionsListResponse) GetSize ¶

func (r *CloudRegionsListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Number of items that will be contained in the returned page. As this collection doesn't support paging or searching the result will always be the total number of regions of the provider.

func (*CloudRegionsListResponse) GetTotal ¶

func (r *CloudRegionsListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection that match the search criteria, regardless of the size of the page. As this collection doesn't support paging or searching the result will always be the total number of regions of the provider.

func (*CloudRegionsListResponse) Header ¶

func (r *CloudRegionsListResponse) Header() http.Header

Header returns header of the response.

func (*CloudRegionsListResponse) Items ¶

Items returns the value of the 'items' parameter.

Retrieved list of cloud providers.

func (*CloudRegionsListResponse) Page ¶

func (r *CloudRegionsListResponse) Page() int

Page returns the value of the 'page' parameter.

Index of the returned page, where one corresponds to the first page. As this collection doesn't support paging the result will always be `1`.

func (*CloudRegionsListResponse) Size ¶

func (r *CloudRegionsListResponse) Size() int

Size returns the value of the 'size' parameter.

Number of items that will be contained in the returned page. As this collection doesn't support paging or searching the result will always be the total number of regions of the provider.

func (*CloudRegionsListResponse) Status ¶

func (r *CloudRegionsListResponse) Status() int

Status returns the response status code.

func (*CloudRegionsListResponse) Total ¶

func (r *CloudRegionsListResponse) Total() int

Total returns the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page. As this collection doesn't support paging or searching the result will always be the total number of regions of the provider.

type CloudRegionsListServerRequest ¶

type CloudRegionsListServerRequest struct {
	// contains filtered or unexported fields
}

CloudRegionsListServerRequest is the request for the 'list' method.

func (*CloudRegionsListServerRequest) GetPage ¶

func (r *CloudRegionsListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the returned page, where one corresponds to the first page. As this collection doesn't support paging the result will always be `1`.

func (*CloudRegionsListServerRequest) GetSize ¶

func (r *CloudRegionsListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Number of items that will be contained in the returned page. As this collection doesn't support paging or searching the result will always be the total number of regions of the provider.

func (*CloudRegionsListServerRequest) Page ¶

Page returns the value of the 'page' parameter.

Index of the returned page, where one corresponds to the first page. As this collection doesn't support paging the result will always be `1`.

func (*CloudRegionsListServerRequest) Size ¶

Size returns the value of the 'size' parameter.

Number of items that will be contained in the returned page. As this collection doesn't support paging or searching the result will always be the total number of regions of the provider.

type CloudRegionsListServerResponse ¶

type CloudRegionsListServerResponse struct {
	// contains filtered or unexported fields
}

CloudRegionsListServerResponse is the response for the 'list' method.

func (*CloudRegionsListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of cloud providers.

func (*CloudRegionsListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the returned page, where one corresponds to the first page. As this collection doesn't support paging the result will always be `1`.

func (*CloudRegionsListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Number of items that will be contained in the returned page. As this collection doesn't support paging or searching the result will always be the total number of regions of the provider.

func (*CloudRegionsListServerResponse) Status ¶

Status sets the status code.

func (*CloudRegionsListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page. As this collection doesn't support paging or searching the result will always be the total number of regions of the provider.

type CloudRegionsServer ¶

type CloudRegionsServer interface {

	// List handles a request for the 'list' method.
	//
	// Retrieves the list of regions of the cloud provider.
	//
	// IMPORTANT: This collection doesn't currently support paging or searching, so the returned
	// `page` will always be 1 and `size` and `total` will always be the total number of regions
	// of the provider.
	List(ctx context.Context, request *CloudRegionsListServerRequest, response *CloudRegionsListServerResponse) error

	// Region returns the target 'cloud_region' server for the given identifier.
	//
	// Reference to the service that manages an specific region.
	Region(id string) CloudRegionServer
}

CloudRegionsServer represents the interface the manages the 'cloud_regions' resource.

type Cluster ¶

type Cluster struct {
	// contains filtered or unexported fields
}

Cluster represents the values of the 'cluster' type.

Definition of an _OpenShift_ cluster.

The `cloud_provider` attribute is a reference to the cloud provider. When a cluster is retrieved it will be a link to the cloud provider, containing only the kind, id and href attributes:

[source,json] ----

{
  "cloud_provider": {
    "kind": "CloudProviderLink",
    "id": "123",
    "href": "/api/clusters_mgmt/v1/cloud_providers/123"
  }
}

----

When a cluster is created this is optional, and if used it should contain the identifier of the cloud provider to use:

[source,json] ----

{
  "cloud_provider": {
    "id": "123",
  }
}

----

If not included, then the cluster will be created using the default cloud provider, which is currently Amazon Web Services.

The region attribute is mandatory when a cluster is created.

The `aws.access_key_id`, `aws.secret_access_key` and `dns.base_domain` attributes are mandatory when creation a cluster with your own Amazon Web Services account.

func UnmarshalCluster ¶

func UnmarshalCluster(source interface{}) (object *Cluster, err error)

UnmarshalCluster reads a value of the 'cluster' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Cluster) API ¶

func (o *Cluster) API() *ClusterAPI

API returns the value of the 'API' attribute, or the zero value of the type if the attribute doesn't have a value.

Information about the API of the cluster.

func (*Cluster) AWS ¶

func (o *Cluster) AWS() *AWS

AWS returns the value of the 'AWS' attribute, or the zero value of the type if the attribute doesn't have a value.

Amazon Web Services settings of the cluster.

func (*Cluster) Addons ¶

func (o *Cluster) Addons() *AddOnList

Addons returns the value of the 'addons' attribute, or the zero value of the type if the attribute doesn't have a value.

List of add-ons on this cluster.

func (*Cluster) CloudProvider ¶

func (o *Cluster) CloudProvider() *CloudProvider

CloudProvider returns the value of the 'cloud_provider' attribute, or the zero value of the type if the attribute doesn't have a value.

Link to the cloud provider where the cluster is installed.

func (*Cluster) Console ¶

func (o *Cluster) Console() *ClusterConsole

Console returns the value of the 'console' attribute, or the zero value of the type if the attribute doesn't have a value.

Information about the console of the cluster.

func (*Cluster) CreationTimestamp ¶

func (o *Cluster) CreationTimestamp() time.Time

CreationTimestamp returns the value of the 'creation_timestamp' attribute, or the zero value of the type if the attribute doesn't have a value.

Date and time when the cluster was initially created, using the format defined in https://www.ietf.org/rfc/rfc3339.txt[RC3339].

func (*Cluster) DNS ¶

func (o *Cluster) DNS() *DNS

DNS returns the value of the 'DNS' attribute, or the zero value of the type if the attribute doesn't have a value.

DNS settings of the cluster.

func (*Cluster) DisplayName ¶

func (o *Cluster) DisplayName() string

DisplayName returns the value of the 'display_name' attribute, or the zero value of the type if the attribute doesn't have a value.

Name of the cluster for display purposes. It can contain any characters, including spaces.

func (*Cluster) Empty ¶

func (o *Cluster) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Cluster) ExpirationTimestamp ¶

func (o *Cluster) ExpirationTimestamp() time.Time

ExpirationTimestamp returns the value of the 'expiration_timestamp' attribute, or the zero value of the type if the attribute doesn't have a value.

Date and time when the cluster will be automatically deleted, using the format defined in https://www.ietf.org/rfc/rfc3339.txt[RFC3339]. If no timestamp is provided, the cluster will never expire.

func (*Cluster) ExternalID ¶

func (o *Cluster) ExternalID() string

ExternalID returns the value of the 'external_ID' attribute, or the zero value of the type if the attribute doesn't have a value.

External identifier of the cluster, generated by the installer.

func (*Cluster) Flavour ¶

func (o *Cluster) Flavour() *Flavour

Flavour returns the value of the 'flavour' attribute, or the zero value of the type if the attribute doesn't have a value.

Link to the _flavour_ that was used to create the cluster.

func (*Cluster) GetAPI ¶

func (o *Cluster) GetAPI() (value *ClusterAPI, ok bool)

GetAPI returns the value of the 'API' attribute and a flag indicating if the attribute has a value.

Information about the API of the cluster.

func (*Cluster) GetAWS ¶

func (o *Cluster) GetAWS() (value *AWS, ok bool)

GetAWS returns the value of the 'AWS' attribute and a flag indicating if the attribute has a value.

Amazon Web Services settings of the cluster.

func (*Cluster) GetAddons ¶

func (o *Cluster) GetAddons() (value *AddOnList, ok bool)

GetAddons returns the value of the 'addons' attribute and a flag indicating if the attribute has a value.

List of add-ons on this cluster.

func (*Cluster) GetCloudProvider ¶

func (o *Cluster) GetCloudProvider() (value *CloudProvider, ok bool)

GetCloudProvider returns the value of the 'cloud_provider' attribute and a flag indicating if the attribute has a value.

Link to the cloud provider where the cluster is installed.

func (*Cluster) GetConsole ¶

func (o *Cluster) GetConsole() (value *ClusterConsole, ok bool)

GetConsole returns the value of the 'console' attribute and a flag indicating if the attribute has a value.

Information about the console of the cluster.

func (*Cluster) GetCreationTimestamp ¶

func (o *Cluster) GetCreationTimestamp() (value time.Time, ok bool)

GetCreationTimestamp returns the value of the 'creation_timestamp' attribute and a flag indicating if the attribute has a value.

Date and time when the cluster was initially created, using the format defined in https://www.ietf.org/rfc/rfc3339.txt[RC3339].

func (*Cluster) GetDNS ¶

func (o *Cluster) GetDNS() (value *DNS, ok bool)

GetDNS returns the value of the 'DNS' attribute and a flag indicating if the attribute has a value.

DNS settings of the cluster.

func (*Cluster) GetDisplayName ¶

func (o *Cluster) GetDisplayName() (value string, ok bool)

GetDisplayName returns the value of the 'display_name' attribute and a flag indicating if the attribute has a value.

Name of the cluster for display purposes. It can contain any characters, including spaces.

func (*Cluster) GetExpirationTimestamp ¶

func (o *Cluster) GetExpirationTimestamp() (value time.Time, ok bool)

GetExpirationTimestamp returns the value of the 'expiration_timestamp' attribute and a flag indicating if the attribute has a value.

Date and time when the cluster will be automatically deleted, using the format defined in https://www.ietf.org/rfc/rfc3339.txt[RFC3339]. If no timestamp is provided, the cluster will never expire.

func (*Cluster) GetExternalID ¶

func (o *Cluster) GetExternalID() (value string, ok bool)

GetExternalID returns the value of the 'external_ID' attribute and a flag indicating if the attribute has a value.

External identifier of the cluster, generated by the installer.

func (*Cluster) GetFlavour ¶

func (o *Cluster) GetFlavour() (value *Flavour, ok bool)

GetFlavour returns the value of the 'flavour' attribute and a flag indicating if the attribute has a value.

Link to the _flavour_ that was used to create the cluster.

func (*Cluster) GetGroups ¶

func (o *Cluster) GetGroups() (value *GroupList, ok bool)

GetGroups returns the value of the 'groups' attribute and a flag indicating if the attribute has a value.

Link to the collection of groups of user of the cluster.

func (*Cluster) GetHREF ¶

func (o *Cluster) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*Cluster) GetID ¶

func (o *Cluster) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*Cluster) GetIdentityProviders ¶

func (o *Cluster) GetIdentityProviders() (value *IdentityProviderList, ok bool)

GetIdentityProviders returns the value of the 'identity_providers' attribute and a flag indicating if the attribute has a value.

Link to the collection of identity providers of the cluster.

func (*Cluster) GetLoadBalancerQuota ¶

func (o *Cluster) GetLoadBalancerQuota() (value int, ok bool)

GetLoadBalancerQuota returns the value of the 'load_balancer_quota' attribute and a flag indicating if the attribute has a value.

Load Balancer quota to be assigned to the cluster.

func (*Cluster) GetManaged ¶

func (o *Cluster) GetManaged() (value bool, ok bool)

GetManaged returns the value of the 'managed' attribute and a flag indicating if the attribute has a value.

Flag indicating if the cluster is managed (by Red Hat) or self-managed by the user.

func (*Cluster) GetMetrics ¶

func (o *Cluster) GetMetrics() (value *ClusterMetrics, ok bool)

GetMetrics returns the value of the 'metrics' attribute and a flag indicating if the attribute has a value.

Cluster metrics received from telemetry.

When provisioning a cluster this will be ignored.

func (*Cluster) GetMultiAZ ¶

func (o *Cluster) GetMultiAZ() (value bool, ok bool)

GetMultiAZ returns the value of the 'multi_AZ' attribute and a flag indicating if the attribute has a value.

Flag indicating if the cluster should be created with nodes in different availability zones or all the nodes in a single one randomly selected.

func (*Cluster) GetName ¶

func (o *Cluster) GetName() (value string, ok bool)

GetName returns the value of the 'name' attribute and a flag indicating if the attribute has a value.

Name of the cluster. This name is assigned by the user when the cluster is created.

func (*Cluster) GetNetwork ¶

func (o *Cluster) GetNetwork() (value *Network, ok bool)

GetNetwork returns the value of the 'network' attribute and a flag indicating if the attribute has a value.

Network settings of the cluster.

func (*Cluster) GetNodes ¶

func (o *Cluster) GetNodes() (value *ClusterNodes, ok bool)

GetNodes returns the value of the 'nodes' attribute and a flag indicating if the attribute has a value.

Information about the nodes of the cluster.

func (*Cluster) GetOpenshiftVersion ¶

func (o *Cluster) GetOpenshiftVersion() (value string, ok bool)

GetOpenshiftVersion returns the value of the 'openshift_version' attribute and a flag indicating if the attribute has a value.

Version of _OpenShift_ installed in the cluster, for example `4.0.0-0.2`.

When retrieving a cluster this will always be reported.

When provisioning a cluster this will be ignored, as the version to deploy will be determined internally.

func (*Cluster) GetProperties ¶

func (o *Cluster) GetProperties() (value map[string]string, ok bool)

GetProperties returns the value of the 'properties' attribute and a flag indicating if the attribute has a value.

User defined properties for tagging and querying.

func (*Cluster) GetRegion ¶

func (o *Cluster) GetRegion() (value *CloudRegion, ok bool)

GetRegion returns the value of the 'region' attribute and a flag indicating if the attribute has a value.

Link to the cloud provider region where the cluster is installed.

func (*Cluster) GetState ¶

func (o *Cluster) GetState() (value ClusterState, ok bool)

GetState returns the value of the 'state' attribute and a flag indicating if the attribute has a value.

Overall state of the cluster.

func (*Cluster) GetStorageQuota ¶

func (o *Cluster) GetStorageQuota() (value *Value, ok bool)

GetStorageQuota returns the value of the 'storage_quota' attribute and a flag indicating if the attribute has a value.

Storage quota to be assigned to the cluster.

func (*Cluster) GetSubscription ¶

func (o *Cluster) GetSubscription() (value *Subscription, ok bool)

GetSubscription returns the value of the 'subscription' attribute and a flag indicating if the attribute has a value.

Link to the subscription that comes from the account management service when the cluster is registered.

func (*Cluster) GetVersion ¶

func (o *Cluster) GetVersion() (value *Version, ok bool)

GetVersion returns the value of the 'version' attribute and a flag indicating if the attribute has a value.

Link to the version of _OpenShift_ that will be used to install the cluster.

func (*Cluster) Groups ¶

func (o *Cluster) Groups() *GroupList

Groups returns the value of the 'groups' attribute, or the zero value of the type if the attribute doesn't have a value.

Link to the collection of groups of user of the cluster.

func (*Cluster) HREF ¶

func (o *Cluster) HREF() string

HREF returns the link to the object.

func (*Cluster) ID ¶

func (o *Cluster) ID() string

ID returns the identifier of the object.

func (*Cluster) IdentityProviders ¶

func (o *Cluster) IdentityProviders() *IdentityProviderList

IdentityProviders returns the value of the 'identity_providers' attribute, or the zero value of the type if the attribute doesn't have a value.

Link to the collection of identity providers of the cluster.

func (*Cluster) Kind ¶

func (o *Cluster) Kind() string

Kind returns the name of the type of the object.

func (o *Cluster) Link() bool

Link returns true iif this is a link.

func (*Cluster) LoadBalancerQuota ¶

func (o *Cluster) LoadBalancerQuota() int

LoadBalancerQuota returns the value of the 'load_balancer_quota' attribute, or the zero value of the type if the attribute doesn't have a value.

Load Balancer quota to be assigned to the cluster.

func (*Cluster) Managed ¶

func (o *Cluster) Managed() bool

Managed returns the value of the 'managed' attribute, or the zero value of the type if the attribute doesn't have a value.

Flag indicating if the cluster is managed (by Red Hat) or self-managed by the user.

func (*Cluster) Metrics ¶

func (o *Cluster) Metrics() *ClusterMetrics

Metrics returns the value of the 'metrics' attribute, or the zero value of the type if the attribute doesn't have a value.

Cluster metrics received from telemetry.

When provisioning a cluster this will be ignored.

func (*Cluster) MultiAZ ¶

func (o *Cluster) MultiAZ() bool

MultiAZ returns the value of the 'multi_AZ' attribute, or the zero value of the type if the attribute doesn't have a value.

Flag indicating if the cluster should be created with nodes in different availability zones or all the nodes in a single one randomly selected.

func (*Cluster) Name ¶

func (o *Cluster) Name() string

Name returns the value of the 'name' attribute, or the zero value of the type if the attribute doesn't have a value.

Name of the cluster. This name is assigned by the user when the cluster is created.

func (*Cluster) Network ¶

func (o *Cluster) Network() *Network

Network returns the value of the 'network' attribute, or the zero value of the type if the attribute doesn't have a value.

Network settings of the cluster.

func (*Cluster) Nodes ¶

func (o *Cluster) Nodes() *ClusterNodes

Nodes returns the value of the 'nodes' attribute, or the zero value of the type if the attribute doesn't have a value.

Information about the nodes of the cluster.

func (*Cluster) OpenshiftVersion ¶

func (o *Cluster) OpenshiftVersion() string

OpenshiftVersion returns the value of the 'openshift_version' attribute, or the zero value of the type if the attribute doesn't have a value.

Version of _OpenShift_ installed in the cluster, for example `4.0.0-0.2`.

When retrieving a cluster this will always be reported.

When provisioning a cluster this will be ignored, as the version to deploy will be determined internally.

func (*Cluster) Properties ¶

func (o *Cluster) Properties() map[string]string

Properties returns the value of the 'properties' attribute, or the zero value of the type if the attribute doesn't have a value.

User defined properties for tagging and querying.

func (*Cluster) Region ¶

func (o *Cluster) Region() *CloudRegion

Region returns the value of the 'region' attribute, or the zero value of the type if the attribute doesn't have a value.

Link to the cloud provider region where the cluster is installed.

func (*Cluster) State ¶

func (o *Cluster) State() ClusterState

State returns the value of the 'state' attribute, or the zero value of the type if the attribute doesn't have a value.

Overall state of the cluster.

func (*Cluster) StorageQuota ¶

func (o *Cluster) StorageQuota() *Value

StorageQuota returns the value of the 'storage_quota' attribute, or the zero value of the type if the attribute doesn't have a value.

Storage quota to be assigned to the cluster.

func (*Cluster) Subscription ¶

func (o *Cluster) Subscription() *Subscription

Subscription returns the value of the 'subscription' attribute, or the zero value of the type if the attribute doesn't have a value.

Link to the subscription that comes from the account management service when the cluster is registered.

func (*Cluster) Version ¶

func (o *Cluster) Version() *Version

Version returns the value of the 'version' attribute, or the zero value of the type if the attribute doesn't have a value.

Link to the version of _OpenShift_ that will be used to install the cluster.

type ClusterAPI ¶

type ClusterAPI struct {
	// contains filtered or unexported fields
}

ClusterAPI represents the values of the 'cluster_API' type.

Information about the API of a cluster.

func UnmarshalClusterAPI ¶

func UnmarshalClusterAPI(source interface{}) (object *ClusterAPI, err error)

UnmarshalClusterAPI reads a value of the 'cluster_API' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*ClusterAPI) Empty ¶

func (o *ClusterAPI) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*ClusterAPI) GetURL ¶

func (o *ClusterAPI) GetURL() (value string, ok bool)

GetURL returns the value of the 'URL' attribute and a flag indicating if the attribute has a value.

The URL of the API server of the cluster.

func (*ClusterAPI) URL ¶

func (o *ClusterAPI) URL() string

URL returns the value of the 'URL' attribute, or the zero value of the type if the attribute doesn't have a value.

The URL of the API server of the cluster.

type ClusterAPIBuilder ¶

type ClusterAPIBuilder struct {
	// contains filtered or unexported fields
}

ClusterAPIBuilder contains the data and logic needed to build 'cluster_API' objects.

Information about the API of a cluster.

func NewClusterAPI ¶

func NewClusterAPI() *ClusterAPIBuilder

NewClusterAPI creates a new builder of 'cluster_API' objects.

func (*ClusterAPIBuilder) Build ¶

func (b *ClusterAPIBuilder) Build() (object *ClusterAPI, err error)

Build creates a 'cluster_API' object using the configuration stored in the builder.

func (*ClusterAPIBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*ClusterAPIBuilder) URL ¶

URL sets the value of the 'URL' attribute to the given value.

type ClusterAPIList ¶

type ClusterAPIList struct {
	// contains filtered or unexported fields
}

ClusterAPIList is a list of values of the 'cluster_API' type.

func UnmarshalClusterAPIList ¶

func UnmarshalClusterAPIList(source interface{}) (list *ClusterAPIList, err error)

UnmarshalClusterAPIList reads a list of values of the 'cluster_API' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*ClusterAPIList) Each ¶

func (l *ClusterAPIList) Each(f func(item *ClusterAPI) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterAPIList) Empty ¶

func (l *ClusterAPIList) Empty() bool

Empty returns true if the list is empty.

func (*ClusterAPIList) Get ¶

func (l *ClusterAPIList) Get(i int) *ClusterAPI

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*ClusterAPIList) Len ¶

func (l *ClusterAPIList) Len() int

Len returns the length of the list.

func (*ClusterAPIList) Range ¶

func (l *ClusterAPIList) Range(f func(index int, item *ClusterAPI) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterAPIList) Slice ¶

func (l *ClusterAPIList) Slice() []*ClusterAPI

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type ClusterAPIListBuilder ¶

type ClusterAPIListBuilder struct {
	// contains filtered or unexported fields
}

ClusterAPIListBuilder contains the data and logic needed to build 'cluster_API' objects.

func NewClusterAPIList ¶

func NewClusterAPIList() *ClusterAPIListBuilder

NewClusterAPIList creates a new builder of 'cluster_API' objects.

func (*ClusterAPIListBuilder) Build ¶

func (b *ClusterAPIListBuilder) Build() (list *ClusterAPIList, err error)

Build creates a list of 'cluster_API' objects using the configuration stored in the builder.

func (*ClusterAPIListBuilder) Items ¶

Items sets the items of the list.

type ClusterBuilder ¶

type ClusterBuilder struct {
	// contains filtered or unexported fields
}

ClusterBuilder contains the data and logic needed to build 'cluster' objects.

Definition of an _OpenShift_ cluster.

The `cloud_provider` attribute is a reference to the cloud provider. When a cluster is retrieved it will be a link to the cloud provider, containing only the kind, id and href attributes:

[source,json] ----

{
  "cloud_provider": {
    "kind": "CloudProviderLink",
    "id": "123",
    "href": "/api/clusters_mgmt/v1/cloud_providers/123"
  }
}

----

When a cluster is created this is optional, and if used it should contain the identifier of the cloud provider to use:

[source,json] ----

{
  "cloud_provider": {
    "id": "123",
  }
}

----

If not included, then the cluster will be created using the default cloud provider, which is currently Amazon Web Services.

The region attribute is mandatory when a cluster is created.

The `aws.access_key_id`, `aws.secret_access_key` and `dns.base_domain` attributes are mandatory when creation a cluster with your own Amazon Web Services account.

func NewCluster ¶

func NewCluster() *ClusterBuilder

NewCluster creates a new builder of 'cluster' objects.

func (*ClusterBuilder) API ¶

API sets the value of the 'API' attribute to the given value.

Information about the API of a cluster.

func (*ClusterBuilder) AWS ¶

func (b *ClusterBuilder) AWS(value *AWSBuilder) *ClusterBuilder

AWS sets the value of the 'AWS' attribute to the given value.

_Amazon Web Services_ specific settings of a cluster.

func (*ClusterBuilder) Addons ¶

func (b *ClusterBuilder) Addons(values ...*AddOnBuilder) *ClusterBuilder

Addons sets the value of the 'addons' attribute to the given values.

func (*ClusterBuilder) Build ¶

func (b *ClusterBuilder) Build() (object *Cluster, err error)

Build creates a 'cluster' object using the configuration stored in the builder.

func (*ClusterBuilder) CloudProvider ¶

func (b *ClusterBuilder) CloudProvider(value *CloudProviderBuilder) *ClusterBuilder

CloudProvider sets the value of the 'cloud_provider' attribute to the given value.

Cloud provider.

func (*ClusterBuilder) Console ¶

Console sets the value of the 'console' attribute to the given value.

Information about the console of a cluster.

func (*ClusterBuilder) Copy ¶

func (b *ClusterBuilder) Copy(object *Cluster) *ClusterBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*ClusterBuilder) CreationTimestamp ¶

func (b *ClusterBuilder) CreationTimestamp(value time.Time) *ClusterBuilder

CreationTimestamp sets the value of the 'creation_timestamp' attribute to the given value.

func (*ClusterBuilder) DNS ¶

func (b *ClusterBuilder) DNS(value *DNSBuilder) *ClusterBuilder

DNS sets the value of the 'DNS' attribute to the given value.

DNS settings of the cluster.

func (*ClusterBuilder) DisplayName ¶

func (b *ClusterBuilder) DisplayName(value string) *ClusterBuilder

DisplayName sets the value of the 'display_name' attribute to the given value.

func (*ClusterBuilder) ExpirationTimestamp ¶

func (b *ClusterBuilder) ExpirationTimestamp(value time.Time) *ClusterBuilder

ExpirationTimestamp sets the value of the 'expiration_timestamp' attribute to the given value.

func (*ClusterBuilder) ExternalID ¶

func (b *ClusterBuilder) ExternalID(value string) *ClusterBuilder

ExternalID sets the value of the 'external_ID' attribute to the given value.

func (*ClusterBuilder) Flavour ¶

func (b *ClusterBuilder) Flavour(value *FlavourBuilder) *ClusterBuilder

Flavour sets the value of the 'flavour' attribute to the given value.

Set of predefined properties of a cluster. For example, a _huge_ flavour can be a cluster with 10 infra nodes and 1000 compute nodes.

func (*ClusterBuilder) Groups ¶

func (b *ClusterBuilder) Groups(values ...*GroupBuilder) *ClusterBuilder

Groups sets the value of the 'groups' attribute to the given values.

func (*ClusterBuilder) HREF ¶

func (b *ClusterBuilder) HREF(value string) *ClusterBuilder

HREF sets the link to the object.

func (*ClusterBuilder) ID ¶

func (b *ClusterBuilder) ID(value string) *ClusterBuilder

ID sets the identifier of the object.

func (*ClusterBuilder) IdentityProviders ¶

func (b *ClusterBuilder) IdentityProviders(values ...*IdentityProviderBuilder) *ClusterBuilder

IdentityProviders sets the value of the 'identity_providers' attribute to the given values.

func (b *ClusterBuilder) Link(value bool) *ClusterBuilder

Link sets the flag that indicates if this is a link.

func (*ClusterBuilder) LoadBalancerQuota ¶

func (b *ClusterBuilder) LoadBalancerQuota(value int) *ClusterBuilder

LoadBalancerQuota sets the value of the 'load_balancer_quota' attribute to the given value.

func (*ClusterBuilder) Managed ¶

func (b *ClusterBuilder) Managed(value bool) *ClusterBuilder

Managed sets the value of the 'managed' attribute to the given value.

func (*ClusterBuilder) Metrics ¶

Metrics sets the value of the 'metrics' attribute to the given value.

Cluster metrics received via telemetry.

func (*ClusterBuilder) MultiAZ ¶

func (b *ClusterBuilder) MultiAZ(value bool) *ClusterBuilder

MultiAZ sets the value of the 'multi_AZ' attribute to the given value.

func (*ClusterBuilder) Name ¶

func (b *ClusterBuilder) Name(value string) *ClusterBuilder

Name sets the value of the 'name' attribute to the given value.

func (*ClusterBuilder) Network ¶

func (b *ClusterBuilder) Network(value *NetworkBuilder) *ClusterBuilder

Network sets the value of the 'network' attribute to the given value.

Network configuration of a cluster.

func (*ClusterBuilder) Nodes ¶

Nodes sets the value of the 'nodes' attribute to the given value.

Counts of different classes of nodes inside a cluster.

func (*ClusterBuilder) OpenshiftVersion ¶

func (b *ClusterBuilder) OpenshiftVersion(value string) *ClusterBuilder

OpenshiftVersion sets the value of the 'openshift_version' attribute to the given value.

func (*ClusterBuilder) Properties ¶

func (b *ClusterBuilder) Properties(value map[string]string) *ClusterBuilder

Properties sets the value of the 'properties' attribute to the given value.

func (*ClusterBuilder) Region ¶

Region sets the value of the 'region' attribute to the given value.

Description of a region of a cloud provider.

func (*ClusterBuilder) State ¶

func (b *ClusterBuilder) State(value ClusterState) *ClusterBuilder

State sets the value of the 'state' attribute to the given value.

Overall state of a cluster.

func (*ClusterBuilder) StorageQuota ¶

func (b *ClusterBuilder) StorageQuota(value *ValueBuilder) *ClusterBuilder

StorageQuota sets the value of the 'storage_quota' attribute to the given value.

Numeric value and the unit used to measure it.

Units are not mandatory, and they're not specified for some resources. For resources that use bytes, the accepted units are:

- 1 B = 1 byte - 1 KB = 10^3 bytes - 1 MB = 10^6 bytes - 1 GB = 10^9 bytes - 1 TB = 10^12 bytes - 1 PB = 10^15 bytes

- 1 B = 1 byte - 1 KiB = 2^10 bytes - 1 MiB = 2^20 bytes - 1 GiB = 2^30 bytes - 1 TiB = 2^40 bytes - 1 PiB = 2^50 bytes

func (*ClusterBuilder) Subscription ¶

func (b *ClusterBuilder) Subscription(value *SubscriptionBuilder) *ClusterBuilder

Subscription sets the value of the 'subscription' attribute to the given value.

Definition of a subscription.

func (*ClusterBuilder) Version ¶

func (b *ClusterBuilder) Version(value *VersionBuilder) *ClusterBuilder

Version sets the value of the 'version' attribute to the given value.

Representation of an _OpenShift_ version.

type ClusterClient ¶

type ClusterClient struct {
	// contains filtered or unexported fields
}

ClusterClient is the client of the 'cluster' resource.

Manages a specific cluster.

func NewClusterClient ¶

func NewClusterClient(transport http.RoundTripper, path string, metric string) *ClusterClient

NewClusterClient creates a new client for the 'cluster' resource using the given transport to sned the requests and receive the responses.

func (*ClusterClient) Addons ¶

func (c *ClusterClient) Addons() *AddOnsClient

Addons returns the target 'add_ons' resource.

Refrence to the resource that manages the collection of add-ons installed on this cluster.

func (*ClusterClient) Credentials ¶

func (c *ClusterClient) Credentials() *CredentialsClient

Credentials returns the target 'credentials' resource.

Reference to the resource that manages the credentials of the cluster.

func (*ClusterClient) Delete ¶

func (c *ClusterClient) Delete() *ClusterDeleteRequest

Delete creates a request for the 'delete' method.

Deletes the cluster.

func (*ClusterClient) Get ¶

func (c *ClusterClient) Get() *ClusterGetRequest

Get creates a request for the 'get' method.

Retrieves the details of the cluster.

func (*ClusterClient) Groups ¶

func (c *ClusterClient) Groups() *GroupsClient

Groups returns the target 'groups' resource.

Reference to the resource that manages the collection of groups.

func (*ClusterClient) IdentityProviders ¶

func (c *ClusterClient) IdentityProviders() *IdentityProvidersClient

IdentityProviders returns the target 'identity_providers' resource.

Reference to the resource that manages the collection of identity providers.

func (*ClusterClient) Logs ¶

func (c *ClusterClient) Logs() *LogsClient

Logs returns the target 'logs' resource.

Reference to the resource that manages the collection of logs of the cluster.

func (*ClusterClient) MetricQueries ¶

func (c *ClusterClient) MetricQueries() *MetricQueriesClient

MetricQueries returns the target 'metric_queries' resource.

Reference to the resource that manages metrics queries for the cluster.

func (*ClusterClient) Poll ¶

func (c *ClusterClient) Poll() *ClusterPollRequest

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

func (*ClusterClient) Status ¶

func (c *ClusterClient) Status() *ClusterStatusClient

Status returns the target 'cluster_status' resource.

Reference to the resource that manages the detailed status of the cluster.

func (*ClusterClient) Update ¶

func (c *ClusterClient) Update() *ClusterUpdateRequest

Update creates a request for the 'update' method.

Updates the cluster.

type ClusterConsole ¶

type ClusterConsole struct {
	// contains filtered or unexported fields
}

ClusterConsole represents the values of the 'cluster_console' type.

Information about the console of a cluster.

func UnmarshalClusterConsole ¶

func UnmarshalClusterConsole(source interface{}) (object *ClusterConsole, err error)

UnmarshalClusterConsole reads a value of the 'cluster_console' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*ClusterConsole) Empty ¶

func (o *ClusterConsole) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*ClusterConsole) GetURL ¶

func (o *ClusterConsole) GetURL() (value string, ok bool)

GetURL returns the value of the 'URL' attribute and a flag indicating if the attribute has a value.

The URL of the console of the cluster.

func (*ClusterConsole) URL ¶

func (o *ClusterConsole) URL() string

URL returns the value of the 'URL' attribute, or the zero value of the type if the attribute doesn't have a value.

The URL of the console of the cluster.

type ClusterConsoleBuilder ¶

type ClusterConsoleBuilder struct {
	// contains filtered or unexported fields
}

ClusterConsoleBuilder contains the data and logic needed to build 'cluster_console' objects.

Information about the console of a cluster.

func NewClusterConsole ¶

func NewClusterConsole() *ClusterConsoleBuilder

NewClusterConsole creates a new builder of 'cluster_console' objects.

func (*ClusterConsoleBuilder) Build ¶

func (b *ClusterConsoleBuilder) Build() (object *ClusterConsole, err error)

Build creates a 'cluster_console' object using the configuration stored in the builder.

func (*ClusterConsoleBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*ClusterConsoleBuilder) URL ¶

URL sets the value of the 'URL' attribute to the given value.

type ClusterConsoleList ¶

type ClusterConsoleList struct {
	// contains filtered or unexported fields
}

ClusterConsoleList is a list of values of the 'cluster_console' type.

func UnmarshalClusterConsoleList ¶

func UnmarshalClusterConsoleList(source interface{}) (list *ClusterConsoleList, err error)

UnmarshalClusterConsoleList reads a list of values of the 'cluster_console' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*ClusterConsoleList) Each ¶

func (l *ClusterConsoleList) Each(f func(item *ClusterConsole) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterConsoleList) Empty ¶

func (l *ClusterConsoleList) Empty() bool

Empty returns true if the list is empty.

func (*ClusterConsoleList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*ClusterConsoleList) Len ¶

func (l *ClusterConsoleList) Len() int

Len returns the length of the list.

func (*ClusterConsoleList) Range ¶

func (l *ClusterConsoleList) Range(f func(index int, item *ClusterConsole) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterConsoleList) Slice ¶

func (l *ClusterConsoleList) Slice() []*ClusterConsole

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type ClusterConsoleListBuilder ¶

type ClusterConsoleListBuilder struct {
	// contains filtered or unexported fields
}

ClusterConsoleListBuilder contains the data and logic needed to build 'cluster_console' objects.

func NewClusterConsoleList ¶

func NewClusterConsoleList() *ClusterConsoleListBuilder

NewClusterConsoleList creates a new builder of 'cluster_console' objects.

func (*ClusterConsoleListBuilder) Build ¶

func (b *ClusterConsoleListBuilder) Build() (list *ClusterConsoleList, err error)

Build creates a list of 'cluster_console' objects using the configuration stored in the builder.

func (*ClusterConsoleListBuilder) Items ¶

Items sets the items of the list.

type ClusterCredentials ¶

type ClusterCredentials struct {
	// contains filtered or unexported fields
}

ClusterCredentials represents the values of the 'cluster_credentials' type.

Credentials of the a cluster.

func UnmarshalClusterCredentials ¶

func UnmarshalClusterCredentials(source interface{}) (object *ClusterCredentials, err error)

UnmarshalClusterCredentials reads a value of the 'cluster_credentials' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*ClusterCredentials) Admin ¶

Admin returns the value of the 'admin' attribute, or the zero value of the type if the attribute doesn't have a value.

Temporary administrator credentials generated during the installation of the cluster.

func (*ClusterCredentials) Empty ¶

func (o *ClusterCredentials) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*ClusterCredentials) GetAdmin ¶

func (o *ClusterCredentials) GetAdmin() (value *AdminCredentials, ok bool)

GetAdmin returns the value of the 'admin' attribute and a flag indicating if the attribute has a value.

Temporary administrator credentials generated during the installation of the cluster.

func (*ClusterCredentials) GetHREF ¶

func (o *ClusterCredentials) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*ClusterCredentials) GetID ¶

func (o *ClusterCredentials) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*ClusterCredentials) GetKubeconfig ¶

func (o *ClusterCredentials) GetKubeconfig() (value string, ok bool)

GetKubeconfig returns the value of the 'kubeconfig' attribute and a flag indicating if the attribute has a value.

Administrator _kubeconfig_ file for the cluster.

func (*ClusterCredentials) GetSSH ¶

func (o *ClusterCredentials) GetSSH() (value *SSHCredentials, ok bool)

GetSSH returns the value of the 'SSH' attribute and a flag indicating if the attribute has a value.

SSH key pair of the cluster.

func (*ClusterCredentials) HREF ¶

func (o *ClusterCredentials) HREF() string

HREF returns the link to the object.

func (*ClusterCredentials) ID ¶

func (o *ClusterCredentials) ID() string

ID returns the identifier of the object.

func (*ClusterCredentials) Kind ¶

func (o *ClusterCredentials) Kind() string

Kind returns the name of the type of the object.

func (*ClusterCredentials) Kubeconfig ¶

func (o *ClusterCredentials) Kubeconfig() string

Kubeconfig returns the value of the 'kubeconfig' attribute, or the zero value of the type if the attribute doesn't have a value.

Administrator _kubeconfig_ file for the cluster.

func (o *ClusterCredentials) Link() bool

Link returns true iif this is a link.

func (*ClusterCredentials) SSH ¶

SSH returns the value of the 'SSH' attribute, or the zero value of the type if the attribute doesn't have a value.

SSH key pair of the cluster.

type ClusterCredentialsBuilder ¶

type ClusterCredentialsBuilder struct {
	// contains filtered or unexported fields
}

ClusterCredentialsBuilder contains the data and logic needed to build 'cluster_credentials' objects.

Credentials of the a cluster.

func NewClusterCredentials ¶

func NewClusterCredentials() *ClusterCredentialsBuilder

NewClusterCredentials creates a new builder of 'cluster_credentials' objects.

func (*ClusterCredentialsBuilder) Admin ¶

Admin sets the value of the 'admin' attribute to the given value.

Temporary administrator credentials generated during the installation of the cluster.

func (*ClusterCredentialsBuilder) Build ¶

func (b *ClusterCredentialsBuilder) Build() (object *ClusterCredentials, err error)

Build creates a 'cluster_credentials' object using the configuration stored in the builder.

func (*ClusterCredentialsBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*ClusterCredentialsBuilder) HREF ¶

HREF sets the link to the object.

func (*ClusterCredentialsBuilder) ID ¶

ID sets the identifier of the object.

func (*ClusterCredentialsBuilder) Kubeconfig ¶

Kubeconfig sets the value of the 'kubeconfig' attribute to the given value.

Link sets the flag that indicates if this is a link.

func (*ClusterCredentialsBuilder) SSH ¶

SSH sets the value of the 'SSH' attribute to the given value.

SSH key pair of a cluster.

type ClusterCredentialsList ¶

type ClusterCredentialsList struct {
	// contains filtered or unexported fields
}

ClusterCredentialsList is a list of values of the 'cluster_credentials' type.

func UnmarshalClusterCredentialsList ¶

func UnmarshalClusterCredentialsList(source interface{}) (list *ClusterCredentialsList, err error)

UnmarshalClusterCredentialsList reads a list of values of the 'cluster_credentials' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*ClusterCredentialsList) Each ¶

func (l *ClusterCredentialsList) Each(f func(item *ClusterCredentials) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterCredentialsList) Empty ¶

func (l *ClusterCredentialsList) Empty() bool

Empty returns true if the list is empty.

func (*ClusterCredentialsList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*ClusterCredentialsList) GetHREF ¶

func (l *ClusterCredentialsList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*ClusterCredentialsList) HREF ¶

func (l *ClusterCredentialsList) HREF() string

HREF returns the link to the list.

func (*ClusterCredentialsList) Kind ¶

func (l *ClusterCredentialsList) Kind() string

Kind returns the name of the type of the object.

func (*ClusterCredentialsList) Len ¶

func (l *ClusterCredentialsList) Len() int

Len returns the length of the list.

func (l *ClusterCredentialsList) Link() bool

Link returns true iif this is a link.

func (*ClusterCredentialsList) Range ¶

func (l *ClusterCredentialsList) Range(f func(index int, item *ClusterCredentials) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterCredentialsList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type ClusterCredentialsListBuilder ¶

type ClusterCredentialsListBuilder struct {
	// contains filtered or unexported fields
}

ClusterCredentialsListBuilder contains the data and logic needed to build 'cluster_credentials' objects.

func NewClusterCredentialsList ¶

func NewClusterCredentialsList() *ClusterCredentialsListBuilder

NewClusterCredentialsList creates a new builder of 'cluster_credentials' objects.

func (*ClusterCredentialsListBuilder) Build ¶

Build creates a list of 'cluster_credentials' objects using the configuration stored in the builder.

func (*ClusterCredentialsListBuilder) Items ¶

Items sets the items of the list.

type ClusterDeleteRequest ¶

type ClusterDeleteRequest struct {
	// contains filtered or unexported fields
}

ClusterDeleteRequest is the request for the 'delete' method.

func (*ClusterDeleteRequest) Header ¶

func (r *ClusterDeleteRequest) Header(name string, value interface{}) *ClusterDeleteRequest

Header adds a request header.

func (*ClusterDeleteRequest) Parameter ¶

func (r *ClusterDeleteRequest) Parameter(name string, value interface{}) *ClusterDeleteRequest

Parameter adds a query parameter.

func (*ClusterDeleteRequest) Send ¶

func (r *ClusterDeleteRequest) Send() (result *ClusterDeleteResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*ClusterDeleteRequest) SendContext ¶

func (r *ClusterDeleteRequest) SendContext(ctx context.Context) (result *ClusterDeleteResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type ClusterDeleteResponse ¶

type ClusterDeleteResponse struct {
	// contains filtered or unexported fields
}

ClusterDeleteResponse is the response for the 'delete' method.

func (*ClusterDeleteResponse) Error ¶

func (r *ClusterDeleteResponse) Error() *errors.Error

Error returns the response error.

func (*ClusterDeleteResponse) Header ¶

func (r *ClusterDeleteResponse) Header() http.Header

Header returns header of the response.

func (*ClusterDeleteResponse) Status ¶

func (r *ClusterDeleteResponse) Status() int

Status returns the response status code.

type ClusterDeleteServerRequest ¶

type ClusterDeleteServerRequest struct {
}

ClusterDeleteServerRequest is the request for the 'delete' method.

type ClusterDeleteServerResponse ¶

type ClusterDeleteServerResponse struct {
	// contains filtered or unexported fields
}

ClusterDeleteServerResponse is the response for the 'delete' method.

func (*ClusterDeleteServerResponse) Status ¶

Status sets the status code.

type ClusterGetRequest ¶

type ClusterGetRequest struct {
	// contains filtered or unexported fields
}

ClusterGetRequest is the request for the 'get' method.

func (*ClusterGetRequest) Header ¶

func (r *ClusterGetRequest) Header(name string, value interface{}) *ClusterGetRequest

Header adds a request header.

func (*ClusterGetRequest) Parameter ¶

func (r *ClusterGetRequest) Parameter(name string, value interface{}) *ClusterGetRequest

Parameter adds a query parameter.

func (*ClusterGetRequest) Send ¶

func (r *ClusterGetRequest) Send() (result *ClusterGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*ClusterGetRequest) SendContext ¶

func (r *ClusterGetRequest) SendContext(ctx context.Context) (result *ClusterGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type ClusterGetResponse ¶

type ClusterGetResponse struct {
	// contains filtered or unexported fields
}

ClusterGetResponse is the response for the 'get' method.

func (*ClusterGetResponse) Body ¶

func (r *ClusterGetResponse) Body() *Cluster

Body returns the value of the 'body' parameter.

func (*ClusterGetResponse) Error ¶

func (r *ClusterGetResponse) Error() *errors.Error

Error returns the response error.

func (*ClusterGetResponse) GetBody ¶

func (r *ClusterGetResponse) GetBody() (value *Cluster, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*ClusterGetResponse) Header ¶

func (r *ClusterGetResponse) Header() http.Header

Header returns header of the response.

func (*ClusterGetResponse) Status ¶

func (r *ClusterGetResponse) Status() int

Status returns the response status code.

type ClusterGetServerRequest ¶

type ClusterGetServerRequest struct {
}

ClusterGetServerRequest is the request for the 'get' method.

type ClusterGetServerResponse ¶

type ClusterGetServerResponse struct {
	// contains filtered or unexported fields
}

ClusterGetServerResponse is the response for the 'get' method.

func (*ClusterGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*ClusterGetServerResponse) Status ¶

Status sets the status code.

type ClusterList ¶

type ClusterList struct {
	// contains filtered or unexported fields
}

ClusterList is a list of values of the 'cluster' type.

func UnmarshalClusterList ¶

func UnmarshalClusterList(source interface{}) (list *ClusterList, err error)

UnmarshalClusterList reads a list of values of the 'cluster' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*ClusterList) Each ¶

func (l *ClusterList) Each(f func(item *Cluster) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterList) Empty ¶

func (l *ClusterList) Empty() bool

Empty returns true if the list is empty.

func (*ClusterList) Get ¶

func (l *ClusterList) Get(i int) *Cluster

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*ClusterList) GetHREF ¶

func (l *ClusterList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*ClusterList) HREF ¶

func (l *ClusterList) HREF() string

HREF returns the link to the list.

func (*ClusterList) Kind ¶

func (l *ClusterList) Kind() string

Kind returns the name of the type of the object.

func (*ClusterList) Len ¶

func (l *ClusterList) Len() int

Len returns the length of the list.

func (l *ClusterList) Link() bool

Link returns true iif this is a link.

func (*ClusterList) Range ¶

func (l *ClusterList) Range(f func(index int, item *Cluster) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterList) Slice ¶

func (l *ClusterList) Slice() []*Cluster

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type ClusterListBuilder ¶

type ClusterListBuilder struct {
	// contains filtered or unexported fields
}

ClusterListBuilder contains the data and logic needed to build 'cluster' objects.

func NewClusterList ¶

func NewClusterList() *ClusterListBuilder

NewClusterList creates a new builder of 'cluster' objects.

func (*ClusterListBuilder) Build ¶

func (b *ClusterListBuilder) Build() (list *ClusterList, err error)

Build creates a list of 'cluster' objects using the configuration stored in the builder.

func (*ClusterListBuilder) Items ¶

Items sets the items of the list.

type ClusterMetric ¶

type ClusterMetric struct {
	// contains filtered or unexported fields
}

ClusterMetric represents the values of the 'cluster_metric' type.

Metric describing the total and used amount of some resource (like RAM, CPU and storage) in a cluster.

func UnmarshalClusterMetric ¶

func UnmarshalClusterMetric(source interface{}) (object *ClusterMetric, err error)

UnmarshalClusterMetric reads a value of the 'cluster_metric' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*ClusterMetric) Empty ¶

func (o *ClusterMetric) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*ClusterMetric) GetTotal ¶

func (o *ClusterMetric) GetTotal() (value *Value, ok bool)

GetTotal returns the value of the 'total' attribute and a flag indicating if the attribute has a value.

Total amount of the resource that exists in the cluster. For example the total amount of RAM.

func (*ClusterMetric) GetUpdatedTimestamp ¶

func (o *ClusterMetric) GetUpdatedTimestamp() (value time.Time, ok bool)

GetUpdatedTimestamp returns the value of the 'updated_timestamp' attribute and a flag indicating if the attribute has a value.

Collection timestamp of the metric.

func (*ClusterMetric) GetUsed ¶

func (o *ClusterMetric) GetUsed() (value *Value, ok bool)

GetUsed returns the value of the 'used' attribute and a flag indicating if the attribute has a value.

Amount of the resource that is currently in use in the cluster. Fore example the amount of RAM in use.

func (*ClusterMetric) Total ¶

func (o *ClusterMetric) Total() *Value

Total returns the value of the 'total' attribute, or the zero value of the type if the attribute doesn't have a value.

Total amount of the resource that exists in the cluster. For example the total amount of RAM.

func (*ClusterMetric) UpdatedTimestamp ¶

func (o *ClusterMetric) UpdatedTimestamp() time.Time

UpdatedTimestamp returns the value of the 'updated_timestamp' attribute, or the zero value of the type if the attribute doesn't have a value.

Collection timestamp of the metric.

func (*ClusterMetric) Used ¶

func (o *ClusterMetric) Used() *Value

Used returns the value of the 'used' attribute, or the zero value of the type if the attribute doesn't have a value.

Amount of the resource that is currently in use in the cluster. Fore example the amount of RAM in use.

type ClusterMetricBuilder ¶

type ClusterMetricBuilder struct {
	// contains filtered or unexported fields
}

ClusterMetricBuilder contains the data and logic needed to build 'cluster_metric' objects.

Metric describing the total and used amount of some resource (like RAM, CPU and storage) in a cluster.

func NewClusterMetric ¶

func NewClusterMetric() *ClusterMetricBuilder

NewClusterMetric creates a new builder of 'cluster_metric' objects.

func (*ClusterMetricBuilder) Build ¶

func (b *ClusterMetricBuilder) Build() (object *ClusterMetric, err error)

Build creates a 'cluster_metric' object using the configuration stored in the builder.

func (*ClusterMetricBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*ClusterMetricBuilder) Total ¶

Total sets the value of the 'total' attribute to the given value.

Numeric value and the unit used to measure it.

Units are not mandatory, and they're not specified for some resources. For resources that use bytes, the accepted units are:

- 1 B = 1 byte - 1 KB = 10^3 bytes - 1 MB = 10^6 bytes - 1 GB = 10^9 bytes - 1 TB = 10^12 bytes - 1 PB = 10^15 bytes

- 1 B = 1 byte - 1 KiB = 2^10 bytes - 1 MiB = 2^20 bytes - 1 GiB = 2^30 bytes - 1 TiB = 2^40 bytes - 1 PiB = 2^50 bytes

func (*ClusterMetricBuilder) UpdatedTimestamp ¶

func (b *ClusterMetricBuilder) UpdatedTimestamp(value time.Time) *ClusterMetricBuilder

UpdatedTimestamp sets the value of the 'updated_timestamp' attribute to the given value.

func (*ClusterMetricBuilder) Used ¶

Used sets the value of the 'used' attribute to the given value.

Numeric value and the unit used to measure it.

Units are not mandatory, and they're not specified for some resources. For resources that use bytes, the accepted units are:

- 1 B = 1 byte - 1 KB = 10^3 bytes - 1 MB = 10^6 bytes - 1 GB = 10^9 bytes - 1 TB = 10^12 bytes - 1 PB = 10^15 bytes

- 1 B = 1 byte - 1 KiB = 2^10 bytes - 1 MiB = 2^20 bytes - 1 GiB = 2^30 bytes - 1 TiB = 2^40 bytes - 1 PiB = 2^50 bytes

type ClusterMetricList ¶

type ClusterMetricList struct {
	// contains filtered or unexported fields
}

ClusterMetricList is a list of values of the 'cluster_metric' type.

func UnmarshalClusterMetricList ¶

func UnmarshalClusterMetricList(source interface{}) (list *ClusterMetricList, err error)

UnmarshalClusterMetricList reads a list of values of the 'cluster_metric' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*ClusterMetricList) Each ¶

func (l *ClusterMetricList) Each(f func(item *ClusterMetric) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterMetricList) Empty ¶

func (l *ClusterMetricList) Empty() bool

Empty returns true if the list is empty.

func (*ClusterMetricList) Get ¶

func (l *ClusterMetricList) Get(i int) *ClusterMetric

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*ClusterMetricList) Len ¶

func (l *ClusterMetricList) Len() int

Len returns the length of the list.

func (*ClusterMetricList) Range ¶

func (l *ClusterMetricList) Range(f func(index int, item *ClusterMetric) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterMetricList) Slice ¶

func (l *ClusterMetricList) Slice() []*ClusterMetric

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type ClusterMetricListBuilder ¶

type ClusterMetricListBuilder struct {
	// contains filtered or unexported fields
}

ClusterMetricListBuilder contains the data and logic needed to build 'cluster_metric' objects.

func NewClusterMetricList ¶

func NewClusterMetricList() *ClusterMetricListBuilder

NewClusterMetricList creates a new builder of 'cluster_metric' objects.

func (*ClusterMetricListBuilder) Build ¶

func (b *ClusterMetricListBuilder) Build() (list *ClusterMetricList, err error)

Build creates a list of 'cluster_metric' objects using the configuration stored in the builder.

func (*ClusterMetricListBuilder) Items ¶

Items sets the items of the list.

type ClusterMetrics ¶

type ClusterMetrics struct {
	// contains filtered or unexported fields
}

ClusterMetrics represents the values of the 'cluster_metrics' type.

Cluster metrics received via telemetry.

func UnmarshalClusterMetrics ¶

func UnmarshalClusterMetrics(source interface{}) (object *ClusterMetrics, err error)

UnmarshalClusterMetrics reads a value of the 'cluster_metrics' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*ClusterMetrics) CPU ¶

func (o *ClusterMetrics) CPU() *ClusterMetric

CPU returns the value of the 'CPU' attribute, or the zero value of the type if the attribute doesn't have a value.

The amount of CPU provisioned and used in the cluster.

func (*ClusterMetrics) ComputeNodesCPU ¶

func (o *ClusterMetrics) ComputeNodesCPU() *ClusterMetric

ComputeNodesCPU returns the value of the 'compute_nodes_CPU' attribute, or the zero value of the type if the attribute doesn't have a value.

The amount of CPU provisioned and used in the cluster by compute nodes.

func (*ClusterMetrics) ComputeNodesMemory ¶

func (o *ClusterMetrics) ComputeNodesMemory() *ClusterMetric

ComputeNodesMemory returns the value of the 'compute_nodes_memory' attribute, or the zero value of the type if the attribute doesn't have a value.

The amount of memory provisioned and used in the cluster by compute nodes.

func (*ClusterMetrics) Empty ¶

func (o *ClusterMetrics) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*ClusterMetrics) GetCPU ¶

func (o *ClusterMetrics) GetCPU() (value *ClusterMetric, ok bool)

GetCPU returns the value of the 'CPU' attribute and a flag indicating if the attribute has a value.

The amount of CPU provisioned and used in the cluster.

func (*ClusterMetrics) GetComputeNodesCPU ¶

func (o *ClusterMetrics) GetComputeNodesCPU() (value *ClusterMetric, ok bool)

GetComputeNodesCPU returns the value of the 'compute_nodes_CPU' attribute and a flag indicating if the attribute has a value.

The amount of CPU provisioned and used in the cluster by compute nodes.

func (*ClusterMetrics) GetComputeNodesMemory ¶

func (o *ClusterMetrics) GetComputeNodesMemory() (value *ClusterMetric, ok bool)

GetComputeNodesMemory returns the value of the 'compute_nodes_memory' attribute and a flag indicating if the attribute has a value.

The amount of memory provisioned and used in the cluster by compute nodes.

func (*ClusterMetrics) GetMemory ¶

func (o *ClusterMetrics) GetMemory() (value *ClusterMetric, ok bool)

GetMemory returns the value of the 'memory' attribute and a flag indicating if the attribute has a value.

The amount of memory provisioned and used in the cluster.

func (*ClusterMetrics) GetNodes ¶

func (o *ClusterMetrics) GetNodes() (value *ClusterNodes, ok bool)

GetNodes returns the value of the 'nodes' attribute and a flag indicating if the attribute has a value.

The number of nodes provisioned for the cluster.

func (*ClusterMetrics) GetStorage ¶

func (o *ClusterMetrics) GetStorage() (value *ClusterMetric, ok bool)

GetStorage returns the value of the 'storage' attribute and a flag indicating if the attribute has a value.

The amount of storage provisioned and used in the cluster.

WARNING: This isn't currently populated.

func (*ClusterMetrics) Memory ¶

func (o *ClusterMetrics) Memory() *ClusterMetric

Memory returns the value of the 'memory' attribute, or the zero value of the type if the attribute doesn't have a value.

The amount of memory provisioned and used in the cluster.

func (*ClusterMetrics) Nodes ¶

func (o *ClusterMetrics) Nodes() *ClusterNodes

Nodes returns the value of the 'nodes' attribute, or the zero value of the type if the attribute doesn't have a value.

The number of nodes provisioned for the cluster.

func (*ClusterMetrics) Storage ¶

func (o *ClusterMetrics) Storage() *ClusterMetric

Storage returns the value of the 'storage' attribute, or the zero value of the type if the attribute doesn't have a value.

The amount of storage provisioned and used in the cluster.

WARNING: This isn't currently populated.

type ClusterMetricsBuilder ¶

type ClusterMetricsBuilder struct {
	// contains filtered or unexported fields
}

ClusterMetricsBuilder contains the data and logic needed to build 'cluster_metrics' objects.

Cluster metrics received via telemetry.

func NewClusterMetrics ¶

func NewClusterMetrics() *ClusterMetricsBuilder

NewClusterMetrics creates a new builder of 'cluster_metrics' objects.

func (*ClusterMetricsBuilder) Build ¶

func (b *ClusterMetricsBuilder) Build() (object *ClusterMetrics, err error)

Build creates a 'cluster_metrics' object using the configuration stored in the builder.

func (*ClusterMetricsBuilder) CPU ¶

CPU sets the value of the 'CPU' attribute to the given value.

Metric describing the total and used amount of some resource (like RAM, CPU and storage) in a cluster.

func (*ClusterMetricsBuilder) ComputeNodesCPU ¶

ComputeNodesCPU sets the value of the 'compute_nodes_CPU' attribute to the given value.

Metric describing the total and used amount of some resource (like RAM, CPU and storage) in a cluster.

func (*ClusterMetricsBuilder) ComputeNodesMemory ¶

func (b *ClusterMetricsBuilder) ComputeNodesMemory(value *ClusterMetricBuilder) *ClusterMetricsBuilder

ComputeNodesMemory sets the value of the 'compute_nodes_memory' attribute to the given value.

Metric describing the total and used amount of some resource (like RAM, CPU and storage) in a cluster.

func (*ClusterMetricsBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*ClusterMetricsBuilder) Memory ¶

Memory sets the value of the 'memory' attribute to the given value.

Metric describing the total and used amount of some resource (like RAM, CPU and storage) in a cluster.

func (*ClusterMetricsBuilder) Nodes ¶

Nodes sets the value of the 'nodes' attribute to the given value.

Counts of different classes of nodes inside a cluster.

func (*ClusterMetricsBuilder) Storage ¶

Storage sets the value of the 'storage' attribute to the given value.

Metric describing the total and used amount of some resource (like RAM, CPU and storage) in a cluster.

type ClusterMetricsList ¶

type ClusterMetricsList struct {
	// contains filtered or unexported fields
}

ClusterMetricsList is a list of values of the 'cluster_metrics' type.

func UnmarshalClusterMetricsList ¶

func UnmarshalClusterMetricsList(source interface{}) (list *ClusterMetricsList, err error)

UnmarshalClusterMetricsList reads a list of values of the 'cluster_metrics' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*ClusterMetricsList) Each ¶

func (l *ClusterMetricsList) Each(f func(item *ClusterMetrics) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterMetricsList) Empty ¶

func (l *ClusterMetricsList) Empty() bool

Empty returns true if the list is empty.

func (*ClusterMetricsList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*ClusterMetricsList) Len ¶

func (l *ClusterMetricsList) Len() int

Len returns the length of the list.

func (*ClusterMetricsList) Range ¶

func (l *ClusterMetricsList) Range(f func(index int, item *ClusterMetrics) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterMetricsList) Slice ¶

func (l *ClusterMetricsList) Slice() []*ClusterMetrics

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type ClusterMetricsListBuilder ¶

type ClusterMetricsListBuilder struct {
	// contains filtered or unexported fields
}

ClusterMetricsListBuilder contains the data and logic needed to build 'cluster_metrics' objects.

func NewClusterMetricsList ¶

func NewClusterMetricsList() *ClusterMetricsListBuilder

NewClusterMetricsList creates a new builder of 'cluster_metrics' objects.

func (*ClusterMetricsListBuilder) Build ¶

func (b *ClusterMetricsListBuilder) Build() (list *ClusterMetricsList, err error)

Build creates a list of 'cluster_metrics' objects using the configuration stored in the builder.

func (*ClusterMetricsListBuilder) Items ¶

Items sets the items of the list.

type ClusterNodes ¶

type ClusterNodes struct {
	// contains filtered or unexported fields
}

ClusterNodes represents the values of the 'cluster_nodes' type.

Counts of different classes of nodes inside a cluster.

func UnmarshalClusterNodes ¶

func UnmarshalClusterNodes(source interface{}) (object *ClusterNodes, err error)

UnmarshalClusterNodes reads a value of the 'cluster_nodes' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*ClusterNodes) Compute ¶

func (o *ClusterNodes) Compute() int

Compute returns the value of the 'compute' attribute, or the zero value of the type if the attribute doesn't have a value.

Number of compute nodes of the cluster.

func (*ClusterNodes) Empty ¶

func (o *ClusterNodes) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*ClusterNodes) GetCompute ¶

func (o *ClusterNodes) GetCompute() (value int, ok bool)

GetCompute returns the value of the 'compute' attribute and a flag indicating if the attribute has a value.

Number of compute nodes of the cluster.

func (*ClusterNodes) GetInfra ¶

func (o *ClusterNodes) GetInfra() (value int, ok bool)

GetInfra returns the value of the 'infra' attribute and a flag indicating if the attribute has a value.

Number of infrastructure nodes of the cluster.

func (*ClusterNodes) GetMaster ¶

func (o *ClusterNodes) GetMaster() (value int, ok bool)

GetMaster returns the value of the 'master' attribute and a flag indicating if the attribute has a value.

Number of master nodes of the cluster.

func (*ClusterNodes) GetTotal ¶

func (o *ClusterNodes) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' attribute and a flag indicating if the attribute has a value.

Total number of nodes of the cluster.

func (*ClusterNodes) Infra ¶

func (o *ClusterNodes) Infra() int

Infra returns the value of the 'infra' attribute, or the zero value of the type if the attribute doesn't have a value.

Number of infrastructure nodes of the cluster.

func (*ClusterNodes) Master ¶

func (o *ClusterNodes) Master() int

Master returns the value of the 'master' attribute, or the zero value of the type if the attribute doesn't have a value.

Number of master nodes of the cluster.

func (*ClusterNodes) Total ¶

func (o *ClusterNodes) Total() int

Total returns the value of the 'total' attribute, or the zero value of the type if the attribute doesn't have a value.

Total number of nodes of the cluster.

type ClusterNodesBuilder ¶

type ClusterNodesBuilder struct {
	// contains filtered or unexported fields
}

ClusterNodesBuilder contains the data and logic needed to build 'cluster_nodes' objects.

Counts of different classes of nodes inside a cluster.

func NewClusterNodes ¶

func NewClusterNodes() *ClusterNodesBuilder

NewClusterNodes creates a new builder of 'cluster_nodes' objects.

func (*ClusterNodesBuilder) Build ¶

func (b *ClusterNodesBuilder) Build() (object *ClusterNodes, err error)

Build creates a 'cluster_nodes' object using the configuration stored in the builder.

func (*ClusterNodesBuilder) Compute ¶

func (b *ClusterNodesBuilder) Compute(value int) *ClusterNodesBuilder

Compute sets the value of the 'compute' attribute to the given value.

func (*ClusterNodesBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*ClusterNodesBuilder) Infra ¶

func (b *ClusterNodesBuilder) Infra(value int) *ClusterNodesBuilder

Infra sets the value of the 'infra' attribute to the given value.

func (*ClusterNodesBuilder) Master ¶

func (b *ClusterNodesBuilder) Master(value int) *ClusterNodesBuilder

Master sets the value of the 'master' attribute to the given value.

func (*ClusterNodesBuilder) Total ¶

func (b *ClusterNodesBuilder) Total(value int) *ClusterNodesBuilder

Total sets the value of the 'total' attribute to the given value.

type ClusterNodesList ¶

type ClusterNodesList struct {
	// contains filtered or unexported fields
}

ClusterNodesList is a list of values of the 'cluster_nodes' type.

func UnmarshalClusterNodesList ¶

func UnmarshalClusterNodesList(source interface{}) (list *ClusterNodesList, err error)

UnmarshalClusterNodesList reads a list of values of the 'cluster_nodes' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*ClusterNodesList) Each ¶

func (l *ClusterNodesList) Each(f func(item *ClusterNodes) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterNodesList) Empty ¶

func (l *ClusterNodesList) Empty() bool

Empty returns true if the list is empty.

func (*ClusterNodesList) Get ¶

func (l *ClusterNodesList) Get(i int) *ClusterNodes

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*ClusterNodesList) Len ¶

func (l *ClusterNodesList) Len() int

Len returns the length of the list.

func (*ClusterNodesList) Range ¶

func (l *ClusterNodesList) Range(f func(index int, item *ClusterNodes) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterNodesList) Slice ¶

func (l *ClusterNodesList) Slice() []*ClusterNodes

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type ClusterNodesListBuilder ¶

type ClusterNodesListBuilder struct {
	// contains filtered or unexported fields
}

ClusterNodesListBuilder contains the data and logic needed to build 'cluster_nodes' objects.

func NewClusterNodesList ¶

func NewClusterNodesList() *ClusterNodesListBuilder

NewClusterNodesList creates a new builder of 'cluster_nodes' objects.

func (*ClusterNodesListBuilder) Build ¶

func (b *ClusterNodesListBuilder) Build() (list *ClusterNodesList, err error)

Build creates a list of 'cluster_nodes' objects using the configuration stored in the builder.

func (*ClusterNodesListBuilder) Items ¶

Items sets the items of the list.

type ClusterPollRequest ¶

type ClusterPollRequest struct {
	// contains filtered or unexported fields
}

ClusterPollRequest is the request for the Poll method.

func (*ClusterPollRequest) Header ¶

func (r *ClusterPollRequest) Header(name string, value interface{}) *ClusterPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*ClusterPollRequest) Interval ¶

func (r *ClusterPollRequest) Interval(value time.Duration) *ClusterPollRequest

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*ClusterPollRequest) Parameter ¶

func (r *ClusterPollRequest) Parameter(name string, value interface{}) *ClusterPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*ClusterPollRequest) Predicate ¶

func (r *ClusterPollRequest) Predicate(value func(*ClusterGetResponse) bool) *ClusterPollRequest

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*ClusterPollRequest) StartContext ¶

func (r *ClusterPollRequest) StartContext(ctx context.Context) (response *ClusterPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*ClusterPollRequest) Status ¶

func (r *ClusterPollRequest) Status(value int) *ClusterPollRequest

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type ClusterPollResponse ¶

type ClusterPollResponse struct {
	// contains filtered or unexported fields
}

ClusterPollResponse is the response for the Poll method.

func (*ClusterPollResponse) Body ¶

func (r *ClusterPollResponse) Body() *Cluster

Body returns the value of the 'body' parameter.

func (*ClusterPollResponse) Error ¶

func (r *ClusterPollResponse) Error() *errors.Error

Error returns the response error.

func (*ClusterPollResponse) GetBody ¶

func (r *ClusterPollResponse) GetBody() (value *Cluster, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*ClusterPollResponse) Header ¶

func (r *ClusterPollResponse) Header() http.Header

Header returns header of the response.

func (*ClusterPollResponse) Status ¶

func (r *ClusterPollResponse) Status() int

Status returns the response status code.

type ClusterRegistration ¶

type ClusterRegistration struct {
	// contains filtered or unexported fields
}

ClusterRegistration represents the values of the 'cluster_registration' type.

Registration of a new cluster to the service.

func UnmarshalClusterRegistration ¶

func UnmarshalClusterRegistration(source interface{}) (object *ClusterRegistration, err error)

UnmarshalClusterRegistration reads a value of the 'cluster_registration' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*ClusterRegistration) Empty ¶

func (o *ClusterRegistration) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*ClusterRegistration) ExternalID ¶

func (o *ClusterRegistration) ExternalID() string

ExternalID returns the value of the 'external_ID' attribute, or the zero value of the type if the attribute doesn't have a value.

Identifier of the cluster generated by the installer.

For example, to register a cluster that has been provisioned outside of this service, send a a request like this:

[source,http] ---- POST /api/clusters_mgmt/v1/register_cluster HTTP/1.1 ----

With a request body like this:

[source,json] ----

{
  "external_id": "d656aecf-11a6-4782-ad86-8f72638449ba"
}

----

func (*ClusterRegistration) GetExternalID ¶

func (o *ClusterRegistration) GetExternalID() (value string, ok bool)

GetExternalID returns the value of the 'external_ID' attribute and a flag indicating if the attribute has a value.

Identifier of the cluster generated by the installer.

For example, to register a cluster that has been provisioned outside of this service, send a a request like this:

[source,http] ---- POST /api/clusters_mgmt/v1/register_cluster HTTP/1.1 ----

With a request body like this:

[source,json] ----

{
  "external_id": "d656aecf-11a6-4782-ad86-8f72638449ba"
}

----

func (*ClusterRegistration) GetSubscriptionID ¶

func (o *ClusterRegistration) GetSubscriptionID() (value string, ok bool)

GetSubscriptionID returns the value of the 'subscription_ID' attribute and a flag indicating if the attribute has a value.

Subscription identifier of the cluster generated by the account manager.

func (*ClusterRegistration) SubscriptionID ¶

func (o *ClusterRegistration) SubscriptionID() string

SubscriptionID returns the value of the 'subscription_ID' attribute, or the zero value of the type if the attribute doesn't have a value.

Subscription identifier of the cluster generated by the account manager.

type ClusterRegistrationBuilder ¶

type ClusterRegistrationBuilder struct {
	// contains filtered or unexported fields
}

ClusterRegistrationBuilder contains the data and logic needed to build 'cluster_registration' objects.

Registration of a new cluster to the service.

func NewClusterRegistration ¶

func NewClusterRegistration() *ClusterRegistrationBuilder

NewClusterRegistration creates a new builder of 'cluster_registration' objects.

func (*ClusterRegistrationBuilder) Build ¶

func (b *ClusterRegistrationBuilder) Build() (object *ClusterRegistration, err error)

Build creates a 'cluster_registration' object using the configuration stored in the builder.

func (*ClusterRegistrationBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*ClusterRegistrationBuilder) ExternalID ¶

ExternalID sets the value of the 'external_ID' attribute to the given value.

func (*ClusterRegistrationBuilder) SubscriptionID ¶

SubscriptionID sets the value of the 'subscription_ID' attribute to the given value.

type ClusterRegistrationList ¶

type ClusterRegistrationList struct {
	// contains filtered or unexported fields
}

ClusterRegistrationList is a list of values of the 'cluster_registration' type.

func UnmarshalClusterRegistrationList ¶

func UnmarshalClusterRegistrationList(source interface{}) (list *ClusterRegistrationList, err error)

UnmarshalClusterRegistrationList reads a list of values of the 'cluster_registration' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*ClusterRegistrationList) Each ¶

func (l *ClusterRegistrationList) Each(f func(item *ClusterRegistration) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterRegistrationList) Empty ¶

func (l *ClusterRegistrationList) Empty() bool

Empty returns true if the list is empty.

func (*ClusterRegistrationList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*ClusterRegistrationList) Len ¶

func (l *ClusterRegistrationList) Len() int

Len returns the length of the list.

func (*ClusterRegistrationList) Range ¶

func (l *ClusterRegistrationList) Range(f func(index int, item *ClusterRegistration) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterRegistrationList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type ClusterRegistrationListBuilder ¶

type ClusterRegistrationListBuilder struct {
	// contains filtered or unexported fields
}

ClusterRegistrationListBuilder contains the data and logic needed to build 'cluster_registration' objects.

func NewClusterRegistrationList ¶

func NewClusterRegistrationList() *ClusterRegistrationListBuilder

NewClusterRegistrationList creates a new builder of 'cluster_registration' objects.

func (*ClusterRegistrationListBuilder) Build ¶

Build creates a list of 'cluster_registration' objects using the configuration stored in the builder.

func (*ClusterRegistrationListBuilder) Items ¶

Items sets the items of the list.

type ClusterServer ¶

type ClusterServer interface {

	// Delete handles a request for the 'delete' method.
	//
	// Deletes the cluster.
	Delete(ctx context.Context, request *ClusterDeleteServerRequest, response *ClusterDeleteServerResponse) error

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the cluster.
	Get(ctx context.Context, request *ClusterGetServerRequest, response *ClusterGetServerResponse) error

	// Update handles a request for the 'update' method.
	//
	// Updates the cluster.
	Update(ctx context.Context, request *ClusterUpdateServerRequest, response *ClusterUpdateServerResponse) error

	// Addons returns the target 'add_ons' resource.
	//
	// Refrence to the resource that manages the collection of add-ons installed on this cluster.
	Addons() AddOnsServer

	// Credentials returns the target 'credentials' resource.
	//
	// Reference to the resource that manages the credentials of the cluster.
	Credentials() CredentialsServer

	// Groups returns the target 'groups' resource.
	//
	// Reference to the resource that manages the collection of groups.
	Groups() GroupsServer

	// IdentityProviders returns the target 'identity_providers' resource.
	//
	// Reference to the resource that manages the collection of identity providers.
	IdentityProviders() IdentityProvidersServer

	// Logs returns the target 'logs' resource.
	//
	// Reference to the resource that manages the collection of logs of the cluster.
	Logs() LogsServer

	// MetricQueries returns the target 'metric_queries' resource.
	//
	// Reference to the resource that manages metrics queries for the cluster.
	MetricQueries() MetricQueriesServer

	// Status returns the target 'cluster_status' resource.
	//
	// Reference to the resource that manages the detailed status of the cluster.
	Status() ClusterStatusServer
}

ClusterServer represents the interface the manages the 'cluster' resource.

type ClusterState ¶

type ClusterState string

ClusterState represents the values of the 'cluster_state' enumerated type.

const (
	// Error during installation.
	ClusterStateError ClusterState = "error"
	// The cluster is still being installed.
	ClusterStateInstalling ClusterState = "installing"
	// The cluster is waiting to be provisioned.
	ClusterStatePending ClusterState = "pending"
	// Creation of the cluster is waiting for the creation of an account in the cloud provider.
	ClusterStatePendingAccount ClusterState = "pending_account"
	// The cluster is ready to use.
	ClusterStateReady ClusterState = "ready"
	// The cluster is being uninstalled.
	ClusterStateUninstalling ClusterState = "uninstalling"
	// The state of the cluster is unknown.
	ClusterStateUnknown ClusterState = "unknown"
)

type ClusterStatus ¶

type ClusterStatus struct {
	// contains filtered or unexported fields
}

ClusterStatus represents the values of the 'cluster_status' type.

Detailed status of a cluster.

func UnmarshalClusterStatus ¶

func UnmarshalClusterStatus(source interface{}) (object *ClusterStatus, err error)

UnmarshalClusterStatus reads a value of the 'cluster_status' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*ClusterStatus) Description ¶

func (o *ClusterStatus) Description() string

Description returns the value of the 'description' attribute, or the zero value of the type if the attribute doesn't have a value.

Detailed description of the cluster status.

func (*ClusterStatus) Empty ¶

func (o *ClusterStatus) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*ClusterStatus) GetDescription ¶

func (o *ClusterStatus) GetDescription() (value string, ok bool)

GetDescription returns the value of the 'description' attribute and a flag indicating if the attribute has a value.

Detailed description of the cluster status.

func (*ClusterStatus) GetHREF ¶

func (o *ClusterStatus) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*ClusterStatus) GetID ¶

func (o *ClusterStatus) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*ClusterStatus) GetState ¶

func (o *ClusterStatus) GetState() (value ClusterState, ok bool)

GetState returns the value of the 'state' attribute and a flag indicating if the attribute has a value.

The overall state of the cluster.

func (*ClusterStatus) HREF ¶

func (o *ClusterStatus) HREF() string

HREF returns the link to the object.

func (*ClusterStatus) ID ¶

func (o *ClusterStatus) ID() string

ID returns the identifier of the object.

func (*ClusterStatus) Kind ¶

func (o *ClusterStatus) Kind() string

Kind returns the name of the type of the object.

func (o *ClusterStatus) Link() bool

Link returns true iif this is a link.

func (*ClusterStatus) State ¶

func (o *ClusterStatus) State() ClusterState

State returns the value of the 'state' attribute, or the zero value of the type if the attribute doesn't have a value.

The overall state of the cluster.

type ClusterStatusBuilder ¶

type ClusterStatusBuilder struct {
	// contains filtered or unexported fields
}

ClusterStatusBuilder contains the data and logic needed to build 'cluster_status' objects.

Detailed status of a cluster.

func NewClusterStatus ¶

func NewClusterStatus() *ClusterStatusBuilder

NewClusterStatus creates a new builder of 'cluster_status' objects.

func (*ClusterStatusBuilder) Build ¶

func (b *ClusterStatusBuilder) Build() (object *ClusterStatus, err error)

Build creates a 'cluster_status' object using the configuration stored in the builder.

func (*ClusterStatusBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*ClusterStatusBuilder) Description ¶

func (b *ClusterStatusBuilder) Description(value string) *ClusterStatusBuilder

Description sets the value of the 'description' attribute to the given value.

func (*ClusterStatusBuilder) HREF ¶

HREF sets the link to the object.

func (*ClusterStatusBuilder) ID ¶

ID sets the identifier of the object.

Link sets the flag that indicates if this is a link.

func (*ClusterStatusBuilder) State ¶

State sets the value of the 'state' attribute to the given value.

Overall state of a cluster.

type ClusterStatusClient ¶

type ClusterStatusClient struct {
	// contains filtered or unexported fields
}

ClusterStatusClient is the client of the 'cluster_status' resource.

Provides detailed information about the status of an specific cluster.

func NewClusterStatusClient ¶

func NewClusterStatusClient(transport http.RoundTripper, path string, metric string) *ClusterStatusClient

NewClusterStatusClient creates a new client for the 'cluster_status' resource using the given transport to sned the requests and receive the responses.

func (*ClusterStatusClient) Get ¶

Get creates a request for the 'get' method.

func (*ClusterStatusClient) Poll ¶

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type ClusterStatusGetRequest ¶

type ClusterStatusGetRequest struct {
	// contains filtered or unexported fields
}

ClusterStatusGetRequest is the request for the 'get' method.

func (*ClusterStatusGetRequest) Header ¶

func (r *ClusterStatusGetRequest) Header(name string, value interface{}) *ClusterStatusGetRequest

Header adds a request header.

func (*ClusterStatusGetRequest) Parameter ¶

func (r *ClusterStatusGetRequest) Parameter(name string, value interface{}) *ClusterStatusGetRequest

Parameter adds a query parameter.

func (*ClusterStatusGetRequest) Send ¶

func (r *ClusterStatusGetRequest) Send() (result *ClusterStatusGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*ClusterStatusGetRequest) SendContext ¶

func (r *ClusterStatusGetRequest) SendContext(ctx context.Context) (result *ClusterStatusGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type ClusterStatusGetResponse ¶

type ClusterStatusGetResponse struct {
	// contains filtered or unexported fields
}

ClusterStatusGetResponse is the response for the 'get' method.

func (*ClusterStatusGetResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*ClusterStatusGetResponse) Error ¶

Error returns the response error.

func (*ClusterStatusGetResponse) GetBody ¶

func (r *ClusterStatusGetResponse) GetBody() (value *ClusterStatus, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*ClusterStatusGetResponse) Header ¶

func (r *ClusterStatusGetResponse) Header() http.Header

Header returns header of the response.

func (*ClusterStatusGetResponse) Status ¶

func (r *ClusterStatusGetResponse) Status() int

Status returns the response status code.

type ClusterStatusGetServerRequest ¶

type ClusterStatusGetServerRequest struct {
}

ClusterStatusGetServerRequest is the request for the 'get' method.

type ClusterStatusGetServerResponse ¶

type ClusterStatusGetServerResponse struct {
	// contains filtered or unexported fields
}

ClusterStatusGetServerResponse is the response for the 'get' method.

func (*ClusterStatusGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*ClusterStatusGetServerResponse) Status ¶

Status sets the status code.

type ClusterStatusList ¶

type ClusterStatusList struct {
	// contains filtered or unexported fields
}

ClusterStatusList is a list of values of the 'cluster_status' type.

func UnmarshalClusterStatusList ¶

func UnmarshalClusterStatusList(source interface{}) (list *ClusterStatusList, err error)

UnmarshalClusterStatusList reads a list of values of the 'cluster_status' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*ClusterStatusList) Each ¶

func (l *ClusterStatusList) Each(f func(item *ClusterStatus) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterStatusList) Empty ¶

func (l *ClusterStatusList) Empty() bool

Empty returns true if the list is empty.

func (*ClusterStatusList) Get ¶

func (l *ClusterStatusList) Get(i int) *ClusterStatus

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*ClusterStatusList) GetHREF ¶

func (l *ClusterStatusList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*ClusterStatusList) HREF ¶

func (l *ClusterStatusList) HREF() string

HREF returns the link to the list.

func (*ClusterStatusList) Kind ¶

func (l *ClusterStatusList) Kind() string

Kind returns the name of the type of the object.

func (*ClusterStatusList) Len ¶

func (l *ClusterStatusList) Len() int

Len returns the length of the list.

func (l *ClusterStatusList) Link() bool

Link returns true iif this is a link.

func (*ClusterStatusList) Range ¶

func (l *ClusterStatusList) Range(f func(index int, item *ClusterStatus) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ClusterStatusList) Slice ¶

func (l *ClusterStatusList) Slice() []*ClusterStatus

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type ClusterStatusListBuilder ¶

type ClusterStatusListBuilder struct {
	// contains filtered or unexported fields
}

ClusterStatusListBuilder contains the data and logic needed to build 'cluster_status' objects.

func NewClusterStatusList ¶

func NewClusterStatusList() *ClusterStatusListBuilder

NewClusterStatusList creates a new builder of 'cluster_status' objects.

func (*ClusterStatusListBuilder) Build ¶

func (b *ClusterStatusListBuilder) Build() (list *ClusterStatusList, err error)

Build creates a list of 'cluster_status' objects using the configuration stored in the builder.

func (*ClusterStatusListBuilder) Items ¶

Items sets the items of the list.

type ClusterStatusPollRequest ¶

type ClusterStatusPollRequest struct {
	// contains filtered or unexported fields
}

ClusterStatusPollRequest is the request for the Poll method.

func (*ClusterStatusPollRequest) Header ¶

func (r *ClusterStatusPollRequest) Header(name string, value interface{}) *ClusterStatusPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*ClusterStatusPollRequest) Interval ¶

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*ClusterStatusPollRequest) Parameter ¶

func (r *ClusterStatusPollRequest) Parameter(name string, value interface{}) *ClusterStatusPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*ClusterStatusPollRequest) Predicate ¶

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*ClusterStatusPollRequest) StartContext ¶

func (r *ClusterStatusPollRequest) StartContext(ctx context.Context) (response *ClusterStatusPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*ClusterStatusPollRequest) Status ¶

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type ClusterStatusPollResponse ¶

type ClusterStatusPollResponse struct {
	// contains filtered or unexported fields
}

ClusterStatusPollResponse is the response for the Poll method.

func (*ClusterStatusPollResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*ClusterStatusPollResponse) Error ¶

Error returns the response error.

func (*ClusterStatusPollResponse) GetBody ¶

func (r *ClusterStatusPollResponse) GetBody() (value *ClusterStatus, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*ClusterStatusPollResponse) Header ¶

Header returns header of the response.

func (*ClusterStatusPollResponse) Status ¶

func (r *ClusterStatusPollResponse) Status() int

Status returns the response status code.

type ClusterStatusServer ¶

type ClusterStatusServer interface {

	// Get handles a request for the 'get' method.
	//
	//
	Get(ctx context.Context, request *ClusterStatusGetServerRequest, response *ClusterStatusGetServerResponse) error
}

ClusterStatusServer represents the interface the manages the 'cluster_status' resource.

type ClusterUpdateRequest ¶

type ClusterUpdateRequest struct {
	// contains filtered or unexported fields
}

ClusterUpdateRequest is the request for the 'update' method.

func (*ClusterUpdateRequest) Body ¶

Body sets the value of the 'body' parameter.

func (*ClusterUpdateRequest) Header ¶

func (r *ClusterUpdateRequest) Header(name string, value interface{}) *ClusterUpdateRequest

Header adds a request header.

func (*ClusterUpdateRequest) Parameter ¶

func (r *ClusterUpdateRequest) Parameter(name string, value interface{}) *ClusterUpdateRequest

Parameter adds a query parameter.

func (*ClusterUpdateRequest) Send ¶

func (r *ClusterUpdateRequest) Send() (result *ClusterUpdateResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*ClusterUpdateRequest) SendContext ¶

func (r *ClusterUpdateRequest) SendContext(ctx context.Context) (result *ClusterUpdateResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type ClusterUpdateResponse ¶

type ClusterUpdateResponse struct {
	// contains filtered or unexported fields
}

ClusterUpdateResponse is the response for the 'update' method.

func (*ClusterUpdateResponse) Body ¶

func (r *ClusterUpdateResponse) Body() *Cluster

Body returns the value of the 'body' parameter.

func (*ClusterUpdateResponse) Error ¶

func (r *ClusterUpdateResponse) Error() *errors.Error

Error returns the response error.

func (*ClusterUpdateResponse) GetBody ¶

func (r *ClusterUpdateResponse) GetBody() (value *Cluster, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*ClusterUpdateResponse) Header ¶

func (r *ClusterUpdateResponse) Header() http.Header

Header returns header of the response.

func (*ClusterUpdateResponse) Status ¶

func (r *ClusterUpdateResponse) Status() int

Status returns the response status code.

type ClusterUpdateServerRequest ¶

type ClusterUpdateServerRequest struct {
	// contains filtered or unexported fields
}

ClusterUpdateServerRequest is the request for the 'update' method.

func (*ClusterUpdateServerRequest) Body ¶

Body returns the value of the 'body' parameter.

func (*ClusterUpdateServerRequest) GetBody ¶

func (r *ClusterUpdateServerRequest) GetBody() (value *Cluster, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

type ClusterUpdateServerResponse ¶

type ClusterUpdateServerResponse struct {
	// contains filtered or unexported fields
}

ClusterUpdateServerResponse is the response for the 'update' method.

func (*ClusterUpdateServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*ClusterUpdateServerResponse) Status ¶

Status sets the status code.

type ClustersAddRequest ¶

type ClustersAddRequest struct {
	// contains filtered or unexported fields
}

ClustersAddRequest is the request for the 'add' method.

func (*ClustersAddRequest) Body ¶

Body sets the value of the 'body' parameter.

Description of the cluster.

func (*ClustersAddRequest) Header ¶

func (r *ClustersAddRequest) Header(name string, value interface{}) *ClustersAddRequest

Header adds a request header.

func (*ClustersAddRequest) Parameter ¶

func (r *ClustersAddRequest) Parameter(name string, value interface{}) *ClustersAddRequest

Parameter adds a query parameter.

func (*ClustersAddRequest) Send ¶

func (r *ClustersAddRequest) Send() (result *ClustersAddResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*ClustersAddRequest) SendContext ¶

func (r *ClustersAddRequest) SendContext(ctx context.Context) (result *ClustersAddResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type ClustersAddResponse ¶

type ClustersAddResponse struct {
	// contains filtered or unexported fields
}

ClustersAddResponse is the response for the 'add' method.

func (*ClustersAddResponse) Body ¶

func (r *ClustersAddResponse) Body() *Cluster

Body returns the value of the 'body' parameter.

Description of the cluster.

func (*ClustersAddResponse) Error ¶

func (r *ClustersAddResponse) Error() *errors.Error

Error returns the response error.

func (*ClustersAddResponse) GetBody ¶

func (r *ClustersAddResponse) GetBody() (value *Cluster, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

Description of the cluster.

func (*ClustersAddResponse) Header ¶

func (r *ClustersAddResponse) Header() http.Header

Header returns header of the response.

func (*ClustersAddResponse) Status ¶

func (r *ClustersAddResponse) Status() int

Status returns the response status code.

type ClustersAddServerRequest ¶

type ClustersAddServerRequest struct {
	// contains filtered or unexported fields
}

ClustersAddServerRequest is the request for the 'add' method.

func (*ClustersAddServerRequest) Body ¶

func (r *ClustersAddServerRequest) Body() *Cluster

Body returns the value of the 'body' parameter.

Description of the cluster.

func (*ClustersAddServerRequest) GetBody ¶

func (r *ClustersAddServerRequest) GetBody() (value *Cluster, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

Description of the cluster.

type ClustersAddServerResponse ¶

type ClustersAddServerResponse struct {
	// contains filtered or unexported fields
}

ClustersAddServerResponse is the response for the 'add' method.

func (*ClustersAddServerResponse) Body ¶

Body sets the value of the 'body' parameter.

Description of the cluster.

func (*ClustersAddServerResponse) Status ¶

Status sets the status code.

type ClustersClient ¶

type ClustersClient struct {
	// contains filtered or unexported fields
}

ClustersClient is the client of the 'clusters' resource.

Manages the collection of clusters.

func NewClustersClient ¶

func NewClustersClient(transport http.RoundTripper, path string, metric string) *ClustersClient

NewClustersClient creates a new client for the 'clusters' resource using the given transport to sned the requests and receive the responses.

func (*ClustersClient) Add ¶

Add creates a request for the 'add' method.

Provision a new cluster and add it to the collection of clusters.

See the `register_cluster` method for adding an existing cluster.

func (*ClustersClient) Cluster ¶

func (c *ClustersClient) Cluster(id string) *ClusterClient

Cluster returns the target 'cluster' resource for the given identifier.

Returns a reference to the service that manages an specific cluster.

func (*ClustersClient) List ¶

List creates a request for the 'list' method.

Retrieves the list of clusters.

type ClustersListRequest ¶

type ClustersListRequest struct {
	// contains filtered or unexported fields
}

ClustersListRequest is the request for the 'list' method.

func (*ClustersListRequest) Header ¶

func (r *ClustersListRequest) Header(name string, value interface{}) *ClustersListRequest

Header adds a request header.

func (*ClustersListRequest) Order ¶

Order sets the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the cluster instead of the names of the columns of a table. For example, in order to sort the clusters descending by region identifier the value should be:

[source,sql] ---- region.id desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*ClustersListRequest) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*ClustersListRequest) Parameter ¶

func (r *ClustersListRequest) Parameter(name string, value interface{}) *ClustersListRequest

Parameter adds a query parameter.

func (*ClustersListRequest) Search ¶

Search sets the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the cluster instead of the names of the columns of a table. For example, in order to retrieve all the clusters with a name starting with `my` in the `us-east-1` region the value should be:

[source,sql] ---- name like 'my%' and region.id = 'us-east-1' ----

If the parameter isn't provided, or if the value is empty, then all the clusters that the user has permission to see will be returned.

func (*ClustersListRequest) Send ¶

func (r *ClustersListRequest) Send() (result *ClustersListResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*ClustersListRequest) SendContext ¶

func (r *ClustersListRequest) SendContext(ctx context.Context) (result *ClustersListResponse, err error)

SendContext sends this request, waits for the response, and returns it.

func (*ClustersListRequest) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

type ClustersListResponse ¶

type ClustersListResponse struct {
	// contains filtered or unexported fields
}

ClustersListResponse is the response for the 'list' method.

func (*ClustersListResponse) Error ¶

func (r *ClustersListResponse) Error() *errors.Error

Error returns the response error.

func (*ClustersListResponse) GetItems ¶

func (r *ClustersListResponse) GetItems() (value *ClusterList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of clusters.

func (*ClustersListResponse) GetPage ¶

func (r *ClustersListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*ClustersListResponse) GetSize ¶

func (r *ClustersListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

func (*ClustersListResponse) GetTotal ¶

func (r *ClustersListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

func (*ClustersListResponse) Header ¶

func (r *ClustersListResponse) Header() http.Header

Header returns header of the response.

func (*ClustersListResponse) Items ¶

func (r *ClustersListResponse) Items() *ClusterList

Items returns the value of the 'items' parameter.

Retrieved list of clusters.

func (*ClustersListResponse) Page ¶

func (r *ClustersListResponse) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*ClustersListResponse) Size ¶

func (r *ClustersListResponse) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

func (*ClustersListResponse) Status ¶

func (r *ClustersListResponse) Status() int

Status returns the response status code.

func (*ClustersListResponse) Total ¶

func (r *ClustersListResponse) Total() int

Total returns the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type ClustersListServerRequest ¶

type ClustersListServerRequest struct {
	// contains filtered or unexported fields
}

ClustersListServerRequest is the request for the 'list' method.

func (*ClustersListServerRequest) GetOrder ¶

func (r *ClustersListServerRequest) GetOrder() (value string, ok bool)

GetOrder returns the value of the 'order' parameter and a flag indicating if the parameter has a value.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the cluster instead of the names of the columns of a table. For example, in order to sort the clusters descending by region identifier the value should be:

[source,sql] ---- region.id desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*ClustersListServerRequest) GetPage ¶

func (r *ClustersListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*ClustersListServerRequest) GetSearch ¶

func (r *ClustersListServerRequest) GetSearch() (value string, ok bool)

GetSearch returns the value of the 'search' parameter and a flag indicating if the parameter has a value.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the cluster instead of the names of the columns of a table. For example, in order to retrieve all the clusters with a name starting with `my` in the `us-east-1` region the value should be:

[source,sql] ---- name like 'my%' and region.id = 'us-east-1' ----

If the parameter isn't provided, or if the value is empty, then all the clusters that the user has permission to see will be returned.

func (*ClustersListServerRequest) GetSize ¶

func (r *ClustersListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

func (*ClustersListServerRequest) Order ¶

func (r *ClustersListServerRequest) Order() string

Order returns the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the cluster instead of the names of the columns of a table. For example, in order to sort the clusters descending by region identifier the value should be:

[source,sql] ---- region.id desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*ClustersListServerRequest) Page ¶

func (r *ClustersListServerRequest) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*ClustersListServerRequest) Search ¶

func (r *ClustersListServerRequest) Search() string

Search returns the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the cluster instead of the names of the columns of a table. For example, in order to retrieve all the clusters with a name starting with `my` in the `us-east-1` region the value should be:

[source,sql] ---- name like 'my%' and region.id = 'us-east-1' ----

If the parameter isn't provided, or if the value is empty, then all the clusters that the user has permission to see will be returned.

func (*ClustersListServerRequest) Size ¶

func (r *ClustersListServerRequest) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

type ClustersListServerResponse ¶

type ClustersListServerResponse struct {
	// contains filtered or unexported fields
}

ClustersListServerResponse is the response for the 'list' method.

func (*ClustersListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of clusters.

func (*ClustersListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*ClustersListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

func (*ClustersListServerResponse) Status ¶

Status sets the status code.

func (*ClustersListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type ClustersServer ¶

type ClustersServer interface {

	// Add handles a request for the 'add' method.
	//
	// Provision a new cluster and add it to the collection of clusters.
	//
	// See the `register_cluster` method for adding an existing cluster.
	Add(ctx context.Context, request *ClustersAddServerRequest, response *ClustersAddServerResponse) error

	// List handles a request for the 'list' method.
	//
	// Retrieves the list of clusters.
	List(ctx context.Context, request *ClustersListServerRequest, response *ClustersListServerResponse) error

	// Cluster returns the target 'cluster' server for the given identifier.
	//
	// Returns a reference to the service that manages an specific cluster.
	Cluster(id string) ClusterServer
}

ClustersServer represents the interface the manages the 'clusters' resource.

type CredentialsClient ¶

type CredentialsClient struct {
	// contains filtered or unexported fields
}

CredentialsClient is the client of the 'credentials' resource.

Manages the credentials of a cluster.

func NewCredentialsClient ¶

func NewCredentialsClient(transport http.RoundTripper, path string, metric string) *CredentialsClient

NewCredentialsClient creates a new client for the 'credentials' resource using the given transport to sned the requests and receive the responses.

func (*CredentialsClient) Get ¶

Get creates a request for the 'get' method.

Retrieves the details of the credentials of a cluster.

func (*CredentialsClient) Poll ¶

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type CredentialsGetRequest ¶

type CredentialsGetRequest struct {
	// contains filtered or unexported fields
}

CredentialsGetRequest is the request for the 'get' method.

func (*CredentialsGetRequest) Header ¶

func (r *CredentialsGetRequest) Header(name string, value interface{}) *CredentialsGetRequest

Header adds a request header.

func (*CredentialsGetRequest) Parameter ¶

func (r *CredentialsGetRequest) Parameter(name string, value interface{}) *CredentialsGetRequest

Parameter adds a query parameter.

func (*CredentialsGetRequest) Send ¶

func (r *CredentialsGetRequest) Send() (result *CredentialsGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*CredentialsGetRequest) SendContext ¶

func (r *CredentialsGetRequest) SendContext(ctx context.Context) (result *CredentialsGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type CredentialsGetResponse ¶

type CredentialsGetResponse struct {
	// contains filtered or unexported fields
}

CredentialsGetResponse is the response for the 'get' method.

func (*CredentialsGetResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*CredentialsGetResponse) Error ¶

func (r *CredentialsGetResponse) Error() *errors.Error

Error returns the response error.

func (*CredentialsGetResponse) GetBody ¶

func (r *CredentialsGetResponse) GetBody() (value *ClusterCredentials, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*CredentialsGetResponse) Header ¶

func (r *CredentialsGetResponse) Header() http.Header

Header returns header of the response.

func (*CredentialsGetResponse) Status ¶

func (r *CredentialsGetResponse) Status() int

Status returns the response status code.

type CredentialsGetServerRequest ¶

type CredentialsGetServerRequest struct {
}

CredentialsGetServerRequest is the request for the 'get' method.

type CredentialsGetServerResponse ¶

type CredentialsGetServerResponse struct {
	// contains filtered or unexported fields
}

CredentialsGetServerResponse is the response for the 'get' method.

func (*CredentialsGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*CredentialsGetServerResponse) Status ¶

Status sets the status code.

type CredentialsPollRequest ¶

type CredentialsPollRequest struct {
	// contains filtered or unexported fields
}

CredentialsPollRequest is the request for the Poll method.

func (*CredentialsPollRequest) Header ¶

func (r *CredentialsPollRequest) Header(name string, value interface{}) *CredentialsPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*CredentialsPollRequest) Interval ¶

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*CredentialsPollRequest) Parameter ¶

func (r *CredentialsPollRequest) Parameter(name string, value interface{}) *CredentialsPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*CredentialsPollRequest) Predicate ¶

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*CredentialsPollRequest) StartContext ¶

func (r *CredentialsPollRequest) StartContext(ctx context.Context) (response *CredentialsPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*CredentialsPollRequest) Status ¶

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type CredentialsPollResponse ¶

type CredentialsPollResponse struct {
	// contains filtered or unexported fields
}

CredentialsPollResponse is the response for the Poll method.

func (*CredentialsPollResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*CredentialsPollResponse) Error ¶

func (r *CredentialsPollResponse) Error() *errors.Error

Error returns the response error.

func (*CredentialsPollResponse) GetBody ¶

func (r *CredentialsPollResponse) GetBody() (value *ClusterCredentials, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*CredentialsPollResponse) Header ¶

func (r *CredentialsPollResponse) Header() http.Header

Header returns header of the response.

func (*CredentialsPollResponse) Status ¶

func (r *CredentialsPollResponse) Status() int

Status returns the response status code.

type CredentialsServer ¶

type CredentialsServer interface {

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the credentials of a cluster.
	Get(ctx context.Context, request *CredentialsGetServerRequest, response *CredentialsGetServerResponse) error
}

CredentialsServer represents the interface the manages the 'credentials' resource.

type DNS ¶

type DNS struct {
	// contains filtered or unexported fields
}

DNS represents the values of the 'DNS' type.

DNS settings of the cluster.

func UnmarshalDNS ¶

func UnmarshalDNS(source interface{}) (object *DNS, err error)

UnmarshalDNS reads a value of the 'DNS' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*DNS) BaseDomain ¶

func (o *DNS) BaseDomain() string

BaseDomain returns the value of the 'base_domain' attribute, or the zero value of the type if the attribute doesn't have a value.

Base DNS domain of the cluster.

During the installation of the cluster it is necessary to create multiple DNS records. They will be created as sub-domains of this domain. For example, if the name of the cluster is `mycluster` and the base domain is `example.com` then the following DNS records will be created:

.... mycluster-api.example.com mycluster-etcd-0.example.com mycluster-etcd-1.example.com mycluster-etcd-3.example.com ....

The exact number, type and names of the created DNS record depends on the characteristics of the cluster, and may be different for different versions of _OpenShift_. Please don't rely on them. For example, to find what is the URL of the Kubernetes API server of the cluster don't assume that it will be `mycluster-api.example.com`. Instead of that use this API to retrieve the description of the cluster, and get it from the `api.url` attribute. For example, if the identifier of the cluster is `123` send a request like this:

[source,http] ---- GET /api/clusters_mgmt/v1/clusters/123 HTTP/1.1 ----

That will return a response like this, including the `api.url` attribute:

[source,json] ----

{
    "kind": "Cluster",
    "id": "123",
    "href": "/api/clusters_mgmt/v1/clusters/123",
        "api": {
        "url": "https://mycluster-api.example.com:6443"
    },
    ...
}

----

When the cluster is created in Amazon Web Services it is necessary to create this base DNS domain in advance, using AWS Route53 (https://console.aws.amazon.com/route53).

func (*DNS) Empty ¶

func (o *DNS) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*DNS) GetBaseDomain ¶

func (o *DNS) GetBaseDomain() (value string, ok bool)

GetBaseDomain returns the value of the 'base_domain' attribute and a flag indicating if the attribute has a value.

Base DNS domain of the cluster.

During the installation of the cluster it is necessary to create multiple DNS records. They will be created as sub-domains of this domain. For example, if the name of the cluster is `mycluster` and the base domain is `example.com` then the following DNS records will be created:

.... mycluster-api.example.com mycluster-etcd-0.example.com mycluster-etcd-1.example.com mycluster-etcd-3.example.com ....

The exact number, type and names of the created DNS record depends on the characteristics of the cluster, and may be different for different versions of _OpenShift_. Please don't rely on them. For example, to find what is the URL of the Kubernetes API server of the cluster don't assume that it will be `mycluster-api.example.com`. Instead of that use this API to retrieve the description of the cluster, and get it from the `api.url` attribute. For example, if the identifier of the cluster is `123` send a request like this:

[source,http] ---- GET /api/clusters_mgmt/v1/clusters/123 HTTP/1.1 ----

That will return a response like this, including the `api.url` attribute:

[source,json] ----

{
    "kind": "Cluster",
    "id": "123",
    "href": "/api/clusters_mgmt/v1/clusters/123",
        "api": {
        "url": "https://mycluster-api.example.com:6443"
    },
    ...
}

----

When the cluster is created in Amazon Web Services it is necessary to create this base DNS domain in advance, using AWS Route53 (https://console.aws.amazon.com/route53).

type DNSBuilder ¶

type DNSBuilder struct {
	// contains filtered or unexported fields
}

DNSBuilder contains the data and logic needed to build 'DNS' objects.

DNS settings of the cluster.

func NewDNS ¶

func NewDNS() *DNSBuilder

NewDNS creates a new builder of 'DNS' objects.

func (*DNSBuilder) BaseDomain ¶

func (b *DNSBuilder) BaseDomain(value string) *DNSBuilder

BaseDomain sets the value of the 'base_domain' attribute to the given value.

func (*DNSBuilder) Build ¶

func (b *DNSBuilder) Build() (object *DNS, err error)

Build creates a 'DNS' object using the configuration stored in the builder.

func (*DNSBuilder) Copy ¶

func (b *DNSBuilder) Copy(object *DNS) *DNSBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

type DNSList ¶

type DNSList struct {
	// contains filtered or unexported fields
}

DNSList is a list of values of the 'DNS' type.

func UnmarshalDNSList ¶

func UnmarshalDNSList(source interface{}) (list *DNSList, err error)

UnmarshalDNSList reads a list of values of the 'DNS' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*DNSList) Each ¶

func (l *DNSList) Each(f func(item *DNS) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*DNSList) Empty ¶

func (l *DNSList) Empty() bool

Empty returns true if the list is empty.

func (*DNSList) Get ¶

func (l *DNSList) Get(i int) *DNS

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*DNSList) Len ¶

func (l *DNSList) Len() int

Len returns the length of the list.

func (*DNSList) Range ¶

func (l *DNSList) Range(f func(index int, item *DNS) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*DNSList) Slice ¶

func (l *DNSList) Slice() []*DNS

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type DNSListBuilder ¶

type DNSListBuilder struct {
	// contains filtered or unexported fields
}

DNSListBuilder contains the data and logic needed to build 'DNS' objects.

func NewDNSList ¶

func NewDNSList() *DNSListBuilder

NewDNSList creates a new builder of 'DNS' objects.

func (*DNSListBuilder) Build ¶

func (b *DNSListBuilder) Build() (list *DNSList, err error)

Build creates a list of 'DNS' objects using the configuration stored in the builder.

func (*DNSListBuilder) Items ¶

func (b *DNSListBuilder) Items(values ...*DNSBuilder) *DNSListBuilder

Items sets the items of the list.

type Dashboard ¶

type Dashboard struct {
	// contains filtered or unexported fields
}

Dashboard represents the values of the 'dashboard' type.

Collection of metrics intended to render a graphical dashboard.

func UnmarshalDashboard ¶

func UnmarshalDashboard(source interface{}) (object *Dashboard, err error)

UnmarshalDashboard reads a value of the 'dashboard' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Dashboard) Empty ¶

func (o *Dashboard) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Dashboard) GetHREF ¶

func (o *Dashboard) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*Dashboard) GetID ¶

func (o *Dashboard) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*Dashboard) GetMetrics ¶

func (o *Dashboard) GetMetrics() (value *MetricList, ok bool)

GetMetrics returns the value of the 'metrics' attribute and a flag indicating if the attribute has a value.

Metrics included in the dashboard.

func (*Dashboard) GetName ¶

func (o *Dashboard) GetName() (value string, ok bool)

GetName returns the value of the 'name' attribute and a flag indicating if the attribute has a value.

Name of the dashboard.

func (*Dashboard) HREF ¶

func (o *Dashboard) HREF() string

HREF returns the link to the object.

func (*Dashboard) ID ¶

func (o *Dashboard) ID() string

ID returns the identifier of the object.

func (*Dashboard) Kind ¶

func (o *Dashboard) Kind() string

Kind returns the name of the type of the object.

func (o *Dashboard) Link() bool

Link returns true iif this is a link.

func (*Dashboard) Metrics ¶

func (o *Dashboard) Metrics() *MetricList

Metrics returns the value of the 'metrics' attribute, or the zero value of the type if the attribute doesn't have a value.

Metrics included in the dashboard.

func (*Dashboard) Name ¶

func (o *Dashboard) Name() string

Name returns the value of the 'name' attribute, or the zero value of the type if the attribute doesn't have a value.

Name of the dashboard.

type DashboardBuilder ¶

type DashboardBuilder struct {
	// contains filtered or unexported fields
}

DashboardBuilder contains the data and logic needed to build 'dashboard' objects.

Collection of metrics intended to render a graphical dashboard.

func NewDashboard ¶

func NewDashboard() *DashboardBuilder

NewDashboard creates a new builder of 'dashboard' objects.

func (*DashboardBuilder) Build ¶

func (b *DashboardBuilder) Build() (object *Dashboard, err error)

Build creates a 'dashboard' object using the configuration stored in the builder.

func (*DashboardBuilder) Copy ¶

func (b *DashboardBuilder) Copy(object *Dashboard) *DashboardBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*DashboardBuilder) HREF ¶

func (b *DashboardBuilder) HREF(value string) *DashboardBuilder

HREF sets the link to the object.

func (*DashboardBuilder) ID ¶

ID sets the identifier of the object.

func (b *DashboardBuilder) Link(value bool) *DashboardBuilder

Link sets the flag that indicates if this is a link.

func (*DashboardBuilder) Metrics ¶

func (b *DashboardBuilder) Metrics(values ...*MetricBuilder) *DashboardBuilder

Metrics sets the value of the 'metrics' attribute to the given values.

func (*DashboardBuilder) Name ¶

func (b *DashboardBuilder) Name(value string) *DashboardBuilder

Name sets the value of the 'name' attribute to the given value.

type DashboardClient ¶

type DashboardClient struct {
	// contains filtered or unexported fields
}

DashboardClient is the client of the 'dashboard' resource.

Manages a specific dashboard.

func NewDashboardClient ¶

func NewDashboardClient(transport http.RoundTripper, path string, metric string) *DashboardClient

NewDashboardClient creates a new client for the 'dashboard' resource using the given transport to sned the requests and receive the responses.

func (*DashboardClient) Get ¶

Get creates a request for the 'get' method.

Retrieves the details of the dashboard.

func (*DashboardClient) Poll ¶

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type DashboardGetRequest ¶

type DashboardGetRequest struct {
	// contains filtered or unexported fields
}

DashboardGetRequest is the request for the 'get' method.

func (*DashboardGetRequest) Header ¶

func (r *DashboardGetRequest) Header(name string, value interface{}) *DashboardGetRequest

Header adds a request header.

func (*DashboardGetRequest) Parameter ¶

func (r *DashboardGetRequest) Parameter(name string, value interface{}) *DashboardGetRequest

Parameter adds a query parameter.

func (*DashboardGetRequest) Send ¶

func (r *DashboardGetRequest) Send() (result *DashboardGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*DashboardGetRequest) SendContext ¶

func (r *DashboardGetRequest) SendContext(ctx context.Context) (result *DashboardGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type DashboardGetResponse ¶

type DashboardGetResponse struct {
	// contains filtered or unexported fields
}

DashboardGetResponse is the response for the 'get' method.

func (*DashboardGetResponse) Body ¶

func (r *DashboardGetResponse) Body() *Dashboard

Body returns the value of the 'body' parameter.

func (*DashboardGetResponse) Error ¶

func (r *DashboardGetResponse) Error() *errors.Error

Error returns the response error.

func (*DashboardGetResponse) GetBody ¶

func (r *DashboardGetResponse) GetBody() (value *Dashboard, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*DashboardGetResponse) Header ¶

func (r *DashboardGetResponse) Header() http.Header

Header returns header of the response.

func (*DashboardGetResponse) Status ¶

func (r *DashboardGetResponse) Status() int

Status returns the response status code.

type DashboardGetServerRequest ¶

type DashboardGetServerRequest struct {
}

DashboardGetServerRequest is the request for the 'get' method.

type DashboardGetServerResponse ¶

type DashboardGetServerResponse struct {
	// contains filtered or unexported fields
}

DashboardGetServerResponse is the response for the 'get' method.

func (*DashboardGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*DashboardGetServerResponse) Status ¶

Status sets the status code.

type DashboardList ¶

type DashboardList struct {
	// contains filtered or unexported fields
}

DashboardList is a list of values of the 'dashboard' type.

func UnmarshalDashboardList ¶

func UnmarshalDashboardList(source interface{}) (list *DashboardList, err error)

UnmarshalDashboardList reads a list of values of the 'dashboard' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*DashboardList) Each ¶

func (l *DashboardList) Each(f func(item *Dashboard) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*DashboardList) Empty ¶

func (l *DashboardList) Empty() bool

Empty returns true if the list is empty.

func (*DashboardList) Get ¶

func (l *DashboardList) Get(i int) *Dashboard

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*DashboardList) GetHREF ¶

func (l *DashboardList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*DashboardList) HREF ¶

func (l *DashboardList) HREF() string

HREF returns the link to the list.

func (*DashboardList) Kind ¶

func (l *DashboardList) Kind() string

Kind returns the name of the type of the object.

func (*DashboardList) Len ¶

func (l *DashboardList) Len() int

Len returns the length of the list.

func (l *DashboardList) Link() bool

Link returns true iif this is a link.

func (*DashboardList) Range ¶

func (l *DashboardList) Range(f func(index int, item *Dashboard) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*DashboardList) Slice ¶

func (l *DashboardList) Slice() []*Dashboard

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type DashboardListBuilder ¶

type DashboardListBuilder struct {
	// contains filtered or unexported fields
}

DashboardListBuilder contains the data and logic needed to build 'dashboard' objects.

func NewDashboardList ¶

func NewDashboardList() *DashboardListBuilder

NewDashboardList creates a new builder of 'dashboard' objects.

func (*DashboardListBuilder) Build ¶

func (b *DashboardListBuilder) Build() (list *DashboardList, err error)

Build creates a list of 'dashboard' objects using the configuration stored in the builder.

func (*DashboardListBuilder) Items ¶

Items sets the items of the list.

type DashboardPollRequest ¶

type DashboardPollRequest struct {
	// contains filtered or unexported fields
}

DashboardPollRequest is the request for the Poll method.

func (*DashboardPollRequest) Header ¶

func (r *DashboardPollRequest) Header(name string, value interface{}) *DashboardPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*DashboardPollRequest) Interval ¶

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*DashboardPollRequest) Parameter ¶

func (r *DashboardPollRequest) Parameter(name string, value interface{}) *DashboardPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*DashboardPollRequest) Predicate ¶

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*DashboardPollRequest) StartContext ¶

func (r *DashboardPollRequest) StartContext(ctx context.Context) (response *DashboardPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*DashboardPollRequest) Status ¶

func (r *DashboardPollRequest) Status(value int) *DashboardPollRequest

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type DashboardPollResponse ¶

type DashboardPollResponse struct {
	// contains filtered or unexported fields
}

DashboardPollResponse is the response for the Poll method.

func (*DashboardPollResponse) Body ¶

func (r *DashboardPollResponse) Body() *Dashboard

Body returns the value of the 'body' parameter.

func (*DashboardPollResponse) Error ¶

func (r *DashboardPollResponse) Error() *errors.Error

Error returns the response error.

func (*DashboardPollResponse) GetBody ¶

func (r *DashboardPollResponse) GetBody() (value *Dashboard, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*DashboardPollResponse) Header ¶

func (r *DashboardPollResponse) Header() http.Header

Header returns header of the response.

func (*DashboardPollResponse) Status ¶

func (r *DashboardPollResponse) Status() int

Status returns the response status code.

type DashboardServer ¶

type DashboardServer interface {

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the dashboard.
	Get(ctx context.Context, request *DashboardGetServerRequest, response *DashboardGetServerResponse) error
}

DashboardServer represents the interface the manages the 'dashboard' resource.

type DashboardsClient ¶

type DashboardsClient struct {
	// contains filtered or unexported fields
}

DashboardsClient is the client of the 'dashboards' resource.

Manages the collection of dashboards.

func NewDashboardsClient ¶

func NewDashboardsClient(transport http.RoundTripper, path string, metric string) *DashboardsClient

NewDashboardsClient creates a new client for the 'dashboards' resource using the given transport to sned the requests and receive the responses.

func (*DashboardsClient) Dashboard ¶

func (c *DashboardsClient) Dashboard(id string) *DashboardClient

Dashboard returns the target 'dashboard' resource for the given identifier.

Reference to the resource that manages a specific dashboard.

func (*DashboardsClient) List ¶

List creates a request for the 'list' method.

Retrieves a list of dashboards.

type DashboardsListRequest ¶

type DashboardsListRequest struct {
	// contains filtered or unexported fields
}

DashboardsListRequest is the request for the 'list' method.

func (*DashboardsListRequest) Header ¶

func (r *DashboardsListRequest) Header(name string, value interface{}) *DashboardsListRequest

Header adds a request header.

func (*DashboardsListRequest) Order ¶

Order sets the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the dashboard instead of the names of the columns of a table. For example, in order to sort the dashboards descending by name the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*DashboardsListRequest) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*DashboardsListRequest) Parameter ¶

func (r *DashboardsListRequest) Parameter(name string, value interface{}) *DashboardsListRequest

Parameter adds a query parameter.

func (*DashboardsListRequest) Search ¶

Search sets the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the dashboard instead of the names of the columns of a table. For example, in order to retrieve all the dashboards with a name starting with `my` the value should be:

[source,sql] ---- name like 'my%' ----

If the parameter isn't provided, or if the value is empty, then all the dashboards that the user has permission to see will be returned.

func (*DashboardsListRequest) Send ¶

func (r *DashboardsListRequest) Send() (result *DashboardsListResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*DashboardsListRequest) SendContext ¶

func (r *DashboardsListRequest) SendContext(ctx context.Context) (result *DashboardsListResponse, err error)

SendContext sends this request, waits for the response, and returns it.

func (*DashboardsListRequest) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

type DashboardsListResponse ¶

type DashboardsListResponse struct {
	// contains filtered or unexported fields
}

DashboardsListResponse is the response for the 'list' method.

func (*DashboardsListResponse) Error ¶

func (r *DashboardsListResponse) Error() *errors.Error

Error returns the response error.

func (*DashboardsListResponse) GetItems ¶

func (r *DashboardsListResponse) GetItems() (value *DashboardList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of dashboards.

func (*DashboardsListResponse) GetPage ¶

func (r *DashboardsListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*DashboardsListResponse) GetSize ¶

func (r *DashboardsListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

func (*DashboardsListResponse) GetTotal ¶

func (r *DashboardsListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

func (*DashboardsListResponse) Header ¶

func (r *DashboardsListResponse) Header() http.Header

Header returns header of the response.

func (*DashboardsListResponse) Items ¶

Items returns the value of the 'items' parameter.

Retrieved list of dashboards.

func (*DashboardsListResponse) Page ¶

func (r *DashboardsListResponse) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*DashboardsListResponse) Size ¶

func (r *DashboardsListResponse) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

func (*DashboardsListResponse) Status ¶

func (r *DashboardsListResponse) Status() int

Status returns the response status code.

func (*DashboardsListResponse) Total ¶

func (r *DashboardsListResponse) Total() int

Total returns the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type DashboardsListServerRequest ¶

type DashboardsListServerRequest struct {
	// contains filtered or unexported fields
}

DashboardsListServerRequest is the request for the 'list' method.

func (*DashboardsListServerRequest) GetOrder ¶

func (r *DashboardsListServerRequest) GetOrder() (value string, ok bool)

GetOrder returns the value of the 'order' parameter and a flag indicating if the parameter has a value.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the dashboard instead of the names of the columns of a table. For example, in order to sort the dashboards descending by name the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*DashboardsListServerRequest) GetPage ¶

func (r *DashboardsListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*DashboardsListServerRequest) GetSearch ¶

func (r *DashboardsListServerRequest) GetSearch() (value string, ok bool)

GetSearch returns the value of the 'search' parameter and a flag indicating if the parameter has a value.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the dashboard instead of the names of the columns of a table. For example, in order to retrieve all the dashboards with a name starting with `my` the value should be:

[source,sql] ---- name like 'my%' ----

If the parameter isn't provided, or if the value is empty, then all the dashboards that the user has permission to see will be returned.

func (*DashboardsListServerRequest) GetSize ¶

func (r *DashboardsListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

func (*DashboardsListServerRequest) Order ¶

Order returns the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the dashboard instead of the names of the columns of a table. For example, in order to sort the dashboards descending by name the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*DashboardsListServerRequest) Page ¶

func (r *DashboardsListServerRequest) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*DashboardsListServerRequest) Search ¶

func (r *DashboardsListServerRequest) Search() string

Search returns the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the dashboard instead of the names of the columns of a table. For example, in order to retrieve all the dashboards with a name starting with `my` the value should be:

[source,sql] ---- name like 'my%' ----

If the parameter isn't provided, or if the value is empty, then all the dashboards that the user has permission to see will be returned.

func (*DashboardsListServerRequest) Size ¶

func (r *DashboardsListServerRequest) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

type DashboardsListServerResponse ¶

type DashboardsListServerResponse struct {
	// contains filtered or unexported fields
}

DashboardsListServerResponse is the response for the 'list' method.

func (*DashboardsListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of dashboards.

func (*DashboardsListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*DashboardsListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

func (*DashboardsListServerResponse) Status ¶

Status sets the status code.

func (*DashboardsListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type DashboardsServer ¶

type DashboardsServer interface {

	// List handles a request for the 'list' method.
	//
	// Retrieves a list of dashboards.
	List(ctx context.Context, request *DashboardsListServerRequest, response *DashboardsListServerResponse) error

	// Dashboard returns the target 'dashboard' server for the given identifier.
	//
	// Reference to the resource that manages a specific dashboard.
	Dashboard(id string) DashboardServer
}

DashboardsServer represents the interface the manages the 'dashboards' resource.

type Flavour ¶

type Flavour struct {
	// contains filtered or unexported fields
}

Flavour represents the values of the 'flavour' type.

Set of predefined properties of a cluster. For example, a _huge_ flavour can be a cluster with 10 infra nodes and 1000 compute nodes.

func UnmarshalFlavour ¶

func UnmarshalFlavour(source interface{}) (object *Flavour, err error)

UnmarshalFlavour reads a value of the 'flavour' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Flavour) AWS ¶

func (o *Flavour) AWS() *AWS

AWS returns the value of the 'AWS' attribute, or the zero value of the type if the attribute doesn't have a value.

Default _Amazon Web Services_ settings of the cluster.

These can be overriden specifying in the clsuter itself a different set of settings.

func (*Flavour) Empty ¶

func (o *Flavour) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Flavour) GetAWS ¶

func (o *Flavour) GetAWS() (value *AWS, ok bool)

GetAWS returns the value of the 'AWS' attribute and a flag indicating if the attribute has a value.

Default _Amazon Web Services_ settings of the cluster.

These can be overriden specifying in the clsuter itself a different set of settings.

func (*Flavour) GetHREF ¶

func (o *Flavour) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*Flavour) GetID ¶

func (o *Flavour) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*Flavour) GetName ¶

func (o *Flavour) GetName() (value string, ok bool)

GetName returns the value of the 'name' attribute and a flag indicating if the attribute has a value.

Human friendly identifier of the cluster, for example `4`.

NOTE: Currently for all flavours the `id` and `name` attributes have exactly the same values.

func (*Flavour) GetNetwork ¶

func (o *Flavour) GetNetwork() (value *Network, ok bool)

GetNetwork returns the value of the 'network' attribute and a flag indicating if the attribute has a value.

Default network settings of the cluster.

These can be overriden specifying in the cluster itself a different set of settings.

func (*Flavour) GetNodes ¶

func (o *Flavour) GetNodes() (value *FlavourNodes, ok bool)

GetNodes returns the value of the 'nodes' attribute and a flag indicating if the attribute has a value.

Number of nodes that will be used by default when creating a cluster that uses this flavour.

These can be overriden specifying in the cluster itself a different number of nodes.

func (*Flavour) GetVersion ¶ added in v0.1.30

func (o *Flavour) GetVersion() (value string, ok bool)

GetVersion returns the value of the 'version' attribute and a flag indicating if the attribute has a value.

Version of _OpenShift_ that will be used to create the cluster.

func (*Flavour) HREF ¶

func (o *Flavour) HREF() string

HREF returns the link to the object.

func (*Flavour) ID ¶

func (o *Flavour) ID() string

ID returns the identifier of the object.

func (*Flavour) Kind ¶

func (o *Flavour) Kind() string

Kind returns the name of the type of the object.

func (o *Flavour) Link() bool

Link returns true iif this is a link.

func (*Flavour) Name ¶

func (o *Flavour) Name() string

Name returns the value of the 'name' attribute, or the zero value of the type if the attribute doesn't have a value.

Human friendly identifier of the cluster, for example `4`.

NOTE: Currently for all flavours the `id` and `name` attributes have exactly the same values.

func (*Flavour) Network ¶

func (o *Flavour) Network() *Network

Network returns the value of the 'network' attribute, or the zero value of the type if the attribute doesn't have a value.

Default network settings of the cluster.

These can be overriden specifying in the cluster itself a different set of settings.

func (*Flavour) Nodes ¶

func (o *Flavour) Nodes() *FlavourNodes

Nodes returns the value of the 'nodes' attribute, or the zero value of the type if the attribute doesn't have a value.

Number of nodes that will be used by default when creating a cluster that uses this flavour.

These can be overriden specifying in the cluster itself a different number of nodes.

func (*Flavour) Version ¶ added in v0.1.30

func (o *Flavour) Version() string

Version returns the value of the 'version' attribute, or the zero value of the type if the attribute doesn't have a value.

Version of _OpenShift_ that will be used to create the cluster.

type FlavourBuilder ¶

type FlavourBuilder struct {
	// contains filtered or unexported fields
}

FlavourBuilder contains the data and logic needed to build 'flavour' objects.

Set of predefined properties of a cluster. For example, a _huge_ flavour can be a cluster with 10 infra nodes and 1000 compute nodes.

func NewFlavour ¶

func NewFlavour() *FlavourBuilder

NewFlavour creates a new builder of 'flavour' objects.

func (*FlavourBuilder) AWS ¶

func (b *FlavourBuilder) AWS(value *AWSBuilder) *FlavourBuilder

AWS sets the value of the 'AWS' attribute to the given value.

_Amazon Web Services_ specific settings of a cluster.

func (*FlavourBuilder) Build ¶

func (b *FlavourBuilder) Build() (object *Flavour, err error)

Build creates a 'flavour' object using the configuration stored in the builder.

func (*FlavourBuilder) Copy ¶

func (b *FlavourBuilder) Copy(object *Flavour) *FlavourBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*FlavourBuilder) HREF ¶

func (b *FlavourBuilder) HREF(value string) *FlavourBuilder

HREF sets the link to the object.

func (*FlavourBuilder) ID ¶

func (b *FlavourBuilder) ID(value string) *FlavourBuilder

ID sets the identifier of the object.

func (b *FlavourBuilder) Link(value bool) *FlavourBuilder

Link sets the flag that indicates if this is a link.

func (*FlavourBuilder) Name ¶

func (b *FlavourBuilder) Name(value string) *FlavourBuilder

Name sets the value of the 'name' attribute to the given value.

func (*FlavourBuilder) Network ¶

func (b *FlavourBuilder) Network(value *NetworkBuilder) *FlavourBuilder

Network sets the value of the 'network' attribute to the given value.

Network configuration of a cluster.

func (*FlavourBuilder) Nodes ¶

Nodes sets the value of the 'nodes' attribute to the given value.

Counts of different classes of nodes inside a flavour.

func (*FlavourBuilder) Version ¶ added in v0.1.30

func (b *FlavourBuilder) Version(value string) *FlavourBuilder

Version sets the value of the 'version' attribute to the given value.

type FlavourClient ¶

type FlavourClient struct {
	// contains filtered or unexported fields
}

FlavourClient is the client of the 'flavour' resource.

Manages a specific cluster flavour.

func NewFlavourClient ¶

func NewFlavourClient(transport http.RoundTripper, path string, metric string) *FlavourClient

NewFlavourClient creates a new client for the 'flavour' resource using the given transport to sned the requests and receive the responses.

func (*FlavourClient) Get ¶

func (c *FlavourClient) Get() *FlavourGetRequest

Get creates a request for the 'get' method.

Retrieves the details of the cluster flavour.

func (*FlavourClient) Poll ¶

func (c *FlavourClient) Poll() *FlavourPollRequest

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type FlavourGetRequest ¶

type FlavourGetRequest struct {
	// contains filtered or unexported fields
}

FlavourGetRequest is the request for the 'get' method.

func (*FlavourGetRequest) Header ¶

func (r *FlavourGetRequest) Header(name string, value interface{}) *FlavourGetRequest

Header adds a request header.

func (*FlavourGetRequest) Parameter ¶

func (r *FlavourGetRequest) Parameter(name string, value interface{}) *FlavourGetRequest

Parameter adds a query parameter.

func (*FlavourGetRequest) Send ¶

func (r *FlavourGetRequest) Send() (result *FlavourGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*FlavourGetRequest) SendContext ¶

func (r *FlavourGetRequest) SendContext(ctx context.Context) (result *FlavourGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type FlavourGetResponse ¶

type FlavourGetResponse struct {
	// contains filtered or unexported fields
}

FlavourGetResponse is the response for the 'get' method.

func (*FlavourGetResponse) Body ¶

func (r *FlavourGetResponse) Body() *Flavour

Body returns the value of the 'body' parameter.

func (*FlavourGetResponse) Error ¶

func (r *FlavourGetResponse) Error() *errors.Error

Error returns the response error.

func (*FlavourGetResponse) GetBody ¶

func (r *FlavourGetResponse) GetBody() (value *Flavour, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*FlavourGetResponse) Header ¶

func (r *FlavourGetResponse) Header() http.Header

Header returns header of the response.

func (*FlavourGetResponse) Status ¶

func (r *FlavourGetResponse) Status() int

Status returns the response status code.

type FlavourGetServerRequest ¶

type FlavourGetServerRequest struct {
}

FlavourGetServerRequest is the request for the 'get' method.

type FlavourGetServerResponse ¶

type FlavourGetServerResponse struct {
	// contains filtered or unexported fields
}

FlavourGetServerResponse is the response for the 'get' method.

func (*FlavourGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*FlavourGetServerResponse) Status ¶

Status sets the status code.

type FlavourList ¶

type FlavourList struct {
	// contains filtered or unexported fields
}

FlavourList is a list of values of the 'flavour' type.

func UnmarshalFlavourList ¶

func UnmarshalFlavourList(source interface{}) (list *FlavourList, err error)

UnmarshalFlavourList reads a list of values of the 'flavour' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*FlavourList) Each ¶

func (l *FlavourList) Each(f func(item *Flavour) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*FlavourList) Empty ¶

func (l *FlavourList) Empty() bool

Empty returns true if the list is empty.

func (*FlavourList) Get ¶

func (l *FlavourList) Get(i int) *Flavour

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*FlavourList) GetHREF ¶

func (l *FlavourList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*FlavourList) HREF ¶

func (l *FlavourList) HREF() string

HREF returns the link to the list.

func (*FlavourList) Kind ¶

func (l *FlavourList) Kind() string

Kind returns the name of the type of the object.

func (*FlavourList) Len ¶

func (l *FlavourList) Len() int

Len returns the length of the list.

func (l *FlavourList) Link() bool

Link returns true iif this is a link.

func (*FlavourList) Range ¶

func (l *FlavourList) Range(f func(index int, item *Flavour) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*FlavourList) Slice ¶

func (l *FlavourList) Slice() []*Flavour

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type FlavourListBuilder ¶

type FlavourListBuilder struct {
	// contains filtered or unexported fields
}

FlavourListBuilder contains the data and logic needed to build 'flavour' objects.

func NewFlavourList ¶

func NewFlavourList() *FlavourListBuilder

NewFlavourList creates a new builder of 'flavour' objects.

func (*FlavourListBuilder) Build ¶

func (b *FlavourListBuilder) Build() (list *FlavourList, err error)

Build creates a list of 'flavour' objects using the configuration stored in the builder.

func (*FlavourListBuilder) Items ¶

Items sets the items of the list.

type FlavourNodes ¶

type FlavourNodes struct {
	// contains filtered or unexported fields
}

FlavourNodes represents the values of the 'flavour_nodes' type.

Counts of different classes of nodes inside a flavour.

func UnmarshalFlavourNodes ¶

func UnmarshalFlavourNodes(source interface{}) (object *FlavourNodes, err error)

UnmarshalFlavourNodes reads a value of the 'flavour_nodes' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*FlavourNodes) Compute ¶

func (o *FlavourNodes) Compute() int

Compute returns the value of the 'compute' attribute, or the zero value of the type if the attribute doesn't have a value.

Number of compute nodes of the cluster.

func (*FlavourNodes) Empty ¶

func (o *FlavourNodes) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*FlavourNodes) GetCompute ¶

func (o *FlavourNodes) GetCompute() (value int, ok bool)

GetCompute returns the value of the 'compute' attribute and a flag indicating if the attribute has a value.

Number of compute nodes of the cluster.

func (*FlavourNodes) GetInfra ¶

func (o *FlavourNodes) GetInfra() (value int, ok bool)

GetInfra returns the value of the 'infra' attribute and a flag indicating if the attribute has a value.

Number of infra nodes of the cluster.

func (*FlavourNodes) GetMaster ¶

func (o *FlavourNodes) GetMaster() (value int, ok bool)

GetMaster returns the value of the 'master' attribute and a flag indicating if the attribute has a value.

Number of master nodes of the cluster.

func (*FlavourNodes) Infra ¶

func (o *FlavourNodes) Infra() int

Infra returns the value of the 'infra' attribute, or the zero value of the type if the attribute doesn't have a value.

Number of infra nodes of the cluster.

func (*FlavourNodes) Master ¶

func (o *FlavourNodes) Master() int

Master returns the value of the 'master' attribute, or the zero value of the type if the attribute doesn't have a value.

Number of master nodes of the cluster.

type FlavourNodesBuilder ¶

type FlavourNodesBuilder struct {
	// contains filtered or unexported fields
}

FlavourNodesBuilder contains the data and logic needed to build 'flavour_nodes' objects.

Counts of different classes of nodes inside a flavour.

func NewFlavourNodes ¶

func NewFlavourNodes() *FlavourNodesBuilder

NewFlavourNodes creates a new builder of 'flavour_nodes' objects.

func (*FlavourNodesBuilder) Build ¶

func (b *FlavourNodesBuilder) Build() (object *FlavourNodes, err error)

Build creates a 'flavour_nodes' object using the configuration stored in the builder.

func (*FlavourNodesBuilder) Compute ¶

func (b *FlavourNodesBuilder) Compute(value int) *FlavourNodesBuilder

Compute sets the value of the 'compute' attribute to the given value.

func (*FlavourNodesBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*FlavourNodesBuilder) Infra ¶

func (b *FlavourNodesBuilder) Infra(value int) *FlavourNodesBuilder

Infra sets the value of the 'infra' attribute to the given value.

func (*FlavourNodesBuilder) Master ¶

func (b *FlavourNodesBuilder) Master(value int) *FlavourNodesBuilder

Master sets the value of the 'master' attribute to the given value.

type FlavourNodesList ¶

type FlavourNodesList struct {
	// contains filtered or unexported fields
}

FlavourNodesList is a list of values of the 'flavour_nodes' type.

func UnmarshalFlavourNodesList ¶

func UnmarshalFlavourNodesList(source interface{}) (list *FlavourNodesList, err error)

UnmarshalFlavourNodesList reads a list of values of the 'flavour_nodes' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*FlavourNodesList) Each ¶

func (l *FlavourNodesList) Each(f func(item *FlavourNodes) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*FlavourNodesList) Empty ¶

func (l *FlavourNodesList) Empty() bool

Empty returns true if the list is empty.

func (*FlavourNodesList) Get ¶

func (l *FlavourNodesList) Get(i int) *FlavourNodes

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*FlavourNodesList) Len ¶

func (l *FlavourNodesList) Len() int

Len returns the length of the list.

func (*FlavourNodesList) Range ¶

func (l *FlavourNodesList) Range(f func(index int, item *FlavourNodes) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*FlavourNodesList) Slice ¶

func (l *FlavourNodesList) Slice() []*FlavourNodes

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type FlavourNodesListBuilder ¶

type FlavourNodesListBuilder struct {
	// contains filtered or unexported fields
}

FlavourNodesListBuilder contains the data and logic needed to build 'flavour_nodes' objects.

func NewFlavourNodesList ¶

func NewFlavourNodesList() *FlavourNodesListBuilder

NewFlavourNodesList creates a new builder of 'flavour_nodes' objects.

func (*FlavourNodesListBuilder) Build ¶

func (b *FlavourNodesListBuilder) Build() (list *FlavourNodesList, err error)

Build creates a list of 'flavour_nodes' objects using the configuration stored in the builder.

func (*FlavourNodesListBuilder) Items ¶

Items sets the items of the list.

type FlavourPollRequest ¶

type FlavourPollRequest struct {
	// contains filtered or unexported fields
}

FlavourPollRequest is the request for the Poll method.

func (*FlavourPollRequest) Header ¶

func (r *FlavourPollRequest) Header(name string, value interface{}) *FlavourPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*FlavourPollRequest) Interval ¶

func (r *FlavourPollRequest) Interval(value time.Duration) *FlavourPollRequest

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*FlavourPollRequest) Parameter ¶

func (r *FlavourPollRequest) Parameter(name string, value interface{}) *FlavourPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*FlavourPollRequest) Predicate ¶

func (r *FlavourPollRequest) Predicate(value func(*FlavourGetResponse) bool) *FlavourPollRequest

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*FlavourPollRequest) StartContext ¶

func (r *FlavourPollRequest) StartContext(ctx context.Context) (response *FlavourPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*FlavourPollRequest) Status ¶

func (r *FlavourPollRequest) Status(value int) *FlavourPollRequest

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type FlavourPollResponse ¶

type FlavourPollResponse struct {
	// contains filtered or unexported fields
}

FlavourPollResponse is the response for the Poll method.

func (*FlavourPollResponse) Body ¶

func (r *FlavourPollResponse) Body() *Flavour

Body returns the value of the 'body' parameter.

func (*FlavourPollResponse) Error ¶

func (r *FlavourPollResponse) Error() *errors.Error

Error returns the response error.

func (*FlavourPollResponse) GetBody ¶

func (r *FlavourPollResponse) GetBody() (value *Flavour, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*FlavourPollResponse) Header ¶

func (r *FlavourPollResponse) Header() http.Header

Header returns header of the response.

func (*FlavourPollResponse) Status ¶

func (r *FlavourPollResponse) Status() int

Status returns the response status code.

type FlavourServer ¶

type FlavourServer interface {

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the cluster flavour.
	Get(ctx context.Context, request *FlavourGetServerRequest, response *FlavourGetServerResponse) error
}

FlavourServer represents the interface the manages the 'flavour' resource.

type FlavoursAddRequest ¶

type FlavoursAddRequest struct {
	// contains filtered or unexported fields
}

FlavoursAddRequest is the request for the 'add' method.

func (*FlavoursAddRequest) Body ¶

Body sets the value of the 'body' parameter.

Details of the cluster flavour.

func (*FlavoursAddRequest) Header ¶

func (r *FlavoursAddRequest) Header(name string, value interface{}) *FlavoursAddRequest

Header adds a request header.

func (*FlavoursAddRequest) Parameter ¶

func (r *FlavoursAddRequest) Parameter(name string, value interface{}) *FlavoursAddRequest

Parameter adds a query parameter.

func (*FlavoursAddRequest) Send ¶

func (r *FlavoursAddRequest) Send() (result *FlavoursAddResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*FlavoursAddRequest) SendContext ¶

func (r *FlavoursAddRequest) SendContext(ctx context.Context) (result *FlavoursAddResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type FlavoursAddResponse ¶

type FlavoursAddResponse struct {
	// contains filtered or unexported fields
}

FlavoursAddResponse is the response for the 'add' method.

func (*FlavoursAddResponse) Body ¶

func (r *FlavoursAddResponse) Body() *Flavour

Body returns the value of the 'body' parameter.

Details of the cluster flavour.

func (*FlavoursAddResponse) Error ¶

func (r *FlavoursAddResponse) Error() *errors.Error

Error returns the response error.

func (*FlavoursAddResponse) GetBody ¶

func (r *FlavoursAddResponse) GetBody() (value *Flavour, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

Details of the cluster flavour.

func (*FlavoursAddResponse) Header ¶

func (r *FlavoursAddResponse) Header() http.Header

Header returns header of the response.

func (*FlavoursAddResponse) Status ¶

func (r *FlavoursAddResponse) Status() int

Status returns the response status code.

type FlavoursAddServerRequest ¶

type FlavoursAddServerRequest struct {
	// contains filtered or unexported fields
}

FlavoursAddServerRequest is the request for the 'add' method.

func (*FlavoursAddServerRequest) Body ¶

func (r *FlavoursAddServerRequest) Body() *Flavour

Body returns the value of the 'body' parameter.

Details of the cluster flavour.

func (*FlavoursAddServerRequest) GetBody ¶

func (r *FlavoursAddServerRequest) GetBody() (value *Flavour, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

Details of the cluster flavour.

type FlavoursAddServerResponse ¶

type FlavoursAddServerResponse struct {
	// contains filtered or unexported fields
}

FlavoursAddServerResponse is the response for the 'add' method.

func (*FlavoursAddServerResponse) Body ¶

Body sets the value of the 'body' parameter.

Details of the cluster flavour.

func (*FlavoursAddServerResponse) Status ¶

Status sets the status code.

type FlavoursClient ¶

type FlavoursClient struct {
	// contains filtered or unexported fields
}

FlavoursClient is the client of the 'flavours' resource.

Manages the collection of cluster flavours.

func NewFlavoursClient ¶

func NewFlavoursClient(transport http.RoundTripper, path string, metric string) *FlavoursClient

NewFlavoursClient creates a new client for the 'flavours' resource using the given transport to sned the requests and receive the responses.

func (*FlavoursClient) Add ¶

Add creates a request for the 'add' method.

Adds a new cluster flavour.

func (*FlavoursClient) Flavour ¶

func (c *FlavoursClient) Flavour(id string) *FlavourClient

Flavour returns the target 'flavour' resource for the given identifier.

Reference to the resource that manages a specific flavour.

func (*FlavoursClient) List ¶

List creates a request for the 'list' method.

type FlavoursListRequest ¶

type FlavoursListRequest struct {
	// contains filtered or unexported fields
}

FlavoursListRequest is the request for the 'list' method.

func (*FlavoursListRequest) Header ¶

func (r *FlavoursListRequest) Header(name string, value interface{}) *FlavoursListRequest

Header adds a request header.

func (*FlavoursListRequest) Order ¶

Order sets the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the flavour instead of the names of the columns of a table. For example, in order to sort the flavours descending by name the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*FlavoursListRequest) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*FlavoursListRequest) Parameter ¶

func (r *FlavoursListRequest) Parameter(name string, value interface{}) *FlavoursListRequest

Parameter adds a query parameter.

func (*FlavoursListRequest) Search ¶

Search sets the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of an SQL statement, but using the names of the attributes of the flavour instead of the names of the columns of a table. For example, in order to retrieve all the flavours with a name starting with `my`the value should be:

[source,sql] ---- name like 'my%' ----

If the parameter isn't provided, or if the value is empty, then all the flavours that the user has permission to see will be returned.

func (*FlavoursListRequest) Send ¶

func (r *FlavoursListRequest) Send() (result *FlavoursListResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*FlavoursListRequest) SendContext ¶

func (r *FlavoursListRequest) SendContext(ctx context.Context) (result *FlavoursListResponse, err error)

SendContext sends this request, waits for the response, and returns it.

func (*FlavoursListRequest) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

type FlavoursListResponse ¶

type FlavoursListResponse struct {
	// contains filtered or unexported fields
}

FlavoursListResponse is the response for the 'list' method.

func (*FlavoursListResponse) Error ¶

func (r *FlavoursListResponse) Error() *errors.Error

Error returns the response error.

func (*FlavoursListResponse) GetItems ¶

func (r *FlavoursListResponse) GetItems() (value *FlavourList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of flavours.

func (*FlavoursListResponse) GetPage ¶

func (r *FlavoursListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*FlavoursListResponse) GetSize ¶

func (r *FlavoursListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

func (*FlavoursListResponse) GetTotal ¶

func (r *FlavoursListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

func (*FlavoursListResponse) Header ¶

func (r *FlavoursListResponse) Header() http.Header

Header returns header of the response.

func (*FlavoursListResponse) Items ¶

func (r *FlavoursListResponse) Items() *FlavourList

Items returns the value of the 'items' parameter.

Retrieved list of flavours.

func (*FlavoursListResponse) Page ¶

func (r *FlavoursListResponse) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*FlavoursListResponse) Size ¶

func (r *FlavoursListResponse) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

func (*FlavoursListResponse) Status ¶

func (r *FlavoursListResponse) Status() int

Status returns the response status code.

func (*FlavoursListResponse) Total ¶

func (r *FlavoursListResponse) Total() int

Total returns the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type FlavoursListServerRequest ¶

type FlavoursListServerRequest struct {
	// contains filtered or unexported fields
}

FlavoursListServerRequest is the request for the 'list' method.

func (*FlavoursListServerRequest) GetOrder ¶

func (r *FlavoursListServerRequest) GetOrder() (value string, ok bool)

GetOrder returns the value of the 'order' parameter and a flag indicating if the parameter has a value.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the flavour instead of the names of the columns of a table. For example, in order to sort the flavours descending by name the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*FlavoursListServerRequest) GetPage ¶

func (r *FlavoursListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*FlavoursListServerRequest) GetSearch ¶

func (r *FlavoursListServerRequest) GetSearch() (value string, ok bool)

GetSearch returns the value of the 'search' parameter and a flag indicating if the parameter has a value.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of an SQL statement, but using the names of the attributes of the flavour instead of the names of the columns of a table. For example, in order to retrieve all the flavours with a name starting with `my`the value should be:

[source,sql] ---- name like 'my%' ----

If the parameter isn't provided, or if the value is empty, then all the flavours that the user has permission to see will be returned.

func (*FlavoursListServerRequest) GetSize ¶

func (r *FlavoursListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

func (*FlavoursListServerRequest) Order ¶

func (r *FlavoursListServerRequest) Order() string

Order returns the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the flavour instead of the names of the columns of a table. For example, in order to sort the flavours descending by name the value should be:

[source,sql] ---- name desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*FlavoursListServerRequest) Page ¶

func (r *FlavoursListServerRequest) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*FlavoursListServerRequest) Search ¶

func (r *FlavoursListServerRequest) Search() string

Search returns the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of an SQL statement, but using the names of the attributes of the flavour instead of the names of the columns of a table. For example, in order to retrieve all the flavours with a name starting with `my`the value should be:

[source,sql] ---- name like 'my%' ----

If the parameter isn't provided, or if the value is empty, then all the flavours that the user has permission to see will be returned.

func (*FlavoursListServerRequest) Size ¶

func (r *FlavoursListServerRequest) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

type FlavoursListServerResponse ¶

type FlavoursListServerResponse struct {
	// contains filtered or unexported fields
}

FlavoursListServerResponse is the response for the 'list' method.

func (*FlavoursListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of flavours.

func (*FlavoursListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*FlavoursListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

func (*FlavoursListServerResponse) Status ¶

Status sets the status code.

func (*FlavoursListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type FlavoursServer ¶

type FlavoursServer interface {

	// Add handles a request for the 'add' method.
	//
	// Adds a new cluster flavour.
	Add(ctx context.Context, request *FlavoursAddServerRequest, response *FlavoursAddServerResponse) error

	// List handles a request for the 'list' method.
	//
	//
	List(ctx context.Context, request *FlavoursListServerRequest, response *FlavoursListServerResponse) error

	// Flavour returns the target 'flavour' server for the given identifier.
	//
	// Reference to the resource that manages a specific flavour.
	Flavour(id string) FlavourServer
}

FlavoursServer represents the interface the manages the 'flavours' resource.

type GithubIdentityProvider ¶

type GithubIdentityProvider struct {
	// contains filtered or unexported fields
}

GithubIdentityProvider represents the values of the 'github_identity_provider' type.

Details for `github` identity providers.

func UnmarshalGithubIdentityProvider ¶

func UnmarshalGithubIdentityProvider(source interface{}) (object *GithubIdentityProvider, err error)

UnmarshalGithubIdentityProvider reads a value of the 'github_identity_provider' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*GithubIdentityProvider) CA ¶

CA returns the value of the 'CA' attribute, or the zero value of the type if the attribute doesn't have a value.

Optional trusted certificate authority bundle to use when making requests tot he server.

func (*GithubIdentityProvider) ClientID ¶

func (o *GithubIdentityProvider) ClientID() string

ClientID returns the value of the 'client_ID' attribute, or the zero value of the type if the attribute doesn't have a value.

Client identifier of a registered _GitHub_ OAuth application.

func (*GithubIdentityProvider) Empty ¶

func (o *GithubIdentityProvider) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*GithubIdentityProvider) GetCA ¶

func (o *GithubIdentityProvider) GetCA() (value string, ok bool)

GetCA returns the value of the 'CA' attribute and a flag indicating if the attribute has a value.

Optional trusted certificate authority bundle to use when making requests tot he server.

func (*GithubIdentityProvider) GetClientID ¶

func (o *GithubIdentityProvider) GetClientID() (value string, ok bool)

GetClientID returns the value of the 'client_ID' attribute and a flag indicating if the attribute has a value.

Client identifier of a registered _GitHub_ OAuth application.

func (*GithubIdentityProvider) GetHostname ¶

func (o *GithubIdentityProvider) GetHostname() (value string, ok bool)

GetHostname returns the value of the 'hostname' attribute and a flag indicating if the attribute has a value.

For _GitHub Enterprise_ you must provide the host name of your instance, such as `example.com`. This value must match the _GitHub Enterprise_ host name value in the `/setup/settings` file and cannot include a port number.

For plain _GitHub_ omit this parameter.

func (*GithubIdentityProvider) GetTeams ¶

func (o *GithubIdentityProvider) GetTeams() (value []string, ok bool)

GetTeams returns the value of the 'teams' attribute and a flag indicating if the attribute has a value.

Optional list of temas. Cannot be used in combination with the organizations field.

func (*GithubIdentityProvider) Hostname ¶

func (o *GithubIdentityProvider) Hostname() string

Hostname returns the value of the 'hostname' attribute, or the zero value of the type if the attribute doesn't have a value.

For _GitHub Enterprise_ you must provide the host name of your instance, such as `example.com`. This value must match the _GitHub Enterprise_ host name value in the `/setup/settings` file and cannot include a port number.

For plain _GitHub_ omit this parameter.

func (*GithubIdentityProvider) Teams ¶

func (o *GithubIdentityProvider) Teams() []string

Teams returns the value of the 'teams' attribute, or the zero value of the type if the attribute doesn't have a value.

Optional list of temas. Cannot be used in combination with the organizations field.

type GithubIdentityProviderBuilder ¶

type GithubIdentityProviderBuilder struct {
	// contains filtered or unexported fields
}

GithubIdentityProviderBuilder contains the data and logic needed to build 'github_identity_provider' objects.

Details for `github` identity providers.

func NewGithubIdentityProvider ¶

func NewGithubIdentityProvider() *GithubIdentityProviderBuilder

NewGithubIdentityProvider creates a new builder of 'github_identity_provider' objects.

func (*GithubIdentityProviderBuilder) Build ¶

Build creates a 'github_identity_provider' object using the configuration stored in the builder.

func (*GithubIdentityProviderBuilder) CA ¶

CA sets the value of the 'CA' attribute to the given value.

func (*GithubIdentityProviderBuilder) ClientID ¶

ClientID sets the value of the 'client_ID' attribute to the given value.

func (*GithubIdentityProviderBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*GithubIdentityProviderBuilder) Hostname ¶

Hostname sets the value of the 'hostname' attribute to the given value.

func (*GithubIdentityProviderBuilder) Teams ¶

Teams sets the value of the 'teams' attribute to the given values.

type GithubIdentityProviderList ¶

type GithubIdentityProviderList struct {
	// contains filtered or unexported fields
}

GithubIdentityProviderList is a list of values of the 'github_identity_provider' type.

func UnmarshalGithubIdentityProviderList ¶

func UnmarshalGithubIdentityProviderList(source interface{}) (list *GithubIdentityProviderList, err error)

UnmarshalGithubIdentityProviderList reads a list of values of the 'github_identity_provider' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*GithubIdentityProviderList) Each ¶

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*GithubIdentityProviderList) Empty ¶

func (l *GithubIdentityProviderList) Empty() bool

Empty returns true if the list is empty.

func (*GithubIdentityProviderList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*GithubIdentityProviderList) Len ¶

Len returns the length of the list.

func (*GithubIdentityProviderList) Range ¶

func (l *GithubIdentityProviderList) Range(f func(index int, item *GithubIdentityProvider) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*GithubIdentityProviderList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type GithubIdentityProviderListBuilder ¶

type GithubIdentityProviderListBuilder struct {
	// contains filtered or unexported fields
}

GithubIdentityProviderListBuilder contains the data and logic needed to build 'github_identity_provider' objects.

func NewGithubIdentityProviderList ¶

func NewGithubIdentityProviderList() *GithubIdentityProviderListBuilder

NewGithubIdentityProviderList creates a new builder of 'github_identity_provider' objects.

func (*GithubIdentityProviderListBuilder) Build ¶

Build creates a list of 'github_identity_provider' objects using the configuration stored in the builder.

func (*GithubIdentityProviderListBuilder) Items ¶

Items sets the items of the list.

type GitlabIdentityProvider ¶

type GitlabIdentityProvider struct {
	// contains filtered or unexported fields
}

GitlabIdentityProvider represents the values of the 'gitlab_identity_provider' type.

Details for `gitlab` identity providers.

func UnmarshalGitlabIdentityProvider ¶

func UnmarshalGitlabIdentityProvider(source interface{}) (object *GitlabIdentityProvider, err error)

UnmarshalGitlabIdentityProvider reads a value of the 'gitlab_identity_provider' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*GitlabIdentityProvider) CA ¶

CA returns the value of the 'CA' attribute, or the zero value of the type if the attribute doesn't have a value.

Optional trusted certificate authority bundle to use when making requests tot he server.

func (*GitlabIdentityProvider) ClientID ¶

func (o *GitlabIdentityProvider) ClientID() string

ClientID returns the value of the 'client_ID' attribute, or the zero value of the type if the attribute doesn't have a value.

Client identifier of a registered _GitLab_ OAuth application.

func (*GitlabIdentityProvider) ClientSecret ¶

func (o *GitlabIdentityProvider) ClientSecret() string

ClientSecret returns the value of the 'client_secret' attribute, or the zero value of the type if the attribute doesn't have a value.

Client secret issued by _GitLab_.

func (*GitlabIdentityProvider) Empty ¶

func (o *GitlabIdentityProvider) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*GitlabIdentityProvider) GetCA ¶

func (o *GitlabIdentityProvider) GetCA() (value string, ok bool)

GetCA returns the value of the 'CA' attribute and a flag indicating if the attribute has a value.

Optional trusted certificate authority bundle to use when making requests tot he server.

func (*GitlabIdentityProvider) GetClientID ¶

func (o *GitlabIdentityProvider) GetClientID() (value string, ok bool)

GetClientID returns the value of the 'client_ID' attribute and a flag indicating if the attribute has a value.

Client identifier of a registered _GitLab_ OAuth application.

func (*GitlabIdentityProvider) GetClientSecret ¶

func (o *GitlabIdentityProvider) GetClientSecret() (value string, ok bool)

GetClientSecret returns the value of the 'client_secret' attribute and a flag indicating if the attribute has a value.

Client secret issued by _GitLab_.

func (*GitlabIdentityProvider) GetURL ¶

func (o *GitlabIdentityProvider) GetURL() (value string, ok bool)

GetURL returns the value of the 'URL' attribute and a flag indicating if the attribute has a value.

URL of the _GitLab_ instance.

func (*GitlabIdentityProvider) URL ¶

func (o *GitlabIdentityProvider) URL() string

URL returns the value of the 'URL' attribute, or the zero value of the type if the attribute doesn't have a value.

URL of the _GitLab_ instance.

type GitlabIdentityProviderBuilder ¶

type GitlabIdentityProviderBuilder struct {
	// contains filtered or unexported fields
}

GitlabIdentityProviderBuilder contains the data and logic needed to build 'gitlab_identity_provider' objects.

Details for `gitlab` identity providers.

func NewGitlabIdentityProvider ¶

func NewGitlabIdentityProvider() *GitlabIdentityProviderBuilder

NewGitlabIdentityProvider creates a new builder of 'gitlab_identity_provider' objects.

func (*GitlabIdentityProviderBuilder) Build ¶

Build creates a 'gitlab_identity_provider' object using the configuration stored in the builder.

func (*GitlabIdentityProviderBuilder) CA ¶

CA sets the value of the 'CA' attribute to the given value.

func (*GitlabIdentityProviderBuilder) ClientID ¶

ClientID sets the value of the 'client_ID' attribute to the given value.

func (*GitlabIdentityProviderBuilder) ClientSecret ¶

ClientSecret sets the value of the 'client_secret' attribute to the given value.

func (*GitlabIdentityProviderBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*GitlabIdentityProviderBuilder) URL ¶

URL sets the value of the 'URL' attribute to the given value.

type GitlabIdentityProviderList ¶

type GitlabIdentityProviderList struct {
	// contains filtered or unexported fields
}

GitlabIdentityProviderList is a list of values of the 'gitlab_identity_provider' type.

func UnmarshalGitlabIdentityProviderList ¶

func UnmarshalGitlabIdentityProviderList(source interface{}) (list *GitlabIdentityProviderList, err error)

UnmarshalGitlabIdentityProviderList reads a list of values of the 'gitlab_identity_provider' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*GitlabIdentityProviderList) Each ¶

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*GitlabIdentityProviderList) Empty ¶

func (l *GitlabIdentityProviderList) Empty() bool

Empty returns true if the list is empty.

func (*GitlabIdentityProviderList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*GitlabIdentityProviderList) Len ¶

Len returns the length of the list.

func (*GitlabIdentityProviderList) Range ¶

func (l *GitlabIdentityProviderList) Range(f func(index int, item *GitlabIdentityProvider) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*GitlabIdentityProviderList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type GitlabIdentityProviderListBuilder ¶

type GitlabIdentityProviderListBuilder struct {
	// contains filtered or unexported fields
}

GitlabIdentityProviderListBuilder contains the data and logic needed to build 'gitlab_identity_provider' objects.

func NewGitlabIdentityProviderList ¶

func NewGitlabIdentityProviderList() *GitlabIdentityProviderListBuilder

NewGitlabIdentityProviderList creates a new builder of 'gitlab_identity_provider' objects.

func (*GitlabIdentityProviderListBuilder) Build ¶

Build creates a list of 'gitlab_identity_provider' objects using the configuration stored in the builder.

func (*GitlabIdentityProviderListBuilder) Items ¶

Items sets the items of the list.

type GoogleIdentityProvider ¶

type GoogleIdentityProvider struct {
	// contains filtered or unexported fields
}

GoogleIdentityProvider represents the values of the 'google_identity_provider' type.

Details for `google` identity providers.

func UnmarshalGoogleIdentityProvider ¶

func UnmarshalGoogleIdentityProvider(source interface{}) (object *GoogleIdentityProvider, err error)

UnmarshalGoogleIdentityProvider reads a value of the 'google_identity_provider' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*GoogleIdentityProvider) ClientID ¶

func (o *GoogleIdentityProvider) ClientID() string

ClientID returns the value of the 'client_ID' attribute, or the zero value of the type if the attribute doesn't have a value.

Client identifier of a registered _Google_ project.

func (*GoogleIdentityProvider) ClientSecret ¶

func (o *GoogleIdentityProvider) ClientSecret() string

ClientSecret returns the value of the 'client_secret' attribute, or the zero value of the type if the attribute doesn't have a value.

Client secret issued by _Google.

func (*GoogleIdentityProvider) Empty ¶

func (o *GoogleIdentityProvider) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*GoogleIdentityProvider) GetClientID ¶

func (o *GoogleIdentityProvider) GetClientID() (value string, ok bool)

GetClientID returns the value of the 'client_ID' attribute and a flag indicating if the attribute has a value.

Client identifier of a registered _Google_ project.

func (*GoogleIdentityProvider) GetClientSecret ¶

func (o *GoogleIdentityProvider) GetClientSecret() (value string, ok bool)

GetClientSecret returns the value of the 'client_secret' attribute and a flag indicating if the attribute has a value.

Client secret issued by _Google.

func (*GoogleIdentityProvider) GetHostedDomain ¶

func (o *GoogleIdentityProvider) GetHostedDomain() (value string, ok bool)

GetHostedDomain returns the value of the 'hosted_domain' attribute and a flag indicating if the attribute has a value.

Optional hosted domain to restrict sign-in accounts to.

func (*GoogleIdentityProvider) HostedDomain ¶

func (o *GoogleIdentityProvider) HostedDomain() string

HostedDomain returns the value of the 'hosted_domain' attribute, or the zero value of the type if the attribute doesn't have a value.

Optional hosted domain to restrict sign-in accounts to.

type GoogleIdentityProviderBuilder ¶

type GoogleIdentityProviderBuilder struct {
	// contains filtered or unexported fields
}

GoogleIdentityProviderBuilder contains the data and logic needed to build 'google_identity_provider' objects.

Details for `google` identity providers.

func NewGoogleIdentityProvider ¶

func NewGoogleIdentityProvider() *GoogleIdentityProviderBuilder

NewGoogleIdentityProvider creates a new builder of 'google_identity_provider' objects.

func (*GoogleIdentityProviderBuilder) Build ¶

Build creates a 'google_identity_provider' object using the configuration stored in the builder.

func (*GoogleIdentityProviderBuilder) ClientID ¶

ClientID sets the value of the 'client_ID' attribute to the given value.

func (*GoogleIdentityProviderBuilder) ClientSecret ¶

ClientSecret sets the value of the 'client_secret' attribute to the given value.

func (*GoogleIdentityProviderBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*GoogleIdentityProviderBuilder) HostedDomain ¶

HostedDomain sets the value of the 'hosted_domain' attribute to the given value.

type GoogleIdentityProviderList ¶

type GoogleIdentityProviderList struct {
	// contains filtered or unexported fields
}

GoogleIdentityProviderList is a list of values of the 'google_identity_provider' type.

func UnmarshalGoogleIdentityProviderList ¶

func UnmarshalGoogleIdentityProviderList(source interface{}) (list *GoogleIdentityProviderList, err error)

UnmarshalGoogleIdentityProviderList reads a list of values of the 'google_identity_provider' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*GoogleIdentityProviderList) Each ¶

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*GoogleIdentityProviderList) Empty ¶

func (l *GoogleIdentityProviderList) Empty() bool

Empty returns true if the list is empty.

func (*GoogleIdentityProviderList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*GoogleIdentityProviderList) Len ¶

Len returns the length of the list.

func (*GoogleIdentityProviderList) Range ¶

func (l *GoogleIdentityProviderList) Range(f func(index int, item *GoogleIdentityProvider) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*GoogleIdentityProviderList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type GoogleIdentityProviderListBuilder ¶

type GoogleIdentityProviderListBuilder struct {
	// contains filtered or unexported fields
}

GoogleIdentityProviderListBuilder contains the data and logic needed to build 'google_identity_provider' objects.

func NewGoogleIdentityProviderList ¶

func NewGoogleIdentityProviderList() *GoogleIdentityProviderListBuilder

NewGoogleIdentityProviderList creates a new builder of 'google_identity_provider' objects.

func (*GoogleIdentityProviderListBuilder) Build ¶

Build creates a list of 'google_identity_provider' objects using the configuration stored in the builder.

func (*GoogleIdentityProviderListBuilder) Items ¶

Items sets the items of the list.

type Group ¶

type Group struct {
	// contains filtered or unexported fields
}

Group represents the values of the 'group' type.

Representation of a group of users.

func UnmarshalGroup ¶

func UnmarshalGroup(source interface{}) (object *Group, err error)

UnmarshalGroup reads a value of the 'group' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Group) Empty ¶

func (o *Group) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Group) GetHREF ¶

func (o *Group) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*Group) GetID ¶

func (o *Group) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*Group) GetUsers ¶

func (o *Group) GetUsers() (value *UserList, ok bool)

GetUsers returns the value of the 'users' attribute and a flag indicating if the attribute has a value.

List of users of the group.

func (*Group) HREF ¶

func (o *Group) HREF() string

HREF returns the link to the object.

func (*Group) ID ¶

func (o *Group) ID() string

ID returns the identifier of the object.

func (*Group) Kind ¶

func (o *Group) Kind() string

Kind returns the name of the type of the object.

func (o *Group) Link() bool

Link returns true iif this is a link.

func (*Group) Users ¶

func (o *Group) Users() *UserList

Users returns the value of the 'users' attribute, or the zero value of the type if the attribute doesn't have a value.

List of users of the group.

type GroupBuilder ¶

type GroupBuilder struct {
	// contains filtered or unexported fields
}

GroupBuilder contains the data and logic needed to build 'group' objects.

Representation of a group of users.

func NewGroup ¶

func NewGroup() *GroupBuilder

NewGroup creates a new builder of 'group' objects.

func (*GroupBuilder) Build ¶

func (b *GroupBuilder) Build() (object *Group, err error)

Build creates a 'group' object using the configuration stored in the builder.

func (*GroupBuilder) Copy ¶

func (b *GroupBuilder) Copy(object *Group) *GroupBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*GroupBuilder) HREF ¶

func (b *GroupBuilder) HREF(value string) *GroupBuilder

HREF sets the link to the object.

func (*GroupBuilder) ID ¶

func (b *GroupBuilder) ID(value string) *GroupBuilder

ID sets the identifier of the object.

func (b *GroupBuilder) Link(value bool) *GroupBuilder

Link sets the flag that indicates if this is a link.

func (*GroupBuilder) Users ¶

func (b *GroupBuilder) Users(values ...*UserBuilder) *GroupBuilder

Users sets the value of the 'users' attribute to the given values.

type GroupClient ¶

type GroupClient struct {
	// contains filtered or unexported fields
}

GroupClient is the client of the 'group' resource.

Manages a specific group.

func NewGroupClient ¶

func NewGroupClient(transport http.RoundTripper, path string, metric string) *GroupClient

NewGroupClient creates a new client for the 'group' resource using the given transport to sned the requests and receive the responses.

func (*GroupClient) Get ¶

func (c *GroupClient) Get() *GroupGetRequest

Get creates a request for the 'get' method.

Retrieves the details of the group.

func (*GroupClient) Poll ¶

func (c *GroupClient) Poll() *GroupPollRequest

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

func (*GroupClient) Users ¶

func (c *GroupClient) Users() *UsersClient

Users returns the target 'users' resource.

Reference to the resource that manages the collection of users.

type GroupGetRequest ¶

type GroupGetRequest struct {
	// contains filtered or unexported fields
}

GroupGetRequest is the request for the 'get' method.

func (*GroupGetRequest) Header ¶

func (r *GroupGetRequest) Header(name string, value interface{}) *GroupGetRequest

Header adds a request header.

func (*GroupGetRequest) Parameter ¶

func (r *GroupGetRequest) Parameter(name string, value interface{}) *GroupGetRequest

Parameter adds a query parameter.

func (*GroupGetRequest) Send ¶

func (r *GroupGetRequest) Send() (result *GroupGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*GroupGetRequest) SendContext ¶

func (r *GroupGetRequest) SendContext(ctx context.Context) (result *GroupGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type GroupGetResponse ¶

type GroupGetResponse struct {
	// contains filtered or unexported fields
}

GroupGetResponse is the response for the 'get' method.

func (*GroupGetResponse) Body ¶

func (r *GroupGetResponse) Body() *Group

Body returns the value of the 'body' parameter.

func (*GroupGetResponse) Error ¶

func (r *GroupGetResponse) Error() *errors.Error

Error returns the response error.

func (*GroupGetResponse) GetBody ¶

func (r *GroupGetResponse) GetBody() (value *Group, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*GroupGetResponse) Header ¶

func (r *GroupGetResponse) Header() http.Header

Header returns header of the response.

func (*GroupGetResponse) Status ¶

func (r *GroupGetResponse) Status() int

Status returns the response status code.

type GroupGetServerRequest ¶

type GroupGetServerRequest struct {
}

GroupGetServerRequest is the request for the 'get' method.

type GroupGetServerResponse ¶

type GroupGetServerResponse struct {
	// contains filtered or unexported fields
}

GroupGetServerResponse is the response for the 'get' method.

func (*GroupGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*GroupGetServerResponse) Status ¶

Status sets the status code.

type GroupList ¶

type GroupList struct {
	// contains filtered or unexported fields
}

GroupList is a list of values of the 'group' type.

func UnmarshalGroupList ¶

func UnmarshalGroupList(source interface{}) (list *GroupList, err error)

UnmarshalGroupList reads a list of values of the 'group' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*GroupList) Each ¶

func (l *GroupList) Each(f func(item *Group) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*GroupList) Empty ¶

func (l *GroupList) Empty() bool

Empty returns true if the list is empty.

func (*GroupList) Get ¶

func (l *GroupList) Get(i int) *Group

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*GroupList) GetHREF ¶

func (l *GroupList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*GroupList) HREF ¶

func (l *GroupList) HREF() string

HREF returns the link to the list.

func (*GroupList) Kind ¶

func (l *GroupList) Kind() string

Kind returns the name of the type of the object.

func (*GroupList) Len ¶

func (l *GroupList) Len() int

Len returns the length of the list.

func (l *GroupList) Link() bool

Link returns true iif this is a link.

func (*GroupList) Range ¶

func (l *GroupList) Range(f func(index int, item *Group) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*GroupList) Slice ¶

func (l *GroupList) Slice() []*Group

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type GroupListBuilder ¶

type GroupListBuilder struct {
	// contains filtered or unexported fields
}

GroupListBuilder contains the data and logic needed to build 'group' objects.

func NewGroupList ¶

func NewGroupList() *GroupListBuilder

NewGroupList creates a new builder of 'group' objects.

func (*GroupListBuilder) Build ¶

func (b *GroupListBuilder) Build() (list *GroupList, err error)

Build creates a list of 'group' objects using the configuration stored in the builder.

func (*GroupListBuilder) Items ¶

func (b *GroupListBuilder) Items(values ...*GroupBuilder) *GroupListBuilder

Items sets the items of the list.

type GroupPollRequest ¶

type GroupPollRequest struct {
	// contains filtered or unexported fields
}

GroupPollRequest is the request for the Poll method.

func (*GroupPollRequest) Header ¶

func (r *GroupPollRequest) Header(name string, value interface{}) *GroupPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*GroupPollRequest) Interval ¶

func (r *GroupPollRequest) Interval(value time.Duration) *GroupPollRequest

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*GroupPollRequest) Parameter ¶

func (r *GroupPollRequest) Parameter(name string, value interface{}) *GroupPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*GroupPollRequest) Predicate ¶

func (r *GroupPollRequest) Predicate(value func(*GroupGetResponse) bool) *GroupPollRequest

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*GroupPollRequest) StartContext ¶

func (r *GroupPollRequest) StartContext(ctx context.Context) (response *GroupPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*GroupPollRequest) Status ¶

func (r *GroupPollRequest) Status(value int) *GroupPollRequest

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type GroupPollResponse ¶

type GroupPollResponse struct {
	// contains filtered or unexported fields
}

GroupPollResponse is the response for the Poll method.

func (*GroupPollResponse) Body ¶

func (r *GroupPollResponse) Body() *Group

Body returns the value of the 'body' parameter.

func (*GroupPollResponse) Error ¶

func (r *GroupPollResponse) Error() *errors.Error

Error returns the response error.

func (*GroupPollResponse) GetBody ¶

func (r *GroupPollResponse) GetBody() (value *Group, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*GroupPollResponse) Header ¶

func (r *GroupPollResponse) Header() http.Header

Header returns header of the response.

func (*GroupPollResponse) Status ¶

func (r *GroupPollResponse) Status() int

Status returns the response status code.

type GroupServer ¶

type GroupServer interface {

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the group.
	Get(ctx context.Context, request *GroupGetServerRequest, response *GroupGetServerResponse) error

	// Users returns the target 'users' resource.
	//
	// Reference to the resource that manages the collection of users.
	Users() UsersServer
}

GroupServer represents the interface the manages the 'group' resource.

type GroupsClient ¶

type GroupsClient struct {
	// contains filtered or unexported fields
}

GroupsClient is the client of the 'groups' resource.

Manages the collection of groups of a cluster.

func NewGroupsClient ¶

func NewGroupsClient(transport http.RoundTripper, path string, metric string) *GroupsClient

NewGroupsClient creates a new client for the 'groups' resource using the given transport to sned the requests and receive the responses.

func (*GroupsClient) Group ¶

func (c *GroupsClient) Group(id string) *GroupClient

Group returns the target 'group' resource for the given identifier.

Reference to the service that manages an specific group.

func (*GroupsClient) List ¶

func (c *GroupsClient) List() *GroupsListRequest

List creates a request for the 'list' method.

Retrieves the list of groups.

type GroupsListRequest ¶

type GroupsListRequest struct {
	// contains filtered or unexported fields
}

GroupsListRequest is the request for the 'list' method.

func (*GroupsListRequest) Header ¶

func (r *GroupsListRequest) Header(name string, value interface{}) *GroupsListRequest

Header adds a request header.

func (*GroupsListRequest) Page ¶

func (r *GroupsListRequest) Page(value int) *GroupsListRequest

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*GroupsListRequest) Parameter ¶

func (r *GroupsListRequest) Parameter(name string, value interface{}) *GroupsListRequest

Parameter adds a query parameter.

func (*GroupsListRequest) Send ¶

func (r *GroupsListRequest) Send() (result *GroupsListResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*GroupsListRequest) SendContext ¶

func (r *GroupsListRequest) SendContext(ctx context.Context) (result *GroupsListResponse, err error)

SendContext sends this request, waits for the response, and returns it.

func (*GroupsListRequest) Size ¶

func (r *GroupsListRequest) Size(value int) *GroupsListRequest

Size sets the value of the 'size' parameter.

Number of items contained in the returned page.

type GroupsListResponse ¶

type GroupsListResponse struct {
	// contains filtered or unexported fields
}

GroupsListResponse is the response for the 'list' method.

func (*GroupsListResponse) Error ¶

func (r *GroupsListResponse) Error() *errors.Error

Error returns the response error.

func (*GroupsListResponse) GetItems ¶

func (r *GroupsListResponse) GetItems() (value *GroupList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of groups.

func (*GroupsListResponse) GetPage ¶

func (r *GroupsListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*GroupsListResponse) GetSize ¶

func (r *GroupsListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Number of items contained in the returned page.

func (*GroupsListResponse) GetTotal ¶

func (r *GroupsListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection.

func (*GroupsListResponse) Header ¶

func (r *GroupsListResponse) Header() http.Header

Header returns header of the response.

func (*GroupsListResponse) Items ¶

func (r *GroupsListResponse) Items() *GroupList

Items returns the value of the 'items' parameter.

Retrieved list of groups.

func (*GroupsListResponse) Page ¶

func (r *GroupsListResponse) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*GroupsListResponse) Size ¶

func (r *GroupsListResponse) Size() int

Size returns the value of the 'size' parameter.

Number of items contained in the returned page.

func (*GroupsListResponse) Status ¶

func (r *GroupsListResponse) Status() int

Status returns the response status code.

func (*GroupsListResponse) Total ¶

func (r *GroupsListResponse) Total() int

Total returns the value of the 'total' parameter.

Total number of items of the collection.

type GroupsListServerRequest ¶

type GroupsListServerRequest struct {
	// contains filtered or unexported fields
}

GroupsListServerRequest is the request for the 'list' method.

func (*GroupsListServerRequest) GetPage ¶

func (r *GroupsListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*GroupsListServerRequest) GetSize ¶

func (r *GroupsListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Number of items contained in the returned page.

func (*GroupsListServerRequest) Page ¶

func (r *GroupsListServerRequest) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*GroupsListServerRequest) Size ¶

func (r *GroupsListServerRequest) Size() int

Size returns the value of the 'size' parameter.

Number of items contained in the returned page.

type GroupsListServerResponse ¶

type GroupsListServerResponse struct {
	// contains filtered or unexported fields
}

GroupsListServerResponse is the response for the 'list' method.

func (*GroupsListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of groups.

func (*GroupsListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*GroupsListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Number of items contained in the returned page.

func (*GroupsListServerResponse) Status ¶

Status sets the status code.

func (*GroupsListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection.

type GroupsServer ¶

type GroupsServer interface {

	// List handles a request for the 'list' method.
	//
	// Retrieves the list of groups.
	List(ctx context.Context, request *GroupsListServerRequest, response *GroupsListServerResponse) error

	// Group returns the target 'group' server for the given identifier.
	//
	// Reference to the service that manages an specific group.
	Group(id string) GroupServer
}

GroupsServer represents the interface the manages the 'groups' resource.

type IdentityProvider ¶

type IdentityProvider struct {
	// contains filtered or unexported fields
}

IdentityProvider represents the values of the 'identity_provider' type.

Representation of an identity provider.

func UnmarshalIdentityProvider ¶

func UnmarshalIdentityProvider(source interface{}) (object *IdentityProvider, err error)

UnmarshalIdentityProvider reads a value of the 'identity_provider' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*IdentityProvider) Challenge ¶

func (o *IdentityProvider) Challenge() bool

Challenge returns the value of the 'challenge' attribute, or the zero value of the type if the attribute doesn't have a value.

When `true` unauthenticated token requests from non-web clients (like the CLI) are sent a `WWW-Authenticate` challenge header for this provider.

func (*IdentityProvider) Empty ¶

func (o *IdentityProvider) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*IdentityProvider) GetChallenge ¶

func (o *IdentityProvider) GetChallenge() (value bool, ok bool)

GetChallenge returns the value of the 'challenge' attribute and a flag indicating if the attribute has a value.

When `true` unauthenticated token requests from non-web clients (like the CLI) are sent a `WWW-Authenticate` challenge header for this provider.

func (*IdentityProvider) GetGithub ¶

func (o *IdentityProvider) GetGithub() (value *GithubIdentityProvider, ok bool)

GetGithub returns the value of the 'github' attribute and a flag indicating if the attribute has a value.

Details for `github` identity providers.

func (*IdentityProvider) GetGitlab ¶

func (o *IdentityProvider) GetGitlab() (value *GitlabIdentityProvider, ok bool)

GetGitlab returns the value of the 'gitlab' attribute and a flag indicating if the attribute has a value.

Details for `gitlab` identity providers.

func (*IdentityProvider) GetGoogle ¶

func (o *IdentityProvider) GetGoogle() (value *GoogleIdentityProvider, ok bool)

GetGoogle returns the value of the 'google' attribute and a flag indicating if the attribute has a value.

Details for `google` identity providers.

func (*IdentityProvider) GetHREF ¶

func (o *IdentityProvider) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*IdentityProvider) GetID ¶

func (o *IdentityProvider) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*IdentityProvider) GetLDAP ¶

func (o *IdentityProvider) GetLDAP() (value *LDAPIdentityProvider, ok bool)

GetLDAP returns the value of the 'LDAP' attribute and a flag indicating if the attribute has a value.

Details for `ldap` identity providers.

func (*IdentityProvider) GetLogin ¶

func (o *IdentityProvider) GetLogin() (value bool, ok bool)

GetLogin returns the value of the 'login' attribute and a flag indicating if the attribute has a value.

When `true` unauthenticated token requests from web clients (like the web console) are redirected to the authorize URL to log in.

func (*IdentityProvider) GetMappingMethod ¶

func (o *IdentityProvider) GetMappingMethod() (value IdentityProviderMappingMethod, ok bool)

GetMappingMethod returns the value of the 'mapping_method' attribute and a flag indicating if the attribute has a value.

Controls how mappings are established between this provider's identities and user objects.

func (*IdentityProvider) GetName ¶

func (o *IdentityProvider) GetName() (value string, ok bool)

GetName returns the value of the 'name' attribute and a flag indicating if the attribute has a value.

The name of the identity provider.

func (*IdentityProvider) GetOpenID ¶

func (o *IdentityProvider) GetOpenID() (value *OpenIDIdentityProvider, ok bool)

GetOpenID returns the value of the 'open_ID' attribute and a flag indicating if the attribute has a value.

Details for `openid` identity providers.

func (*IdentityProvider) GetType ¶

func (o *IdentityProvider) GetType() (value IdentityProviderType, ok bool)

GetType returns the value of the 'type' attribute and a flag indicating if the attribute has a value.

Type of identity provider. The rest of the attributes will be populated according to this value. For example, if the type is `github` then only the `github` attribute will be populated.

func (*IdentityProvider) Github ¶

Github returns the value of the 'github' attribute, or the zero value of the type if the attribute doesn't have a value.

Details for `github` identity providers.

func (*IdentityProvider) Gitlab ¶

Gitlab returns the value of the 'gitlab' attribute, or the zero value of the type if the attribute doesn't have a value.

Details for `gitlab` identity providers.

func (*IdentityProvider) Google ¶

Google returns the value of the 'google' attribute, or the zero value of the type if the attribute doesn't have a value.

Details for `google` identity providers.

func (*IdentityProvider) HREF ¶

func (o *IdentityProvider) HREF() string

HREF returns the link to the object.

func (*IdentityProvider) ID ¶

func (o *IdentityProvider) ID() string

ID returns the identifier of the object.

func (*IdentityProvider) Kind ¶

func (o *IdentityProvider) Kind() string

Kind returns the name of the type of the object.

func (*IdentityProvider) LDAP ¶

LDAP returns the value of the 'LDAP' attribute, or the zero value of the type if the attribute doesn't have a value.

Details for `ldap` identity providers.

func (o *IdentityProvider) Link() bool

Link returns true iif this is a link.

func (*IdentityProvider) Login ¶

func (o *IdentityProvider) Login() bool

Login returns the value of the 'login' attribute, or the zero value of the type if the attribute doesn't have a value.

When `true` unauthenticated token requests from web clients (like the web console) are redirected to the authorize URL to log in.

func (*IdentityProvider) MappingMethod ¶

MappingMethod returns the value of the 'mapping_method' attribute, or the zero value of the type if the attribute doesn't have a value.

Controls how mappings are established between this provider's identities and user objects.

func (*IdentityProvider) Name ¶

func (o *IdentityProvider) Name() string

Name returns the value of the 'name' attribute, or the zero value of the type if the attribute doesn't have a value.

The name of the identity provider.

func (*IdentityProvider) OpenID ¶

OpenID returns the value of the 'open_ID' attribute, or the zero value of the type if the attribute doesn't have a value.

Details for `openid` identity providers.

func (*IdentityProvider) Type ¶

Type returns the value of the 'type' attribute, or the zero value of the type if the attribute doesn't have a value.

Type of identity provider. The rest of the attributes will be populated according to this value. For example, if the type is `github` then only the `github` attribute will be populated.

type IdentityProviderBuilder ¶

type IdentityProviderBuilder struct {
	// contains filtered or unexported fields
}

IdentityProviderBuilder contains the data and logic needed to build 'identity_provider' objects.

Representation of an identity provider.

func NewIdentityProvider ¶

func NewIdentityProvider() *IdentityProviderBuilder

NewIdentityProvider creates a new builder of 'identity_provider' objects.

func (*IdentityProviderBuilder) Build ¶

func (b *IdentityProviderBuilder) Build() (object *IdentityProvider, err error)

Build creates a 'identity_provider' object using the configuration stored in the builder.

func (*IdentityProviderBuilder) Challenge ¶

Challenge sets the value of the 'challenge' attribute to the given value.

func (*IdentityProviderBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*IdentityProviderBuilder) Github ¶

Github sets the value of the 'github' attribute to the given value.

Details for `github` identity providers.

func (*IdentityProviderBuilder) Gitlab ¶

Gitlab sets the value of the 'gitlab' attribute to the given value.

Details for `gitlab` identity providers.

func (*IdentityProviderBuilder) Google ¶

Google sets the value of the 'google' attribute to the given value.

Details for `google` identity providers.

func (*IdentityProviderBuilder) HREF ¶

HREF sets the link to the object.

func (*IdentityProviderBuilder) ID ¶

ID sets the identifier of the object.

func (*IdentityProviderBuilder) LDAP ¶

LDAP sets the value of the 'LDAP' attribute to the given value.

Details for `ldap` identity providers.

Link sets the flag that indicates if this is a link.

func (*IdentityProviderBuilder) Login ¶

Login sets the value of the 'login' attribute to the given value.

func (*IdentityProviderBuilder) MappingMethod ¶

MappingMethod sets the value of the 'mapping_method' attribute to the given value.

Controls how mappings are established between provider identities and user objects.

func (*IdentityProviderBuilder) Name ¶

Name sets the value of the 'name' attribute to the given value.

func (*IdentityProviderBuilder) OpenID ¶

OpenID sets the value of the 'open_ID' attribute to the given value.

Details for `openid` identity providers.

func (*IdentityProviderBuilder) Type ¶

Type sets the value of the 'type' attribute to the given value.

Type of identity provider.

type IdentityProviderClient ¶

type IdentityProviderClient struct {
	// contains filtered or unexported fields
}

IdentityProviderClient is the client of the 'identity_provider' resource.

Manages a specific identity provider.

func NewIdentityProviderClient ¶

func NewIdentityProviderClient(transport http.RoundTripper, path string, metric string) *IdentityProviderClient

NewIdentityProviderClient creates a new client for the 'identity_provider' resource using the given transport to sned the requests and receive the responses.

func (*IdentityProviderClient) Delete ¶

Delete creates a request for the 'delete' method.

Deletes the identity provider.

func (*IdentityProviderClient) Get ¶

Get creates a request for the 'get' method.

Retrieves the details of the identity provider.

func (*IdentityProviderClient) Poll ¶

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type IdentityProviderDeleteRequest ¶

type IdentityProviderDeleteRequest struct {
	// contains filtered or unexported fields
}

IdentityProviderDeleteRequest is the request for the 'delete' method.

func (*IdentityProviderDeleteRequest) Header ¶

func (r *IdentityProviderDeleteRequest) Header(name string, value interface{}) *IdentityProviderDeleteRequest

Header adds a request header.

func (*IdentityProviderDeleteRequest) Parameter ¶

func (r *IdentityProviderDeleteRequest) Parameter(name string, value interface{}) *IdentityProviderDeleteRequest

Parameter adds a query parameter.

func (*IdentityProviderDeleteRequest) Send ¶

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*IdentityProviderDeleteRequest) SendContext ¶

SendContext sends this request, waits for the response, and returns it.

type IdentityProviderDeleteResponse ¶

type IdentityProviderDeleteResponse struct {
	// contains filtered or unexported fields
}

IdentityProviderDeleteResponse is the response for the 'delete' method.

func (*IdentityProviderDeleteResponse) Error ¶

Error returns the response error.

func (*IdentityProviderDeleteResponse) Header ¶

Header returns header of the response.

func (*IdentityProviderDeleteResponse) Status ¶

func (r *IdentityProviderDeleteResponse) Status() int

Status returns the response status code.

type IdentityProviderDeleteServerRequest ¶

type IdentityProviderDeleteServerRequest struct {
}

IdentityProviderDeleteServerRequest is the request for the 'delete' method.

type IdentityProviderDeleteServerResponse ¶

type IdentityProviderDeleteServerResponse struct {
	// contains filtered or unexported fields
}

IdentityProviderDeleteServerResponse is the response for the 'delete' method.

func (*IdentityProviderDeleteServerResponse) Status ¶

Status sets the status code.

type IdentityProviderGetRequest ¶

type IdentityProviderGetRequest struct {
	// contains filtered or unexported fields
}

IdentityProviderGetRequest is the request for the 'get' method.

func (*IdentityProviderGetRequest) Header ¶

func (r *IdentityProviderGetRequest) Header(name string, value interface{}) *IdentityProviderGetRequest

Header adds a request header.

func (*IdentityProviderGetRequest) Parameter ¶

func (r *IdentityProviderGetRequest) Parameter(name string, value interface{}) *IdentityProviderGetRequest

Parameter adds a query parameter.

func (*IdentityProviderGetRequest) Send ¶

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*IdentityProviderGetRequest) SendContext ¶

func (r *IdentityProviderGetRequest) SendContext(ctx context.Context) (result *IdentityProviderGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type IdentityProviderGetResponse ¶

type IdentityProviderGetResponse struct {
	// contains filtered or unexported fields
}

IdentityProviderGetResponse is the response for the 'get' method.

func (*IdentityProviderGetResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*IdentityProviderGetResponse) Error ¶

Error returns the response error.

func (*IdentityProviderGetResponse) GetBody ¶

func (r *IdentityProviderGetResponse) GetBody() (value *IdentityProvider, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*IdentityProviderGetResponse) Header ¶

Header returns header of the response.

func (*IdentityProviderGetResponse) Status ¶

func (r *IdentityProviderGetResponse) Status() int

Status returns the response status code.

type IdentityProviderGetServerRequest ¶

type IdentityProviderGetServerRequest struct {
}

IdentityProviderGetServerRequest is the request for the 'get' method.

type IdentityProviderGetServerResponse ¶

type IdentityProviderGetServerResponse struct {
	// contains filtered or unexported fields
}

IdentityProviderGetServerResponse is the response for the 'get' method.

func (*IdentityProviderGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*IdentityProviderGetServerResponse) Status ¶

Status sets the status code.

type IdentityProviderList ¶

type IdentityProviderList struct {
	// contains filtered or unexported fields
}

IdentityProviderList is a list of values of the 'identity_provider' type.

func UnmarshalIdentityProviderList ¶

func UnmarshalIdentityProviderList(source interface{}) (list *IdentityProviderList, err error)

UnmarshalIdentityProviderList reads a list of values of the 'identity_provider' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*IdentityProviderList) Each ¶

func (l *IdentityProviderList) Each(f func(item *IdentityProvider) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*IdentityProviderList) Empty ¶

func (l *IdentityProviderList) Empty() bool

Empty returns true if the list is empty.

func (*IdentityProviderList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*IdentityProviderList) GetHREF ¶

func (l *IdentityProviderList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*IdentityProviderList) HREF ¶

func (l *IdentityProviderList) HREF() string

HREF returns the link to the list.

func (*IdentityProviderList) Kind ¶

func (l *IdentityProviderList) Kind() string

Kind returns the name of the type of the object.

func (*IdentityProviderList) Len ¶

func (l *IdentityProviderList) Len() int

Len returns the length of the list.

func (l *IdentityProviderList) Link() bool

Link returns true iif this is a link.

func (*IdentityProviderList) Range ¶

func (l *IdentityProviderList) Range(f func(index int, item *IdentityProvider) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*IdentityProviderList) Slice ¶

func (l *IdentityProviderList) Slice() []*IdentityProvider

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type IdentityProviderListBuilder ¶

type IdentityProviderListBuilder struct {
	// contains filtered or unexported fields
}

IdentityProviderListBuilder contains the data and logic needed to build 'identity_provider' objects.

func NewIdentityProviderList ¶

func NewIdentityProviderList() *IdentityProviderListBuilder

NewIdentityProviderList creates a new builder of 'identity_provider' objects.

func (*IdentityProviderListBuilder) Build ¶

func (b *IdentityProviderListBuilder) Build() (list *IdentityProviderList, err error)

Build creates a list of 'identity_provider' objects using the configuration stored in the builder.

func (*IdentityProviderListBuilder) Items ¶

Items sets the items of the list.

type IdentityProviderMappingMethod ¶

type IdentityProviderMappingMethod string

IdentityProviderMappingMethod represents the values of the 'identity_provider_mapping_method' enumerated type.

const (
	//
	IdentityProviderMappingMethodAdd IdentityProviderMappingMethod = "add"
	//
	IdentityProviderMappingMethodClaim IdentityProviderMappingMethod = "claim"
	//
	IdentityProviderMappingMethodGenerate IdentityProviderMappingMethod = "generate"
	//
	IdentityProviderMappingMethodLookup IdentityProviderMappingMethod = "lookup"
)

type IdentityProviderPollRequest ¶

type IdentityProviderPollRequest struct {
	// contains filtered or unexported fields
}

IdentityProviderPollRequest is the request for the Poll method.

func (*IdentityProviderPollRequest) Header ¶

func (r *IdentityProviderPollRequest) Header(name string, value interface{}) *IdentityProviderPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*IdentityProviderPollRequest) Interval ¶

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*IdentityProviderPollRequest) Parameter ¶

func (r *IdentityProviderPollRequest) Parameter(name string, value interface{}) *IdentityProviderPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*IdentityProviderPollRequest) Predicate ¶

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*IdentityProviderPollRequest) StartContext ¶

func (r *IdentityProviderPollRequest) StartContext(ctx context.Context) (response *IdentityProviderPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*IdentityProviderPollRequest) Status ¶

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type IdentityProviderPollResponse ¶

type IdentityProviderPollResponse struct {
	// contains filtered or unexported fields
}

IdentityProviderPollResponse is the response for the Poll method.

func (*IdentityProviderPollResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*IdentityProviderPollResponse) Error ¶

Error returns the response error.

func (*IdentityProviderPollResponse) GetBody ¶

func (r *IdentityProviderPollResponse) GetBody() (value *IdentityProvider, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*IdentityProviderPollResponse) Header ¶

Header returns header of the response.

func (*IdentityProviderPollResponse) Status ¶

func (r *IdentityProviderPollResponse) Status() int

Status returns the response status code.

type IdentityProviderServer ¶

type IdentityProviderServer interface {

	// Delete handles a request for the 'delete' method.
	//
	// Deletes the identity provider.
	Delete(ctx context.Context, request *IdentityProviderDeleteServerRequest, response *IdentityProviderDeleteServerResponse) error

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the identity provider.
	Get(ctx context.Context, request *IdentityProviderGetServerRequest, response *IdentityProviderGetServerResponse) error
}

IdentityProviderServer represents the interface the manages the 'identity_provider' resource.

type IdentityProviderType ¶

type IdentityProviderType string

IdentityProviderType represents the values of the 'identity_provider_type' enumerated type.

const (
	//
	IdentityProviderTypeLDAP IdentityProviderType = "LDAP"
	//
	IdentityProviderTypeGithub IdentityProviderType = "github"
	//
	IdentityProviderTypeGitlab IdentityProviderType = "gitlab"
	//
	IdentityProviderTypeGoogle IdentityProviderType = "google"
	//
	IdentityProviderTypeOpenID IdentityProviderType = "open_ID"
)

type IdentityProvidersAddRequest ¶

type IdentityProvidersAddRequest struct {
	// contains filtered or unexported fields
}

IdentityProvidersAddRequest is the request for the 'add' method.

func (*IdentityProvidersAddRequest) Body ¶

Body sets the value of the 'body' parameter.

Description of the cluster.

func (*IdentityProvidersAddRequest) Header ¶

func (r *IdentityProvidersAddRequest) Header(name string, value interface{}) *IdentityProvidersAddRequest

Header adds a request header.

func (*IdentityProvidersAddRequest) Parameter ¶

func (r *IdentityProvidersAddRequest) Parameter(name string, value interface{}) *IdentityProvidersAddRequest

Parameter adds a query parameter.

func (*IdentityProvidersAddRequest) Send ¶

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*IdentityProvidersAddRequest) SendContext ¶

SendContext sends this request, waits for the response, and returns it.

type IdentityProvidersAddResponse ¶

type IdentityProvidersAddResponse struct {
	// contains filtered or unexported fields
}

IdentityProvidersAddResponse is the response for the 'add' method.

func (*IdentityProvidersAddResponse) Body ¶

Body returns the value of the 'body' parameter.

Description of the cluster.

func (*IdentityProvidersAddResponse) Error ¶

Error returns the response error.

func (*IdentityProvidersAddResponse) GetBody ¶

func (r *IdentityProvidersAddResponse) GetBody() (value *IdentityProvider, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

Description of the cluster.

func (*IdentityProvidersAddResponse) Header ¶

Header returns header of the response.

func (*IdentityProvidersAddResponse) Status ¶

func (r *IdentityProvidersAddResponse) Status() int

Status returns the response status code.

type IdentityProvidersAddServerRequest ¶

type IdentityProvidersAddServerRequest struct {
	// contains filtered or unexported fields
}

IdentityProvidersAddServerRequest is the request for the 'add' method.

func (*IdentityProvidersAddServerRequest) Body ¶

Body returns the value of the 'body' parameter.

Description of the cluster.

func (*IdentityProvidersAddServerRequest) GetBody ¶

func (r *IdentityProvidersAddServerRequest) GetBody() (value *IdentityProvider, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

Description of the cluster.

type IdentityProvidersAddServerResponse ¶

type IdentityProvidersAddServerResponse struct {
	// contains filtered or unexported fields
}

IdentityProvidersAddServerResponse is the response for the 'add' method.

func (*IdentityProvidersAddServerResponse) Body ¶

Body sets the value of the 'body' parameter.

Description of the cluster.

func (*IdentityProvidersAddServerResponse) Status ¶

Status sets the status code.

type IdentityProvidersClient ¶

type IdentityProvidersClient struct {
	// contains filtered or unexported fields
}

IdentityProvidersClient is the client of the 'identity_providers' resource.

Manages the collection of identity providers of a cluster.

func NewIdentityProvidersClient ¶

func NewIdentityProvidersClient(transport http.RoundTripper, path string, metric string) *IdentityProvidersClient

NewIdentityProvidersClient creates a new client for the 'identity_providers' resource using the given transport to sned the requests and receive the responses.

func (*IdentityProvidersClient) Add ¶

Add creates a request for the 'add' method.

Adds a new identity provider to the cluster.

func (*IdentityProvidersClient) IdentityProvider ¶

func (c *IdentityProvidersClient) IdentityProvider(id string) *IdentityProviderClient

IdentityProvider returns the target 'identity_provider' resource for the given identifier.

Reference to the service that manages an specific identity provider.

func (*IdentityProvidersClient) List ¶

List creates a request for the 'list' method.

Retrieves the list of identity providers.

type IdentityProvidersListRequest ¶

type IdentityProvidersListRequest struct {
	// contains filtered or unexported fields
}

IdentityProvidersListRequest is the request for the 'list' method.

func (*IdentityProvidersListRequest) Header ¶

func (r *IdentityProvidersListRequest) Header(name string, value interface{}) *IdentityProvidersListRequest

Header adds a request header.

func (*IdentityProvidersListRequest) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*IdentityProvidersListRequest) Parameter ¶

func (r *IdentityProvidersListRequest) Parameter(name string, value interface{}) *IdentityProvidersListRequest

Parameter adds a query parameter.

func (*IdentityProvidersListRequest) Send ¶

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*IdentityProvidersListRequest) SendContext ¶

SendContext sends this request, waits for the response, and returns it.

func (*IdentityProvidersListRequest) Size ¶

Size sets the value of the 'size' parameter.

Number of items contained in the returned page.

type IdentityProvidersListResponse ¶

type IdentityProvidersListResponse struct {
	// contains filtered or unexported fields
}

IdentityProvidersListResponse is the response for the 'list' method.

func (*IdentityProvidersListResponse) Error ¶

Error returns the response error.

func (*IdentityProvidersListResponse) GetItems ¶

func (r *IdentityProvidersListResponse) GetItems() (value *IdentityProviderList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of identity providers.

func (*IdentityProvidersListResponse) GetPage ¶

func (r *IdentityProvidersListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*IdentityProvidersListResponse) GetSize ¶

func (r *IdentityProvidersListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Number of items contained in the returned page.

func (*IdentityProvidersListResponse) GetTotal ¶

func (r *IdentityProvidersListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection.

func (*IdentityProvidersListResponse) Header ¶

Header returns header of the response.

func (*IdentityProvidersListResponse) Items ¶

Items returns the value of the 'items' parameter.

Retrieved list of identity providers.

func (*IdentityProvidersListResponse) Page ¶

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*IdentityProvidersListResponse) Size ¶

Size returns the value of the 'size' parameter.

Number of items contained in the returned page.

func (*IdentityProvidersListResponse) Status ¶

func (r *IdentityProvidersListResponse) Status() int

Status returns the response status code.

func (*IdentityProvidersListResponse) Total ¶

Total returns the value of the 'total' parameter.

Total number of items of the collection.

type IdentityProvidersListServerRequest ¶

type IdentityProvidersListServerRequest struct {
	// contains filtered or unexported fields
}

IdentityProvidersListServerRequest is the request for the 'list' method.

func (*IdentityProvidersListServerRequest) GetPage ¶

func (r *IdentityProvidersListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*IdentityProvidersListServerRequest) GetSize ¶

func (r *IdentityProvidersListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Number of items contained in the returned page.

func (*IdentityProvidersListServerRequest) Page ¶

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*IdentityProvidersListServerRequest) Size ¶

Size returns the value of the 'size' parameter.

Number of items contained in the returned page.

type IdentityProvidersListServerResponse ¶

type IdentityProvidersListServerResponse struct {
	// contains filtered or unexported fields
}

IdentityProvidersListServerResponse is the response for the 'list' method.

func (*IdentityProvidersListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of identity providers.

func (*IdentityProvidersListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*IdentityProvidersListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Number of items contained in the returned page.

func (*IdentityProvidersListServerResponse) Status ¶

Status sets the status code.

func (*IdentityProvidersListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection.

type IdentityProvidersServer ¶

type IdentityProvidersServer interface {

	// Add handles a request for the 'add' method.
	//
	// Adds a new identity provider to the cluster.
	Add(ctx context.Context, request *IdentityProvidersAddServerRequest, response *IdentityProvidersAddServerResponse) error

	// List handles a request for the 'list' method.
	//
	// Retrieves the list of identity providers.
	List(ctx context.Context, request *IdentityProvidersListServerRequest, response *IdentityProvidersListServerResponse) error

	// IdentityProvider returns the target 'identity_provider' server for the given identifier.
	//
	// Reference to the service that manages an specific identity provider.
	IdentityProvider(id string) IdentityProviderServer
}

IdentityProvidersServer represents the interface the manages the 'identity_providers' resource.

type LDAPAttributes ¶

type LDAPAttributes struct {
	// contains filtered or unexported fields
}

LDAPAttributes represents the values of the 'LDAP_attributes' type.

LDAP attributes used to configure the LDAP identity provider.

func UnmarshalLDAPAttributes ¶

func UnmarshalLDAPAttributes(source interface{}) (object *LDAPAttributes, err error)

UnmarshalLDAPAttributes reads a value of the 'LDAP_attributes' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*LDAPAttributes) Email ¶

func (o *LDAPAttributes) Email() []string

Email returns the value of the 'email' attribute, or the zero value of the type if the attribute doesn't have a value.

List of attributes to use as the mail address.

func (*LDAPAttributes) Empty ¶

func (o *LDAPAttributes) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*LDAPAttributes) GetEmail ¶

func (o *LDAPAttributes) GetEmail() (value []string, ok bool)

GetEmail returns the value of the 'email' attribute and a flag indicating if the attribute has a value.

List of attributes to use as the mail address.

func (*LDAPAttributes) GetID ¶

func (o *LDAPAttributes) GetID() (value []string, ok bool)

GetID returns the value of the 'ID' attribute and a flag indicating if the attribute has a value.

List of attributes to use as the identity.

func (*LDAPAttributes) GetName ¶

func (o *LDAPAttributes) GetName() (value []string, ok bool)

GetName returns the value of the 'name' attribute and a flag indicating if the attribute has a value.

List of attributes to use as the display name.

func (*LDAPAttributes) GetPreferredUsername ¶

func (o *LDAPAttributes) GetPreferredUsername() (value []string, ok bool)

GetPreferredUsername returns the value of the 'preferred_username' attribute and a flag indicating if the attribute has a value.

List of attributes to use as the preferred user name when provisioning a user.

func (*LDAPAttributes) ID ¶

func (o *LDAPAttributes) ID() []string

ID returns the value of the 'ID' attribute, or the zero value of the type if the attribute doesn't have a value.

List of attributes to use as the identity.

func (*LDAPAttributes) Name ¶

func (o *LDAPAttributes) Name() []string

Name returns the value of the 'name' attribute, or the zero value of the type if the attribute doesn't have a value.

List of attributes to use as the display name.

func (*LDAPAttributes) PreferredUsername ¶

func (o *LDAPAttributes) PreferredUsername() []string

PreferredUsername returns the value of the 'preferred_username' attribute, or the zero value of the type if the attribute doesn't have a value.

List of attributes to use as the preferred user name when provisioning a user.

type LDAPAttributesBuilder ¶

type LDAPAttributesBuilder struct {
	// contains filtered or unexported fields
}

LDAPAttributesBuilder contains the data and logic needed to build 'LDAP_attributes' objects.

LDAP attributes used to configure the LDAP identity provider.

func NewLDAPAttributes ¶

func NewLDAPAttributes() *LDAPAttributesBuilder

NewLDAPAttributes creates a new builder of 'LDAP_attributes' objects.

func (*LDAPAttributesBuilder) Build ¶

func (b *LDAPAttributesBuilder) Build() (object *LDAPAttributes, err error)

Build creates a 'LDAP_attributes' object using the configuration stored in the builder.

func (*LDAPAttributesBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*LDAPAttributesBuilder) Email ¶

func (b *LDAPAttributesBuilder) Email(values ...string) *LDAPAttributesBuilder

Email sets the value of the 'email' attribute to the given values.

func (*LDAPAttributesBuilder) ID ¶

ID sets the value of the 'ID' attribute to the given values.

func (*LDAPAttributesBuilder) Name ¶

Name sets the value of the 'name' attribute to the given values.

func (*LDAPAttributesBuilder) PreferredUsername ¶

func (b *LDAPAttributesBuilder) PreferredUsername(values ...string) *LDAPAttributesBuilder

PreferredUsername sets the value of the 'preferred_username' attribute to the given values.

type LDAPAttributesList ¶

type LDAPAttributesList struct {
	// contains filtered or unexported fields
}

LDAPAttributesList is a list of values of the 'LDAP_attributes' type.

func UnmarshalLDAPAttributesList ¶

func UnmarshalLDAPAttributesList(source interface{}) (list *LDAPAttributesList, err error)

UnmarshalLDAPAttributesList reads a list of values of the 'LDAP_attributes' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*LDAPAttributesList) Each ¶

func (l *LDAPAttributesList) Each(f func(item *LDAPAttributes) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*LDAPAttributesList) Empty ¶

func (l *LDAPAttributesList) Empty() bool

Empty returns true if the list is empty.

func (*LDAPAttributesList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*LDAPAttributesList) Len ¶

func (l *LDAPAttributesList) Len() int

Len returns the length of the list.

func (*LDAPAttributesList) Range ¶

func (l *LDAPAttributesList) Range(f func(index int, item *LDAPAttributes) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*LDAPAttributesList) Slice ¶

func (l *LDAPAttributesList) Slice() []*LDAPAttributes

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type LDAPAttributesListBuilder ¶

type LDAPAttributesListBuilder struct {
	// contains filtered or unexported fields
}

LDAPAttributesListBuilder contains the data and logic needed to build 'LDAP_attributes' objects.

func NewLDAPAttributesList ¶

func NewLDAPAttributesList() *LDAPAttributesListBuilder

NewLDAPAttributesList creates a new builder of 'LDAP_attributes' objects.

func (*LDAPAttributesListBuilder) Build ¶

func (b *LDAPAttributesListBuilder) Build() (list *LDAPAttributesList, err error)

Build creates a list of 'LDAP_attributes' objects using the configuration stored in the builder.

func (*LDAPAttributesListBuilder) Items ¶

Items sets the items of the list.

type LDAPIdentityProvider ¶

type LDAPIdentityProvider struct {
	// contains filtered or unexported fields
}

LDAPIdentityProvider represents the values of the 'LDAP_identity_provider' type.

Details for `ldap` identity providers.

func UnmarshalLDAPIdentityProvider ¶

func UnmarshalLDAPIdentityProvider(source interface{}) (object *LDAPIdentityProvider, err error)

UnmarshalLDAPIdentityProvider reads a value of the 'LDAP_identity_provider' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*LDAPIdentityProvider) BindDN ¶

func (o *LDAPIdentityProvider) BindDN() string

BindDN returns the value of the 'bind_DN' attribute, or the zero value of the type if the attribute doesn't have a value.

Optional distinguished name to use to bind during the search phase.

func (*LDAPIdentityProvider) BindPassword ¶

func (o *LDAPIdentityProvider) BindPassword() string

BindPassword returns the value of the 'bind_password' attribute, or the zero value of the type if the attribute doesn't have a value.

Optional password to use to bind during the search phase.

func (*LDAPIdentityProvider) CA ¶

func (o *LDAPIdentityProvider) CA() string

CA returns the value of the 'CA' attribute, or the zero value of the type if the attribute doesn't have a value.

Certificate bundle to use to validate server certificates for the configured URL.

func (*LDAPIdentityProvider) Empty ¶

func (o *LDAPIdentityProvider) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*LDAPIdentityProvider) GetBindDN ¶

func (o *LDAPIdentityProvider) GetBindDN() (value string, ok bool)

GetBindDN returns the value of the 'bind_DN' attribute and a flag indicating if the attribute has a value.

Optional distinguished name to use to bind during the search phase.

func (*LDAPIdentityProvider) GetBindPassword ¶

func (o *LDAPIdentityProvider) GetBindPassword() (value string, ok bool)

GetBindPassword returns the value of the 'bind_password' attribute and a flag indicating if the attribute has a value.

Optional password to use to bind during the search phase.

func (*LDAPIdentityProvider) GetCA ¶

func (o *LDAPIdentityProvider) GetCA() (value string, ok bool)

GetCA returns the value of the 'CA' attribute and a flag indicating if the attribute has a value.

Certificate bundle to use to validate server certificates for the configured URL.

func (*LDAPIdentityProvider) GetInsecure ¶

func (o *LDAPIdentityProvider) GetInsecure() (value bool, ok bool)

GetInsecure returns the value of the 'insecure' attribute and a flag indicating if the attribute has a value.

When `true` no TLS connection is made to the server. When `false` `ldaps://...` URLs connect using TLS and `ldap://...` are upgraded to TLS.

func (*LDAPIdentityProvider) GetLDAPAttributes ¶ added in v0.1.32

func (o *LDAPIdentityProvider) GetLDAPAttributes() (value *LDAPAttributes, ok bool)

GetLDAPAttributes returns the value of the 'LDAP_attributes' attribute and a flag indicating if the attribute has a value.

LDAP attributes used to configure the provider.

func (*LDAPIdentityProvider) GetURL ¶

func (o *LDAPIdentityProvider) GetURL() (value string, ok bool)

GetURL returns the value of the 'URL' attribute and a flag indicating if the attribute has a value.

An https://tools.ietf.org/html/rfc2255[RFC 2255] URL which specifies the LDAP host and search parameters to use.

func (*LDAPIdentityProvider) Insecure ¶

func (o *LDAPIdentityProvider) Insecure() bool

Insecure returns the value of the 'insecure' attribute, or the zero value of the type if the attribute doesn't have a value.

When `true` no TLS connection is made to the server. When `false` `ldaps://...` URLs connect using TLS and `ldap://...` are upgraded to TLS.

func (*LDAPIdentityProvider) LDAPAttributes ¶ added in v0.1.32

func (o *LDAPIdentityProvider) LDAPAttributes() *LDAPAttributes

LDAPAttributes returns the value of the 'LDAP_attributes' attribute, or the zero value of the type if the attribute doesn't have a value.

LDAP attributes used to configure the provider.

func (*LDAPIdentityProvider) URL ¶

func (o *LDAPIdentityProvider) URL() string

URL returns the value of the 'URL' attribute, or the zero value of the type if the attribute doesn't have a value.

An https://tools.ietf.org/html/rfc2255[RFC 2255] URL which specifies the LDAP host and search parameters to use.

type LDAPIdentityProviderBuilder ¶

type LDAPIdentityProviderBuilder struct {
	// contains filtered or unexported fields
}

LDAPIdentityProviderBuilder contains the data and logic needed to build 'LDAP_identity_provider' objects.

Details for `ldap` identity providers.

func NewLDAPIdentityProvider ¶

func NewLDAPIdentityProvider() *LDAPIdentityProviderBuilder

NewLDAPIdentityProvider creates a new builder of 'LDAP_identity_provider' objects.

func (*LDAPIdentityProviderBuilder) BindDN ¶

BindDN sets the value of the 'bind_DN' attribute to the given value.

func (*LDAPIdentityProviderBuilder) BindPassword ¶

BindPassword sets the value of the 'bind_password' attribute to the given value.

func (*LDAPIdentityProviderBuilder) Build ¶

func (b *LDAPIdentityProviderBuilder) Build() (object *LDAPIdentityProvider, err error)

Build creates a 'LDAP_identity_provider' object using the configuration stored in the builder.

func (*LDAPIdentityProviderBuilder) CA ¶

CA sets the value of the 'CA' attribute to the given value.

func (*LDAPIdentityProviderBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*LDAPIdentityProviderBuilder) Insecure ¶

Insecure sets the value of the 'insecure' attribute to the given value.

func (*LDAPIdentityProviderBuilder) LDAPAttributes ¶ added in v0.1.32

LDAPAttributes sets the value of the 'LDAP_attributes' attribute to the given value.

LDAP attributes used to configure the LDAP identity provider.

func (*LDAPIdentityProviderBuilder) URL ¶

URL sets the value of the 'URL' attribute to the given value.

type LDAPIdentityProviderList ¶

type LDAPIdentityProviderList struct {
	// contains filtered or unexported fields
}

LDAPIdentityProviderList is a list of values of the 'LDAP_identity_provider' type.

func UnmarshalLDAPIdentityProviderList ¶

func UnmarshalLDAPIdentityProviderList(source interface{}) (list *LDAPIdentityProviderList, err error)

UnmarshalLDAPIdentityProviderList reads a list of values of the 'LDAP_identity_provider' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*LDAPIdentityProviderList) Each ¶

func (l *LDAPIdentityProviderList) Each(f func(item *LDAPIdentityProvider) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*LDAPIdentityProviderList) Empty ¶

func (l *LDAPIdentityProviderList) Empty() bool

Empty returns true if the list is empty.

func (*LDAPIdentityProviderList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*LDAPIdentityProviderList) Len ¶

func (l *LDAPIdentityProviderList) Len() int

Len returns the length of the list.

func (*LDAPIdentityProviderList) Range ¶

func (l *LDAPIdentityProviderList) Range(f func(index int, item *LDAPIdentityProvider) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*LDAPIdentityProviderList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type LDAPIdentityProviderListBuilder ¶

type LDAPIdentityProviderListBuilder struct {
	// contains filtered or unexported fields
}

LDAPIdentityProviderListBuilder contains the data and logic needed to build 'LDAP_identity_provider' objects.

func NewLDAPIdentityProviderList ¶

func NewLDAPIdentityProviderList() *LDAPIdentityProviderListBuilder

NewLDAPIdentityProviderList creates a new builder of 'LDAP_identity_provider' objects.

func (*LDAPIdentityProviderListBuilder) Build ¶

Build creates a list of 'LDAP_identity_provider' objects using the configuration stored in the builder.

func (*LDAPIdentityProviderListBuilder) Items ¶

Items sets the items of the list.

type Log ¶

type Log struct {
	// contains filtered or unexported fields
}

Log represents the values of the 'log' type.

Log of the cluster.

func UnmarshalLog ¶

func UnmarshalLog(source interface{}) (object *Log, err error)

UnmarshalLog reads a value of the 'log' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Log) Content ¶

func (o *Log) Content() string

Content returns the value of the 'content' attribute, or the zero value of the type if the attribute doesn't have a value.

Content of the log.

func (*Log) Empty ¶

func (o *Log) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Log) GetContent ¶

func (o *Log) GetContent() (value string, ok bool)

GetContent returns the value of the 'content' attribute and a flag indicating if the attribute has a value.

Content of the log.

func (*Log) GetHREF ¶

func (o *Log) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*Log) GetID ¶

func (o *Log) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*Log) HREF ¶

func (o *Log) HREF() string

HREF returns the link to the object.

func (*Log) ID ¶

func (o *Log) ID() string

ID returns the identifier of the object.

func (*Log) Kind ¶

func (o *Log) Kind() string

Kind returns the name of the type of the object.

func (o *Log) Link() bool

Link returns true iif this is a link.

type LogBuilder ¶

type LogBuilder struct {
	// contains filtered or unexported fields
}

LogBuilder contains the data and logic needed to build 'log' objects.

Log of the cluster.

func NewLog ¶

func NewLog() *LogBuilder

NewLog creates a new builder of 'log' objects.

func (*LogBuilder) Build ¶

func (b *LogBuilder) Build() (object *Log, err error)

Build creates a 'log' object using the configuration stored in the builder.

func (*LogBuilder) Content ¶

func (b *LogBuilder) Content(value string) *LogBuilder

Content sets the value of the 'content' attribute to the given value.

func (*LogBuilder) Copy ¶

func (b *LogBuilder) Copy(object *Log) *LogBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*LogBuilder) HREF ¶

func (b *LogBuilder) HREF(value string) *LogBuilder

HREF sets the link to the object.

func (*LogBuilder) ID ¶

func (b *LogBuilder) ID(value string) *LogBuilder

ID sets the identifier of the object.

func (b *LogBuilder) Link(value bool) *LogBuilder

Link sets the flag that indicates if this is a link.

type LogClient ¶

type LogClient struct {
	// contains filtered or unexported fields
}

LogClient is the client of the 'log' resource.

Manages a specific log.

func NewLogClient ¶

func NewLogClient(transport http.RoundTripper, path string, metric string) *LogClient

NewLogClient creates a new client for the 'log' resource using the given transport to sned the requests and receive the responses.

func (*LogClient) Get ¶

func (c *LogClient) Get() *LogGetRequest

Get creates a request for the 'get' method.

Retrieves the details of the log.

func (*LogClient) Poll ¶

func (c *LogClient) Poll() *LogPollRequest

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type LogGetRequest ¶

type LogGetRequest struct {
	// contains filtered or unexported fields
}

LogGetRequest is the request for the 'get' method.

func (*LogGetRequest) Header ¶

func (r *LogGetRequest) Header(name string, value interface{}) *LogGetRequest

Header adds a request header.

func (*LogGetRequest) Parameter ¶

func (r *LogGetRequest) Parameter(name string, value interface{}) *LogGetRequest

Parameter adds a query parameter.

func (*LogGetRequest) Send ¶

func (r *LogGetRequest) Send() (result *LogGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*LogGetRequest) SendContext ¶

func (r *LogGetRequest) SendContext(ctx context.Context) (result *LogGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type LogGetResponse ¶

type LogGetResponse struct {
	// contains filtered or unexported fields
}

LogGetResponse is the response for the 'get' method.

func (*LogGetResponse) Body ¶

func (r *LogGetResponse) Body() *Log

Body returns the value of the 'body' parameter.

func (*LogGetResponse) Error ¶

func (r *LogGetResponse) Error() *errors.Error

Error returns the response error.

func (*LogGetResponse) GetBody ¶

func (r *LogGetResponse) GetBody() (value *Log, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*LogGetResponse) Header ¶

func (r *LogGetResponse) Header() http.Header

Header returns header of the response.

func (*LogGetResponse) Status ¶

func (r *LogGetResponse) Status() int

Status returns the response status code.

type LogGetServerRequest ¶

type LogGetServerRequest struct {
}

LogGetServerRequest is the request for the 'get' method.

type LogGetServerResponse ¶

type LogGetServerResponse struct {
	// contains filtered or unexported fields
}

LogGetServerResponse is the response for the 'get' method.

func (*LogGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*LogGetServerResponse) Status ¶

func (r *LogGetServerResponse) Status(value int) *LogGetServerResponse

Status sets the status code.

type LogList ¶

type LogList struct {
	// contains filtered or unexported fields
}

LogList is a list of values of the 'log' type.

func UnmarshalLogList ¶

func UnmarshalLogList(source interface{}) (list *LogList, err error)

UnmarshalLogList reads a list of values of the 'log' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*LogList) Each ¶

func (l *LogList) Each(f func(item *Log) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*LogList) Empty ¶

func (l *LogList) Empty() bool

Empty returns true if the list is empty.

func (*LogList) Get ¶

func (l *LogList) Get(i int) *Log

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*LogList) GetHREF ¶

func (l *LogList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*LogList) HREF ¶

func (l *LogList) HREF() string

HREF returns the link to the list.

func (*LogList) Kind ¶

func (l *LogList) Kind() string

Kind returns the name of the type of the object.

func (*LogList) Len ¶

func (l *LogList) Len() int

Len returns the length of the list.

func (l *LogList) Link() bool

Link returns true iif this is a link.

func (*LogList) Range ¶

func (l *LogList) Range(f func(index int, item *Log) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*LogList) Slice ¶

func (l *LogList) Slice() []*Log

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type LogListBuilder ¶

type LogListBuilder struct {
	// contains filtered or unexported fields
}

LogListBuilder contains the data and logic needed to build 'log' objects.

func NewLogList ¶

func NewLogList() *LogListBuilder

NewLogList creates a new builder of 'log' objects.

func (*LogListBuilder) Build ¶

func (b *LogListBuilder) Build() (list *LogList, err error)

Build creates a list of 'log' objects using the configuration stored in the builder.

func (*LogListBuilder) Items ¶

func (b *LogListBuilder) Items(values ...*LogBuilder) *LogListBuilder

Items sets the items of the list.

type LogPollRequest ¶

type LogPollRequest struct {
	// contains filtered or unexported fields
}

LogPollRequest is the request for the Poll method.

func (*LogPollRequest) Header ¶

func (r *LogPollRequest) Header(name string, value interface{}) *LogPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*LogPollRequest) Interval ¶

func (r *LogPollRequest) Interval(value time.Duration) *LogPollRequest

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*LogPollRequest) Parameter ¶

func (r *LogPollRequest) Parameter(name string, value interface{}) *LogPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*LogPollRequest) Predicate ¶

func (r *LogPollRequest) Predicate(value func(*LogGetResponse) bool) *LogPollRequest

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*LogPollRequest) StartContext ¶

func (r *LogPollRequest) StartContext(ctx context.Context) (response *LogPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*LogPollRequest) Status ¶

func (r *LogPollRequest) Status(value int) *LogPollRequest

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type LogPollResponse ¶

type LogPollResponse struct {
	// contains filtered or unexported fields
}

LogPollResponse is the response for the Poll method.

func (*LogPollResponse) Body ¶

func (r *LogPollResponse) Body() *Log

Body returns the value of the 'body' parameter.

func (*LogPollResponse) Error ¶

func (r *LogPollResponse) Error() *errors.Error

Error returns the response error.

func (*LogPollResponse) GetBody ¶

func (r *LogPollResponse) GetBody() (value *Log, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*LogPollResponse) Header ¶

func (r *LogPollResponse) Header() http.Header

Header returns header of the response.

func (*LogPollResponse) Status ¶

func (r *LogPollResponse) Status() int

Status returns the response status code.

type LogServer ¶

type LogServer interface {

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the log.
	Get(ctx context.Context, request *LogGetServerRequest, response *LogGetServerResponse) error
}

LogServer represents the interface the manages the 'log' resource.

type LogsClient ¶

type LogsClient struct {
	// contains filtered or unexported fields
}

LogsClient is the client of the 'logs' resource.

Manages a collection of logs.

func NewLogsClient ¶

func NewLogsClient(transport http.RoundTripper, path string, metric string) *LogsClient

NewLogsClient creates a new client for the 'logs' resource using the given transport to sned the requests and receive the responses.

func (*LogsClient) List ¶

func (c *LogsClient) List() *LogsListRequest

List creates a request for the 'list' method.

Retrieves the list of clusters.

func (*LogsClient) Log ¶ added in v0.1.30

func (c *LogsClient) Log(id string) *LogClient

Log returns the target 'log' resource for the given identifier.

Returns a reference to the service that manages an specific log.

type LogsListRequest ¶

type LogsListRequest struct {
	// contains filtered or unexported fields
}

LogsListRequest is the request for the 'list' method.

func (*LogsListRequest) Header ¶

func (r *LogsListRequest) Header(name string, value interface{}) *LogsListRequest

Header adds a request header.

func (*LogsListRequest) Page ¶

func (r *LogsListRequest) Page(value int) *LogsListRequest

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*LogsListRequest) Parameter ¶

func (r *LogsListRequest) Parameter(name string, value interface{}) *LogsListRequest

Parameter adds a query parameter.

func (*LogsListRequest) Send ¶

func (r *LogsListRequest) Send() (result *LogsListResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*LogsListRequest) SendContext ¶

func (r *LogsListRequest) SendContext(ctx context.Context) (result *LogsListResponse, err error)

SendContext sends this request, waits for the response, and returns it.

func (*LogsListRequest) Size ¶

func (r *LogsListRequest) Size(value int) *LogsListRequest

Size sets the value of the 'size' parameter.

Number of items contained in the returned page.

type LogsListResponse ¶

type LogsListResponse struct {
	// contains filtered or unexported fields
}

LogsListResponse is the response for the 'list' method.

func (*LogsListResponse) Error ¶

func (r *LogsListResponse) Error() *errors.Error

Error returns the response error.

func (*LogsListResponse) GetItems ¶

func (r *LogsListResponse) GetItems() (value *LogList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of logs.

func (*LogsListResponse) GetPage ¶

func (r *LogsListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*LogsListResponse) GetSize ¶

func (r *LogsListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Number of items contained in the returned page.

func (*LogsListResponse) GetTotal ¶

func (r *LogsListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection.

func (*LogsListResponse) Header ¶

func (r *LogsListResponse) Header() http.Header

Header returns header of the response.

func (*LogsListResponse) Items ¶

func (r *LogsListResponse) Items() *LogList

Items returns the value of the 'items' parameter.

Retrieved list of logs.

func (*LogsListResponse) Page ¶

func (r *LogsListResponse) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*LogsListResponse) Size ¶

func (r *LogsListResponse) Size() int

Size returns the value of the 'size' parameter.

Number of items contained in the returned page.

func (*LogsListResponse) Status ¶

func (r *LogsListResponse) Status() int

Status returns the response status code.

func (*LogsListResponse) Total ¶

func (r *LogsListResponse) Total() int

Total returns the value of the 'total' parameter.

Total number of items of the collection.

type LogsListServerRequest ¶

type LogsListServerRequest struct {
	// contains filtered or unexported fields
}

LogsListServerRequest is the request for the 'list' method.

func (*LogsListServerRequest) GetPage ¶

func (r *LogsListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*LogsListServerRequest) GetSize ¶

func (r *LogsListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Number of items contained in the returned page.

func (*LogsListServerRequest) Page ¶

func (r *LogsListServerRequest) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*LogsListServerRequest) Size ¶

func (r *LogsListServerRequest) Size() int

Size returns the value of the 'size' parameter.

Number of items contained in the returned page.

type LogsListServerResponse ¶

type LogsListServerResponse struct {
	// contains filtered or unexported fields
}

LogsListServerResponse is the response for the 'list' method.

func (*LogsListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of logs.

func (*LogsListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*LogsListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Number of items contained in the returned page.

func (*LogsListServerResponse) Status ¶

Status sets the status code.

func (*LogsListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection.

type LogsServer ¶

type LogsServer interface {

	// List handles a request for the 'list' method.
	//
	// Retrieves the list of clusters.
	List(ctx context.Context, request *LogsListServerRequest, response *LogsListServerResponse) error

	// Log returns the target 'log' server for the given identifier.
	//
	// Returns a reference to the service that manages an specific log.
	Log(id string) LogServer
}

LogsServer represents the interface the manages the 'logs' resource.

type Metadata ¶

type Metadata struct {
	// contains filtered or unexported fields
}

Metadata contains the version metadata.

func UnmarshalMetadata ¶

func UnmarshalMetadata(source interface{}) (object *Metadata, err error)

UnmarshalMetadata reads a value of the metadata type from the given source, which which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Metadata) GetServerVersion ¶

func (m *Metadata) GetServerVersion() (value string, ok bool)

GetServerVersion returns the value of the server version and a flag indicating if the attribute has a value.

func (*Metadata) ServerVersion ¶

func (m *Metadata) ServerVersion() string

ServerVersion returns the version of the server.

type MetadataRequest ¶

type MetadataRequest struct {
	// contains filtered or unexported fields
}

MetadataRequest is the request to retrieve the metadata.

func (*MetadataRequest) Header ¶

func (r *MetadataRequest) Header(name string, value interface{}) *MetadataRequest

Header adds a request header.

func (*MetadataRequest) Parameter ¶

func (r *MetadataRequest) Parameter(name string, value interface{}) *MetadataRequest

Parameter adds a query parameter.

func (*MetadataRequest) Send ¶

func (r *MetadataRequest) Send() (result *MetadataResponse, err error)

Send sends the metadata request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*MetadataRequest) SendContext ¶

func (r *MetadataRequest) SendContext(ctx context.Context) (result *MetadataResponse, err error)

SendContext sends the metadata request, waits for the response, and returns it.

type MetadataResponse ¶

type MetadataResponse struct {
	// contains filtered or unexported fields
}

MetadataResponse is the response for the metadata request.

func (*MetadataResponse) Body ¶

func (r *MetadataResponse) Body() *Metadata

Body returns the response body.

func (*MetadataResponse) Error ¶

func (r *MetadataResponse) Error() *errors.Error

Error returns the response error.

func (*MetadataResponse) Header ¶

func (r *MetadataResponse) Header() http.Header

Header returns header of the response.

func (*MetadataResponse) Status ¶

func (r *MetadataResponse) Status() int

Status returns the response status code.

type Metric ¶

type Metric struct {
	// contains filtered or unexported fields
}

Metric represents the values of the 'metric' type.

Metric included in a dashboard.

func UnmarshalMetric ¶

func UnmarshalMetric(source interface{}) (object *Metric, err error)

UnmarshalMetric reads a value of the 'metric' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Metric) Empty ¶

func (o *Metric) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Metric) GetName ¶

func (o *Metric) GetName() (value string, ok bool)

GetName returns the value of the 'name' attribute and a flag indicating if the attribute has a value.

Name of the metric.

func (*Metric) GetVector ¶

func (o *Metric) GetVector() (value *SampleList, ok bool)

GetVector returns the value of the 'vector' attribute and a flag indicating if the attribute has a value.

Samples of the metric.

func (*Metric) Name ¶

func (o *Metric) Name() string

Name returns the value of the 'name' attribute, or the zero value of the type if the attribute doesn't have a value.

Name of the metric.

func (*Metric) Vector ¶

func (o *Metric) Vector() *SampleList

Vector returns the value of the 'vector' attribute, or the zero value of the type if the attribute doesn't have a value.

Samples of the metric.

type MetricBuilder ¶

type MetricBuilder struct {
	// contains filtered or unexported fields
}

MetricBuilder contains the data and logic needed to build 'metric' objects.

Metric included in a dashboard.

func NewMetric ¶

func NewMetric() *MetricBuilder

NewMetric creates a new builder of 'metric' objects.

func (*MetricBuilder) Build ¶

func (b *MetricBuilder) Build() (object *Metric, err error)

Build creates a 'metric' object using the configuration stored in the builder.

func (*MetricBuilder) Copy ¶

func (b *MetricBuilder) Copy(object *Metric) *MetricBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*MetricBuilder) Name ¶

func (b *MetricBuilder) Name(value string) *MetricBuilder

Name sets the value of the 'name' attribute to the given value.

func (*MetricBuilder) Vector ¶

func (b *MetricBuilder) Vector(values ...*SampleBuilder) *MetricBuilder

Vector sets the value of the 'vector' attribute to the given values.

type MetricList ¶

type MetricList struct {
	// contains filtered or unexported fields
}

MetricList is a list of values of the 'metric' type.

func UnmarshalMetricList ¶

func UnmarshalMetricList(source interface{}) (list *MetricList, err error)

UnmarshalMetricList reads a list of values of the 'metric' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*MetricList) Each ¶

func (l *MetricList) Each(f func(item *Metric) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*MetricList) Empty ¶

func (l *MetricList) Empty() bool

Empty returns true if the list is empty.

func (*MetricList) Get ¶

func (l *MetricList) Get(i int) *Metric

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*MetricList) Len ¶

func (l *MetricList) Len() int

Len returns the length of the list.

func (*MetricList) Range ¶

func (l *MetricList) Range(f func(index int, item *Metric) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*MetricList) Slice ¶

func (l *MetricList) Slice() []*Metric

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type MetricListBuilder ¶

type MetricListBuilder struct {
	// contains filtered or unexported fields
}

MetricListBuilder contains the data and logic needed to build 'metric' objects.

func NewMetricList ¶

func NewMetricList() *MetricListBuilder

NewMetricList creates a new builder of 'metric' objects.

func (*MetricListBuilder) Build ¶

func (b *MetricListBuilder) Build() (list *MetricList, err error)

Build creates a list of 'metric' objects using the configuration stored in the builder.

func (*MetricListBuilder) Items ¶

func (b *MetricListBuilder) Items(values ...*MetricBuilder) *MetricListBuilder

Items sets the items of the list.

type MetricQueriesClient ¶

type MetricQueriesClient struct {
	// contains filtered or unexported fields
}

MetricQueriesClient is the client of the 'metric_queries' resource.

Manages metric queries for a cluster.

func NewMetricQueriesClient ¶

func NewMetricQueriesClient(transport http.RoundTripper, path string, metric string) *MetricQueriesClient

NewMetricQueriesClient creates a new client for the 'metric_queries' resource using the given transport to sned the requests and receive the responses.

func (*MetricQueriesClient) CPUTotalByNodeRolesOS ¶

func (c *MetricQueriesClient) CPUTotalByNodeRolesOS() *CPUTotalByNodeRolesOSMetricQueryClient

CPUTotalByNodeRolesOS returns the target 'CPU_total_by_node_roles_OS_metric_query' resource.

Reference to the resource that retrieves the total cpu capacity in the cluster by node role and operating system.

func (*MetricQueriesClient) SocketTotalByNodeRolesOS ¶

func (c *MetricQueriesClient) SocketTotalByNodeRolesOS() *SocketTotalByNodeRolesOSMetricQueryClient

SocketTotalByNodeRolesOS returns the target 'socket_total_by_node_roles_OS_metric_query' resource.

Reference to the resource that retrieves the total socket capacity in the cluster by node role and operating system.

type MetricQueriesServer ¶

type MetricQueriesServer interface {

	// CPUTotalByNodeRolesOS returns the target 'CPU_total_by_node_roles_OS_metric_query' resource.
	//
	// Reference to the resource that retrieves the total cpu
	// capacity in the cluster by node role and operating system.
	CPUTotalByNodeRolesOS() CPUTotalByNodeRolesOSMetricQueryServer

	// SocketTotalByNodeRolesOS returns the target 'socket_total_by_node_roles_OS_metric_query' resource.
	//
	// Reference to the resource that retrieves the total socket
	// capacity in the cluster by node role and operating system.
	SocketTotalByNodeRolesOS() SocketTotalByNodeRolesOSMetricQueryServer
}

MetricQueriesServer represents the interface the manages the 'metric_queries' resource.

type Network ¶

type Network struct {
	// contains filtered or unexported fields
}

Network represents the values of the 'network' type.

Network configuration of a cluster.

func UnmarshalNetwork ¶

func UnmarshalNetwork(source interface{}) (object *Network, err error)

UnmarshalNetwork reads a value of the 'network' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Network) Empty ¶

func (o *Network) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Network) GetMachineCIDR ¶

func (o *Network) GetMachineCIDR() (value string, ok bool)

GetMachineCIDR returns the value of the 'machine_CIDR' attribute and a flag indicating if the attribute has a value.

IP address block from which to assign machine IP addresses, for example `10.0.0.0/16`.

func (*Network) GetPodCIDR ¶

func (o *Network) GetPodCIDR() (value string, ok bool)

GetPodCIDR returns the value of the 'pod_CIDR' attribute and a flag indicating if the attribute has a value.

IP address block from which to assign pod IP addresses, for example `10.128.0.0/14`.

func (*Network) GetServiceCIDR ¶

func (o *Network) GetServiceCIDR() (value string, ok bool)

GetServiceCIDR returns the value of the 'service_CIDR' attribute and a flag indicating if the attribute has a value.

IP address block from which to assign service IP addresses, for example `172.30.0.0/16`.

func (*Network) MachineCIDR ¶

func (o *Network) MachineCIDR() string

MachineCIDR returns the value of the 'machine_CIDR' attribute, or the zero value of the type if the attribute doesn't have a value.

IP address block from which to assign machine IP addresses, for example `10.0.0.0/16`.

func (*Network) PodCIDR ¶

func (o *Network) PodCIDR() string

PodCIDR returns the value of the 'pod_CIDR' attribute, or the zero value of the type if the attribute doesn't have a value.

IP address block from which to assign pod IP addresses, for example `10.128.0.0/14`.

func (*Network) ServiceCIDR ¶

func (o *Network) ServiceCIDR() string

ServiceCIDR returns the value of the 'service_CIDR' attribute, or the zero value of the type if the attribute doesn't have a value.

IP address block from which to assign service IP addresses, for example `172.30.0.0/16`.

type NetworkBuilder ¶

type NetworkBuilder struct {
	// contains filtered or unexported fields
}

NetworkBuilder contains the data and logic needed to build 'network' objects.

Network configuration of a cluster.

func NewNetwork ¶

func NewNetwork() *NetworkBuilder

NewNetwork creates a new builder of 'network' objects.

func (*NetworkBuilder) Build ¶

func (b *NetworkBuilder) Build() (object *Network, err error)

Build creates a 'network' object using the configuration stored in the builder.

func (*NetworkBuilder) Copy ¶

func (b *NetworkBuilder) Copy(object *Network) *NetworkBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*NetworkBuilder) MachineCIDR ¶

func (b *NetworkBuilder) MachineCIDR(value string) *NetworkBuilder

MachineCIDR sets the value of the 'machine_CIDR' attribute to the given value.

func (*NetworkBuilder) PodCIDR ¶

func (b *NetworkBuilder) PodCIDR(value string) *NetworkBuilder

PodCIDR sets the value of the 'pod_CIDR' attribute to the given value.

func (*NetworkBuilder) ServiceCIDR ¶

func (b *NetworkBuilder) ServiceCIDR(value string) *NetworkBuilder

ServiceCIDR sets the value of the 'service_CIDR' attribute to the given value.

type NetworkList ¶

type NetworkList struct {
	// contains filtered or unexported fields
}

NetworkList is a list of values of the 'network' type.

func UnmarshalNetworkList ¶

func UnmarshalNetworkList(source interface{}) (list *NetworkList, err error)

UnmarshalNetworkList reads a list of values of the 'network' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*NetworkList) Each ¶

func (l *NetworkList) Each(f func(item *Network) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*NetworkList) Empty ¶

func (l *NetworkList) Empty() bool

Empty returns true if the list is empty.

func (*NetworkList) Get ¶

func (l *NetworkList) Get(i int) *Network

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*NetworkList) Len ¶

func (l *NetworkList) Len() int

Len returns the length of the list.

func (*NetworkList) Range ¶

func (l *NetworkList) Range(f func(index int, item *Network) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*NetworkList) Slice ¶

func (l *NetworkList) Slice() []*Network

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type NetworkListBuilder ¶

type NetworkListBuilder struct {
	// contains filtered or unexported fields
}

NetworkListBuilder contains the data and logic needed to build 'network' objects.

func NewNetworkList ¶

func NewNetworkList() *NetworkListBuilder

NewNetworkList creates a new builder of 'network' objects.

func (*NetworkListBuilder) Build ¶

func (b *NetworkListBuilder) Build() (list *NetworkList, err error)

Build creates a list of 'network' objects using the configuration stored in the builder.

func (*NetworkListBuilder) Items ¶

Items sets the items of the list.

type OpenIDClaims ¶

type OpenIDClaims struct {
	// contains filtered or unexported fields
}

OpenIDClaims represents the values of the 'open_ID_claims' type.

_OpenID_ identity provider claims.

func UnmarshalOpenIDClaims ¶

func UnmarshalOpenIDClaims(source interface{}) (object *OpenIDClaims, err error)

UnmarshalOpenIDClaims reads a value of the 'open_ID_claims' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*OpenIDClaims) Email ¶

func (o *OpenIDClaims) Email() []string

Email returns the value of the 'email' attribute, or the zero value of the type if the attribute doesn't have a value.

List of claims to use as the mail address.

func (*OpenIDClaims) Empty ¶

func (o *OpenIDClaims) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*OpenIDClaims) GetEmail ¶

func (o *OpenIDClaims) GetEmail() (value []string, ok bool)

GetEmail returns the value of the 'email' attribute and a flag indicating if the attribute has a value.

List of claims to use as the mail address.

func (*OpenIDClaims) GetName ¶

func (o *OpenIDClaims) GetName() (value []string, ok bool)

GetName returns the value of the 'name' attribute and a flag indicating if the attribute has a value.

List of claims to use as the display name.

func (*OpenIDClaims) GetPreferredUsername ¶

func (o *OpenIDClaims) GetPreferredUsername() (value []string, ok bool)

GetPreferredUsername returns the value of the 'preferred_username' attribute and a flag indicating if the attribute has a value.

List of claims to use as the preferred user name when provisioning a user.

func (*OpenIDClaims) Name ¶

func (o *OpenIDClaims) Name() []string

Name returns the value of the 'name' attribute, or the zero value of the type if the attribute doesn't have a value.

List of claims to use as the display name.

func (*OpenIDClaims) PreferredUsername ¶

func (o *OpenIDClaims) PreferredUsername() []string

PreferredUsername returns the value of the 'preferred_username' attribute, or the zero value of the type if the attribute doesn't have a value.

List of claims to use as the preferred user name when provisioning a user.

type OpenIDClaimsBuilder ¶

type OpenIDClaimsBuilder struct {
	// contains filtered or unexported fields
}

OpenIDClaimsBuilder contains the data and logic needed to build 'open_ID_claims' objects.

_OpenID_ identity provider claims.

func NewOpenIDClaims ¶

func NewOpenIDClaims() *OpenIDClaimsBuilder

NewOpenIDClaims creates a new builder of 'open_ID_claims' objects.

func (*OpenIDClaimsBuilder) Build ¶

func (b *OpenIDClaimsBuilder) Build() (object *OpenIDClaims, err error)

Build creates a 'open_ID_claims' object using the configuration stored in the builder.

func (*OpenIDClaimsBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*OpenIDClaimsBuilder) Email ¶

func (b *OpenIDClaimsBuilder) Email(values ...string) *OpenIDClaimsBuilder

Email sets the value of the 'email' attribute to the given values.

func (*OpenIDClaimsBuilder) Name ¶

func (b *OpenIDClaimsBuilder) Name(values ...string) *OpenIDClaimsBuilder

Name sets the value of the 'name' attribute to the given values.

func (*OpenIDClaimsBuilder) PreferredUsername ¶

func (b *OpenIDClaimsBuilder) PreferredUsername(values ...string) *OpenIDClaimsBuilder

PreferredUsername sets the value of the 'preferred_username' attribute to the given values.

type OpenIDClaimsList ¶

type OpenIDClaimsList struct {
	// contains filtered or unexported fields
}

OpenIDClaimsList is a list of values of the 'open_ID_claims' type.

func UnmarshalOpenIDClaimsList ¶

func UnmarshalOpenIDClaimsList(source interface{}) (list *OpenIDClaimsList, err error)

UnmarshalOpenIDClaimsList reads a list of values of the 'open_ID_claims' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*OpenIDClaimsList) Each ¶

func (l *OpenIDClaimsList) Each(f func(item *OpenIDClaims) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*OpenIDClaimsList) Empty ¶

func (l *OpenIDClaimsList) Empty() bool

Empty returns true if the list is empty.

func (*OpenIDClaimsList) Get ¶

func (l *OpenIDClaimsList) Get(i int) *OpenIDClaims

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*OpenIDClaimsList) Len ¶

func (l *OpenIDClaimsList) Len() int

Len returns the length of the list.

func (*OpenIDClaimsList) Range ¶

func (l *OpenIDClaimsList) Range(f func(index int, item *OpenIDClaims) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*OpenIDClaimsList) Slice ¶

func (l *OpenIDClaimsList) Slice() []*OpenIDClaims

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type OpenIDClaimsListBuilder ¶

type OpenIDClaimsListBuilder struct {
	// contains filtered or unexported fields
}

OpenIDClaimsListBuilder contains the data and logic needed to build 'open_ID_claims' objects.

func NewOpenIDClaimsList ¶

func NewOpenIDClaimsList() *OpenIDClaimsListBuilder

NewOpenIDClaimsList creates a new builder of 'open_ID_claims' objects.

func (*OpenIDClaimsListBuilder) Build ¶

func (b *OpenIDClaimsListBuilder) Build() (list *OpenIDClaimsList, err error)

Build creates a list of 'open_ID_claims' objects using the configuration stored in the builder.

func (*OpenIDClaimsListBuilder) Items ¶

Items sets the items of the list.

type OpenIDIdentityProvider ¶

type OpenIDIdentityProvider struct {
	// contains filtered or unexported fields
}

OpenIDIdentityProvider represents the values of the 'open_ID_identity_provider' type.

Details for `openid` identity providers.

func UnmarshalOpenIDIdentityProvider ¶

func UnmarshalOpenIDIdentityProvider(source interface{}) (object *OpenIDIdentityProvider, err error)

UnmarshalOpenIDIdentityProvider reads a value of the 'open_ID_identity_provider' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*OpenIDIdentityProvider) CA ¶

CA returns the value of the 'CA' attribute, or the zero value of the type if the attribute doesn't have a value.

Certificate bunde to use to validate server certificates for the configured URL.

func (*OpenIDIdentityProvider) Claims ¶

func (o *OpenIDIdentityProvider) Claims() *OpenIDClaims

Claims returns the value of the 'claims' attribute, or the zero value of the type if the attribute doesn't have a value.

Claims used to configure the provider.

func (*OpenIDIdentityProvider) ClientID ¶

func (o *OpenIDIdentityProvider) ClientID() string

ClientID returns the value of the 'client_ID' attribute, or the zero value of the type if the attribute doesn't have a value.

Identifier of a client registered with the _OpenID_ provider.

func (*OpenIDIdentityProvider) ClientSecret ¶

func (o *OpenIDIdentityProvider) ClientSecret() string

ClientSecret returns the value of the 'client_secret' attribute, or the zero value of the type if the attribute doesn't have a value.

Client secret.

func (*OpenIDIdentityProvider) Empty ¶

func (o *OpenIDIdentityProvider) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*OpenIDIdentityProvider) ExtraAuthorizeParameters ¶

func (o *OpenIDIdentityProvider) ExtraAuthorizeParameters() map[string]string

ExtraAuthorizeParameters returns the value of the 'extra_authorize_parameters' attribute, or the zero value of the type if the attribute doesn't have a value.

Optional map of extra parameters to add to the authorization token request.

func (*OpenIDIdentityProvider) ExtraScopes ¶

func (o *OpenIDIdentityProvider) ExtraScopes() []string

ExtraScopes returns the value of the 'extra_scopes' attribute, or the zero value of the type if the attribute doesn't have a value.

Optional list of scopes to request, in addition to the `openid` scope, during the authorization token request.

func (*OpenIDIdentityProvider) GetCA ¶

func (o *OpenIDIdentityProvider) GetCA() (value string, ok bool)

GetCA returns the value of the 'CA' attribute and a flag indicating if the attribute has a value.

Certificate bunde to use to validate server certificates for the configured URL.

func (*OpenIDIdentityProvider) GetClaims ¶

func (o *OpenIDIdentityProvider) GetClaims() (value *OpenIDClaims, ok bool)

GetClaims returns the value of the 'claims' attribute and a flag indicating if the attribute has a value.

Claims used to configure the provider.

func (*OpenIDIdentityProvider) GetClientID ¶

func (o *OpenIDIdentityProvider) GetClientID() (value string, ok bool)

GetClientID returns the value of the 'client_ID' attribute and a flag indicating if the attribute has a value.

Identifier of a client registered with the _OpenID_ provider.

func (*OpenIDIdentityProvider) GetClientSecret ¶

func (o *OpenIDIdentityProvider) GetClientSecret() (value string, ok bool)

GetClientSecret returns the value of the 'client_secret' attribute and a flag indicating if the attribute has a value.

Client secret.

func (*OpenIDIdentityProvider) GetExtraAuthorizeParameters ¶

func (o *OpenIDIdentityProvider) GetExtraAuthorizeParameters() (value map[string]string, ok bool)

GetExtraAuthorizeParameters returns the value of the 'extra_authorize_parameters' attribute and a flag indicating if the attribute has a value.

Optional map of extra parameters to add to the authorization token request.

func (*OpenIDIdentityProvider) GetExtraScopes ¶

func (o *OpenIDIdentityProvider) GetExtraScopes() (value []string, ok bool)

GetExtraScopes returns the value of the 'extra_scopes' attribute and a flag indicating if the attribute has a value.

Optional list of scopes to request, in addition to the `openid` scope, during the authorization token request.

func (*OpenIDIdentityProvider) GetURLS ¶ added in v0.1.32

func (o *OpenIDIdentityProvider) GetURLS() (value *OpenIDURLs, ok bool)

GetURLS returns the value of the 'URLS' attribute and a flag indicating if the attribute has a value.

URLs of the provider.

func (*OpenIDIdentityProvider) URLS ¶ added in v0.1.32

URLS returns the value of the 'URLS' attribute, or the zero value of the type if the attribute doesn't have a value.

URLs of the provider.

type OpenIDIdentityProviderBuilder ¶

type OpenIDIdentityProviderBuilder struct {
	// contains filtered or unexported fields
}

OpenIDIdentityProviderBuilder contains the data and logic needed to build 'open_ID_identity_provider' objects.

Details for `openid` identity providers.

func NewOpenIDIdentityProvider ¶

func NewOpenIDIdentityProvider() *OpenIDIdentityProviderBuilder

NewOpenIDIdentityProvider creates a new builder of 'open_ID_identity_provider' objects.

func (*OpenIDIdentityProviderBuilder) Build ¶

Build creates a 'open_ID_identity_provider' object using the configuration stored in the builder.

func (*OpenIDIdentityProviderBuilder) CA ¶

CA sets the value of the 'CA' attribute to the given value.

func (*OpenIDIdentityProviderBuilder) Claims ¶

Claims sets the value of the 'claims' attribute to the given value.

_OpenID_ identity provider claims.

func (*OpenIDIdentityProviderBuilder) ClientID ¶

ClientID sets the value of the 'client_ID' attribute to the given value.

func (*OpenIDIdentityProviderBuilder) ClientSecret ¶

ClientSecret sets the value of the 'client_secret' attribute to the given value.

func (*OpenIDIdentityProviderBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*OpenIDIdentityProviderBuilder) ExtraAuthorizeParameters ¶

func (b *OpenIDIdentityProviderBuilder) ExtraAuthorizeParameters(value map[string]string) *OpenIDIdentityProviderBuilder

ExtraAuthorizeParameters sets the value of the 'extra_authorize_parameters' attribute to the given value.

func (*OpenIDIdentityProviderBuilder) ExtraScopes ¶

ExtraScopes sets the value of the 'extra_scopes' attribute to the given values.

func (*OpenIDIdentityProviderBuilder) URLS ¶ added in v0.1.32

URLS sets the value of the 'URLS' attribute to the given value.

_OpenID_ identity provider URLs.

type OpenIDIdentityProviderList ¶

type OpenIDIdentityProviderList struct {
	// contains filtered or unexported fields
}

OpenIDIdentityProviderList is a list of values of the 'open_ID_identity_provider' type.

func UnmarshalOpenIDIdentityProviderList ¶

func UnmarshalOpenIDIdentityProviderList(source interface{}) (list *OpenIDIdentityProviderList, err error)

UnmarshalOpenIDIdentityProviderList reads a list of values of the 'open_ID_identity_provider' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*OpenIDIdentityProviderList) Each ¶

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*OpenIDIdentityProviderList) Empty ¶

func (l *OpenIDIdentityProviderList) Empty() bool

Empty returns true if the list is empty.

func (*OpenIDIdentityProviderList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*OpenIDIdentityProviderList) Len ¶

Len returns the length of the list.

func (*OpenIDIdentityProviderList) Range ¶

func (l *OpenIDIdentityProviderList) Range(f func(index int, item *OpenIDIdentityProvider) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*OpenIDIdentityProviderList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type OpenIDIdentityProviderListBuilder ¶

type OpenIDIdentityProviderListBuilder struct {
	// contains filtered or unexported fields
}

OpenIDIdentityProviderListBuilder contains the data and logic needed to build 'open_ID_identity_provider' objects.

func NewOpenIDIdentityProviderList ¶

func NewOpenIDIdentityProviderList() *OpenIDIdentityProviderListBuilder

NewOpenIDIdentityProviderList creates a new builder of 'open_ID_identity_provider' objects.

func (*OpenIDIdentityProviderListBuilder) Build ¶

Build creates a list of 'open_ID_identity_provider' objects using the configuration stored in the builder.

func (*OpenIDIdentityProviderListBuilder) Items ¶

Items sets the items of the list.

type OpenIDURLs ¶ added in v0.1.32

type OpenIDURLs struct {
	// contains filtered or unexported fields
}

OpenIDURLs represents the values of the 'open_IDURLs' type.

_OpenID_ identity provider URLs.

func UnmarshalOpenIDURLs ¶ added in v0.1.32

func UnmarshalOpenIDURLs(source interface{}) (object *OpenIDURLs, err error)

UnmarshalOpenIDURLs reads a value of the 'open_IDURLs' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*OpenIDURLs) Authorize ¶ added in v0.1.32

func (o *OpenIDURLs) Authorize() string

Authorize returns the value of the 'authorize' attribute, or the zero value of the type if the attribute doesn't have a value.

Authorization endpoint described in the _OpenID_ specification. Must use HTTPS.

func (*OpenIDURLs) Empty ¶ added in v0.1.32

func (o *OpenIDURLs) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*OpenIDURLs) GetAuthorize ¶ added in v0.1.32

func (o *OpenIDURLs) GetAuthorize() (value string, ok bool)

GetAuthorize returns the value of the 'authorize' attribute and a flag indicating if the attribute has a value.

Authorization endpoint described in the _OpenID_ specification. Must use HTTPS.

func (*OpenIDURLs) GetToken ¶ added in v0.1.32

func (o *OpenIDURLs) GetToken() (value string, ok bool)

GetToken returns the value of the 'token' attribute and a flag indicating if the attribute has a value.

Token endpoint described in the _OpenID_ specification. Must use HTTPS.

func (*OpenIDURLs) GetUserInfo ¶ added in v0.1.32

func (o *OpenIDURLs) GetUserInfo() (value string, ok bool)

GetUserInfo returns the value of the 'user_info' attribute and a flag indicating if the attribute has a value.

User information endpoint described in the _OpenID_ specification. Must use HTTPS.

func (*OpenIDURLs) Token ¶ added in v0.1.32

func (o *OpenIDURLs) Token() string

Token returns the value of the 'token' attribute, or the zero value of the type if the attribute doesn't have a value.

Token endpoint described in the _OpenID_ specification. Must use HTTPS.

func (*OpenIDURLs) UserInfo ¶ added in v0.1.32

func (o *OpenIDURLs) UserInfo() string

UserInfo returns the value of the 'user_info' attribute, or the zero value of the type if the attribute doesn't have a value.

User information endpoint described in the _OpenID_ specification. Must use HTTPS.

type OpenIDURLsBuilder ¶ added in v0.1.32

type OpenIDURLsBuilder struct {
	// contains filtered or unexported fields
}

OpenIDURLsBuilder contains the data and logic needed to build 'open_IDURLs' objects.

_OpenID_ identity provider URLs.

func NewOpenIDURLs ¶ added in v0.1.32

func NewOpenIDURLs() *OpenIDURLsBuilder

NewOpenIDURLs creates a new builder of 'open_IDURLs' objects.

func (*OpenIDURLsBuilder) Authorize ¶ added in v0.1.32

func (b *OpenIDURLsBuilder) Authorize(value string) *OpenIDURLsBuilder

Authorize sets the value of the 'authorize' attribute to the given value.

func (*OpenIDURLsBuilder) Build ¶ added in v0.1.32

func (b *OpenIDURLsBuilder) Build() (object *OpenIDURLs, err error)

Build creates a 'open_IDURLs' object using the configuration stored in the builder.

func (*OpenIDURLsBuilder) Copy ¶ added in v0.1.36

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*OpenIDURLsBuilder) Token ¶ added in v0.1.32

func (b *OpenIDURLsBuilder) Token(value string) *OpenIDURLsBuilder

Token sets the value of the 'token' attribute to the given value.

func (*OpenIDURLsBuilder) UserInfo ¶ added in v0.1.32

func (b *OpenIDURLsBuilder) UserInfo(value string) *OpenIDURLsBuilder

UserInfo sets the value of the 'user_info' attribute to the given value.

type OpenIDURLsList ¶ added in v0.1.32

type OpenIDURLsList struct {
	// contains filtered or unexported fields
}

OpenIDURLsList is a list of values of the 'open_IDURLs' type.

func UnmarshalOpenIDURLsList ¶ added in v0.1.32

func UnmarshalOpenIDURLsList(source interface{}) (list *OpenIDURLsList, err error)

UnmarshalOpenIDURLsList reads a list of values of the 'open_IDURLs' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*OpenIDURLsList) Each ¶ added in v0.1.32

func (l *OpenIDURLsList) Each(f func(item *OpenIDURLs) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*OpenIDURLsList) Empty ¶ added in v0.1.32

func (l *OpenIDURLsList) Empty() bool

Empty returns true if the list is empty.

func (*OpenIDURLsList) Get ¶ added in v0.1.32

func (l *OpenIDURLsList) Get(i int) *OpenIDURLs

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*OpenIDURLsList) Len ¶ added in v0.1.32

func (l *OpenIDURLsList) Len() int

Len returns the length of the list.

func (*OpenIDURLsList) Range ¶ added in v0.1.32

func (l *OpenIDURLsList) Range(f func(index int, item *OpenIDURLs) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*OpenIDURLsList) Slice ¶ added in v0.1.32

func (l *OpenIDURLsList) Slice() []*OpenIDURLs

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type OpenIDURLsListBuilder ¶ added in v0.1.32

type OpenIDURLsListBuilder struct {
	// contains filtered or unexported fields
}

OpenIDURLsListBuilder contains the data and logic needed to build 'open_IDURLs' objects.

func NewOpenIDURLsList ¶ added in v0.1.32

func NewOpenIDURLsList() *OpenIDURLsListBuilder

NewOpenIDURLsList creates a new builder of 'open_IDURLs' objects.

func (*OpenIDURLsListBuilder) Build ¶ added in v0.1.32

func (b *OpenIDURLsListBuilder) Build() (list *OpenIDURLsList, err error)

Build creates a list of 'open_IDURLs' objects using the configuration stored in the builder.

func (*OpenIDURLsListBuilder) Items ¶ added in v0.1.32

Items sets the items of the list.

type SSHCredentials ¶

type SSHCredentials struct {
	// contains filtered or unexported fields
}

SSHCredentials represents the values of the 'SSH_credentials' type.

SSH key pair of a cluster.

func UnmarshalSSHCredentials ¶

func UnmarshalSSHCredentials(source interface{}) (object *SSHCredentials, err error)

UnmarshalSSHCredentials reads a value of the 'SSH_credentials' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*SSHCredentials) Empty ¶

func (o *SSHCredentials) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*SSHCredentials) GetPrivateKey ¶

func (o *SSHCredentials) GetPrivateKey() (value string, ok bool)

GetPrivateKey returns the value of the 'private_key' attribute and a flag indicating if the attribute has a value.

SSH private key of the cluster.

func (*SSHCredentials) GetPublicKey ¶

func (o *SSHCredentials) GetPublicKey() (value string, ok bool)

GetPublicKey returns the value of the 'public_key' attribute and a flag indicating if the attribute has a value.

SSH public key of the cluster.

func (*SSHCredentials) PrivateKey ¶

func (o *SSHCredentials) PrivateKey() string

PrivateKey returns the value of the 'private_key' attribute, or the zero value of the type if the attribute doesn't have a value.

SSH private key of the cluster.

func (*SSHCredentials) PublicKey ¶

func (o *SSHCredentials) PublicKey() string

PublicKey returns the value of the 'public_key' attribute, or the zero value of the type if the attribute doesn't have a value.

SSH public key of the cluster.

type SSHCredentialsBuilder ¶

type SSHCredentialsBuilder struct {
	// contains filtered or unexported fields
}

SSHCredentialsBuilder contains the data and logic needed to build 'SSH_credentials' objects.

SSH key pair of a cluster.

func NewSSHCredentials ¶

func NewSSHCredentials() *SSHCredentialsBuilder

NewSSHCredentials creates a new builder of 'SSH_credentials' objects.

func (*SSHCredentialsBuilder) Build ¶

func (b *SSHCredentialsBuilder) Build() (object *SSHCredentials, err error)

Build creates a 'SSH_credentials' object using the configuration stored in the builder.

func (*SSHCredentialsBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*SSHCredentialsBuilder) PrivateKey ¶

func (b *SSHCredentialsBuilder) PrivateKey(value string) *SSHCredentialsBuilder

PrivateKey sets the value of the 'private_key' attribute to the given value.

func (*SSHCredentialsBuilder) PublicKey ¶

func (b *SSHCredentialsBuilder) PublicKey(value string) *SSHCredentialsBuilder

PublicKey sets the value of the 'public_key' attribute to the given value.

type SSHCredentialsList ¶

type SSHCredentialsList struct {
	// contains filtered or unexported fields
}

SSHCredentialsList is a list of values of the 'SSH_credentials' type.

func UnmarshalSSHCredentialsList ¶

func UnmarshalSSHCredentialsList(source interface{}) (list *SSHCredentialsList, err error)

UnmarshalSSHCredentialsList reads a list of values of the 'SSH_credentials' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*SSHCredentialsList) Each ¶

func (l *SSHCredentialsList) Each(f func(item *SSHCredentials) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*SSHCredentialsList) Empty ¶

func (l *SSHCredentialsList) Empty() bool

Empty returns true if the list is empty.

func (*SSHCredentialsList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*SSHCredentialsList) Len ¶

func (l *SSHCredentialsList) Len() int

Len returns the length of the list.

func (*SSHCredentialsList) Range ¶

func (l *SSHCredentialsList) Range(f func(index int, item *SSHCredentials) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*SSHCredentialsList) Slice ¶

func (l *SSHCredentialsList) Slice() []*SSHCredentials

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type SSHCredentialsListBuilder ¶

type SSHCredentialsListBuilder struct {
	// contains filtered or unexported fields
}

SSHCredentialsListBuilder contains the data and logic needed to build 'SSH_credentials' objects.

func NewSSHCredentialsList ¶

func NewSSHCredentialsList() *SSHCredentialsListBuilder

NewSSHCredentialsList creates a new builder of 'SSH_credentials' objects.

func (*SSHCredentialsListBuilder) Build ¶

func (b *SSHCredentialsListBuilder) Build() (list *SSHCredentialsList, err error)

Build creates a list of 'SSH_credentials' objects using the configuration stored in the builder.

func (*SSHCredentialsListBuilder) Items ¶

Items sets the items of the list.

type Sample ¶

type Sample struct {
	// contains filtered or unexported fields
}

Sample represents the values of the 'sample' type.

Sample of a metric.

func UnmarshalSample ¶

func UnmarshalSample(source interface{}) (object *Sample, err error)

UnmarshalSample reads a value of the 'sample' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Sample) Empty ¶

func (o *Sample) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Sample) GetTime ¶

func (o *Sample) GetTime() (value time.Time, ok bool)

GetTime returns the value of the 'time' attribute and a flag indicating if the attribute has a value.

Time when the sample was obtained.

func (*Sample) GetValue ¶

func (o *Sample) GetValue() (value float64, ok bool)

GetValue returns the value of the 'value' attribute and a flag indicating if the attribute has a value.

Numeric value of the sample.

func (*Sample) Time ¶

func (o *Sample) Time() time.Time

Time returns the value of the 'time' attribute, or the zero value of the type if the attribute doesn't have a value.

Time when the sample was obtained.

func (*Sample) Value ¶

func (o *Sample) Value() float64

Value returns the value of the 'value' attribute, or the zero value of the type if the attribute doesn't have a value.

Numeric value of the sample.

type SampleBuilder ¶

type SampleBuilder struct {
	// contains filtered or unexported fields
}

SampleBuilder contains the data and logic needed to build 'sample' objects.

Sample of a metric.

func NewSample ¶

func NewSample() *SampleBuilder

NewSample creates a new builder of 'sample' objects.

func (*SampleBuilder) Build ¶

func (b *SampleBuilder) Build() (object *Sample, err error)

Build creates a 'sample' object using the configuration stored in the builder.

func (*SampleBuilder) Copy ¶

func (b *SampleBuilder) Copy(object *Sample) *SampleBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*SampleBuilder) Time ¶

func (b *SampleBuilder) Time(value time.Time) *SampleBuilder

Time sets the value of the 'time' attribute to the given value.

func (*SampleBuilder) Value ¶

func (b *SampleBuilder) Value(value float64) *SampleBuilder

Value sets the value of the 'value' attribute to the given value.

type SampleList ¶

type SampleList struct {
	// contains filtered or unexported fields
}

SampleList is a list of values of the 'sample' type.

func UnmarshalSampleList ¶

func UnmarshalSampleList(source interface{}) (list *SampleList, err error)

UnmarshalSampleList reads a list of values of the 'sample' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*SampleList) Each ¶

func (l *SampleList) Each(f func(item *Sample) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*SampleList) Empty ¶

func (l *SampleList) Empty() bool

Empty returns true if the list is empty.

func (*SampleList) Get ¶

func (l *SampleList) Get(i int) *Sample

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*SampleList) Len ¶

func (l *SampleList) Len() int

Len returns the length of the list.

func (*SampleList) Range ¶

func (l *SampleList) Range(f func(index int, item *Sample) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*SampleList) Slice ¶

func (l *SampleList) Slice() []*Sample

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type SampleListBuilder ¶

type SampleListBuilder struct {
	// contains filtered or unexported fields
}

SampleListBuilder contains the data and logic needed to build 'sample' objects.

func NewSampleList ¶

func NewSampleList() *SampleListBuilder

NewSampleList creates a new builder of 'sample' objects.

func (*SampleListBuilder) Build ¶

func (b *SampleListBuilder) Build() (list *SampleList, err error)

Build creates a list of 'sample' objects using the configuration stored in the builder.

func (*SampleListBuilder) Items ¶

func (b *SampleListBuilder) Items(values ...*SampleBuilder) *SampleListBuilder

Items sets the items of the list.

type Server ¶

type Server interface {

	// Addons returns the target 'add_ons' resource.
	//
	// Reference to the resource that manages the collection of add-ons.
	Addons() AddOnsServer

	// CloudProviders returns the target 'cloud_providers' resource.
	//
	// Reference to the resource that manages the collection of cloud providers.
	CloudProviders() CloudProvidersServer

	// Clusters returns the target 'clusters' resource.
	//
	// Reference to the resource that manages the collection of clusters.
	Clusters() ClustersServer

	// Dashboards returns the target 'dashboards' resource.
	//
	// Reference to the resource that manages the collection of dashboards.
	Dashboards() DashboardsServer

	// Flavours returns the target 'flavours' resource.
	//
	// Reference to the service that manages the collection of flavours.
	Flavours() FlavoursServer

	// Versions returns the target 'versions' resource.
	//
	// Reference to the resource that manage the collection of versions.
	Versions() VersionsServer
}

Server represents the interface the manages the 'root' resource.

type SocketTotalByNodeRolesOSMetricQueryClient ¶

type SocketTotalByNodeRolesOSMetricQueryClient struct {
	// contains filtered or unexported fields
}

SocketTotalByNodeRolesOSMetricQueryClient is the client of the 'socket_total_by_node_roles_OS_metric_query' resource.

Total socket capacity in the cluster by node role and operating system.

func NewSocketTotalByNodeRolesOSMetricQueryClient ¶

func NewSocketTotalByNodeRolesOSMetricQueryClient(transport http.RoundTripper, path string, metric string) *SocketTotalByNodeRolesOSMetricQueryClient

NewSocketTotalByNodeRolesOSMetricQueryClient creates a new client for the 'socket_total_by_node_roles_OS_metric_query' resource using the given transport to sned the requests and receive the responses.

func (*SocketTotalByNodeRolesOSMetricQueryClient) Get ¶

Get creates a request for the 'get' method.

Retrieves the metrics.

func (*SocketTotalByNodeRolesOSMetricQueryClient) Poll ¶

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type SocketTotalByNodeRolesOSMetricQueryGetRequest ¶

type SocketTotalByNodeRolesOSMetricQueryGetRequest struct {
	// contains filtered or unexported fields
}

SocketTotalByNodeRolesOSMetricQueryGetRequest is the request for the 'get' method.

func (*SocketTotalByNodeRolesOSMetricQueryGetRequest) Header ¶

Header adds a request header.

func (*SocketTotalByNodeRolesOSMetricQueryGetRequest) Parameter ¶

Parameter adds a query parameter.

func (*SocketTotalByNodeRolesOSMetricQueryGetRequest) Send ¶

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*SocketTotalByNodeRolesOSMetricQueryGetRequest) SendContext ¶

SendContext sends this request, waits for the response, and returns it.

type SocketTotalByNodeRolesOSMetricQueryGetResponse ¶

type SocketTotalByNodeRolesOSMetricQueryGetResponse struct {
	// contains filtered or unexported fields
}

SocketTotalByNodeRolesOSMetricQueryGetResponse is the response for the 'get' method.

func (*SocketTotalByNodeRolesOSMetricQueryGetResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*SocketTotalByNodeRolesOSMetricQueryGetResponse) Error ¶

Error returns the response error.

func (*SocketTotalByNodeRolesOSMetricQueryGetResponse) GetBody ¶

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*SocketTotalByNodeRolesOSMetricQueryGetResponse) Header ¶

Header returns header of the response.

func (*SocketTotalByNodeRolesOSMetricQueryGetResponse) Status ¶

Status returns the response status code.

type SocketTotalByNodeRolesOSMetricQueryGetServerRequest ¶

type SocketTotalByNodeRolesOSMetricQueryGetServerRequest struct {
}

SocketTotalByNodeRolesOSMetricQueryGetServerRequest is the request for the 'get' method.

type SocketTotalByNodeRolesOSMetricQueryGetServerResponse ¶

type SocketTotalByNodeRolesOSMetricQueryGetServerResponse struct {
	// contains filtered or unexported fields
}

SocketTotalByNodeRolesOSMetricQueryGetServerResponse is the response for the 'get' method.

func (*SocketTotalByNodeRolesOSMetricQueryGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*SocketTotalByNodeRolesOSMetricQueryGetServerResponse) Status ¶

Status sets the status code.

type SocketTotalByNodeRolesOSMetricQueryPollRequest ¶

type SocketTotalByNodeRolesOSMetricQueryPollRequest struct {
	// contains filtered or unexported fields
}

SocketTotalByNodeRolesOSMetricQueryPollRequest is the request for the Poll method.

func (*SocketTotalByNodeRolesOSMetricQueryPollRequest) Header ¶

Header adds a request header to all the requests that will be used to retrieve the object.

func (*SocketTotalByNodeRolesOSMetricQueryPollRequest) Interval ¶

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*SocketTotalByNodeRolesOSMetricQueryPollRequest) Parameter ¶

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*SocketTotalByNodeRolesOSMetricQueryPollRequest) Predicate ¶

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*SocketTotalByNodeRolesOSMetricQueryPollRequest) StartContext ¶

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*SocketTotalByNodeRolesOSMetricQueryPollRequest) Status ¶

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type SocketTotalByNodeRolesOSMetricQueryPollResponse ¶

type SocketTotalByNodeRolesOSMetricQueryPollResponse struct {
	// contains filtered or unexported fields
}

SocketTotalByNodeRolesOSMetricQueryPollResponse is the response for the Poll method.

func (*SocketTotalByNodeRolesOSMetricQueryPollResponse) Body ¶

Body returns the value of the 'body' parameter.

func (*SocketTotalByNodeRolesOSMetricQueryPollResponse) Error ¶

Error returns the response error.

func (*SocketTotalByNodeRolesOSMetricQueryPollResponse) GetBody ¶

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*SocketTotalByNodeRolesOSMetricQueryPollResponse) Header ¶

Header returns header of the response.

func (*SocketTotalByNodeRolesOSMetricQueryPollResponse) Status ¶

Status returns the response status code.

type SocketTotalByNodeRolesOSMetricQueryServer ¶

type SocketTotalByNodeRolesOSMetricQueryServer interface {

	// Get handles a request for the 'get' method.
	//
	// Retrieves the metrics.
	Get(ctx context.Context, request *SocketTotalByNodeRolesOSMetricQueryGetServerRequest, response *SocketTotalByNodeRolesOSMetricQueryGetServerResponse) error
}

SocketTotalByNodeRolesOSMetricQueryServer represents the interface the manages the 'socket_total_by_node_roles_OS_metric_query' resource.

type SocketTotalNodeRoleOSMetricNode ¶

type SocketTotalNodeRoleOSMetricNode struct {
	// contains filtered or unexported fields
}

SocketTotalNodeRoleOSMetricNode represents the values of the 'socket_total_node_role_OS_metric_node' type.

Representation of information from telemetry about a the socket capacity by node role and OS.

func UnmarshalSocketTotalNodeRoleOSMetricNode ¶

func UnmarshalSocketTotalNodeRoleOSMetricNode(source interface{}) (object *SocketTotalNodeRoleOSMetricNode, err error)

UnmarshalSocketTotalNodeRoleOSMetricNode reads a value of the 'socket_total_node_role_OS_metric_node' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*SocketTotalNodeRoleOSMetricNode) Empty ¶

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*SocketTotalNodeRoleOSMetricNode) GetNodeRoles ¶

func (o *SocketTotalNodeRoleOSMetricNode) GetNodeRoles() (value []string, ok bool)

GetNodeRoles returns the value of the 'node_roles' attribute and a flag indicating if the attribute has a value.

Representation of the node role for a cluster.

func (*SocketTotalNodeRoleOSMetricNode) GetOperatingSystem ¶

func (o *SocketTotalNodeRoleOSMetricNode) GetOperatingSystem() (value string, ok bool)

GetOperatingSystem returns the value of the 'operating_system' attribute and a flag indicating if the attribute has a value.

The operating system.

func (*SocketTotalNodeRoleOSMetricNode) GetSocketTotal ¶

func (o *SocketTotalNodeRoleOSMetricNode) GetSocketTotal() (value float64, ok bool)

GetSocketTotal returns the value of the 'socket_total' attribute and a flag indicating if the attribute has a value.

The total socket capacity of nodes with this set of roles and operating system.

func (*SocketTotalNodeRoleOSMetricNode) GetTime ¶

func (o *SocketTotalNodeRoleOSMetricNode) GetTime() (value time.Time, ok bool)

GetTime returns the value of the 'time' attribute and a flag indicating if the attribute has a value.

func (*SocketTotalNodeRoleOSMetricNode) NodeRoles ¶

func (o *SocketTotalNodeRoleOSMetricNode) NodeRoles() []string

NodeRoles returns the value of the 'node_roles' attribute, or the zero value of the type if the attribute doesn't have a value.

Representation of the node role for a cluster.

func (*SocketTotalNodeRoleOSMetricNode) OperatingSystem ¶

func (o *SocketTotalNodeRoleOSMetricNode) OperatingSystem() string

OperatingSystem returns the value of the 'operating_system' attribute, or the zero value of the type if the attribute doesn't have a value.

The operating system.

func (*SocketTotalNodeRoleOSMetricNode) SocketTotal ¶

func (o *SocketTotalNodeRoleOSMetricNode) SocketTotal() float64

SocketTotal returns the value of the 'socket_total' attribute, or the zero value of the type if the attribute doesn't have a value.

The total socket capacity of nodes with this set of roles and operating system.

func (*SocketTotalNodeRoleOSMetricNode) Time ¶

Time returns the value of the 'time' attribute, or the zero value of the type if the attribute doesn't have a value.

type SocketTotalNodeRoleOSMetricNodeBuilder ¶

type SocketTotalNodeRoleOSMetricNodeBuilder struct {
	// contains filtered or unexported fields
}

SocketTotalNodeRoleOSMetricNodeBuilder contains the data and logic needed to build 'socket_total_node_role_OS_metric_node' objects.

Representation of information from telemetry about a the socket capacity by node role and OS.

func NewSocketTotalNodeRoleOSMetricNode ¶

func NewSocketTotalNodeRoleOSMetricNode() *SocketTotalNodeRoleOSMetricNodeBuilder

NewSocketTotalNodeRoleOSMetricNode creates a new builder of 'socket_total_node_role_OS_metric_node' objects.

func (*SocketTotalNodeRoleOSMetricNodeBuilder) Build ¶

Build creates a 'socket_total_node_role_OS_metric_node' object using the configuration stored in the builder.

func (*SocketTotalNodeRoleOSMetricNodeBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*SocketTotalNodeRoleOSMetricNodeBuilder) NodeRoles ¶

NodeRoles sets the value of the 'node_roles' attribute to the given values.

func (*SocketTotalNodeRoleOSMetricNodeBuilder) OperatingSystem ¶

OperatingSystem sets the value of the 'operating_system' attribute to the given value.

func (*SocketTotalNodeRoleOSMetricNodeBuilder) SocketTotal ¶

SocketTotal sets the value of the 'socket_total' attribute to the given value.

func (*SocketTotalNodeRoleOSMetricNodeBuilder) Time ¶

Time sets the value of the 'time' attribute to the given value.

type SocketTotalNodeRoleOSMetricNodeList ¶

type SocketTotalNodeRoleOSMetricNodeList struct {
	// contains filtered or unexported fields
}

SocketTotalNodeRoleOSMetricNodeList is a list of values of the 'socket_total_node_role_OS_metric_node' type.

func UnmarshalSocketTotalNodeRoleOSMetricNodeList ¶

func UnmarshalSocketTotalNodeRoleOSMetricNodeList(source interface{}) (list *SocketTotalNodeRoleOSMetricNodeList, err error)

UnmarshalSocketTotalNodeRoleOSMetricNodeList reads a list of values of the 'socket_total_node_role_OS_metric_node' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*SocketTotalNodeRoleOSMetricNodeList) Each ¶

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*SocketTotalNodeRoleOSMetricNodeList) Empty ¶

Empty returns true if the list is empty.

func (*SocketTotalNodeRoleOSMetricNodeList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*SocketTotalNodeRoleOSMetricNodeList) Len ¶

Len returns the length of the list.

func (*SocketTotalNodeRoleOSMetricNodeList) Range ¶

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*SocketTotalNodeRoleOSMetricNodeList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type SocketTotalNodeRoleOSMetricNodeListBuilder ¶

type SocketTotalNodeRoleOSMetricNodeListBuilder struct {
	// contains filtered or unexported fields
}

SocketTotalNodeRoleOSMetricNodeListBuilder contains the data and logic needed to build 'socket_total_node_role_OS_metric_node' objects.

func NewSocketTotalNodeRoleOSMetricNodeList ¶

func NewSocketTotalNodeRoleOSMetricNodeList() *SocketTotalNodeRoleOSMetricNodeListBuilder

NewSocketTotalNodeRoleOSMetricNodeList creates a new builder of 'socket_total_node_role_OS_metric_node' objects.

func (*SocketTotalNodeRoleOSMetricNodeListBuilder) Build ¶

Build creates a list of 'socket_total_node_role_OS_metric_node' objects using the configuration stored in the builder.

func (*SocketTotalNodeRoleOSMetricNodeListBuilder) Items ¶

Items sets the items of the list.

type SocketTotalsNodeRoleOSMetricNode ¶

type SocketTotalsNodeRoleOSMetricNode struct {
	// contains filtered or unexported fields
}

SocketTotalsNodeRoleOSMetricNode represents the values of the 'socket_totals_node_role_OS_metric_node' type.

Representation of information from telemetry about the socket capacity by node role and OS of a cluster.

func UnmarshalSocketTotalsNodeRoleOSMetricNode ¶

func UnmarshalSocketTotalsNodeRoleOSMetricNode(source interface{}) (object *SocketTotalsNodeRoleOSMetricNode, err error)

UnmarshalSocketTotalsNodeRoleOSMetricNode reads a value of the 'socket_totals_node_role_OS_metric_node' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*SocketTotalsNodeRoleOSMetricNode) Empty ¶

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*SocketTotalsNodeRoleOSMetricNode) GetSocketTotals ¶

GetSocketTotals returns the value of the 'socket_totals' attribute and a flag indicating if the attribute has a value.

func (*SocketTotalsNodeRoleOSMetricNode) SocketTotals ¶

SocketTotals returns the value of the 'socket_totals' attribute, or the zero value of the type if the attribute doesn't have a value.

type SocketTotalsNodeRoleOSMetricNodeBuilder ¶

type SocketTotalsNodeRoleOSMetricNodeBuilder struct {
	// contains filtered or unexported fields
}

SocketTotalsNodeRoleOSMetricNodeBuilder contains the data and logic needed to build 'socket_totals_node_role_OS_metric_node' objects.

Representation of information from telemetry about the socket capacity by node role and OS of a cluster.

func NewSocketTotalsNodeRoleOSMetricNode ¶

func NewSocketTotalsNodeRoleOSMetricNode() *SocketTotalsNodeRoleOSMetricNodeBuilder

NewSocketTotalsNodeRoleOSMetricNode creates a new builder of 'socket_totals_node_role_OS_metric_node' objects.

func (*SocketTotalsNodeRoleOSMetricNodeBuilder) Build ¶

Build creates a 'socket_totals_node_role_OS_metric_node' object using the configuration stored in the builder.

func (*SocketTotalsNodeRoleOSMetricNodeBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*SocketTotalsNodeRoleOSMetricNodeBuilder) SocketTotals ¶

SocketTotals sets the value of the 'socket_totals' attribute to the given values.

type SocketTotalsNodeRoleOSMetricNodeList ¶

type SocketTotalsNodeRoleOSMetricNodeList struct {
	// contains filtered or unexported fields
}

SocketTotalsNodeRoleOSMetricNodeList is a list of values of the 'socket_totals_node_role_OS_metric_node' type.

func UnmarshalSocketTotalsNodeRoleOSMetricNodeList ¶

func UnmarshalSocketTotalsNodeRoleOSMetricNodeList(source interface{}) (list *SocketTotalsNodeRoleOSMetricNodeList, err error)

UnmarshalSocketTotalsNodeRoleOSMetricNodeList reads a list of values of the 'socket_totals_node_role_OS_metric_node' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*SocketTotalsNodeRoleOSMetricNodeList) Each ¶

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*SocketTotalsNodeRoleOSMetricNodeList) Empty ¶

Empty returns true if the list is empty.

func (*SocketTotalsNodeRoleOSMetricNodeList) Get ¶

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*SocketTotalsNodeRoleOSMetricNodeList) Len ¶

Len returns the length of the list.

func (*SocketTotalsNodeRoleOSMetricNodeList) Range ¶

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*SocketTotalsNodeRoleOSMetricNodeList) Slice ¶

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type SocketTotalsNodeRoleOSMetricNodeListBuilder ¶

type SocketTotalsNodeRoleOSMetricNodeListBuilder struct {
	// contains filtered or unexported fields
}

SocketTotalsNodeRoleOSMetricNodeListBuilder contains the data and logic needed to build 'socket_totals_node_role_OS_metric_node' objects.

func NewSocketTotalsNodeRoleOSMetricNodeList ¶

func NewSocketTotalsNodeRoleOSMetricNodeList() *SocketTotalsNodeRoleOSMetricNodeListBuilder

NewSocketTotalsNodeRoleOSMetricNodeList creates a new builder of 'socket_totals_node_role_OS_metric_node' objects.

func (*SocketTotalsNodeRoleOSMetricNodeListBuilder) Build ¶

Build creates a list of 'socket_totals_node_role_OS_metric_node' objects using the configuration stored in the builder.

func (*SocketTotalsNodeRoleOSMetricNodeListBuilder) Items ¶

Items sets the items of the list.

type Subscription ¶

type Subscription struct {
	// contains filtered or unexported fields
}

Subscription represents the values of the 'subscription' type.

Definition of a subscription.

func UnmarshalSubscription ¶

func UnmarshalSubscription(source interface{}) (object *Subscription, err error)

UnmarshalSubscription reads a value of the 'subscription' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Subscription) Empty ¶

func (o *Subscription) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Subscription) GetHREF ¶

func (o *Subscription) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*Subscription) GetID ¶

func (o *Subscription) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*Subscription) HREF ¶

func (o *Subscription) HREF() string

HREF returns the link to the object.

func (*Subscription) ID ¶

func (o *Subscription) ID() string

ID returns the identifier of the object.

func (*Subscription) Kind ¶

func (o *Subscription) Kind() string

Kind returns the name of the type of the object.

func (o *Subscription) Link() bool

Link returns true iif this is a link.

type SubscriptionBuilder ¶

type SubscriptionBuilder struct {
	// contains filtered or unexported fields
}

SubscriptionBuilder contains the data and logic needed to build 'subscription' objects.

Definition of a subscription.

func NewSubscription ¶

func NewSubscription() *SubscriptionBuilder

NewSubscription creates a new builder of 'subscription' objects.

func (*SubscriptionBuilder) Build ¶

func (b *SubscriptionBuilder) Build() (object *Subscription, err error)

Build creates a 'subscription' object using the configuration stored in the builder.

func (*SubscriptionBuilder) Copy ¶

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*SubscriptionBuilder) HREF ¶

HREF sets the link to the object.

func (*SubscriptionBuilder) ID ¶

ID sets the identifier of the object.

Link sets the flag that indicates if this is a link.

type SubscriptionList ¶

type SubscriptionList struct {
	// contains filtered or unexported fields
}

SubscriptionList is a list of values of the 'subscription' type.

func UnmarshalSubscriptionList ¶

func UnmarshalSubscriptionList(source interface{}) (list *SubscriptionList, err error)

UnmarshalSubscriptionList reads a list of values of the 'subscription' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*SubscriptionList) Each ¶

func (l *SubscriptionList) Each(f func(item *Subscription) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*SubscriptionList) Empty ¶

func (l *SubscriptionList) Empty() bool

Empty returns true if the list is empty.

func (*SubscriptionList) Get ¶

func (l *SubscriptionList) Get(i int) *Subscription

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*SubscriptionList) GetHREF ¶

func (l *SubscriptionList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*SubscriptionList) HREF ¶

func (l *SubscriptionList) HREF() string

HREF returns the link to the list.

func (*SubscriptionList) Kind ¶

func (l *SubscriptionList) Kind() string

Kind returns the name of the type of the object.

func (*SubscriptionList) Len ¶

func (l *SubscriptionList) Len() int

Len returns the length of the list.

func (l *SubscriptionList) Link() bool

Link returns true iif this is a link.

func (*SubscriptionList) Range ¶

func (l *SubscriptionList) Range(f func(index int, item *Subscription) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*SubscriptionList) Slice ¶

func (l *SubscriptionList) Slice() []*Subscription

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type SubscriptionListBuilder ¶

type SubscriptionListBuilder struct {
	// contains filtered or unexported fields
}

SubscriptionListBuilder contains the data and logic needed to build 'subscription' objects.

func NewSubscriptionList ¶

func NewSubscriptionList() *SubscriptionListBuilder

NewSubscriptionList creates a new builder of 'subscription' objects.

func (*SubscriptionListBuilder) Build ¶

func (b *SubscriptionListBuilder) Build() (list *SubscriptionList, err error)

Build creates a list of 'subscription' objects using the configuration stored in the builder.

func (*SubscriptionListBuilder) Items ¶

Items sets the items of the list.

type User ¶

type User struct {
	// contains filtered or unexported fields
}

User represents the values of the 'user' type.

Representation of a user.

func UnmarshalUser ¶

func UnmarshalUser(source interface{}) (object *User, err error)

UnmarshalUser reads a value of the 'user' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*User) Empty ¶

func (o *User) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*User) GetHREF ¶

func (o *User) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*User) GetID ¶

func (o *User) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*User) HREF ¶

func (o *User) HREF() string

HREF returns the link to the object.

func (*User) ID ¶

func (o *User) ID() string

ID returns the identifier of the object.

func (*User) Kind ¶

func (o *User) Kind() string

Kind returns the name of the type of the object.

func (o *User) Link() bool

Link returns true iif this is a link.

type UserBuilder ¶

type UserBuilder struct {
	// contains filtered or unexported fields
}

UserBuilder contains the data and logic needed to build 'user' objects.

Representation of a user.

func NewUser ¶

func NewUser() *UserBuilder

NewUser creates a new builder of 'user' objects.

func (*UserBuilder) Build ¶

func (b *UserBuilder) Build() (object *User, err error)

Build creates a 'user' object using the configuration stored in the builder.

func (*UserBuilder) Copy ¶

func (b *UserBuilder) Copy(object *User) *UserBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*UserBuilder) HREF ¶

func (b *UserBuilder) HREF(value string) *UserBuilder

HREF sets the link to the object.

func (*UserBuilder) ID ¶

func (b *UserBuilder) ID(value string) *UserBuilder

ID sets the identifier of the object.

func (b *UserBuilder) Link(value bool) *UserBuilder

Link sets the flag that indicates if this is a link.

type UserClient ¶

type UserClient struct {
	// contains filtered or unexported fields
}

UserClient is the client of the 'user' resource.

Manages a specific user.

func NewUserClient ¶

func NewUserClient(transport http.RoundTripper, path string, metric string) *UserClient

NewUserClient creates a new client for the 'user' resource using the given transport to sned the requests and receive the responses.

func (*UserClient) Delete ¶

func (c *UserClient) Delete() *UserDeleteRequest

Delete creates a request for the 'delete' method.

Deletes the user.

func (*UserClient) Get ¶

func (c *UserClient) Get() *UserGetRequest

Get creates a request for the 'get' method.

Retrieves the details of the user.

func (*UserClient) Poll ¶

func (c *UserClient) Poll() *UserPollRequest

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type UserDeleteRequest ¶

type UserDeleteRequest struct {
	// contains filtered or unexported fields
}

UserDeleteRequest is the request for the 'delete' method.

func (*UserDeleteRequest) Header ¶

func (r *UserDeleteRequest) Header(name string, value interface{}) *UserDeleteRequest

Header adds a request header.

func (*UserDeleteRequest) Parameter ¶

func (r *UserDeleteRequest) Parameter(name string, value interface{}) *UserDeleteRequest

Parameter adds a query parameter.

func (*UserDeleteRequest) Send ¶

func (r *UserDeleteRequest) Send() (result *UserDeleteResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*UserDeleteRequest) SendContext ¶

func (r *UserDeleteRequest) SendContext(ctx context.Context) (result *UserDeleteResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type UserDeleteResponse ¶

type UserDeleteResponse struct {
	// contains filtered or unexported fields
}

UserDeleteResponse is the response for the 'delete' method.

func (*UserDeleteResponse) Error ¶

func (r *UserDeleteResponse) Error() *errors.Error

Error returns the response error.

func (*UserDeleteResponse) Header ¶

func (r *UserDeleteResponse) Header() http.Header

Header returns header of the response.

func (*UserDeleteResponse) Status ¶

func (r *UserDeleteResponse) Status() int

Status returns the response status code.

type UserDeleteServerRequest ¶

type UserDeleteServerRequest struct {
}

UserDeleteServerRequest is the request for the 'delete' method.

type UserDeleteServerResponse ¶

type UserDeleteServerResponse struct {
	// contains filtered or unexported fields
}

UserDeleteServerResponse is the response for the 'delete' method.

func (*UserDeleteServerResponse) Status ¶

Status sets the status code.

type UserGetRequest ¶

type UserGetRequest struct {
	// contains filtered or unexported fields
}

UserGetRequest is the request for the 'get' method.

func (*UserGetRequest) Header ¶

func (r *UserGetRequest) Header(name string, value interface{}) *UserGetRequest

Header adds a request header.

func (*UserGetRequest) Parameter ¶

func (r *UserGetRequest) Parameter(name string, value interface{}) *UserGetRequest

Parameter adds a query parameter.

func (*UserGetRequest) Send ¶

func (r *UserGetRequest) Send() (result *UserGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*UserGetRequest) SendContext ¶

func (r *UserGetRequest) SendContext(ctx context.Context) (result *UserGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type UserGetResponse ¶

type UserGetResponse struct {
	// contains filtered or unexported fields
}

UserGetResponse is the response for the 'get' method.

func (*UserGetResponse) Body ¶

func (r *UserGetResponse) Body() *User

Body returns the value of the 'body' parameter.

func (*UserGetResponse) Error ¶

func (r *UserGetResponse) Error() *errors.Error

Error returns the response error.

func (*UserGetResponse) GetBody ¶

func (r *UserGetResponse) GetBody() (value *User, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*UserGetResponse) Header ¶

func (r *UserGetResponse) Header() http.Header

Header returns header of the response.

func (*UserGetResponse) Status ¶

func (r *UserGetResponse) Status() int

Status returns the response status code.

type UserGetServerRequest ¶

type UserGetServerRequest struct {
}

UserGetServerRequest is the request for the 'get' method.

type UserGetServerResponse ¶

type UserGetServerResponse struct {
	// contains filtered or unexported fields
}

UserGetServerResponse is the response for the 'get' method.

func (*UserGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*UserGetServerResponse) Status ¶

Status sets the status code.

type UserList ¶

type UserList struct {
	// contains filtered or unexported fields
}

UserList is a list of values of the 'user' type.

func UnmarshalUserList ¶

func UnmarshalUserList(source interface{}) (list *UserList, err error)

UnmarshalUserList reads a list of values of the 'user' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*UserList) Each ¶

func (l *UserList) Each(f func(item *User) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*UserList) Empty ¶

func (l *UserList) Empty() bool

Empty returns true if the list is empty.

func (*UserList) Get ¶

func (l *UserList) Get(i int) *User

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*UserList) GetHREF ¶

func (l *UserList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*UserList) HREF ¶

func (l *UserList) HREF() string

HREF returns the link to the list.

func (*UserList) Kind ¶

func (l *UserList) Kind() string

Kind returns the name of the type of the object.

func (*UserList) Len ¶

func (l *UserList) Len() int

Len returns the length of the list.

func (l *UserList) Link() bool

Link returns true iif this is a link.

func (*UserList) Range ¶

func (l *UserList) Range(f func(index int, item *User) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*UserList) Slice ¶

func (l *UserList) Slice() []*User

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type UserListBuilder ¶

type UserListBuilder struct {
	// contains filtered or unexported fields
}

UserListBuilder contains the data and logic needed to build 'user' objects.

func NewUserList ¶

func NewUserList() *UserListBuilder

NewUserList creates a new builder of 'user' objects.

func (*UserListBuilder) Build ¶

func (b *UserListBuilder) Build() (list *UserList, err error)

Build creates a list of 'user' objects using the configuration stored in the builder.

func (*UserListBuilder) Items ¶

func (b *UserListBuilder) Items(values ...*UserBuilder) *UserListBuilder

Items sets the items of the list.

type UserPollRequest ¶

type UserPollRequest struct {
	// contains filtered or unexported fields
}

UserPollRequest is the request for the Poll method.

func (*UserPollRequest) Header ¶

func (r *UserPollRequest) Header(name string, value interface{}) *UserPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*UserPollRequest) Interval ¶

func (r *UserPollRequest) Interval(value time.Duration) *UserPollRequest

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*UserPollRequest) Parameter ¶

func (r *UserPollRequest) Parameter(name string, value interface{}) *UserPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*UserPollRequest) Predicate ¶

func (r *UserPollRequest) Predicate(value func(*UserGetResponse) bool) *UserPollRequest

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*UserPollRequest) StartContext ¶

func (r *UserPollRequest) StartContext(ctx context.Context) (response *UserPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*UserPollRequest) Status ¶

func (r *UserPollRequest) Status(value int) *UserPollRequest

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type UserPollResponse ¶

type UserPollResponse struct {
	// contains filtered or unexported fields
}

UserPollResponse is the response for the Poll method.

func (*UserPollResponse) Body ¶

func (r *UserPollResponse) Body() *User

Body returns the value of the 'body' parameter.

func (*UserPollResponse) Error ¶

func (r *UserPollResponse) Error() *errors.Error

Error returns the response error.

func (*UserPollResponse) GetBody ¶

func (r *UserPollResponse) GetBody() (value *User, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*UserPollResponse) Header ¶

func (r *UserPollResponse) Header() http.Header

Header returns header of the response.

func (*UserPollResponse) Status ¶

func (r *UserPollResponse) Status() int

Status returns the response status code.

type UserServer ¶

type UserServer interface {

	// Delete handles a request for the 'delete' method.
	//
	// Deletes the user.
	Delete(ctx context.Context, request *UserDeleteServerRequest, response *UserDeleteServerResponse) error

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the user.
	Get(ctx context.Context, request *UserGetServerRequest, response *UserGetServerResponse) error
}

UserServer represents the interface the manages the 'user' resource.

type UsersAddRequest ¶

type UsersAddRequest struct {
	// contains filtered or unexported fields
}

UsersAddRequest is the request for the 'add' method.

func (*UsersAddRequest) Body ¶

func (r *UsersAddRequest) Body(value *User) *UsersAddRequest

Body sets the value of the 'body' parameter.

Description of the user.

func (*UsersAddRequest) Header ¶

func (r *UsersAddRequest) Header(name string, value interface{}) *UsersAddRequest

Header adds a request header.

func (*UsersAddRequest) Parameter ¶

func (r *UsersAddRequest) Parameter(name string, value interface{}) *UsersAddRequest

Parameter adds a query parameter.

func (*UsersAddRequest) Send ¶

func (r *UsersAddRequest) Send() (result *UsersAddResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*UsersAddRequest) SendContext ¶

func (r *UsersAddRequest) SendContext(ctx context.Context) (result *UsersAddResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type UsersAddResponse ¶

type UsersAddResponse struct {
	// contains filtered or unexported fields
}

UsersAddResponse is the response for the 'add' method.

func (*UsersAddResponse) Body ¶

func (r *UsersAddResponse) Body() *User

Body returns the value of the 'body' parameter.

Description of the user.

func (*UsersAddResponse) Error ¶

func (r *UsersAddResponse) Error() *errors.Error

Error returns the response error.

func (*UsersAddResponse) GetBody ¶

func (r *UsersAddResponse) GetBody() (value *User, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

Description of the user.

func (*UsersAddResponse) Header ¶

func (r *UsersAddResponse) Header() http.Header

Header returns header of the response.

func (*UsersAddResponse) Status ¶

func (r *UsersAddResponse) Status() int

Status returns the response status code.

type UsersAddServerRequest ¶

type UsersAddServerRequest struct {
	// contains filtered or unexported fields
}

UsersAddServerRequest is the request for the 'add' method.

func (*UsersAddServerRequest) Body ¶

func (r *UsersAddServerRequest) Body() *User

Body returns the value of the 'body' parameter.

Description of the user.

func (*UsersAddServerRequest) GetBody ¶

func (r *UsersAddServerRequest) GetBody() (value *User, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

Description of the user.

type UsersAddServerResponse ¶

type UsersAddServerResponse struct {
	// contains filtered or unexported fields
}

UsersAddServerResponse is the response for the 'add' method.

func (*UsersAddServerResponse) Body ¶

Body sets the value of the 'body' parameter.

Description of the user.

func (*UsersAddServerResponse) Status ¶

Status sets the status code.

type UsersClient ¶

type UsersClient struct {
	// contains filtered or unexported fields
}

UsersClient is the client of the 'users' resource.

Manages the collection of users of a group.

func NewUsersClient ¶

func NewUsersClient(transport http.RoundTripper, path string, metric string) *UsersClient

NewUsersClient creates a new client for the 'users' resource using the given transport to sned the requests and receive the responses.

func (*UsersClient) Add ¶

func (c *UsersClient) Add() *UsersAddRequest

Add creates a request for the 'add' method.

Adds a new user to the group.

func (*UsersClient) List ¶

func (c *UsersClient) List() *UsersListRequest

List creates a request for the 'list' method.

Retrieves the list of users.

func (*UsersClient) User ¶

func (c *UsersClient) User(id string) *UserClient

User returns the target 'user' resource for the given identifier.

Reference to the service that manages an specific user.

type UsersListRequest ¶

type UsersListRequest struct {
	// contains filtered or unexported fields
}

UsersListRequest is the request for the 'list' method.

func (*UsersListRequest) Header ¶

func (r *UsersListRequest) Header(name string, value interface{}) *UsersListRequest

Header adds a request header.

func (*UsersListRequest) Page ¶

func (r *UsersListRequest) Page(value int) *UsersListRequest

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*UsersListRequest) Parameter ¶

func (r *UsersListRequest) Parameter(name string, value interface{}) *UsersListRequest

Parameter adds a query parameter.

func (*UsersListRequest) Send ¶

func (r *UsersListRequest) Send() (result *UsersListResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*UsersListRequest) SendContext ¶

func (r *UsersListRequest) SendContext(ctx context.Context) (result *UsersListResponse, err error)

SendContext sends this request, waits for the response, and returns it.

func (*UsersListRequest) Size ¶

func (r *UsersListRequest) Size(value int) *UsersListRequest

Size sets the value of the 'size' parameter.

Number of items contained in the returned page.

type UsersListResponse ¶

type UsersListResponse struct {
	// contains filtered or unexported fields
}

UsersListResponse is the response for the 'list' method.

func (*UsersListResponse) Error ¶

func (r *UsersListResponse) Error() *errors.Error

Error returns the response error.

func (*UsersListResponse) GetItems ¶

func (r *UsersListResponse) GetItems() (value *UserList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of users.

func (*UsersListResponse) GetPage ¶

func (r *UsersListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*UsersListResponse) GetSize ¶

func (r *UsersListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Number of items contained in the returned page.

func (*UsersListResponse) GetTotal ¶

func (r *UsersListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection.

func (*UsersListResponse) Header ¶

func (r *UsersListResponse) Header() http.Header

Header returns header of the response.

func (*UsersListResponse) Items ¶

func (r *UsersListResponse) Items() *UserList

Items returns the value of the 'items' parameter.

Retrieved list of users.

func (*UsersListResponse) Page ¶

func (r *UsersListResponse) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*UsersListResponse) Size ¶

func (r *UsersListResponse) Size() int

Size returns the value of the 'size' parameter.

Number of items contained in the returned page.

func (*UsersListResponse) Status ¶

func (r *UsersListResponse) Status() int

Status returns the response status code.

func (*UsersListResponse) Total ¶

func (r *UsersListResponse) Total() int

Total returns the value of the 'total' parameter.

Total number of items of the collection.

type UsersListServerRequest ¶

type UsersListServerRequest struct {
	// contains filtered or unexported fields
}

UsersListServerRequest is the request for the 'list' method.

func (*UsersListServerRequest) GetPage ¶

func (r *UsersListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*UsersListServerRequest) GetSize ¶

func (r *UsersListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Number of items contained in the returned page.

func (*UsersListServerRequest) Page ¶

func (r *UsersListServerRequest) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*UsersListServerRequest) Size ¶

func (r *UsersListServerRequest) Size() int

Size returns the value of the 'size' parameter.

Number of items contained in the returned page.

type UsersListServerResponse ¶

type UsersListServerResponse struct {
	// contains filtered or unexported fields
}

UsersListServerResponse is the response for the 'list' method.

func (*UsersListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of users.

func (*UsersListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*UsersListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Number of items contained in the returned page.

func (*UsersListServerResponse) Status ¶

Status sets the status code.

func (*UsersListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection.

type UsersServer ¶

type UsersServer interface {

	// Add handles a request for the 'add' method.
	//
	// Adds a new user to the group.
	Add(ctx context.Context, request *UsersAddServerRequest, response *UsersAddServerResponse) error

	// List handles a request for the 'list' method.
	//
	// Retrieves the list of users.
	List(ctx context.Context, request *UsersListServerRequest, response *UsersListServerResponse) error

	// User returns the target 'user' server for the given identifier.
	//
	// Reference to the service that manages an specific user.
	User(id string) UserServer
}

UsersServer represents the interface the manages the 'users' resource.

type Value ¶

type Value struct {
	// contains filtered or unexported fields
}

Value represents the values of the 'value' type.

Numeric value and the unit used to measure it.

Units are not mandatory, and they're not specified for some resources. For resources that use bytes, the accepted units are:

- 1 B = 1 byte - 1 KB = 10^3 bytes - 1 MB = 10^6 bytes - 1 GB = 10^9 bytes - 1 TB = 10^12 bytes - 1 PB = 10^15 bytes

- 1 B = 1 byte - 1 KiB = 2^10 bytes - 1 MiB = 2^20 bytes - 1 GiB = 2^30 bytes - 1 TiB = 2^40 bytes - 1 PiB = 2^50 bytes

func UnmarshalValue ¶

func UnmarshalValue(source interface{}) (object *Value, err error)

UnmarshalValue reads a value of the 'value' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Value) Empty ¶

func (o *Value) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Value) GetUnit ¶

func (o *Value) GetUnit() (value string, ok bool)

GetUnit returns the value of the 'unit' attribute and a flag indicating if the attribute has a value.

Name of the unit used to measure the value.

func (*Value) GetValue ¶

func (o *Value) GetValue() (value float64, ok bool)

GetValue returns the value of the 'value' attribute and a flag indicating if the attribute has a value.

Numeric value.

func (*Value) Unit ¶

func (o *Value) Unit() string

Unit returns the value of the 'unit' attribute, or the zero value of the type if the attribute doesn't have a value.

Name of the unit used to measure the value.

func (*Value) Value ¶

func (o *Value) Value() float64

Value returns the value of the 'value' attribute, or the zero value of the type if the attribute doesn't have a value.

Numeric value.

type ValueBuilder ¶

type ValueBuilder struct {
	// contains filtered or unexported fields
}

ValueBuilder contains the data and logic needed to build 'value' objects.

Numeric value and the unit used to measure it.

Units are not mandatory, and they're not specified for some resources. For resources that use bytes, the accepted units are:

- 1 B = 1 byte - 1 KB = 10^3 bytes - 1 MB = 10^6 bytes - 1 GB = 10^9 bytes - 1 TB = 10^12 bytes - 1 PB = 10^15 bytes

- 1 B = 1 byte - 1 KiB = 2^10 bytes - 1 MiB = 2^20 bytes - 1 GiB = 2^30 bytes - 1 TiB = 2^40 bytes - 1 PiB = 2^50 bytes

func NewValue ¶

func NewValue() *ValueBuilder

NewValue creates a new builder of 'value' objects.

func (*ValueBuilder) Build ¶

func (b *ValueBuilder) Build() (object *Value, err error)

Build creates a 'value' object using the configuration stored in the builder.

func (*ValueBuilder) Copy ¶

func (b *ValueBuilder) Copy(object *Value) *ValueBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*ValueBuilder) Unit ¶

func (b *ValueBuilder) Unit(value string) *ValueBuilder

Unit sets the value of the 'unit' attribute to the given value.

func (*ValueBuilder) Value ¶

func (b *ValueBuilder) Value(value float64) *ValueBuilder

Value sets the value of the 'value' attribute to the given value.

type ValueList ¶

type ValueList struct {
	// contains filtered or unexported fields
}

ValueList is a list of values of the 'value' type.

func UnmarshalValueList ¶

func UnmarshalValueList(source interface{}) (list *ValueList, err error)

UnmarshalValueList reads a list of values of the 'value' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*ValueList) Each ¶

func (l *ValueList) Each(f func(item *Value) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ValueList) Empty ¶

func (l *ValueList) Empty() bool

Empty returns true if the list is empty.

func (*ValueList) Get ¶

func (l *ValueList) Get(i int) *Value

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*ValueList) Len ¶

func (l *ValueList) Len() int

Len returns the length of the list.

func (*ValueList) Range ¶

func (l *ValueList) Range(f func(index int, item *Value) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*ValueList) Slice ¶

func (l *ValueList) Slice() []*Value

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type ValueListBuilder ¶

type ValueListBuilder struct {
	// contains filtered or unexported fields
}

ValueListBuilder contains the data and logic needed to build 'value' objects.

func NewValueList ¶

func NewValueList() *ValueListBuilder

NewValueList creates a new builder of 'value' objects.

func (*ValueListBuilder) Build ¶

func (b *ValueListBuilder) Build() (list *ValueList, err error)

Build creates a list of 'value' objects using the configuration stored in the builder.

func (*ValueListBuilder) Items ¶

func (b *ValueListBuilder) Items(values ...*ValueBuilder) *ValueListBuilder

Items sets the items of the list.

type Version ¶

type Version struct {
	// contains filtered or unexported fields
}

Version represents the values of the 'version' type.

Representation of an _OpenShift_ version.

func UnmarshalVersion ¶

func UnmarshalVersion(source interface{}) (object *Version, err error)

UnmarshalVersion reads a value of the 'version' type from the given source, which can be an slice of bytes, a string, a reader or a JSON decoder.

func (*Version) Default ¶

func (o *Version) Default() bool

Default returns the value of the 'default' attribute, or the zero value of the type if the attribute doesn't have a value.

Indicates if this should be selected as the default version when a cluster is created without specifying explicitly the version.

func (*Version) Empty ¶

func (o *Version) Empty() bool

Empty returns true if the object is empty, i.e. no attribute has a value.

func (*Version) Enabled ¶

func (o *Version) Enabled() bool

Enabled returns the value of the 'enabled' attribute, or the zero value of the type if the attribute doesn't have a value.

Indicates if this version can be used to create clusters.

func (*Version) GetDefault ¶

func (o *Version) GetDefault() (value bool, ok bool)

GetDefault returns the value of the 'default' attribute and a flag indicating if the attribute has a value.

Indicates if this should be selected as the default version when a cluster is created without specifying explicitly the version.

func (*Version) GetEnabled ¶

func (o *Version) GetEnabled() (value bool, ok bool)

GetEnabled returns the value of the 'enabled' attribute and a flag indicating if the attribute has a value.

Indicates if this version can be used to create clusters.

func (*Version) GetHREF ¶

func (o *Version) GetHREF() (value string, ok bool)

GetHREF returns the link of the object and a flag indicating if the link has a value.

func (*Version) GetID ¶

func (o *Version) GetID() (value string, ok bool)

GetID returns the identifier of the object and a flag indicating if the identifier has a value.

func (*Version) HREF ¶

func (o *Version) HREF() string

HREF returns the link to the object.

func (*Version) ID ¶

func (o *Version) ID() string

ID returns the identifier of the object.

func (*Version) Kind ¶

func (o *Version) Kind() string

Kind returns the name of the type of the object.

func (o *Version) Link() bool

Link returns true iif this is a link.

type VersionBuilder ¶

type VersionBuilder struct {
	// contains filtered or unexported fields
}

VersionBuilder contains the data and logic needed to build 'version' objects.

Representation of an _OpenShift_ version.

func NewVersion ¶

func NewVersion() *VersionBuilder

NewVersion creates a new builder of 'version' objects.

func (*VersionBuilder) Build ¶

func (b *VersionBuilder) Build() (object *Version, err error)

Build creates a 'version' object using the configuration stored in the builder.

func (*VersionBuilder) Copy ¶

func (b *VersionBuilder) Copy(object *Version) *VersionBuilder

Copy copies the attributes of the given object into this builder, discarding any previous values.

func (*VersionBuilder) Default ¶

func (b *VersionBuilder) Default(value bool) *VersionBuilder

Default sets the value of the 'default' attribute to the given value.

func (*VersionBuilder) Enabled ¶

func (b *VersionBuilder) Enabled(value bool) *VersionBuilder

Enabled sets the value of the 'enabled' attribute to the given value.

func (*VersionBuilder) HREF ¶

func (b *VersionBuilder) HREF(value string) *VersionBuilder

HREF sets the link to the object.

func (*VersionBuilder) ID ¶

func (b *VersionBuilder) ID(value string) *VersionBuilder

ID sets the identifier of the object.

func (b *VersionBuilder) Link(value bool) *VersionBuilder

Link sets the flag that indicates if this is a link.

type VersionClient ¶

type VersionClient struct {
	// contains filtered or unexported fields
}

VersionClient is the client of the 'version' resource.

Manages a specific version.

func NewVersionClient ¶

func NewVersionClient(transport http.RoundTripper, path string, metric string) *VersionClient

NewVersionClient creates a new client for the 'version' resource using the given transport to sned the requests and receive the responses.

func (*VersionClient) Get ¶

func (c *VersionClient) Get() *VersionGetRequest

Get creates a request for the 'get' method.

Retrieves the details of the version.

func (*VersionClient) Poll ¶

func (c *VersionClient) Poll() *VersionPollRequest

Poll creates a request to repeatedly retrieve the object till the response has one of a given set of states and satisfies a set of predicates.

type VersionGetRequest ¶

type VersionGetRequest struct {
	// contains filtered or unexported fields
}

VersionGetRequest is the request for the 'get' method.

func (*VersionGetRequest) Header ¶

func (r *VersionGetRequest) Header(name string, value interface{}) *VersionGetRequest

Header adds a request header.

func (*VersionGetRequest) Parameter ¶

func (r *VersionGetRequest) Parameter(name string, value interface{}) *VersionGetRequest

Parameter adds a query parameter.

func (*VersionGetRequest) Send ¶

func (r *VersionGetRequest) Send() (result *VersionGetResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*VersionGetRequest) SendContext ¶

func (r *VersionGetRequest) SendContext(ctx context.Context) (result *VersionGetResponse, err error)

SendContext sends this request, waits for the response, and returns it.

type VersionGetResponse ¶

type VersionGetResponse struct {
	// contains filtered or unexported fields
}

VersionGetResponse is the response for the 'get' method.

func (*VersionGetResponse) Body ¶

func (r *VersionGetResponse) Body() *Version

Body returns the value of the 'body' parameter.

func (*VersionGetResponse) Error ¶

func (r *VersionGetResponse) Error() *errors.Error

Error returns the response error.

func (*VersionGetResponse) GetBody ¶

func (r *VersionGetResponse) GetBody() (value *Version, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*VersionGetResponse) Header ¶

func (r *VersionGetResponse) Header() http.Header

Header returns header of the response.

func (*VersionGetResponse) Status ¶

func (r *VersionGetResponse) Status() int

Status returns the response status code.

type VersionGetServerRequest ¶

type VersionGetServerRequest struct {
}

VersionGetServerRequest is the request for the 'get' method.

type VersionGetServerResponse ¶

type VersionGetServerResponse struct {
	// contains filtered or unexported fields
}

VersionGetServerResponse is the response for the 'get' method.

func (*VersionGetServerResponse) Body ¶

Body sets the value of the 'body' parameter.

func (*VersionGetServerResponse) Status ¶

Status sets the status code.

type VersionList ¶

type VersionList struct {
	// contains filtered or unexported fields
}

VersionList is a list of values of the 'version' type.

func UnmarshalVersionList ¶

func UnmarshalVersionList(source interface{}) (list *VersionList, err error)

UnmarshalVersionList reads a list of values of the 'version' from the given source, which can be a slice of bytes, a string, an io.Reader or a json.Decoder.

func (*VersionList) Each ¶

func (l *VersionList) Each(f func(item *Version) bool)

Each runs the given function for each item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*VersionList) Empty ¶

func (l *VersionList) Empty() bool

Empty returns true if the list is empty.

func (*VersionList) Get ¶

func (l *VersionList) Get(i int) *Version

Get returns the item of the list with the given index. If there is no item with that index it returns nil.

func (*VersionList) GetHREF ¶

func (l *VersionList) GetHREF() (value string, ok bool)

GetHREF returns the link of the list and a flag indicating if the link has a value.

func (*VersionList) HREF ¶

func (l *VersionList) HREF() string

HREF returns the link to the list.

func (*VersionList) Kind ¶

func (l *VersionList) Kind() string

Kind returns the name of the type of the object.

func (*VersionList) Len ¶

func (l *VersionList) Len() int

Len returns the length of the list.

func (l *VersionList) Link() bool

Link returns true iif this is a link.

func (*VersionList) Range ¶

func (l *VersionList) Range(f func(index int, item *Version) bool)

Range runs the given function for each index and item of the list, in order. If the function returns false the iteration stops, otherwise it continues till all the elements of the list have been processed.

func (*VersionList) Slice ¶

func (l *VersionList) Slice() []*Version

Slice returns an slice containing the items of the list. The returned slice is a copy of the one used internally, so it can be modified without affecting the internal representation.

If you don't need to modify the returned slice consider using the Each or Range functions, as they don't need to allocate a new slice.

type VersionListBuilder ¶

type VersionListBuilder struct {
	// contains filtered or unexported fields
}

VersionListBuilder contains the data and logic needed to build 'version' objects.

func NewVersionList ¶

func NewVersionList() *VersionListBuilder

NewVersionList creates a new builder of 'version' objects.

func (*VersionListBuilder) Build ¶

func (b *VersionListBuilder) Build() (list *VersionList, err error)

Build creates a list of 'version' objects using the configuration stored in the builder.

func (*VersionListBuilder) Items ¶

Items sets the items of the list.

type VersionPollRequest ¶

type VersionPollRequest struct {
	// contains filtered or unexported fields
}

VersionPollRequest is the request for the Poll method.

func (*VersionPollRequest) Header ¶

func (r *VersionPollRequest) Header(name string, value interface{}) *VersionPollRequest

Header adds a request header to all the requests that will be used to retrieve the object.

func (*VersionPollRequest) Interval ¶

func (r *VersionPollRequest) Interval(value time.Duration) *VersionPollRequest

Interval sets the polling interval. This parameter is mandatory and must be greater than zero.

func (*VersionPollRequest) Parameter ¶

func (r *VersionPollRequest) Parameter(name string, value interface{}) *VersionPollRequest

Parameter adds a query parameter to all the requests that will be used to retrieve the object.

func (*VersionPollRequest) Predicate ¶

func (r *VersionPollRequest) Predicate(value func(*VersionGetResponse) bool) *VersionPollRequest

Predicate adds a predicate that the response should satisfy be considered successful. Multiple predicates can be set calling this method multiple times. The response will be considered successful if all the predicates are satisfied.

func (*VersionPollRequest) StartContext ¶

func (r *VersionPollRequest) StartContext(ctx context.Context) (response *VersionPollResponse, err error)

StartContext starts the polling loop. Responses will be considered successful if the status is one of the values specified with the Status method and if all the predicates specified with the Predicate method return nil.

The context must have a timeout or deadline, otherwise this method will immediately return an error.

func (*VersionPollRequest) Status ¶

func (r *VersionPollRequest) Status(value int) *VersionPollRequest

Status set the expected status of the response. Multiple values can be set calling this method multiple times. The response will be considered successful if the status is any of those values.

type VersionPollResponse ¶

type VersionPollResponse struct {
	// contains filtered or unexported fields
}

VersionPollResponse is the response for the Poll method.

func (*VersionPollResponse) Body ¶

func (r *VersionPollResponse) Body() *Version

Body returns the value of the 'body' parameter.

func (*VersionPollResponse) Error ¶

func (r *VersionPollResponse) Error() *errors.Error

Error returns the response error.

func (*VersionPollResponse) GetBody ¶

func (r *VersionPollResponse) GetBody() (value *Version, ok bool)

GetBody returns the value of the 'body' parameter and a flag indicating if the parameter has a value.

func (*VersionPollResponse) Header ¶

func (r *VersionPollResponse) Header() http.Header

Header returns header of the response.

func (*VersionPollResponse) Status ¶

func (r *VersionPollResponse) Status() int

Status returns the response status code.

type VersionServer ¶

type VersionServer interface {

	// Get handles a request for the 'get' method.
	//
	// Retrieves the details of the version.
	Get(ctx context.Context, request *VersionGetServerRequest, response *VersionGetServerResponse) error
}

VersionServer represents the interface the manages the 'version' resource.

type VersionsClient ¶

type VersionsClient struct {
	// contains filtered or unexported fields
}

VersionsClient is the client of the 'versions' resource.

Manages the collection of versions.

func NewVersionsClient ¶

func NewVersionsClient(transport http.RoundTripper, path string, metric string) *VersionsClient

NewVersionsClient creates a new client for the 'versions' resource using the given transport to sned the requests and receive the responses.

func (*VersionsClient) List ¶

List creates a request for the 'list' method.

Retrieves a list of versions.

func (*VersionsClient) Version ¶

func (c *VersionsClient) Version(id string) *VersionClient

Version returns the target 'version' resource for the given identifier.

Reference to the resource that manages a specific version.

type VersionsListRequest ¶

type VersionsListRequest struct {
	// contains filtered or unexported fields
}

VersionsListRequest is the request for the 'list' method.

func (*VersionsListRequest) Header ¶

func (r *VersionsListRequest) Header(name string, value interface{}) *VersionsListRequest

Header adds a request header.

func (*VersionsListRequest) Order ¶

Order sets the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the version instead of the names of the columns of a table. For example, in order to sort the versions descending by identifier the value should be:

[source,sql] ---- id desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*VersionsListRequest) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*VersionsListRequest) Parameter ¶

func (r *VersionsListRequest) Parameter(name string, value interface{}) *VersionsListRequest

Parameter adds a query parameter.

func (*VersionsListRequest) Search ¶

Search sets the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the version instead of the names of the columns of a table. For example, in order to retrieve all the versions that are enabled:

[source,sql] ---- enabled = 't' ----

If the parameter isn't provided, or if the value is empty, then all the versions that the user has permission to see will be returned.

func (*VersionsListRequest) Send ¶

func (r *VersionsListRequest) Send() (result *VersionsListResponse, err error)

Send sends this request, waits for the response, and returns it.

This is a potentially lengthy operation, as it requires network communication. Consider using a context and the SendContext method.

func (*VersionsListRequest) SendContext ¶

func (r *VersionsListRequest) SendContext(ctx context.Context) (result *VersionsListResponse, err error)

SendContext sends this request, waits for the response, and returns it.

func (*VersionsListRequest) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

Default value is `100`.

type VersionsListResponse ¶

type VersionsListResponse struct {
	// contains filtered or unexported fields
}

VersionsListResponse is the response for the 'list' method.

func (*VersionsListResponse) Error ¶

func (r *VersionsListResponse) Error() *errors.Error

Error returns the response error.

func (*VersionsListResponse) GetItems ¶

func (r *VersionsListResponse) GetItems() (value *VersionList, ok bool)

GetItems returns the value of the 'items' parameter and a flag indicating if the parameter has a value.

Retrieved list of versions.

func (*VersionsListResponse) GetPage ¶

func (r *VersionsListResponse) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*VersionsListResponse) GetSize ¶

func (r *VersionsListResponse) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

Default value is `100`.

func (*VersionsListResponse) GetTotal ¶

func (r *VersionsListResponse) GetTotal() (value int, ok bool)

GetTotal returns the value of the 'total' parameter and a flag indicating if the parameter has a value.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

func (*VersionsListResponse) Header ¶

func (r *VersionsListResponse) Header() http.Header

Header returns header of the response.

func (*VersionsListResponse) Items ¶

func (r *VersionsListResponse) Items() *VersionList

Items returns the value of the 'items' parameter.

Retrieved list of versions.

func (*VersionsListResponse) Page ¶

func (r *VersionsListResponse) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*VersionsListResponse) Size ¶

func (r *VersionsListResponse) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

Default value is `100`.

func (*VersionsListResponse) Status ¶

func (r *VersionsListResponse) Status() int

Status returns the response status code.

func (*VersionsListResponse) Total ¶

func (r *VersionsListResponse) Total() int

Total returns the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type VersionsListServerRequest ¶

type VersionsListServerRequest struct {
	// contains filtered or unexported fields
}

VersionsListServerRequest is the request for the 'list' method.

func (*VersionsListServerRequest) GetOrder ¶

func (r *VersionsListServerRequest) GetOrder() (value string, ok bool)

GetOrder returns the value of the 'order' parameter and a flag indicating if the parameter has a value.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the version instead of the names of the columns of a table. For example, in order to sort the versions descending by identifier the value should be:

[source,sql] ---- id desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*VersionsListServerRequest) GetPage ¶

func (r *VersionsListServerRequest) GetPage() (value int, ok bool)

GetPage returns the value of the 'page' parameter and a flag indicating if the parameter has a value.

Index of the requested page, where one corresponds to the first page.

func (*VersionsListServerRequest) GetSearch ¶

func (r *VersionsListServerRequest) GetSearch() (value string, ok bool)

GetSearch returns the value of the 'search' parameter and a flag indicating if the parameter has a value.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the version instead of the names of the columns of a table. For example, in order to retrieve all the versions that are enabled:

[source,sql] ---- enabled = 't' ----

If the parameter isn't provided, or if the value is empty, then all the versions that the user has permission to see will be returned.

func (*VersionsListServerRequest) GetSize ¶

func (r *VersionsListServerRequest) GetSize() (value int, ok bool)

GetSize returns the value of the 'size' parameter and a flag indicating if the parameter has a value.

Maximum number of items that will be contained in the returned page.

Default value is `100`.

func (*VersionsListServerRequest) Order ¶

func (r *VersionsListServerRequest) Order() string

Order returns the value of the 'order' parameter.

Order criteria.

The syntax of this parameter is similar to the syntax of the _order by_ clause of a SQL statement, but using the names of the attributes of the version instead of the names of the columns of a table. For example, in order to sort the versions descending by identifier the value should be:

[source,sql] ---- id desc ----

If the parameter isn't provided, or if the value is empty, then the order of the results is undefined.

func (*VersionsListServerRequest) Page ¶

func (r *VersionsListServerRequest) Page() int

Page returns the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*VersionsListServerRequest) Search ¶

func (r *VersionsListServerRequest) Search() string

Search returns the value of the 'search' parameter.

Search criteria.

The syntax of this parameter is similar to the syntax of the _where_ clause of a SQL statement, but using the names of the attributes of the version instead of the names of the columns of a table. For example, in order to retrieve all the versions that are enabled:

[source,sql] ---- enabled = 't' ----

If the parameter isn't provided, or if the value is empty, then all the versions that the user has permission to see will be returned.

func (*VersionsListServerRequest) Size ¶

func (r *VersionsListServerRequest) Size() int

Size returns the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

Default value is `100`.

type VersionsListServerResponse ¶

type VersionsListServerResponse struct {
	// contains filtered or unexported fields
}

VersionsListServerResponse is the response for the 'list' method.

func (*VersionsListServerResponse) Items ¶

Items sets the value of the 'items' parameter.

Retrieved list of versions.

func (*VersionsListServerResponse) Page ¶

Page sets the value of the 'page' parameter.

Index of the requested page, where one corresponds to the first page.

func (*VersionsListServerResponse) Size ¶

Size sets the value of the 'size' parameter.

Maximum number of items that will be contained in the returned page.

Default value is `100`.

func (*VersionsListServerResponse) Status ¶

Status sets the status code.

func (*VersionsListServerResponse) Total ¶

Total sets the value of the 'total' parameter.

Total number of items of the collection that match the search criteria, regardless of the size of the page.

type VersionsServer ¶

type VersionsServer interface {

	// List handles a request for the 'list' method.
	//
	// Retrieves a list of versions.
	List(ctx context.Context, request *VersionsListServerRequest, response *VersionsListServerResponse) error

	// Version returns the target 'version' server for the given identifier.
	//
	// Reference to the resource that manages a specific version.
	Version(id string) VersionServer
}

VersionsServer represents the interface the manages the 'versions' resource.

Source Files ¶

Jump to

Keyboard shortcuts

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