application

Documentation

Overview

+kubebuilder:object:generate=true

Index

• type Application
  • func (in *Application) DeepCopy() *Application
  • func (in *Application) DeepCopyInto(out *Application)
  • func (in *Application) GetSettings() core.ApplicationSettings
• type GrantType
• type Member
  • func (in *Member) DeepCopy() *Member
  • func (in *Member) DeepCopyInto(out *Member)
• type MetaDataFormat
• type Metadata
  • func (in *Metadata) DeepCopy() *Metadata
  • func (in *Metadata) DeepCopyInto(out *Metadata)
• type OAuthClientSettings
  • func (in *OAuthClientSettings) DeepCopy() *OAuthClientSettings
  • func (in *OAuthClientSettings) DeepCopyInto(out *OAuthClientSettings)
• type OauthType
• type Setting
  • func (in *Setting) DeepCopy() *Setting
  • func (in *Setting) DeepCopyInto(out *Setting)
  • func (in *Setting) GetClientCertificate() string
  • func (in *Setting) GetClientID() string
  • func (in *Setting) GetOAuthType() string
  • func (in *Setting) HasTLS() bool
  • func (in *Setting) IsOAuth() bool
  • func (in *Setting) IsSimple() bool
• type SimpleSettings
  • func (in *SimpleSettings) DeepCopy() *SimpleSettings
  • func (in *SimpleSettings) DeepCopyInto(out *SimpleSettings)
• type Status
  • func (in *Status) DeepCopy() *Status
  • func (in *Status) DeepCopyInto(out *Status)
• type TLSSettings
  • func (in *TLSSettings) DeepCopy() *TLSSettings
  • func (in *TLSSettings) DeepCopyInto(out *TLSSettings)

Types

type Application

type Application struct {
	// +kubebuilder:validation:Required
	// Application name
	Name string `json:"name"`
	// +kubebuilder:validation:Required
	// Application Description
	Description string `json:"description"`
	// io.gravitee.definition.model.Application
	// Application ID
	ID string `json:"id,omitempty"`
	// The base64 encoded background to use for this application when displaying it on the portal
	// +kubebuilder:validation:Optional
	Background *string `json:"background,omitempty"`
	// Application domain
	// +kubebuilder:validation:Optional
	Domain *string `json:"domain,omitempty"`
	// Application groups
	// +kubebuilder:validation:Optional
	Groups []string `json:"groups"`
	// The base64 encoded picture to use for this application when displaying it on the portal (if not relying on an URL)
	// +kubebuilder:validation:Optional
	Picture *string `json:"picture,omitempty"`
	// A URL pointing to the picture to use when displaying the application on the portal
	// +kubebuilder:validation:Optional
	PictureURL *string `json:"pictureUrl,omitempty"`
	// Application settings
	// +kubebuilder:validation:Required
	Settings *Setting `json:"settings"`
	// +kubebuilder:validation:Optional
	// Notify members when they are added to the application
	NotifyMembers *bool `json:"notifyMembers"`
	// Application metadata
	// +kubebuilder:validation:Optional
	Metadata *[]Metadata `json:"metadata"`
	// Application members
	// +kubebuilder:validation:Optional
	Members *[]Member `json:"members"`
}

func (*Application) DeepCopy

func (in *Application) DeepCopy() *Application

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Application.

func (*Application) DeepCopyInto

func (in *Application) DeepCopyInto(out *Application)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Application) GetSettings

func (in *Application) GetSettings() core.ApplicationSettings

GetSettings implements core.ApplicationModel.

type GrantType

type GrantType string

+kubebuilder:validation:Enum=authorization_code;client_credentials;refresh_token;password;implicit

const (
	GrantTypeClientCredentials GrantType = "client_credentials"
	GrantTypeAuthorizationCode GrantType = "authorization_code"
	GrantTypeRefreshToken      GrantType = "refresh_token"
	GrantTypePassword          GrantType = "password"
	GrantTypeImplicit          GrantType = "implicit"
)

type Member

type Member struct {
	// Member source
	// +kubebuilder:validation:Required
	// +kubebuilder:example:=gravitee
	Source string `json:"source"`
	// Member source ID
	// +kubebuilder:validation:Required
	// +kubebuilder:example:=user@email.com
	SourceID string `json:"sourceId"`
	// The API role associated with this Member
	// +kubebuilder:default:=USER
	Role string `json:"role,omitempty"`
}

func (*Member) DeepCopy

func (in *Member) DeepCopy() *Member

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Member.

func (*Member) DeepCopyInto

func (in *Member) DeepCopyInto(out *Member)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MetaDataFormat

type MetaDataFormat string

+kubebuilder:validation:Enum=STRING;NUMERIC;BOOLEAN;DATE;MAIL;URL;

type Metadata

