models

package
v0.0.0-...-208ba13 Latest Latest
Warning

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

 Go to latest Published: Nov 13, 2024 License: MulanPSL-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// AgentSecurityProfileSHAREDSECRET captures enum value "SHARED_SECRET"
	AgentSecurityProfileSHAREDSECRET string = "SHARED_SECRET"

	// AgentSecurityProfileRSA3072 captures enum value "RSA_3072"
	AgentSecurityProfileRSA3072 string = "RSA_3072"

	// AgentSecurityProfileNATIVECACERTIFIEDX509 captures enum value "NATIVE_CA_CERTIFIED_X509"
	AgentSecurityProfileNATIVECACERTIFIEDX509 string = "NATIVE_CA_CERTIFIED_X509"
)
View Source 
const (

	// ClientIdentifierTokenEndpointAuthMethodClientSecretJwt captures enum value "client_secret_jwt"
	ClientIdentifierTokenEndpointAuthMethodClientSecretJwt string = "client_secret_jwt"

	// ClientIdentifierTokenEndpointAuthMethodPrivateKeyJwt captures enum value "private_key_jwt"
	ClientIdentifierTokenEndpointAuthMethodPrivateKeyJwt string = "private_key_jwt"
)
View Source 
const (

	// CreateAgentRequestSecurityProfileSHAREDSECRET captures enum value "SHARED_SECRET"
	CreateAgentRequestSecurityProfileSHAREDSECRET string = "SHARED_SECRET"

	// CreateAgentRequestSecurityProfileRSA3072 captures enum value "RSA_3072"
	CreateAgentRequestSecurityProfileRSA3072 string = "RSA_3072"
)
View Source 
const (

	// DataPointTypeINT captures enum value "INT"
	DataPointTypeINT string = "INT"

	// DataPointTypeLONG captures enum value "LONG"
	DataPointTypeLONG string = "LONG"

	// DataPointTypeDOUBLE captures enum value "DOUBLE"
	DataPointTypeDOUBLE string = "DOUBLE"

	// DataPointTypeBOOLEAN captures enum value "BOOLEAN"
	DataPointTypeBOOLEAN string = "BOOLEAN"

	// DataPointTypeSTRING captures enum value "STRING"
	DataPointTypeSTRING string = "STRING"
)
View Source 
const (

	// OnboardingStatusStatusNOTONBOARDED captures enum value "NOT_ONBOARDED"
	OnboardingStatusStatusNOTONBOARDED string = "NOT_ONBOARDED"

	// OnboardingStatusStatusONBOARDING captures enum value "ONBOARDING"
	OnboardingStatusStatusONBOARDING string = "ONBOARDING"

	// OnboardingStatusStatusONBOARDED captures enum value "ONBOARDED"
	OnboardingStatusStatusONBOARDED string = "ONBOARDED"
)
View Source 
const (

	// OnlineStatusStatusONLINE captures enum value "ONLINE"
	OnlineStatusStatusONLINE string = "ONLINE"

	// OnlineStatusStatusOFFLINE captures enum value "OFFLINE"
	OnlineStatusStatusOFFLINE string = "OFFLINE"
)
View Source 
const (

	// OrderDirectionASC captures enum value "ASC"
	OrderDirectionASC string = "ASC"

	// OrderDirectionDESC captures enum value "DESC"
	OrderDirectionDESC string = "DESC"
)
View Source 
const (

	// OrderNullHandlingNATIVE captures enum value "NATIVE"
	OrderNullHandlingNATIVE string = "NATIVE"

	// OrderNullHandlingNULLSFIRST captures enum value "NULLS_FIRST"
	OrderNullHandlingNULLSFIRST string = "NULLS_FIRST"

	// OrderNullHandlingNULLSLAST captures enum value "NULLS_LAST"
	OrderNullHandlingNULLSLAST string = "NULLS_LAST"
)
View Source 
const (

	// UpdateAgentRequestSecurityProfileSHAREDSECRET captures enum value "SHARED_SECRET"
	UpdateAgentRequestSecurityProfileSHAREDSECRET string = "SHARED_SECRET"

	// UpdateAgentRequestSecurityProfileRSA3072 captures enum value "RSA_3072"
	UpdateAgentRequestSecurityProfileRSA3072 string = "RSA_3072"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type APIRateLimitExceeded 

type APIRateLimitExceeded struct {

	// id
	ID string `json:"id,omitempty"`

	// message
	// Example: API rate limit exceeded.
	Message string `json:"message,omitempty"`
}

APIRateLimitExceeded API rate limit exceeded

swagger:model APIRateLimitExceeded

func (*APIRateLimitExceeded) ContextValidate 

func (m *APIRateLimitExceeded) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this API rate limit exceeded based on context it is used

func (*APIRateLimitExceeded) MarshalBinary 

func (m *APIRateLimitExceeded) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*APIRateLimitExceeded) UnmarshalBinary 

