Documentation
¶
Index ¶
Constants ¶
const ( // ServiceProviderTenant captures enum value "tenant" ServiceProviderTenant string = "tenant" // ServiceProviderCp captures enum value "cp" ServiceProviderCp string = "cp" )
const ( // ServiceStatusAVAILABLE captures enum value "AVAILABLE" ServiceStatusAVAILABLE string = "AVAILABLE" // ServiceStatusPENDINGCREATE captures enum value "PENDING_CREATE" ServiceStatusPENDINGCREATE string = "PENDING_CREATE" // ServiceStatusPENDINGUPDATE captures enum value "PENDING_UPDATE" ServiceStatusPENDINGUPDATE string = "PENDING_UPDATE" // ServiceStatusPENDINGDELETE captures enum value "PENDING_DELETE" ServiceStatusPENDINGDELETE string = "PENDING_DELETE" // ServiceStatusUNAVAILABLE captures enum value "UNAVAILABLE" ServiceStatusUNAVAILABLE string = "UNAVAILABLE" // ServiceStatusERRORQUOTA captures enum value "ERROR_QUOTA" ServiceStatusERRORQUOTA string = "ERROR_QUOTA" )
const ( // ServiceVisibilityPrivate captures enum value "private" ServiceVisibilityPrivate string = "private" // ServiceVisibilityPublic captures enum value "public" ServiceVisibilityPublic string = "public" )
const ( // ServiceUpdatableVisibilityPrivate captures enum value "private" ServiceUpdatableVisibilityPrivate string = "private" // ServiceUpdatableVisibilityPublic captures enum value "public" ServiceUpdatableVisibilityPublic string = "public" )
const ( // RbacpolicyTargetTypeProject captures enum value "project" RbacpolicyTargetTypeProject string = "project" )
const ( // RbacpolicycommonTargetTypeProject captures enum value "project" RbacpolicycommonTargetTypeProject string = "project" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Endpoint ¶
type Endpoint struct {
// created at
CreatedAt time.Time `json:"created_at,omitempty"`
// Description of the endpoint.
// Example: An example of an endpoint.
// Max Length: 255
Description string `json:"description"`
// The ID of the resource.
// Read Only: true
// Format: uuid
ID strfmt.UUID `json:"id,omitempty"`
// Endpoint IP address.
// Example: 1.2.3.4
// Read Only: true
// Format: ipv4
IPAddress strfmt.IPv4 `json:"ip_address,omitempty"`
// Name of the endpoint.
// Example: Example endpoint.
// Max Length: 64
Name string `json:"name"`
// project id
ProjectID Project `json:"project_id"`
// The ID of the service.
// Format: uuid
ServiceID strfmt.UUID `json:"service_id,omitempty"`
// status
Status EndpointStatus `json:"status,omitempty"`
// The list of tags on the resource.
Tags []string `json:"tags"`
// target
Target EndpointTarget `json:"target,omitempty"`
// updated at
UpdatedAt time.Time `json:"updated_at,omitempty"`
}
Endpoint endpoint
swagger:model Endpoint
func (*Endpoint) ContextValidate ¶
ContextValidate validate this endpoint based on the context it is used
func (*Endpoint) MarshalBinary ¶
MarshalBinary interface implementation
func (*Endpoint) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EndpointConsumer ¶
type EndpointConsumer struct {
// The ID of the resource.
// Read Only: true
// Format: uuid
ID strfmt.UUID `json:"id,omitempty"`
// project id
ProjectID Project `json:"project_id"`
// status
Status EndpointStatus `json:"status,omitempty"`
}
EndpointConsumer endpoint consumer
swagger:model EndpointConsumer
func (*EndpointConsumer) ContextValidate ¶
ContextValidate validate this endpoint consumer based on the context it is used
func (*EndpointConsumer) MarshalBinary ¶
func (m *EndpointConsumer) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointConsumer) UnmarshalBinary ¶
func (m *EndpointConsumer) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointConsumerList ¶
type EndpointConsumerList struct {
// endpoint ids
EndpointIds []strfmt.UUID `json:"endpoint_ids"`
// project ids
ProjectIds []Project `json:"project_ids"`
}
EndpointConsumerList list of consumer ids.
swagger:model EndpointConsumerList
func (*EndpointConsumerList) ContextValidate ¶
ContextValidate validate this endpoint consumer list based on the context it is used
func (*EndpointConsumerList) MarshalBinary ¶
func (m *EndpointConsumerList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointConsumerList) UnmarshalBinary ¶
func (m *EndpointConsumerList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointStatus ¶
type EndpointStatus string
EndpointStatus Status of the endpoint
### Status can be one of | Status | Description | | ------------------ | ------------------------------------- | | AVAILABLE | Endpoint is avaiable for consumption | | PENDING_APPROVAL | Endpoint is waiting for approval | | PENDING_CREATE | Endpoint is being set up | | PENDING_UPDATE | Endpoint is being updated | | PENDING_REJECTED | Endpoint is being rejected | | PENDING_DELETE | Endpoint is being deleted | | REJECTED | Endpoint was rejected | | FAILED | Endpoint setup failed |
swagger:model EndpointStatus
const ( // EndpointStatusAVAILABLE captures enum value "AVAILABLE" EndpointStatusAVAILABLE EndpointStatus = "AVAILABLE" // EndpointStatusPENDINGAPPROVAL captures enum value "PENDING_APPROVAL" EndpointStatusPENDINGAPPROVAL EndpointStatus = "PENDING_APPROVAL" // EndpointStatusPENDINGCREATE captures enum value "PENDING_CREATE" EndpointStatusPENDINGCREATE EndpointStatus = "PENDING_CREATE" // EndpointStatusPENDINGUPDATE captures enum value "PENDING_UPDATE" EndpointStatusPENDINGUPDATE EndpointStatus = "PENDING_UPDATE" // EndpointStatusPENDINGREJECTED captures enum value "PENDING_REJECTED" EndpointStatusPENDINGREJECTED EndpointStatus = "PENDING_REJECTED" // EndpointStatusPENDINGDELETE captures enum value "PENDING_DELETE" EndpointStatusPENDINGDELETE EndpointStatus = "PENDING_DELETE" // EndpointStatusREJECTED captures enum value "REJECTED" EndpointStatusREJECTED EndpointStatus = "REJECTED" // EndpointStatusFAILED captures enum value "FAILED" EndpointStatusFAILED EndpointStatus = "FAILED" )
func NewEndpointStatus ¶
func NewEndpointStatus(value EndpointStatus) *EndpointStatus
func (EndpointStatus) ContextValidate ¶
ContextValidate validate this endpoint status based on the context it is used
func (EndpointStatus) Pointer ¶
func (m EndpointStatus) Pointer() *EndpointStatus
Pointer returns a pointer to a freshly-allocated EndpointStatus.
type EndpointTarget ¶
type EndpointTarget struct {
// Endpoint network target. One of `target_network`, `target_subnet` or `target_port` must be specified.
// Example: 49b6480b-24d3-4376-a4c9-aecbb89e16d9
// Format: uuid
Network *strfmt.UUID `json:"network,omitempty"`
// Endpoint port target. One of `target_network`, `target_subnet` or `target_port` must be specified.
// Example: b2accf1a-1c99-4b54-9eeb-22be53f177f5
// Format: uuid
Port *strfmt.UUID `json:"port,omitempty"`
// Endpoint subnet target. One of `target_network`, `target_subnet` or `target_port` must be specified.
// Example: 1fb12a1a-a1a5-4732-9a2e-635ba6ec8d3b
// Format: uuid
Subnet *strfmt.UUID `json:"subnet,omitempty"`
}
EndpointTarget Endpoint target
swagger:model EndpointTarget
func (*EndpointTarget) ContextValidate ¶
ContextValidate validates this endpoint target based on context it is used
func (*EndpointTarget) MarshalBinary ¶
func (m *EndpointTarget) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointTarget) UnmarshalBinary ¶
func (m *EndpointTarget) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// code
Code int64 `json:"code,omitempty"`
// message
Message string `json:"message,omitempty"`
}
Error error
swagger:model Error
func (*Error) ContextValidate ¶
ContextValidate validates this error based on context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Link ¶
type Link struct {
// href
// Example: /
Href string `json:"href,omitempty"`
// rel
// Example: self
Rel string `json:"rel,omitempty"`
}
Link link
swagger:model Link
func (*Link) ContextValidate ¶
ContextValidate validates this link based on context it is used
func (*Link) MarshalBinary ¶
MarshalBinary interface implementation
func (*Link) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Project ¶
type Project string
Project The ID of the project owning this resource. Example: fa84c217f361441986a220edf9b1e337
swagger:model Project
func (Project) ContextValidate ¶
ContextValidate validates this project based on context it is used
type Quota ¶
type Quota struct {
// The configured endpoint quota limit. A setting of null means it is using the deployment default quota. A setting of -1 means unlimited.
// Example: 5
// Minimum: -1
Endpoint int64 `json:"endpoint,omitempty"`
// The configured service quota limit. A setting of null means it is using the deployment default quota. A setting of -1 means unlimited.
// Example: 5
// Minimum: -1
Service int64 `json:"service,omitempty"`
}
Quota quota
swagger:model Quota
func (*Quota) ContextValidate ¶
ContextValidate validates this quota based on context it is used
func (*Quota) MarshalBinary ¶
MarshalBinary interface implementation
func (*Quota) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type QuotaUsage ¶
type QuotaUsage struct {
// The current quota usage of endpoints.
// Example: 5
InUseEndpoint int64 `json:"in_use_endpoint"`
// The current quota usage of services.
// Example: 5
InUseService int64 `json:"in_use_service"`
}
QuotaUsage quota usage
swagger:model QuotaUsage
func (*QuotaUsage) ContextValidate ¶
ContextValidate validates this quota usage based on context it is used
func (*QuotaUsage) MarshalBinary ¶
func (m *QuotaUsage) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*QuotaUsage) UnmarshalBinary ¶
func (m *QuotaUsage) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Rbacpolicy ¶
type Rbacpolicy struct {
// created at
CreatedAt time.Time `json:"created_at,omitempty"`
// The ID of the resource.
// Read Only: true
// Format: uuid
ID strfmt.UUID `json:"id,omitempty"`
// project id
ProjectID Project `json:"project_id"`
// The ID of the service resource.
// Required: true
// Format: uuid
ServiceID *strfmt.UUID `json:"service_id"`
// The ID of the project to which the RBAC policy will be enforced.
// Example: 666da95112694b37b3efb0913de3f499
Target string `json:"target,omitempty"`
// target type
// Enum: [project]
TargetType *string `json:"target_type,omitempty"`
// updated at
UpdatedAt time.Time `json:"updated_at,omitempty"`
}
Rbacpolicy rbacpolicy
swagger:model rbacpolicy
func (*Rbacpolicy) ContextValidate ¶
ContextValidate validate this rbacpolicy based on the context it is used
func (*Rbacpolicy) MarshalBinary ¶
func (m *Rbacpolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Rbacpolicy) UnmarshalBinary ¶
func (m *Rbacpolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Rbacpolicycommon ¶
type Rbacpolicycommon struct {
// The ID of the resource.
// Read Only: true
// Format: uuid
ID strfmt.UUID `json:"id,omitempty"`
// project id
ProjectID Project `json:"project_id"`
// The ID of the project to which the RBAC policy will be enforced.
// Example: 666da95112694b37b3efb0913de3f499
// Required: true
Target *string `json:"target"`
// target type
// Enum: [project]
TargetType *string `json:"target_type,omitempty"`
}
Rbacpolicycommon rbacpolicycommon
swagger:model rbacpolicycommon
func (*Rbacpolicycommon) ContextValidate ¶
ContextValidate validate this rbacpolicycommon based on the context it is used
func (*Rbacpolicycommon) MarshalBinary ¶
func (m *Rbacpolicycommon) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Rbacpolicycommon) UnmarshalBinary ¶
func (m *Rbacpolicycommon) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Service ¶
type Service struct {
// Availability zone of this service.
// Example: AZ-A
AvailabilityZone *string `json:"availability_zone"`
// created at
CreatedAt time.Time `json:"created_at,omitempty"`
// Description of the service.
// Example: An example of an Service.
// Max Length: 255
Description string `json:"description"`
// Enable/disable this service. Existing endpoints are not touched by this.
Enabled *bool `json:"enabled,omitempty"`
// Device host.
// Read Only: true
Host *string `json:"host,omitempty"`
// The ID of the resource.
// Read Only: true
// Format: uuid
ID strfmt.UUID `json:"id,omitempty"`
// IP Addresses of the providing service, multiple addresses will be round robin load balanced.
// Required: true
// Min Items: 1
IPAddresses []strfmt.IPv4 `json:"ip_addresses"`
// Name of the service.
// Example: ExampleService
// Max Length: 64
Name string `json:"name"`
// Network ID of the network that provides this service.
// Required: true
// Format: uuid
NetworkID *strfmt.UUID `json:"network_id"`
// Port exposed by the service.
// Example: 80
// Required: true
// Maximum: 65535
// Minimum: 1
Port int32 `json:"port"`
// project id
ProjectID Project `json:"project_id"`
// Provider type, defaults to tenant type.
// Enum: [tenant cp]
Provider *string `json:"provider,omitempty"`
// Proxy protocol v2 enabled for this service.
ProxyProtocol *bool `json:"proxy_protocol,omitempty"`
// Require explicit project approval for the service owner.
RequireApproval *bool `json:"require_approval,omitempty"`
// Status of the service.
//
// ### Status can be one of
// | Status | Description |
// | ---------------- | -------------------------------------- |
// | AVAILABLE | Service is ready for consumption. |
// | PENDING_CREATE | Service is being set up |
// | PENDING_UPDATE | Service is being updated |
// | PENDING_DELETE | Service is being deleted |
// | UNAVAILABLE | Service is unavailable (e.g. disabled) |
// | ERROR_QUOTA | Service has not enough port quota |
//
// Read Only: true
// Enum: [AVAILABLE PENDING_CREATE PENDING_UPDATE PENDING_DELETE UNAVAILABLE ERROR_QUOTA]
Status string `json:"status,omitempty"`
// The list of tags on the resource.
Tags []string `json:"tags"`
// updated at
UpdatedAt time.Time `json:"updated_at,omitempty"`
// Set global visibility of the service. For `private` visibility, RBAC policies can extend the visibility to specific projects.
// Enum: [private public]
Visibility *string `json:"visibility,omitempty"`
}
Service service
swagger:model Service
func (*Service) ContextValidate ¶
ContextValidate validate this service based on the context it is used
func (*Service) MarshalBinary ¶
MarshalBinary interface implementation
func (*Service) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ServiceUpdatable ¶
type ServiceUpdatable struct {
// Description of the service.
// Example: An example of an Service.
// Max Length: 255
Description *string `json:"description,omitempty"`
// Enable/disable this service. Existing endpoints are not touched by this.
Enabled *bool `json:"enabled,omitempty"`
// IP Addresses of the providing service, multiple addresses will be round robin load balanced.
// Min Items: 1
IPAddresses []strfmt.IPv4 `json:"ip_addresses"`
// Name of the service.
// Example: ExampleService
// Max Length: 64
Name *string `json:"name,omitempty"`
// Port exposed by the service.
// Example: 80
// Maximum: 65535
// Minimum: 1
Port *int32 `json:"port,omitempty"`
// Proxy protocol v2 enabled for this service.
ProxyProtocol *bool `json:"proxy_protocol,omitempty"`
// Require explicit project approval for the service owner.
RequireApproval *bool `json:"require_approval,omitempty"`
// The list of tags on the resource.
Tags []string `json:"tags"`
// Set global visibility of the service. For `private` visibility, RBAC policies can extend the visibility to specific projects.
// Enum: [private public]
Visibility *string `json:"visibility,omitempty"`
}
ServiceUpdatable service updatable
swagger:model ServiceUpdatable
func (*ServiceUpdatable) ContextValidate ¶
ContextValidate validates this service updatable based on context it is used
func (*ServiceUpdatable) MarshalBinary ¶
func (m *ServiceUpdatable) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceUpdatable) UnmarshalBinary ¶
func (m *ServiceUpdatable) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Timestamp ¶
Timestamp The UTC date and timestamp. Example: 2020-05-11T17:21:34
swagger:model Timestamp
func (Timestamp) ContextValidate ¶
func (*Timestamp) MarshalBinary ¶
MarshalBinary interface implementation
func (*Timestamp) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Version ¶
type Version struct {
// capabilities
// Example: ["pagination","sort"]
Capabilities []string `json:"capabilities"`
// links
Links []*Link `json:"links"`
// Last update of the running version
// Example: 2018-09-30T00:00:00Z
Updated string `json:"updated,omitempty"`
// Version of Archer
// Example: 1.3.0
Version string `json:"version,omitempty"`
}
Version version
swagger:model Version
func (*Version) ContextValidate ¶
ContextValidate validate this version based on the context it is used
func (*Version) MarshalBinary ¶
MarshalBinary interface implementation
func (*Version) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files