models

package
v0.15.2 Latest Latest
Warning

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

 Go to latest Published: Aug 14, 2019 License: BSD-3-Clause Imports: 11 Imported by: 7

Documentation

Index

Constants

View Source 
const (
	// CallbackResponseStateDone captures enum value "done"
	CallbackResponseStateDone string = "done"
	// CallbackResponseStateError captures enum value "error"
	CallbackResponseStateError string = "error"
)
View Source 
const (
	// AccessTokenTokenTypeBearer captures enum value "bearer"
	AccessTokenTokenTypeBearer string = "bearer"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessToken 

type AccessToken struct {

	// access token
	// Required: true
	// Max Length: 295
	AccessToken *string `json:"access_token"`

	// expires in
	// Required: true
	ExpiresIn *int64 `json:"expires_in"`

	// token type
	// Required: true
	TokenType *string `json:"token_type"`
}

AccessToken A granted access token used for performing requests on behalf o a user or provider against the Manifold Connector API.

swagger:model AccessToken

func (*AccessToken) Validate 

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

Validate validates this access token

type AccessTokenRequest 

type AccessTokenRequest interface {
	runtime.Validatable

	// client id
	ClientID() manifold.ID
	SetClientID(manifold.ID)

	// client secret
	ClientSecret() OAuthClientSecret
	SetClientSecret(OAuthClientSecret)

	// grant type
	// Required: true
	GrantType() string
	SetGrantType(string)
}

AccessTokenRequest HTTP Request Body of an Access Token swagger:discriminator AccessTokenRequest grant_type

func UnmarshalAccessTokenRequest 

func UnmarshalAccessTokenRequest(reader io.Reader, consumer runtime.Consumer) (AccessTokenRequest, error)

UnmarshalAccessTokenRequest unmarshals polymorphic AccessTokenRequest

func UnmarshalAccessTokenRequestSlice 

func UnmarshalAccessTokenRequestSlice(reader io.Reader, consumer runtime.Consumer) ([]AccessTokenRequest, error)

UnmarshalAccessTokenRequestSlice unmarshals polymorphic slices of AccessTokenRequest

type AuthCodeRequest 

type AuthCodeRequest struct {

	// body
	// Required: true
	Body *AuthCodeRequestBody `json:"body"`
}

AuthCodeRequest HTTP Request Body of an Auth Code swagger:model AuthCodeRequest

func (*AuthCodeRequest) Validate 

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

Validate validates this auth code request

type AuthCodeRequestBody 

type AuthCodeRequestBody struct {

	// resource id
	// Required: true
	ResourceID manifold.ID `json:"resource_id"`
}

AuthCodeRequestBody auth code request body swagger:model AuthCodeRequestBody

func (*AuthCodeRequestBody) Validate 

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

Validate validates this auth code request body

type AuthorizationCode 

type AuthorizationCode struct {

	// code
	// Required: true
	Code Code `json:"code"`
	// contains filtered or unexported fields
}

AuthorizationCode authorization code swagger:model authorization_code

func (*AuthorizationCode) ClientID 

func (m *AuthorizationCode) ClientID() manifold.ID

func (*AuthorizationCode) ClientSecret 

func (m *AuthorizationCode) ClientSecret() OAuthClientSecret

func (*AuthorizationCode) GrantType 

func (m *AuthorizationCode) GrantType() string

func (AuthorizationCode) MarshalJSON 

func (m AuthorizationCode) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*AuthorizationCode) SetClientID 

func (m *AuthorizationCode) SetClientID(val manifold.ID)

func (*AuthorizationCode) SetClientSecret 

func (m *AuthorizationCode) SetClientSecret(val OAuthClientSecret)

func (*AuthorizationCode) SetGrantType 

func (m *AuthorizationCode) SetGrantType(val string)

func (*AuthorizationCode) UnmarshalJSON 

func (m *AuthorizationCode) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*AuthorizationCode) Validate 

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