func (m *APIRateLimitExceeded) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*APIRateLimitExceeded) Validate 

func (m *APIRateLimitExceeded) Validate(formats strfmt.Registry) error

Validate validates this API rate limit exceeded

type AccessToken 

type AccessToken struct {

	// The access token to be used in calls to MindSphere with Bearer authentication scheme.
	// Example: eyJh...
	AccessToken string `json:"access_token,omitempty"`

	// Number of seconds before this token expires from the time of issuance.
	// Example: 43199
	ExpiresIn int64 `json:"expires_in,omitempty"`

	// jti
	Jti Jti `json:"jti,omitempty"`

	// Agent permissions list.
	Scope []string `json:"scope"`

	// The type of the access token issued.
	// Example: bearer
	TokenType string `json:"token_type,omitempty"`
}

AccessToken access token

swagger:model AccessToken

func (*AccessToken) ContextValidate 

func (m *AccessToken) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this access token based on the context it is used

func (*AccessToken) MarshalBinary 

func (m *AccessToken) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccessToken) UnmarshalBinary 

func (m *AccessToken) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccessToken) Validate 

func (m *AccessToken) Validate(formats strfmt.Registry) error

Validate validates this access token

type Agent 

type Agent struct {

	// e tag
	// Example: 2
	ETag string `json:"eTag,omitempty"`

	// Unique identifier of the entity
	// Example: 3b27818ea09a46b48c7eb3fbd878349f
	// Required: true
	// Max Length: 36
	EntityID *string `json:"entityId"`

	// Unique identifier of the agent
	// Example: 3b27818ea09a46b48c7eb3fbd878349f
	// Max Length: 36
	ID string `json:"id,omitempty"`

	// Name must be unique per tenant.
	// Example: Nanobox Agent
	// Required: true
	// Max Length: 128
	Name *string `json:"name"`

	// security profile
	// Required: true
	// Enum: ["SHARED_SECRET","RSA_3072","NATIVE_CA_CERTIFIED_X509"]
	SecurityProfile *string `json:"securityProfile"`
}

Agent agent

swagger:model Agent

func (*Agent) ContextValidate 

func (m *Agent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this agent based on context it is used

func (*Agent) MarshalBinary 

func (m *Agent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Agent) UnmarshalBinary 

func (m *Agent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Agent) Validate 

func (m *Agent) Validate(formats strfmt.Registry) error

Validate validates this agent

type Badrequest 

type Badrequest struct {

	// id
	ID string `json:"id,omitempty"`

	// message
	// Example: The request is not valid.
	Message string `json:"message,omitempty"`
}

Badrequest badrequest

swagger:model Badrequest

func (*Badrequest) ContextValidate 

func (m *Badrequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this badrequest based on context it is used

func (*Badrequest) MarshalBinary 

func (m *Badrequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Badrequest) UnmarshalBinary 

func (m *Badrequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Badrequest) Validate 

func (m *Badrequest) Validate(formats strfmt.Registry) error

Validate validates this badrequest

type BadrequestIAM 

type BadrequestIAM struct {

	// error
	// Example: invalid_authorization_header
	Error string `json:"error,omitempty"`

	// An error message with Correlation-ID value.
	// Example: [feae1a0b-48fb-4af5-bc0d-7c96d8058e37] Header is missing.
	ErrorDescription string `json:"error_description,omitempty"`

	// id
	ID string `json:"id,omitempty"`
}

BadrequestIAM badrequest i a m

swagger:model BadrequestIAM

func (*BadrequestIAM) ContextValidate 

func (m *BadrequestIAM) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this badrequest i a m based on context it is used

func (*BadrequestIAM) MarshalBinary 

func (m *BadrequestIAM) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BadrequestIAM) UnmarshalBinary 

func (m *BadrequestIAM) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BadrequestIAM) Validate 