type Metadata struct {
	// +kubebuilder:validation:Required
	// Metadata Name
	Name string `json:"name"`
	// Metadata Value
	// +kubebuilder:validation:Optional
	Value *string `json:"value,omitempty"`
	// Metadata DefaultValue
	// +kubebuilder:validation:Optional
	DefaultValue *string `json:"defaultValue,omitempty"`
	// Metadata Format
	Format *MetaDataFormat `json:"format,omitempty"`
	// Metadata is hidden or not?
	// +kubebuilder:validation:Optional
	Hidden *bool `json:"hidden,omitempty"`
}

func (*Metadata) DeepCopy

func (in *Metadata) DeepCopy() *Metadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Metadata.

func (*Metadata) DeepCopyInto

func (in *Metadata) DeepCopyInto(out *Metadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OAuthClientSettings

type OAuthClientSettings struct {
	// Oauth client application type
	// +kubebuilder:validation:Required
	ApplicationType OauthType `json:"applicationType"`
	// List of Oauth client grant types
	GrantTypes []GrantType `json:"grantTypes"`
	// List of Oauth client redirect uris
	// +kubebuilder:validation:Optional
	RedirectUris []string `json:"redirectUris"`
}

func (*OAuthClientSettings) DeepCopy

func (in *OAuthClientSettings) DeepCopy() *OAuthClientSettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuthClientSettings.

func (*OAuthClientSettings) DeepCopyInto

func (in *OAuthClientSettings) DeepCopyInto(out *OAuthClientSettings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OauthType

type OauthType string

+kubebuilder:validation:Enum=BACKEND_TO_BACKEND;NATIVE;BROWSER;WEB

type Setting

type Setting struct {
	App   *SimpleSettings      `json:"app,omitempty"`
	Oauth *OAuthClientSettings `json:"oauth,omitempty"`
	TLS   *TLSSettings         `json:"tls,omitempty"`
}

func (*Setting) DeepCopy

func (in *Setting) DeepCopy() *Setting

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Setting.

func (*Setting) DeepCopyInto

func (in *Setting) DeepCopyInto(out *Setting)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Setting) GetClientCertificate

func (in *Setting) GetClientCertificate() string

func (*Setting) GetClientID

func (in *Setting) GetClientID() string

func (*Setting) GetOAuthType

func (in *Setting) GetOAuthType() string

GetOAuthType implements core.ApplicationSettings.

func (*Setting) HasTLS

func (in *Setting) HasTLS() bool

HasTLS implements core.ApplicationSettings.

func (*Setting) IsOAuth

func (in *Setting) IsOAuth() bool

IsOAuth implements core.ApplicationSettings.

func (*Setting) IsSimple

func (in *Setting) IsSimple() bool

IsSimple implements core.ApplicationSettings.

type SimpleSettings

type SimpleSettings struct {
	// Application Type
	AppType string `json:"type"`
	// ClientID is the client id of the application
	ClientID *string `json:"clientId,omitempty"`
}

func (*SimpleSettings) DeepCopy

func (in *SimpleSettings) DeepCopy() *SimpleSettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SimpleSettings.

func (*SimpleSettings) DeepCopyInto

func (in *SimpleSettings) DeepCopyInto(out *SimpleSettings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Status

type Status struct {
	// The organization ID, if a management context has been defined to sync with an APIM instance
	OrgID string `json:"organizationId,omitempty"`
	// The environment ID, if a management context has been defined to sync with an APIM instance
	EnvID string `json:"environmentId,omitempty"`
	// The ID of the Application, if a management context has been defined to sync with an APIM instance
	ID string `json:"id,omitempty"`
	// The processing status of the Application.
	// The value is `Completed` if the sync with APIM succeeded, Failed otherwise.
	ProcessingStatus core.ProcessingStatus `json:"processingStatus,omitempty"`
	// The number of subscriptions that reference the application
	SubscriptionCount uint `json:"subscriptions,omitempty"`
	// When application has been created regardless of errors, this field is
	// used to persist the error message encountered during admission
	Errors status.Errors `json:"errors,omitempty"`
}

func (*Status) DeepCopy

func (in *Status) DeepCopy() *Status

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Status.

func (*Status) DeepCopyInto

func (in *Status) DeepCopyInto(out *Status)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TLSSettings

type TLSSettings struct {
	// This client certificate is mandatory to subscribe to a TLS plan.
	// +kubebuilder:validation:Required
	ClientCertificate string `json:"clientCertificate"`
}

TLS settings are used to configure client side TLS in order to be able to subscribe to a MTLS plan.

func (*TLSSettings) DeepCopy

func (in *TLSSettings) DeepCopy() *TLSSettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSSettings.

func (*TLSSettings) DeepCopyInto

func (in *TLSSettings) DeepCopyInto(out *TLSSettings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.