Validate validates this authorization code

type CallbackResponse 

type CallbackResponse struct {

	// credentials
	Credentials map[string]string `json:"credentials,omitempty"`

	// message
	// Required: true
	// Max Length: 256
	// Min Length: 3
	Message *string `json:"message"`

	// state
	// Required: true
	State *string `json:"state"`
}

CallbackResponse A callback sent from a provider to complete an asynchronous request.

Credentials can only be specified *if* the callback corresponds with a credential provisioning request.

swagger:model CallbackResponse

func (*CallbackResponse) Validate 

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

Validate validates this callback response

type ClientCredentials 

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

ClientCredentials client credentials swagger:model client_credentials

func (*ClientCredentials) ClientID 

func (m *ClientCredentials) ClientID() manifold.ID

func (*ClientCredentials) ClientSecret 

func (m *ClientCredentials) ClientSecret() OAuthClientSecret

func (*ClientCredentials) GrantType 

func (m *ClientCredentials) GrantType() string

func (ClientCredentials) MarshalJSON 

func (m ClientCredentials) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*ClientCredentials) SetClientID 

func (m *ClientCredentials) SetClientID(val manifold.ID)

func (*ClientCredentials) SetClientSecret 

func (m *ClientCredentials) SetClientSecret(val OAuthClientSecret)

func (*ClientCredentials) SetGrantType 

func (m *ClientCredentials) SetGrantType(val string)

func (*ClientCredentials) UnmarshalJSON 

func (m *ClientCredentials) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*ClientCredentials) Validate 

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

Validate validates this client credentials

type Code 

type Code string

Code An authorization code used by a provider in exchange for a scoped Access Token.

swagger:model Code

func (Code) Validate 

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

Validate validates this code

type CredentialRotationRequest added in v0.15.0 

type CredentialRotationRequest struct {

	// credential id
	// Required: true
	CredentialID manifold.ID `json:"credential_id"`

	// reason
	// Required: true
	// Max Length: 256
	// Min Length: 3
	Reason *string `json:"reason"`

	// resource id
	// Required: true
	ResourceID manifold.ID `json:"resource_id"`
}

CredentialRotationRequest The information on the credential rotation to perform.

swagger:model CredentialRotationRequest

func (*CredentialRotationRequest) Validate added in v0.15.0 

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

Validate validates this credential rotation request

type Identity 

type Identity interface {
	runtime.Validatable

	// type
	// Required: true
	Type() string
	SetType(string)
}

Identity The underlying actor represented by the current Access Token. swagger:discriminator Identity type

func UnmarshalIdentity 

func UnmarshalIdentity(reader io.Reader, consumer runtime.Consumer) (Identity, error)

UnmarshalIdentity unmarshals polymorphic Identity

func UnmarshalIdentitySlice 

func UnmarshalIdentitySlice(reader io.Reader, consumer runtime.Consumer) ([]Identity, error)

UnmarshalIdentitySlice unmarshals polymorphic slices of Identity

type OAuthClientSecret 

type OAuthClientSecret string

OAuthClientSecret Client Secret portion of the OAuth Credentials used for accessing the Manifold Connector API. A client secret is a 32byte base64 encoded value.

This value must be kept a secret.

swagger:model OAuthClientSecret

func (OAuthClientSecret) Validate 

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

Validate validates this o auth client secret

type OAuthCredentialCreateRequest 

type OAuthCredentialCreateRequest struct {

	// A human readable description of this credential pair.
	//
	// Required: true
	// Max Length: 256
	// Min Length: 3
	Description *string `json:"description"`

	// Product identifier to scope the credential to a single product.
	//
	ProductID *manifold.ID `json:"product_id,omitempty"`

	// **ALPHA** Provider identifier to scope the credential to
	// all products of a provider.
	//
	ProviderID *manifold.ID `json:"provider_id,omitempty"`
}