func (m *BadrequestIAM) Validate(formats strfmt.Registry) error

Validate validates this badrequest i a m

type ClientID 

type ClientID string

ClientID Client identifier, equals value of 'sub' claim in IAT. Example: 0b2d1cde-cc76-11e7-abc4-cec278b6b50a

swagger:model ClientId

func (ClientID) ContextValidate 

func (m ClientID) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this client Id based on context it is used

func (ClientID) Validate 

func (m ClientID) Validate(formats strfmt.Registry) error

Validate validates this client Id

type ClientIdentifier 

type ClientIdentifier struct {

	// client id
	// Required: true
	ClientID *ClientID `json:"client_id"`

	// Server generated client secret. Required if security profile is SHARED_SECRET.
	ClientSecret string `json:"client_secret,omitempty"`

	// Epoch time in seconds which client secret expires at.
	// Example: 1511020133
	ClientSecretExpiresAt int64 `json:"client_secret_expires_at,omitempty"`

	// grant types
	GrantTypes []string `json:"grant_types"`

	// The access token to be used at the client configuration endpoint to perform subsequent operations upon the client registration.
	// Example: eyJh...
	// Required: true
	RegistrationAccessToken *string `json:"registration_access_token"`

	// The fully qualified URL of the client configuration endpoint for this client.
	// Example: https://southgate.eu-central.mindsphere.io/api/agentmanagement/v3/register/0b2d1cde-cc76-11e7-abc4-cec278b6b50a
	// Required: true
	// Format: uri
	RegistrationClientURI *strfmt.URI `json:"registration_client_uri"`

	// The client authentication method.
	// Enum: ["client_secret_jwt","private_key_jwt"]
	TokenEndpointAuthMethod string `json:"token_endpoint_auth_method,omitempty"`
}

ClientIdentifier client identifier

swagger:model ClientIdentifier

func (*ClientIdentifier) ContextValidate 

func (m *ClientIdentifier) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this client identifier based on the context it is used

func (*ClientIdentifier) MarshalBinary 

func (m *ClientIdentifier) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ClientIdentifier) UnmarshalBinary 

func (m *ClientIdentifier) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ClientIdentifier) Validate 

func (m *ClientIdentifier) Validate(formats strfmt.Registry) error

Validate validates this client identifier

type Configuration 

type Configuration struct {

	// content
	Content *OnboardingConfigurationContent `json:"content,omitempty"`

	// expiration
	// Format: date-time
	Expiration strfmt.DateTime `json:"expiration,omitempty"`
}

Configuration configuration

swagger:model Configuration

func (*Configuration) ContextValidate 

func (m *Configuration) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this configuration based on the context it is used

func (*Configuration) MarshalBinary 

func (m *Configuration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Configuration) UnmarshalBinary 

func (m *Configuration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Configuration) Validate 

func (m *Configuration) Validate(formats strfmt.Registry) error

Validate validates this configuration

type Conflict 

type Conflict struct {

	// id
	ID string `json:"id,omitempty"`

	// message
	// Example: Resource is already available.
	Message string `json:"message,omitempty"`
}

Conflict Operation on resource is not allowed due to a conflicting state.

swagger:model Conflict

func (*Conflict) ContextValidate 

func (m *Conflict) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this conflict based on context it is used

func (*Conflict) MarshalBinary 

func (m *Conflict) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Conflict) UnmarshalBinary 

func (m *Conflict) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Conflict) Validate 

func (m *Conflict) Validate(formats strfmt.Registry) error

Validate validates this conflict

type CreateAgentRequest 

type CreateAgentRequest struct {

	// Unique identifier of the entity
	// Example: 3b27818ea09a46b48c7eb3fbd878349f
	// Required: true
	// Max Length: 36
	EntityID *string `json:"entityId"`

	// Name must be unique per tenant.
	// Example: Nanobox Agent
	// Required: true
	// Max Length: 128
	Name *string `json:"name"`

	// security profile
	// Required: true
	// Enum: ["SHARED_SECRET","RSA_3072"]
	SecurityProfile *string `json:"securityProfile"`
}

CreateAgentRequest create agent request

swagger:model CreateAgentRequest

func (*CreateAgentRequest) ContextValidate 

func (m *CreateAgentRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create agent request based on context it is used

func (*CreateAgentRequest) MarshalBinary 

func (m *CreateAgentRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateAgentRequest) UnmarshalBinary 

func (m *CreateAgentRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateAgentRequest) Validate 

func (m *CreateAgentRequest) Validate(formats strfmt.Registry) error

Validate validates this create agent request

type DataPoint 

type DataPoint struct {

	// A custom object of user-defined attributes.
	// Example: {"Nominal":"~220 Volts","details":{"tag":"Machine-1"}}
	CustomData map[string]interface{} `json:"customData,omitempty"`

	// description
	// Example: Voltage value read.
	// Max Length: 256
	Description string `json:"description,omitempty"`

	// Identifier of this data point. This id needs to be unique per data source configuration. Agents expected to upload timeseries value with this id, enabling backend services to match data with this data point.
	// This is NOT an auto generated field, enabling agents to specify it before uploading matching timeseries value.
	//
	// Example: DP001
	// Required: true
	// Max Length: 36
	ID *string `json:"id"`

	// name
	// Example: Voltage
	// Required: true
	// Max Length: 64
	Name *string `json:"name"`

	// type
	// Example: DOUBLE
	// Required: true
	// Enum: ["INT","LONG","DOUBLE","BOOLEAN","STRING"]
	Type *string `json:"type"`

	// Unit of data point. Can be empty.
	//
	// Example: V
	// Required: true
	// Max Length: 32
	Unit *string `json:"unit"`
}

DataPoint data point

swagger:model DataPoint

func (*DataPoint) ContextValidate 

func (m *DataPoint) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this data point based on context it is used

func (*DataPoint) MarshalBinary 

func (m *DataPoint) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DataPoint) UnmarshalBinary 

func (m *DataPoint) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DataPoint) Validate 

func (m *DataPoint) Validate(formats strfmt.Registry) error

Validate validates this data point

type DataSource 

type DataSource struct {

	// A custom object of user-defined attributes.
	// Example: {"Host":"192.168.0.111","Port":"8765","details":{"tag":"Server-1"}}
	CustomData map[string]interface{} `json:"customData,omitempty"`

	// data points
	// Required: true
	DataPoints []*DataPoint `json:"dataPoints"`

	// description
	// Example: OPC-UA Server installed on site.
	// Max Length: 256
	Description string `json:"description,omitempty"`

	// name
	// Example: OPC-UA Server
	// Required: true
	// Max Length: 64
	Name *string `json:"name"`
}

DataSource data source

swagger:model DataSource

func (*DataSource) ContextValidate 

func (m *DataSource) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this data source based on the context it is used

func (*DataSource) MarshalBinary 

func (m *DataSource) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DataSource) UnmarshalBinary 

func (m *DataSource) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DataSource) Validate 

func (m *DataSource) Validate(formats strfmt.Registry) error

Validate validates this data source

type DataSourceConfiguration 

type DataSourceConfiguration struct {

	// Unique identifier of the datasource configuration.
	// Example: Configuration01
	// Required: true
	// Max Length: 36
	ConfigurationID *string `json:"configurationId"`

	// data sources
	// Required: true
	DataSources []*DataSource `json:"dataSources"`

	// e tag
	// Example: 2
	ETag string `json:"eTag,omitempty"`

	// id
	// Example: c3b7d31d-e966-46e6-9db1-d4b3e8c90d7b
	// Max Length: 36
	ID string `json:"id,omitempty"`
}

DataSourceConfiguration data source configuration

swagger:model DataSourceConfiguration

func (*DataSourceConfiguration) ContextValidate 

func (m *DataSourceConfiguration) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this data source configuration based on the context it is used

func (*DataSourceConfiguration) MarshalBinary 

func (m *DataSourceConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DataSourceConfiguration) UnmarshalBinary 

func (m *DataSourceConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DataSourceConfiguration) Validate 