OAuthCredentialCreateRequest o auth credential create request swagger:model OAuthCredentialCreateRequest

func (*OAuthCredentialCreateRequest) Validate 

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

Validate validates this o auth credential create request

type OAuthCredentialCreateResponse 

type OAuthCredentialCreateResponse struct {

	// secret
	// Required: true
	Secret OAuthClientSecret `json:"secret"`

	OAuthCredentialGetResponse
}

OAuthCredentialCreateResponse o auth credential create response swagger:model OAuthCredentialCreateResponse

func (OAuthCredentialCreateResponse) MarshalJSON 

func (m OAuthCredentialCreateResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*OAuthCredentialCreateResponse) UnmarshalJSON 

func (m *OAuthCredentialCreateResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*OAuthCredentialCreateResponse) Validate 

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

Validate validates this o auth credential create response

type OAuthCredentialGetResponse 

type OAuthCredentialGetResponse struct {

	// created at
	// Required: true
	CreatedAt *strfmt.DateTime `json:"created_at"`

	// expires at
	ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`

	// id
	// Required: true
	ID manifold.ID `json:"id"`

	// updated at
	// Required: true
	UpdatedAt *strfmt.DateTime `json:"updated_at"`

	OAuthCredentialCreateRequest
}

OAuthCredentialGetResponse o auth credential get response swagger:model OAuthCredentialGetResponse

func (OAuthCredentialGetResponse) MarshalJSON 

func (m OAuthCredentialGetResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*OAuthCredentialGetResponse) UnmarshalJSON 

func (m *OAuthCredentialGetResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*OAuthCredentialGetResponse) Validate 

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

Validate validates this o auth credential get response

type Product 

type Product struct {

	// target
	// Required: true
	Target *ProductAO1Target `json:"target"`
}

Product product swagger:model product

func (Product) MarshalJSON 

func (m Product) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*Product) SetType 

func (m *Product) SetType(val string)

func (*Product) Type 

func (m *Product) Type() string

func (*Product) UnmarshalJSON 

func (m *Product) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*Product) Validate 

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

Validate validates this product

type ProductAO1Target 

type ProductAO1Target struct {

	// label
	// Required: true
	Label manifold.Label `json:"label"`

	// name
	// Required: true
	Name manifold.Name `json:"name"`
}

ProductAO1Target product a o1 target swagger:model ProductAO1Target

func (*ProductAO1Target) Validate 

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

Validate validates this product a o1 target

type Profile 

type Profile struct {

	// email
	// Required: true
	Email manifold.Email `json:"email"`

	// id
	ID manifold.ID `json:"id,omitempty"`

	// name
	// Required: true
	Name manifold.Name `json:"name"`

	// role
	Role UserRole `json:"role,omitempty"`
}

Profile A view of a Manifold User.

Do not store any of this data, instead query Manifold for the most up to date information.

swagger:model Profile

func (*Profile) Validate 

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

Validate validates this profile

type Project added in v0.14.0 

type Project struct {

	// description
	// Max Length: 1000
	// Min Length: 1
	Description string `json:"description,omitempty"`

	// id
	ID manifold.ID `json:"id,omitempty"`

	// label
	Label manifold.Label `json:"label,omitempty"`

	// name
	Name manifold.Name `json:"name,omitempty"`

	// resources
	Resources []*Resource `json:"resources"`
}

Project project swagger:model Project

func (*Project) Validate added in v0.14.0 

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

Validate validates this project

type Provider added in v0.15.2 

type Provider struct {

	// target
	// Required: true
	Target *ProviderAO1Target `json:"target"`
}

Provider provider swagger:model provider

func (Provider) MarshalJSON added in v0.15.2 

func (m Provider) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*Provider) SetType added in v0.15.2 

func (m *Provider) SetType(val string)

func (*Provider) Type added in v0.15.2 

func (m *Provider) Type() string

func (*Provider) UnmarshalJSON added in v0.15.2 

func (m *Provider) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*Provider) Validate added in v0.15.2 

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

Validate validates this provider

type ProviderAO1Target added in v0.15.2 

type ProviderAO1Target struct {

	// label
	// Required: true
	Label manifold.Label `json:"label"`

	// name
	// Required: true
	Name manifold.Name `json:"name"`
}

ProviderAO1Target provider a o1 target swagger:model ProviderAO1Target

func (*ProviderAO1Target) Validate added in v0.15.2 

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

Validate validates this provider a o1 target

type RegionSlug 

type RegionSlug string

RegionSlug Combination of the cloud platform and location to provision this resource within.

swagger:model RegionSlug

func (RegionSlug) Validate 

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

Validate validates this region slug

type Resource 

type Resource struct {

	// created at
	CreatedAt strfmt.DateTime `json:"created_at,omitempty"`

	// features
	Features manifold.FeatureMap `json:"features,omitempty"`

	// id
	ID manifold.ID `json:"id,omitempty"`

	// label
	Label manifold.Label `json:"label,omitempty"`

	// This field is deprecated in favor of label
	Name manifold.Name `json:"name,omitempty"`

	// plan
	Plan manifold.Label `json:"plan,omitempty"`

	// product
	Product manifold.Label `json:"product,omitempty"`

	// region
	Region RegionSlug `json:"region,omitempty"`

	// updated at
	UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}

Resource A view of a Resource provisioned through Manifold.

Do not store any of this data, instead query Manifold for the most up to date information.

swagger:model Resource

func (*Resource) Validate 

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

Validate validates this resource

type ResourceCredentials added in v0.14.0 

type ResourceCredentials struct {

	// created on
	// Required: true
	CreatedOn *strfmt.DateTime `json:"created_on"`

	// Map of configuration variable aliases to original names
	CustomNames map[string]string `json:"custom_names,omitempty"`

	// Map of configuration variable names to values, names
	// must IEEE 1003.1 - 2001 Standard (checked in code).
	//
	// Required: true
	Keys map[string]string `json:"keys"`
}

ResourceCredentials resource credentials swagger:model ResourceCredentials

func (*ResourceCredentials) Validate added in v0.14.0 

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

Validate validates this resource credentials

type ResourceMeasure added in v0.14.0 

type ResourceMeasure struct {

	// feature
	// Required: true
	Feature *ResourceMeasureFeature `json:"feature"`

	// feature value
	// Required: true
	FeatureValue *ResourceMeasureFeatureValue `json:"feature_value"`

	// max
	Max *int64 `json:"max,omitempty"`

	// suffix
	Suffix *string `json:"suffix,omitempty"`

	// usage
	// Required: true
	Usage int64 `json:"usage"`
}

ResourceMeasure resource measure swagger:model ResourceMeasure

func (*ResourceMeasure) Validate added in v0.14.0 

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

Validate validates this resource measure

type ResourceMeasureFeature added in v0.14.0 

type ResourceMeasureFeature struct {

	// label
	Label manifold.Label `json:"label,omitempty"`

	// name
	Name manifold.Name `json:"name,omitempty"`
}

ResourceMeasureFeature resource measure feature swagger:model ResourceMeasureFeature

func (*ResourceMeasureFeature) Validate added in v0.14.0 

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

Validate validates this resource measure feature

type ResourceMeasureFeatureValue added in v0.14.0 

type ResourceMeasureFeatureValue struct {

	// A machine readable unique label, which is url safe.
	// Pattern: ^[a-z0-9][a-z0-9-_\.]{1,128}$
	Label string `json:"label,omitempty"`

	// name
	Name manifold.Name `json:"name,omitempty"`
}

ResourceMeasureFeatureValue resource measure feature value swagger:model ResourceMeasureFeatureValue

func (*ResourceMeasureFeatureValue) Validate added in v0.14.0 

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

Validate validates this resource measure feature value

type ResourceMeasures added in v0.14.0 

type ResourceMeasures struct {

	// body
	// Required: true
	Body *ResourceMeasuresBody `json:"body"`
}

ResourceMeasures resource measures swagger:model ResourceMeasures

func (*ResourceMeasures) Validate added in v0.14.0 

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

Validate validates this resource measures

type ResourceMeasuresBody added in v0.14.0 

type ResourceMeasuresBody struct {

	// measures
	// Required: true
	Measures map[string]int64 `json:"measures"`

	// period end
	// Required: true
	PeriodEnd *strfmt.DateTime `json:"period_end"`

	// period start
	// Required: true
	PeriodStart *strfmt.DateTime `json:"period_start"`

	// resource id
	// Required: true
	ResourceID manifold.ID `json:"resource_id"`
}

ResourceMeasuresBody resource measures body swagger:model ResourceMeasuresBody

func (*ResourceMeasuresBody) Validate added in v0.14.0 

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

Validate validates this resource measures body

type ResourceMeasuresUsage added in v0.14.0 

type ResourceMeasuresUsage struct {

	// measures
	Measures []*ResourceMeasure `json:"measures"`

	// period end
	PeriodEnd strfmt.DateTime `json:"period_end,omitempty"`

	// period start
	PeriodStart strfmt.DateTime `json:"period_start,omitempty"`

	// updated at
	UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}

ResourceMeasuresUsage resource measures usage swagger:model ResourceMeasuresUsage

func (*ResourceMeasuresUsage) Validate added in v0.14.0 

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

Validate validates this resource measures usage

type ResourceMeasuresUsages added in v0.14.0 

type ResourceMeasuresUsages []*ResourceMeasuresUsage

ResourceMeasuresUsages resource measures usages swagger:model ResourceMeasuresUsages

func (ResourceMeasuresUsages) Validate added in v0.14.0 

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

Validate validates this resource measures usages

type Team added in v0.14.0 

type Team struct {

	// id
	ID manifold.ID `json:"id,omitempty"`

	// label
	Label manifold.Label `json:"label,omitempty"`

	// name
	Name manifold.Name `json:"name,omitempty"`

	// projects
	Projects []*Project `json:"projects"`

	// resources
	Resources []*Resource `json:"resources"`

	// user role
	UserRole UserRole `json:"user_role,omitempty"`
}

Team team swagger:model Team

func (*Team) Validate added in v0.14.0 

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

Validate validates this team

type User 

type User struct {

	// target
	// Required: true
	Target *UserAO1Target `json:"target"`
}

User user swagger:model user

func (User) MarshalJSON 

func (m User) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*User) SetType 

func (m *User) SetType(val string)

func (*User) Type 

func (m *User) Type() string

func (*User) UnmarshalJSON 

func (m *User) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*User) Validate 

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

Validate validates this user

type UserAO1Target 

type UserAO1Target struct {

	// email
	// Required: true
	Email manifold.Email `json:"email"`

	// id
	ID manifold.ID `json:"id,omitempty"`

	// name
	// Required: true
	Name manifold.Name `json:"name"`

	// projects
	Projects []*Project `json:"projects"`

	// resources
	Resources []*Resource `json:"resources"`

	// teams
	Teams []*Team `json:"teams"`
}

UserAO1Target user a o1 target swagger:model UserAO1Target

func (*UserAO1Target) Validate 

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

Validate validates this user a o1 target

type UserRole added in v0.14.0 

type UserRole string

UserRole user role swagger:model UserRole 

const (
	// UserRoleOwner captures enum value "owner"
	UserRoleOwner UserRole = "owner"
	// UserRoleMember captures enum value "member"
	UserRoleMember UserRole = "member"
	// UserRoleAdmin captures enum value "admin"
	UserRoleAdmin UserRole = "admin"
)

func (UserRole) Validate added in v0.14.0 

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

Validate validates this user role

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.