func (m *DataSourceConfiguration) Validate(formats strfmt.Registry) error

Validate validates this data source configuration

type Error 

type Error struct {

	// id
	ID string `json:"id,omitempty"`

	// message
	Message string `json:"message,omitempty"`
}

Error error

swagger:model Error

func (*Error) ContextValidate 

func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error based on context it is used

func (*Error) MarshalBinary 

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary 

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate 

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type Forbidden 

type Forbidden struct {

	// id
	ID string `json:"id,omitempty"`

	// message
	// Example: Insufficient authorization for this resource.
	Message string `json:"message,omitempty"`
}

Forbidden forbidden

swagger:model Forbidden

func (*Forbidden) ContextValidate 

func (m *Forbidden) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this forbidden based on context it is used

func (*Forbidden) MarshalBinary 

func (m *Forbidden) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Forbidden) UnmarshalBinary 

func (m *Forbidden) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Forbidden) Validate 

func (m *Forbidden) Validate(formats strfmt.Registry) error

Validate validates this forbidden

type Jti 

type Jti string

Jti Unique identifier of the token. Example: 3fcf2a5e-cc76-11e7-abc4-cec278b6b50a

swagger:model Jti

func (Jti) ContextValidate 

func (m Jti) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this jti based on context it is used

func (Jti) Validate 

func (m Jti) Validate(formats strfmt.Registry) error

Validate validates this jti

type Jwks 

type Jwks struct {

	// keys
	Keys []*Key `json:"keys"`
}

Jwks jwks

swagger:model Jwks

func (*Jwks) ContextValidate 

func (m *Jwks) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this jwks based on the context it is used

func (*Jwks) MarshalBinary 

func (m *Jwks) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Jwks) UnmarshalBinary 

func (m *Jwks) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Jwks) Validate 

func (m *Jwks) Validate(formats strfmt.Registry) error

Validate validates this jwks

type Key 

type Key struct {

	// e
	// Required: true
	E *string `json:"e"`

	// kid
	// Required: true
	Kid *string `json:"kid"`

	// kty
	// Example: RSA
	// Required: true
	Kty *string `json:"kty"`

	// n
	// Required: true
	N *string `json:"n"`
}

Key key

swagger:model Key

func (*Key) ContextValidate 

func (m *Key) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this key based on context it is used

func (*Key) MarshalBinary 

func (m *Key) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Key) UnmarshalBinary 

func (m *Key) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Key) Validate 

func (m *Key) Validate(formats strfmt.Registry) error

Validate validates this key

type Keys 

type Keys struct {

	// jwks
	Jwks *Jwks `json:"jwks,omitempty"`
}

Keys keys

swagger:model Keys

func (*Keys) ContextValidate 

func (m *Keys) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this keys based on the context it is used

func (*Keys) MarshalBinary 

func (m *Keys) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Keys) UnmarshalBinary 

func (m *Keys) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Keys) Validate 

func (m *Keys) Validate(formats strfmt.Registry) error

Validate validates this keys

type NotSupported 

type NotSupported struct {

	// id
	ID string `json:"id,omitempty"`

	// message
	// Example: Offboard request is not supported for NATIVE_CA_CERTIFIED_X509 agents.
	Message string `json:"message,omitempty"`
}

NotSupported Operation on resource is not allowed for NATIVE_CA_CERTIFIED_X509 agents.

swagger:model NotSupported

func (*NotSupported) ContextValidate 

func (m *NotSupported) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this not supported based on context it is used

func (*NotSupported) MarshalBinary 

func (m *NotSupported) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NotSupported) UnmarshalBinary 

func (m *NotSupported) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NotSupported) Validate 

func (m *NotSupported) Validate(formats strfmt.Registry) error

Validate validates this not supported

type Notfound 

type Notfound struct {

	// id
	ID string `json:"id,omitempty"`

	// message
	// Example: Resource not found.
	Message string `json:"message,omitempty"`
}

Notfound notfound

swagger:model Notfound

func (*Notfound) ContextValidate 

func (m *Notfound) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notfound based on context it is used

func (*Notfound) MarshalBinary 

func (m *Notfound) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Notfound) UnmarshalBinary 

func (m *Notfound) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Notfound) Validate 

func (m *Notfound) Validate(formats strfmt.Registry) error

Validate validates this notfound

type OnboardingConfigurationContent 

type OnboardingConfigurationContent struct {

	// base Url
	// Example: https://southgate.eu-central.mindsphere.io
	BaseURL string `json:"baseUrl,omitempty"`

	// client credential profile
	ClientCredentialProfile []string `json:"clientCredentialProfile"`

	// client Id
	// Example: 5fa51b64-dce2-11e7-9296-cec278b6b50a
	// Max Length: 36
	ClientID string `json:"clientId,omitempty"`

	// iat
	// Example: eyJh...
	Iat string `json:"iat,omitempty"`

	// tenant
	// Example: testtenant
	// Max Length: 36
	Tenant string `json:"tenant,omitempty"`
}

OnboardingConfigurationContent onboarding configuration content

swagger:model OnboardingConfigurationContent

func (*OnboardingConfigurationContent) ContextValidate 

func (m *OnboardingConfigurationContent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this onboarding configuration content based on context it is used

func (*OnboardingConfigurationContent) MarshalBinary 

func (m *OnboardingConfigurationContent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OnboardingConfigurationContent) UnmarshalBinary 

func (m *OnboardingConfigurationContent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OnboardingConfigurationContent) Validate 

func (m *OnboardingConfigurationContent) Validate(formats strfmt.Registry) error

Validate validates this onboarding configuration content

type OnboardingStatus 

type OnboardingStatus struct {

	// status
	// Enum: ["NOT_ONBOARDED","ONBOARDING","ONBOARDED"]
	Status string `json:"status,omitempty"`
}

OnboardingStatus onboarding status

swagger:model OnboardingStatus

func (*OnboardingStatus) ContextValidate 

func (m *OnboardingStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this onboarding status based on context it is used

func (*OnboardingStatus) MarshalBinary 

func (m *OnboardingStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OnboardingStatus) UnmarshalBinary 

func (m *OnboardingStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OnboardingStatus) Validate 

func (m *OnboardingStatus) Validate(formats strfmt.Registry) error

Validate validates this onboarding status

type OnlineStatus 

type OnlineStatus struct {

	// since
	// Format: date-time
	Since strfmt.DateTime `json:"since,omitempty"`

	// status
	// Enum: ["ONLINE","OFFLINE"]
	Status string `json:"status,omitempty"`
}

OnlineStatus online status

swagger:model OnlineStatus

func (*OnlineStatus) ContextValidate 

func (m *OnlineStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this online status based on context it is used

func (*OnlineStatus) MarshalBinary 

func (m *OnlineStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OnlineStatus) UnmarshalBinary 

func (m *OnlineStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OnlineStatus) Validate 

func (m *OnlineStatus) Validate(formats strfmt.Registry) error

Validate validates this online status

type Order 

type Order struct {

	// Whether sorting for this property shall be ascending.
	Ascending bool `json:"ascending,omitempty"`

	// Whether sorting for this property shall be descending.
	Descending bool `json:"descending,omitempty"`

	// The order the property shall be sorted for.
	// Enum: ["ASC","DESC"]
	Direction string `json:"direction,omitempty"`

	// Whether or not the sort will be case sensitive.
	IgnoreCase bool `json:"ignoreCase,omitempty"`

	// null handling
	// Enum: ["NATIVE","NULLS_FIRST","NULLS_LAST"]
	NullHandling string `json:"nullHandling,omitempty"`

	// The property to order for.
	Property string `json:"property,omitempty"`
}

Order order

swagger:model Order

func (*Order) ContextValidate 

func (m *Order) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this order based on context it is used

func (*Order) MarshalBinary 

func (m *Order) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Order) UnmarshalBinary 

func (m *Order) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Order) Validate 

func (m *Order) Validate(formats strfmt.Registry) error

Validate validates this order

type PagedAgent 

type PagedAgent struct {

	// content
	// Required: true
	Content []*Agent `json:"content"`

	// Whether the current item is the first one.
	// Example: true
	// Required: true
	First *bool `json:"first"`

	// Whether the current item is the last one.
	// Example: true
	// Required: true
	Last *bool `json:"last"`

	// The number of the current item.
	// Example: 0
	// Required: true
	Number *int64 `json:"number"`

	// The number of elements currently on this page.
	// Example: 1
	// Required: true
	NumberOfElements *int64 `json:"numberOfElements"`

	// The size of the page.
	// Example: 20
	// Required: true
	Size *int64 `json:"size"`

	// The sorting parameters for the page.
	// Required: true
	Sort []*Order `json:"sort"`

	// The total amount of elements.
	// Example: 1
	// Required: true
	TotalElements *int64 `json:"totalElements"`

	// The number of total pages.
	// Example: 1
	// Required: true
	TotalPages *int64 `json:"totalPages"`
}

PagedAgent paged agent

swagger:model PagedAgent

func (*PagedAgent) ContextValidate 

func (m *PagedAgent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this paged agent based on the context it is used

func (*PagedAgent) MarshalBinary 

func (m *PagedAgent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PagedAgent) UnmarshalBinary 

func (m *PagedAgent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PagedAgent) Validate 

func (m *PagedAgent) Validate(formats strfmt.Registry) error

Validate validates this paged agent

type Preconditionfailed 

type Preconditionfailed struct {

	// id
	ID string `json:"id,omitempty"`

	// message
	// Example: Resource not found with given the condition.
	Message string `json:"message,omitempty"`
}

Preconditionfailed preconditionfailed

swagger:model Preconditionfailed

func (*Preconditionfailed) ContextValidate 

func (m *Preconditionfailed) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this preconditionfailed based on context it is used

func (*Preconditionfailed) MarshalBinary 

func (m *Preconditionfailed) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Preconditionfailed) UnmarshalBinary 

func (m *Preconditionfailed) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Preconditionfailed) Validate 

func (m *Preconditionfailed) Validate(formats strfmt.Registry) error

Validate validates this preconditionfailed

type RotationKeys 

type RotationKeys struct {

	// client id
	ClientID string `json:"client_id,omitempty"`

	// jwks
	Jwks *Jwks `json:"jwks,omitempty"`
}

RotationKeys rotation keys

swagger:model RotationKeys

func (*RotationKeys) ContextValidate 

func (m *RotationKeys) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this rotation keys based on the context it is used

func (*RotationKeys) MarshalBinary 

func (m *RotationKeys) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RotationKeys) UnmarshalBinary 

func (m *RotationKeys) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RotationKeys) Validate 

func (m *RotationKeys) Validate(formats strfmt.Registry) error

Validate validates this rotation keys

type TokenKey 

type TokenKey struct {

	// alg
	Alg string `json:"alg,omitempty"`

	// e
	// Required: true
	E *string `json:"e"`

	// kid
	// Required: true
	Kid *string `json:"kid"`

	// kty
	// Example: RSA
	// Required: true
	Kty *string `json:"kty"`

	// n
	// Required: true
	N *string `json:"n"`

	// use
	Use string `json:"use,omitempty"`

	// value
	Value string `json:"value,omitempty"`
}

TokenKey token key

swagger:model TokenKey

func (*TokenKey) ContextValidate 

func (m *TokenKey) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this token key based on context it is used

func (*TokenKey) MarshalBinary 

func (m *TokenKey) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TokenKey) UnmarshalBinary 

func (m *TokenKey) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TokenKey) Validate 

func (m *TokenKey) Validate(formats strfmt.Registry) error

Validate validates this token key

type TokenKeys 

type TokenKeys struct {

	// keys
	Keys []*TokenKey `json:"keys"`
}

TokenKeys token keys

swagger:model TokenKeys

func (*TokenKeys) ContextValidate 

func (m *TokenKeys) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this token keys based on the context it is used

func (*TokenKeys) MarshalBinary 

func (m *TokenKeys) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TokenKeys) UnmarshalBinary 

func (m *TokenKeys) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TokenKeys) Validate 

func (m *TokenKeys) Validate(formats strfmt.Registry) error

Validate validates this token keys

type TooManyRequests 

type TooManyRequests struct {

	// error
	// Example: too_many_requests
	Error string `json:"error,omitempty"`

	// An error message with Correlation-ID value.
	// Example: [d6270fa4-f8f2-46d7-8370-1fbcacb37c52] There is already an ongoing registration process for the agent.
	ErrorDescription string `json:"error_description,omitempty"`

	// id
	ID string `json:"id,omitempty"`
}

TooManyRequests too many requests

swagger:model TooManyRequests

func (*TooManyRequests) ContextValidate 

func (m *TooManyRequests) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this too many requests based on context it is used

func (*TooManyRequests) MarshalBinary 

func (m *TooManyRequests) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TooManyRequests) UnmarshalBinary 

func (m *TooManyRequests) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TooManyRequests) Validate 

func (m *TooManyRequests) Validate(formats strfmt.Registry) error

Validate validates this too many requests

type Unauthorized 

type Unauthorized struct {

	// id
	ID string `json:"id,omitempty"`

	// message
	// Example: Not authorized to access this resource.
	Message string `json:"message,omitempty"`
}

Unauthorized unauthorized

swagger:model Unauthorized

func (*Unauthorized) ContextValidate 

func (m *Unauthorized) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this unauthorized based on context it is used

func (*Unauthorized) MarshalBinary 

func (m *Unauthorized) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Unauthorized) UnmarshalBinary 

func (m *Unauthorized) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Unauthorized) Validate 

func (m *Unauthorized) Validate(formats strfmt.Registry) error

Validate validates this unauthorized

type UnauthorizedIAM 

type UnauthorizedIAM struct {

	// error
	// Example: token_validation_failed
	Error string `json:"error,omitempty"`

	// An error message with Correlation-ID value.
	// Example: [d6270fa4-f8f2-46d7-8370-1fbcacb37c52] Token validation failed.
	ErrorDescription string `json:"error_description,omitempty"`

	// id
	ID string `json:"id,omitempty"`
}

UnauthorizedIAM unauthorized i a m

swagger:model UnauthorizedIAM

func (*UnauthorizedIAM) ContextValidate 

func (m *UnauthorizedIAM) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this unauthorized i a m based on context it is used

func (*UnauthorizedIAM) MarshalBinary 

func (m *UnauthorizedIAM) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UnauthorizedIAM) UnmarshalBinary 

func (m *UnauthorizedIAM) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UnauthorizedIAM) Validate 

func (m *UnauthorizedIAM) Validate(formats strfmt.Registry) error

Validate validates this unauthorized i a m

type UpdateAgentRequest 

type UpdateAgentRequest struct {

	// Name must be unique per tenant.
	// Example: Nanobox Agent
	// Required: true
	// Max Length: 128
	Name *string `json:"name"`

	// security profile
	// Required: true
	// Enum: ["SHARED_SECRET","RSA_3072"]
	SecurityProfile *string `json:"securityProfile"`
}

UpdateAgentRequest update agent request

swagger:model UpdateAgentRequest

func (*UpdateAgentRequest) ContextValidate 

func (m *UpdateAgentRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this update agent request based on context it is used

func (*UpdateAgentRequest) MarshalBinary 

func (m *UpdateAgentRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateAgentRequest) UnmarshalBinary 

func (m *UpdateAgentRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateAgentRequest) Validate 

func (m *UpdateAgentRequest) Validate(formats strfmt.Registry) error

Validate validates this update agent request

type UpdateDataSourceConfigurationRequest 

type UpdateDataSourceConfigurationRequest struct {

	// Unique identifier of the datasource configuration.
	// Example: Configuration01
	// Required: true
	// Max Length: 36
	ConfigurationID *string `json:"configurationId"`

	// data sources
	// Required: true
	DataSources []*DataSource `json:"dataSources"`
}

UpdateDataSourceConfigurationRequest update data source configuration request

swagger:model UpdateDataSourceConfigurationRequest

func (*UpdateDataSourceConfigurationRequest) ContextValidate 

func (m *UpdateDataSourceConfigurationRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this update data source configuration request based on the context it is used

func (*UpdateDataSourceConfigurationRequest) MarshalBinary 

func (m *UpdateDataSourceConfigurationRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateDataSourceConfigurationRequest) UnmarshalBinary 

func (m *UpdateDataSourceConfigurationRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateDataSourceConfigurationRequest) Validate 

func (m *UpdateDataSourceConfigurationRequest) Validate(formats strfmt.Registry) error

Validate validates this update data source configuration request

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.