client

type APIClient struct {
	AllocationApi AllocationAPI

	AvailableResourcesApi AvailableResourcesAPI

	HostsApi HostsAPI

	IppoolsApi IPPoolsAPI

	NetworksApi NetworksAPI

	ProjectsApi ProjectsAPI

	ProjectsInfoApi ProjectsInfoAPI

	ServicesApi ServicesAPI

	SshkeysApi SshkeysAPI

	VersionApi VersionAPI

	VolumeAttachmentsApi VolumeAttachmentsAPI

	VolumesApi VolumesAPI
	// contains filtered or unexported fields
}

type APIKey struct {
	Key    string
	Prefix string
}

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

type AddVolume struct {
	Name        string `json:"Name,omitempty"`
	Description string `json:"Description,omitempty"`
	// This object is used for new volume creation in the host create operation. Since host create already has location ID that field is not provided in this object.
	FlavorID string `json:"FlavorID,omitempty"`
	// The size of the volume in GiB
	Capacity int64 `json:"Capacity,omitempty"`
	// Indicates if the volume can be attached to multiple hosts
	Shareable bool `json:"Shareable,omitempty"`
	// The storage pool is one of those listed by the StoragePools array returned as part of the get /available-resources call that are available to create volumes of the specified flavor and location.
	StoragePoolID string `json:"StoragePoolID,omitempty"`
	// The  optional volume collection is one of those listed by the VolumeCollections  array returned as part of the get /available-resources call
	VolumeCollectionID string `json:"VolumeCollectionID,omitempty"`
}

type Algorithm string

type Allocation struct {
	// Type of the resource the allocation information is listed for.
	ResourceType string `json:"ResourceType"`
	// Total number of servers.
	Total int32 `json:"Total"`
	// Instance type family name.
	InstanceFamily string `json:"InstanceFamily"`
	// Server instance type
	InstanceType string `json:"InstanceType"`
	// Available number of servers.
	Available int32 `json:"Available"`
	// Array listing of server allocation information for each service type.
	AllocationInfo []ServiceServerInfo `json:"AllocationInfo"`
}

type AllocationAPI interface {
	/*
	   GetBySite Get servers allocation
	   Returns an array of allocation information for each server instance type. Each instance type's allocation information is further grouped by service type. When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. If the 'siteID' query parameter is present, the information returned is specific to that site ID.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param optional nil or *AllocationApiGetBySiteOpts - Optional Parameters:
	     - @param "SiteID" (optional.String) -  site ID

	   @return []Allocation
	*/
	GetBySite(ctx _context.Context, localVarOptionals *AllocationApiGetBySiteOpts) ([]Allocation, *_nethttp.Response, error)
	/*
	   StorageGetBySite Get storage allocation
	   Returns an array of allocation information for each server instance type. Each instance type's allocation information is further grouped by service type. When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. If the 'siteID' query parameter is present, the information returned is specific to that site ID.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param optional nil or *AllocationApiStorageGetBySiteOpts - Optional Parameters:
	     - @param "SiteID" (optional.String) -  site ID

	   @return []AllocationStorage
	*/
	StorageGetBySite(ctx _context.Context, localVarOptionals *AllocationApiStorageGetBySiteOpts) ([]AllocationStorage, *_nethttp.Response, error)
}

type AllocationApiGetBySiteOpts struct {
	SiteID optional.String
}

type AllocationApiService service

type AllocationApiStorageGetBySiteOpts struct {
	SiteID optional.String
}

type AllocationStorage struct {
	// Type of the resource the allocation information is listed for.
	ResourceType string `json:"ResourceType"`
	// Total storage capacity in TB
	Total float32 `json:"Total"`
	// Instance type family name.
	InstanceFamily string `json:"InstanceFamily"`
	// volume type
	InstanceType string `json:"InstanceType"`
	// Available storage space in TB
	Available float32 `json:"Available"`
	// Array listing the storage allocation information for each service type.
	AllocationInfo []ServiceStorageInfo `json:"AllocationInfo"`
}

type AttributeRule struct {
	// The machine attribute.
	Attribute string `json:"Attribute"`
	// The value for the attribute.
	Value    string             `json:"Value"`
	Operator ClassifierOperator `json:"Operator"`
}

type AvailableImage struct {
	// Unique ID for imaging service
	ID string `json:"ID"`
	// Top-level grouping of imaging services that may reference an OS or application type
	Category string `json:"Category"`
	// Second-level grouping of imaging services.  Typically references a specific OS or application.
	Flavor string `json:"Flavor"`
	// Name of imaging service.
	Name string `json:"Name"`
	// Specific version of a imaging service flavor.
	Version string `json:"Version"`
	// Additional image information for additional services added to the OS
	Description string `json:"Description"`
}

type AvailableNetwork struct {
	// ID of the network
	ID string `json:"ID"`
	// The name of the network
	Name string `json:"Name"`
	// The location ID is the data center location of the resource.  The LocationID must be one of those provided by the LocationInfo array returned as part of the get /available-resources call.  The locations are typically described by country, region, and data center.
	LocationID  string         `json:"LocationID"`
	Description string         `json:"Description"`
	HostUse     NetworkHostUse `json:"HostUse"`
	Purpose     NetworkPurpose `json:"Purpose"`
	IPPoolID    string         `json:"IPPoolID"`
	// VLAN ID of the network
	VLAN int32 `json:"VLAN"`
	// VNI ID of the network
	VNI int32 `json:"VNI"`
}

type AvailableResources struct {
	// Array listing the available host imaging services
	Images []AvailableImage `json:"Images"`
	// Array listing the data center locations with available resources
	Locations []LocationInfo `json:"Locations"`
	// Array listing the networks available for host connections
	Networks []AvailableNetwork `json:"Networks"`
	// Array listing the available machine (server) sizes
	MachineSizes []MachineSize `json:"MachineSizes"`
	// Array listing the available volume flavors
	VolumeFlavors []VolumeFlavor `json:"VolumeFlavors"`
	// Array listing the existing project volumes that could be attached to a host
	Volumes []VolumeInfo `json:"Volumes"`
	// Array listing the number of machines of each size in each location
	MachineInventory []MachineInventory `json:"MachineInventory"`
	// Array providing information on the amount of available storage of each flavor in each location
	StorageInventory []StorageInventory `json:"StorageInventory"`
	// Array listing pre-defined SSH keys that could be referenced when creating a Host
	SSHKeys []SshKeyEntry `json:"SSHKeys"`
	// Array listing the available storage pools
	StoragePools []StoragePool `json:"StoragePools"`
	// Array listing the available volume collections
	VolumeCollections []VolumeCollection `json:"VolumeCollections"`
}

type AvailableResourcesAPI interface {
	/*
	   List Get lists of available resources for creating hosts and volumes
	   Used to get lists of options that are used when creating hosts and volumes. A get /available-resources will return an object that includes the following arrays: * Images - A list of image service IDs along with their category (Linux),    flavor (ubuntu), and version (18.04)  * MachineSizes - A list of machine size IDs along with the machine size    names and detailed descriptions  * Locations - A list of location IDs along with their country, region,    and data center.  * Networks - A list of available Network IDs along with the network name,   location ID, network kind, and host usage (Required, Default, Optional)  * MachineInventory - Information about the available inventory of machines    based on location ID and machine size ID.  While this information may    change rapidly, it can be used by GUIs and systems to restrict host   creates to locations with the desired machine size.  * StorageInventory - Information about the current available storage capacity    for a specific volume flavor by site.   * VolumeFlavors - A list of volume flavor IDs along with their name and    detailed description.  * Volumes - A list of current, existing volumes.  If the volume is in the   the right state, it could be attached to a new Host.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

	   @return AvailableResources
	*/
	List(ctx _context.Context) (AvailableResources, *_nethttp.Response, error)
}

type AvailableResourcesApiService service

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

type BondMode string

type BootMethod string

type ClassifierOperator string

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

type Country string

type DiskPartitions struct {
	// Indicates the device name of the disk of the form /dev/sdX as known by the os e.g. /dev/sda This is the default device that will be used to deploy the OS Image to the host. The default value may be overridden when creating the host by a UUID/NAA/EUI  logical volume ID (BootDeviceID).
	Device      string `json:"Device"`
	Description string `json:"Description"`
	// StartOffset is the offset from the start of the disk to the first partition,  if zero a default of 1 MiB (2048 sectors) will be used, units bytes.
	StartOffset int64          `json:"StartOffset"`
	TableType   PartitionTable `json:"TableType"`
	Partitions  []Partition    `json:"Partitions"`
}

type Encoding string

type ErrorResponse struct {
	// Description of the error condition
	Message string `json:"message"`
	// Optional verbose description of the error condition
	Details string `json:"details,omitempty"`
}

type FileInfo struct {
	// Unique ID of this FileInfo.
	ID string `json:"ID"`
	// Depending upon the service approach, this is either the mount-path where the file should be placed or  the relative URL where it should be served.
	Path string `json:"Path"`
	// Size of the files in bytes.
	FileSize int32 `json:"FileSize"`
	// Maximum amount of time in seconds to download the Service image.
	DownloadTimeout int64 `json:"DownloadTimeout"`
	// The signature (checksum) of the image to download.  This ensure the integrity and authenticity of the images downloaded.
	Signature string    `json:"Signature"`
	Algorithm Algorithm `json:"Algorithm"`
	// Indicates if the file is compressed and should be expanded  using the filename suffix in the Path as a guide.
	Expand bool `json:"Expand"`
	// URL of the file that should be returned in REST response or used for display purpose. The file is downloaded from this URL only when SecureURL is not set.
	DisplayURL string `json:"DisplayURL"`
	// URL of the file that should be kept secret.  If this field is set, it will be used for accessing the file and DisplayURL will be ignored.
	SecureURL string `json:"SecureURL"`
}

type FlavorDesc struct {
	// Groups flavors together to make finding a specific flavor easier
	Collection string   `json:"Collection"`
	Banner1    string   `json:"Banner1"`
	Banner2    string   `json:"Banner2"`
	Bullets    []string `json:"Bullets"`
	// URI to more information about the specific machine size or volume flavor
	InfoLink string `json:"InfoLink"`
	// Supplemental tooltip text to use in GUIs
	Tooltip string `json:"Tooltip"`
}

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

type HealthStatus string

type Host struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// Time when the resource was created in the database
	Created time.Time `json:"Created"`
	// Time when the resource was last modified in the database
	Modified    time.Time `json:"Modified"`
	Description string    `json:"Description"`
	// The image service identifier used to image the server. ServiceID is one of those listed by the Images array returned as part of the get /available-resources call.
	ServiceID string `json:"ServiceID"`
	// Overall flavor of server image used to image the server
	ServiceFlavor string `json:"ServiceFlavor"`
	// Version of the ServiceFlavor used to image the server
	ServiceVersion string `json:"ServiceVersion"`
	// The location of the machine assigned to the host.  LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call.
	LocationID string `json:"LocationID"`
	// Name of the machine size used to identify and select the machine assigned to the host.  MachineSizes are described by the MachineSize array returned by the get /available-resources call.
	MachineSizeName string `json:"MachineSizeName"`
	// UniqueID referring to the machine size used to identify and select the machine assigned to the host.  MachineSizes are described by the MachineSize array returned by the get /available-resources call.
	MachineSizeID string `json:"MachineSizeID"`
	// UniqueID referring to the machine on which this host is running.
	MachineID string `json:"MachineID"`
	// IDs of SSH Keys used when configuring the Host
	SSHKeyIDs []string `json:"SSHKeyIDs"`
	// Specific SSH keys that were when configuring the host.
	SSHAuthorizedKeys []string `json:"SSHAuthorizedKeys"`
	// The list of IDs corresponding to the networks that were provisioned to the host. These networks are among those listed in the Networks array returned by the get /available-resources call.
	NetworkIDs []string `json:"NetworkIDs"`
	// The host's default network ID. This needs to be one of the values in the  \"NetworkIDs\" list.
	NetworkForDefaultRoute string `json:"NetworkForDefaultRoute"`
	// ID of the network selected to be untagged. This needs to be one of the values in the  \"NetworkIDs\" list.
	NetworkUntagged string `json:"NetworkUntagged"`
	// The list of pre-allocated IP addresses corresponding to the list of NetworkIDs. Pre-allocated IP addresses are optional, but required when updating a host containing Pre-allocated IP addresses.
	PreAllocatedIPs []string `json:"PreAllocatedIPs"`
	// The map of Service Network (Provider) ID to Provider MAC address.   The Service Network must be a provider network provisioned to this host. Any Service Networks not included here will default to the physical MAC learned during machine discovery.
	ServiceNetsProviderMAC map[string]string `json:"ServiceNetsProviderMAC"`
	// User-provided data attached to the image configuration data when the host was provisioned
	UserData string `json:"UserData"`
	// User-provided data to represent the identity of the host within an application environment. For example, this could be set to represent the Kubernetes node ID if the host is provisioned as a Kubernetes node.
	NodeID      string           `json:"NodeID"`
	ISCSIConfig *HostIscsiConfig `json:"ISCSIConfig"`
	// Details describing host network connections
	Connections []HostConnection `json:"Connections"`
	// True if the Host has been deleted.
	Deleted bool `json:"Deleted"`
	// Describes if the portal is in active communication to the device
	PortalCommOkay bool            `json:"PortalCommOkay"`
	PowerStatus    HostPowerState  `json:"PowerStatus"`
	State          HostState       `json:"State"`
	Substate       HostSubstate    `json:"Substate"`
	StateTime      time.Time       `json:"StateTime"`
	SubstateTime   time.Time       `json:"SubstateTime"`
	Progress       int64           `json:"Progress"`
	Alert          bool            `json:"Alert"`
	AlertInfo      []HostAlertInfo `json:"AlertInfo"`
	// The current workflow the host is in
	Workflow      string       `json:"Workflow"`
	SummaryStatus HealthStatus `json:"SummaryStatus"`
	// The map of label name to label value for the resource.
	Labels map[string]string `json:"Labels"`
	// FC HBA world wide port names
	WWPNs []string `json:"WWPNs"`
}

type HostAlertInfo struct {
	// Identifies the type of alert
	Alert    string       `json:"Alert"`
	State    HostState    `json:"State"`
	Substate HostSubstate `json:"Substate"`
	// Provides some detailed description about the Alert
	Message string    `json:"Message"`
	Time    time.Time `json:"Time"`
	// Used to acknowledge the alert so that the UI can list only unacknowledged alerts
	Ack bool `json:"Ack"`
}

type HostAllOf struct {
	Description string `json:"Description"`
	// The image service identifier used to image the server. ServiceID is one of those listed by the Images array returned as part of the get /available-resources call.
	ServiceID string `json:"ServiceID"`
	// Overall flavor of server image used to image the server
	ServiceFlavor string `json:"ServiceFlavor"`
	// Version of the ServiceFlavor used to image the server
	ServiceVersion string `json:"ServiceVersion"`
	// The location of the machine assigned to the host.  LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call.
	LocationID string `json:"LocationID"`
	// Name of the machine size used to identify and select the machine assigned to the host.  MachineSizes are described by the MachineSize array returned by the get /available-resources call.
	MachineSizeName string `json:"MachineSizeName"`
	// UniqueID referring to the machine size used to identify and select the machine assigned to the host.  MachineSizes are described by the MachineSize array returned by the get /available-resources call.
	MachineSizeID string `json:"MachineSizeID"`
	// UniqueID referring to the machine on which this host is running.
	MachineID string `json:"MachineID"`
	// IDs of SSH Keys used when configuring the Host
	SSHKeyIDs []string `json:"SSHKeyIDs"`
	// Specific SSH keys that were when configuring the host.
	SSHAuthorizedKeys []string `json:"SSHAuthorizedKeys"`
	// The list of IDs corresponding to the networks that were provisioned to the host. These networks are among those listed in the Networks array returned by the get /available-resources call.
	NetworkIDs []string `json:"NetworkIDs"`
	// The host's default network ID. This needs to be one of the values in the  \"NetworkIDs\" list.
	NetworkForDefaultRoute string `json:"NetworkForDefaultRoute"`
	// ID of the network selected to be untagged. This needs to be one of the values in the  \"NetworkIDs\" list.
	NetworkUntagged string `json:"NetworkUntagged"`
	// The list of pre-allocated IP addresses corresponding to the list of NetworkIDs. Pre-allocated IP addresses are optional, but required when updating a host containing Pre-allocated IP addresses.
	PreAllocatedIPs []string `json:"PreAllocatedIPs"`
	// The map of Service Network (Provider) ID to Provider MAC address.   The Service Network must be a provider network provisioned to this host. Any Service Networks not included here will default to the physical MAC learned during machine discovery.
	ServiceNetsProviderMAC map[string]string `json:"ServiceNetsProviderMAC"`
	// User-provided data attached to the image configuration data when the host was provisioned
	UserData string `json:"UserData"`
	// User-provided data to represent the identity of the host within an application environment. For example, this could be set to represent the Kubernetes node ID if the host is provisioned as a Kubernetes node.
	NodeID      string           `json:"NodeID"`
	ISCSIConfig *HostIscsiConfig `json:"ISCSIConfig"`
	// Details describing host network connections
	Connections []HostConnection `json:"Connections"`
	// True if the Host has been deleted.
	Deleted bool `json:"Deleted"`
	// Describes if the portal is in active communication to the device
	PortalCommOkay bool            `json:"PortalCommOkay"`
	PowerStatus    HostPowerState  `json:"PowerStatus"`
	State          HostState       `json:"State"`
	Substate       HostSubstate    `json:"Substate"`
	StateTime      time.Time       `json:"StateTime"`
	SubstateTime   time.Time       `json:"SubstateTime"`
	Progress       int64           `json:"Progress"`
	Alert          bool            `json:"Alert"`
	AlertInfo      []HostAlertInfo `json:"AlertInfo"`
	// The current workflow the host is in
	Workflow      string       `json:"Workflow"`
	SummaryStatus HealthStatus `json:"SummaryStatus"`
	// The map of label name to label value for the resource.
	Labels map[string]string `json:"Labels"`
	// FC HBA world wide port names
	WWPNs []string `json:"WWPNs"`
}

type HostConnection struct {
	Name  string           `json:"Name"`
	Ports []HostServerPort `json:"Ports"`
	// Indicates whether the network connection should be a link aggregation group (LAG)
	HA bool `json:"HA"`
	// The speed of the physical connection from the server to the top of rack switch
	Speed    string                  `json:"Speed"`
	Networks []HostNetworkConnection `json:"Networks"`
}

type HostIscsiConfig struct {
	// Fully qualified iSCSI intiator name of this host. This is generated when a host is created and the information is pushed to the new host
	InitiatorName string `json:"InitiatorName"`
	// CHAP secret as generated by the system when attaching a volume.   Visible in VolumeAttachment object.
	CHAPSecret string `json:"CHAPSecret"`
	// CHAP user as generated by the system when attaching a volume.   Visible in VolumeAttachment object.
	CHAPUser              string `json:"CHAPUser"`
	ISCSIDiscoveryAddress string `json:"ISCSIDiscoveryAddress"`
}

type HostNetworkConnection struct {
	// Name of the network connection
	Name string `json:"Name"`
	// Unique ID corresponding to a network in the local data center
	NetworkID string `json:"NetworkID"`
	// IP address for the network connection
	IP string `json:"IP"`
	// The IP subnet address
	Subnet  string `json:"Subnet"`
	Netmask string `json:"Netmask"`
	// The IP subnet gateway address
	Gateway string `json:"Gateway"`
	// List of DNS servers for the IP subnet
	DNS []string `json:"DNS"`
	// VLAN ID of the network
	VLAN int32 `json:"VLAN"`
	// VNI ID of the network
	VNI int32 `json:"VNI"`
	// True if the network is untagged
	Untagged bool `json:"Untagged"`
	// Optional web-proxy for external internet access should the IP subnet actually be behind a firewall
	Proxy string `json:"Proxy"`
	// Addresses or CIDRs for which proxy requests are not made
	NoProxy string `json:"NoProxy"`
}

type HostPowerState string

type HostServerPort struct {
	// Server port name
	Name string `json:"Name"`
	// Hardware address for the Ethernet interface (MAC)
	HWAddr string `json:"HWAddr"`
}

type HostState string

type HostSubstate string

type HostsAPI interface {
	/*
	   Add Create a new Host
	   Creates a new host object which kicks off the provisioning of a physical server in accordance to the attributes provided for the Host object.  Most values for these options must be selected from the set of options provided by the get available-resources API call. The SvcFlavor, SvcVersion, LocationID, SSHKeyIDs, and Network attribute must all be set with appropriate ID values from the available-resources call.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param newHost Defines the configuration of the desired host. See the schema for descriptions of individual attributes.

	   @return Host
	*/
	Add(ctx _context.Context, newHost NewHost) (Host, *_nethttp.Response, error)
	/*
	   BootHDD Set HDD boot order on Host by ID
	   Sets a single Host with matching ID to attempt HDD boot
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of Host to set to HDD boot

	   @return Host
	*/
	BootHDD(ctx _context.Context, hostId string) (Host, *_nethttp.Response, error)
	/*
	   BootPXE Set PXE boot order on Host by ID
	   Sets a single Host with matching ID to attempt PXE boot when next booting
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of Host to set to PXE boot

	   @return Host
	*/
	BootPXE(ctx _context.Context, hostId string) (Host, *_nethttp.Response, error)
	/*
	   Delete Delete a Host
	   Deletes the Host with the matching ID.  A host in the 'Ready' state must first be powered-off before a delete will be permitted.  Deletes to hosts in other states is permitted regardless of the power state
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of Host to delete
	*/
	Delete(ctx _context.Context, hostId string) (*_nethttp.Response, error)
	/*
	   GetByID Retrieve Host by ID
	   Returns a single Host with matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of Host to return

	   @return Host
	*/
	GetByID(ctx _context.Context, hostId string) (Host, *_nethttp.Response, error)
	/*
	   List List all Hosts in project
	   Returns an array of all Host objects defined within the project.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param optional nil or *HostsApiListOpts - Optional Parameters:
	     - @param "All" (optional.String) -  Includes deleted Host objects in the response when set to \"true\".

	   @return []Host
	*/
	List(ctx _context.Context, localVarOptionals *HostsApiListOpts) ([]Host, *_nethttp.Response, error)
	/*
	   Maintenance Do maintenance on a Host by ID
	   Do maintenance on a host by executing pre-defined operations. The host must be powered off.  The host must also be in the Ready state or in the Failed state and in the Maintenance workflow.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of Host to do maintenance on

	   @return Host
	*/
	Maintenance(ctx _context.Context, hostId string) (Host, *_nethttp.Response, error)
	/*
	   PowerOff Power off Host by ID
	   Powers off a single Host with matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of Host to power off

	   @return Host
	*/
	PowerOff(ctx _context.Context, hostId string) (Host, *_nethttp.Response, error)
	/*
	   PowerOn Power on Host by ID
	   Powers on a single Host with matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of Host to power on

	   @return Host
	*/
	PowerOn(ctx _context.Context, hostId string) (Host, *_nethttp.Response, error)
	/*
	   PowerReset Reset Host by ID
	   Resets a single Host with matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of Host to reset

	   @return Host
	*/
	PowerReset(ctx _context.Context, hostId string) (Host, *_nethttp.Response, error)
	/*
	   Reimage Reimage Host by ID
	   Re-deploys a host to the same machine. WARNING -- all drives will be erased! Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed. The host must be powered off.  The host must also be in the Ready state.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of Host to reimage

	   @return Host
	*/
	Reimage(ctx _context.Context, hostId string) (Host, *_nethttp.Response, error)
	/*
	   Replace Replace Host by ID
	   Re-deploys a host with a new machine that satisfies the current host settings. WARNING -- all drives will be erased! Only the machine is replaced, IP addresses, volumes, etc are not changed. The host must be powered off.  The host must also be in the Ready state or in the Failed state and in the Replace or Maintenace workflow.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of Host to replace

	   @return Host
	*/
	Replace(ctx _context.Context, hostId string) (Host, *_nethttp.Response, error)
	/*
	   Update Update an existing Host
	   Updates the Host with the matching ID.  Update is permitted only if the host is in the 'Ready' or 'Connection Updating Failed' state.  Only the Host 'Description', 'Networks', 'NetworkForDefaultRoute', 'NetworkUntagged' and 'ISCSIConfig:InitiatorName' can be updated. 'ISCSIConfig:InitiatorName' can be updated only if the host has no volumes attached.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param hostId ID of host to update
	     - @param updateHost Updated Host

	   @return Host
	*/
	Update(ctx _context.Context, hostId string, updateHost UpdateHost) (Host, *_nethttp.Response, error)
}

type HostsApiListOpts struct {
	All optional.String
}

type HostsApiService service

type IPPoolsAPI interface {
	/*
	   AllocateIPs Allocate IPs from the pool
	   Allocate IPs from the pool
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param ippoolId ID of IP pool to allocate IPs
	     - @param iPAllocation IPs being requested starting from an optional base IP and their usage

	   @return IpPool
	*/
	AllocateIPs(ctx _context.Context, ippoolId string, iPAllocation []IpAllocation) (IpPool, *_nethttp.Response, error)
	/*
	   GetByID Retrieve IP pool by ID
	   Returns a single ip pool with matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param ippoolId ID of IP pool to return

	   @return IpPool
	*/
	GetByID(ctx _context.Context, ippoolId string) (IpPool, *_nethttp.Response, error)
	/*
	   List List all ip pools in project
	   Returns an array of all ip pool objects defined within the project.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

	   @return []IpPool
	*/
	List(ctx _context.Context) ([]IpPool, *_nethttp.Response, error)
	/*
	   ReturnIPs Return IPs to the pool
	   Return IPs to the pool
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param ippoolId ID of IP pool to return IPs
	     - @param requestBody IP returned to the pool

	   @return IpPool
	*/
	ReturnIPs(ctx _context.Context, ippoolId string, requestBody []string) (IpPool, *_nethttp.Response, error)
	/*
	   Update Update IP pool by ID
	   Update a single ip pool with matching ID. 'DefaultRoute' can only be updated if ip pool is not currently in-use.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param ippoolId ID of IP pool to update
	     - @param updateIpPool Update IPPool

	   @return IpPool
	*/
	Update(ctx _context.Context, ippoolId string, updateIpPool UpdateIpPool) (IpPool, *_nethttp.Response, error)
}

type IpAllocation struct {
	// An optional base address for the allocation, if not specified first available address from the pool will be the base
	Base string `json:"Base"`
	// Number of addresses to allocate starting from the base
	Count int32 `json:"Count"`
	// A short description for the allocation
	Usage string `json:"Usage"`
}

type IpPool struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// Time when the resource was created in the database
	Created time.Time `json:"Created"`
	// Time when the resource was last modified in the database
	Modified    time.Time `json:"Modified"`
	Description string    `json:"Description"`
	IPVersion   IpVer     `json:"IPVersion"`
	// Unique ID of the network associated with the IP pool
	NetworkID string `json:"NetworkID"`
	// Base address of the IP pool
	BaseIP  string  `json:"BaseIP"`
	Netmask Netmask `json:"Netmask"`
	// Default route associated with the IP pool
	DefaultRoute string      `json:"DefaultRoute"`
	Sources      []IpSource  `json:"Sources"`
	UseRecords   []UseRecord `json:"UseRecords"`
	// List of DNS servers for the IP pool
	DNS []string `json:"DNS"`
	// Optional web-proxy for external internet access should the pool actually be behind a firewall
	Proxy string `json:"Proxy"`
	// Addresses or CIDRs for which proxy requests are not made
	NoProxy string `json:"NoProxy"`
	// List of NTP servers for the IP pool
	NTP  []string `json:"NTP"`
	Pool Pool     `json:"Pool"`
}

type IpPoolAllOf struct {
	Description string `json:"Description"`
	IPVersion   IpVer  `json:"IPVersion"`
	// Unique ID of the network associated with the IP pool
	NetworkID string `json:"NetworkID"`
	// Base address of the IP pool
	BaseIP  string  `json:"BaseIP"`
	Netmask Netmask `json:"Netmask"`
	// Default route associated with the IP pool
	DefaultRoute string      `json:"DefaultRoute"`
	Sources      []IpSource  `json:"Sources"`
	UseRecords   []UseRecord `json:"UseRecords"`
	// List of DNS servers for the IP pool
	DNS []string `json:"DNS"`
	// Optional web-proxy for external internet access should the pool actually be behind a firewall
	Proxy string `json:"Proxy"`
	// Addresses or CIDRs for which proxy requests are not made
	NoProxy string `json:"NoProxy"`
	// List of NTP servers for the IP pool
	NTP  []string `json:"NTP"`
	Pool Pool     `json:"Pool"`
}

type IpPoolStats struct {
	// Total number of IPs (pool capacity)
	Total int32 `json:"Total"`
	// Number of non allocated IPs
	Available int32 `json:"Available"`
	// Number of allocated IPs
	InUse int32 `json:"InUse"`
}

type IpRange struct {
	// Base address for the IP range
	Base string `json:"Base"`
	// Number of IPs to count from the base
	Count int32 `json:"Count"`
	// Default route for the IP range
	DefaultRoute string  `json:"DefaultRoute"`
	Netmask      Netmask `json:"Netmask"`
	// Base address of the Source the IPRange was allocated from
	SourceBase string `json:"SourceBase"`
}

type IpSource struct {
	// Base address for the IP source
	Base string `json:"Base"`
	// Number of IPs to count from the base
	Count int32 `json:"Count"`
}

type IpVer string

type IppoolsApiService service

type IscsiParameters struct {
	// The IP address of the host in dotted notation.
	HostIPAddress string `json:"HostIPAddress"`
	// The full initiator name to be created. The name must be at least 12 characters in length and begin with \"iqn.\".
	InitiatorName string `json:"InitiatorName"`
	// CHAPSecret is the Challenge Authentication Protocol secret to be shared between array and initiator. If empty, no CHAP login is enabled; if set it must be a string between 12 and 16 characters.
	CHAPSecret string `json:"CHAPSecret,omitempty"`
	// CHAPUserName is the CHAP username to use for CHAP authentication. If CHAPSecret is specified, CHAPUserName must also be specified.
	CHAPUserName string `json:"CHAPUserName,omitempty"`
}

type Limits struct {
	// Maximum number of hosts to allow
	Hosts int32 `json:"Hosts"`
	// Maximum number of volumes to allow
	Volumes int32 `json:"Volumes"`
	// Maximum capacity to allow in TiB
	VolumeCapacity int64 `json:"VolumeCapacity"`
	// Maximum number of private networks to allow
	PrivateNetworks int32 `json:"PrivateNetworks"`
	// Map of instance type ID to maximum number of hosts that can be created with that instance type
	InstanceTypes map[string]int32 `json:"InstanceTypes"`
}

type LocationInfo struct {
	// Unique ID for data center location
	ID      string  `json:"ID"`
	Country Country `json:"Country"`
	// Region within the indicated country
	Region string `json:"Region"`
	// Data center descriptor
	DataCenter string `json:"DataCenter"`
	// Indicates whether or not the fabric dedicated for private networks supports VLAN ID.
	PrivateNetworkVIDSupport bool `json:"PrivateNetworkVIDSupport"`
	// Indicates whether or not the fabric dedicated for private networks supports VNI ID.
	PrivateNetworkVNISupport bool `json:"PrivateNetworkVNISupport"`
}

type MachineClassifier struct {
	Name string `json:"Name"`
	// A list of machine classifier rules.
	Rules []MachineClassifierRule `json:"Rules"`
}

type MachineClassifierRule struct {
	SubAttributeRules []AttributeRule `json:"SubAttributeRules"`
	// The machine attribute.
	Attribute string `json:"Attribute"`
	// The value for the attribute.
	Value    string             `json:"Value"`
	Operator ClassifierOperator `json:"Operator"`
}

type MachineInventory struct {
	// Unique ID of the data center location
	LocationID string `json:"LocationID"`
	// ID of a MachineSize as listed in the MachineSizes array
	SizeID string `json:"SizeID"`
	// The number of machines in inventory with indicated machine size at the indicated location
	Number int32 `json:"Number"`
}

type MachineSize struct {
	// Unique ID for the machine size offering
	ID string `json:"ID"`
	// Typical user-visible name for a machine size offering
	Name    string     `json:"Name"`
	Details FlavorDesc `json:"Details"`
}

type MachineSizeInfo struct {
	Name         string `json:"Name"`
	ProjectsUsed int32  `json:"ProjectsUsed"`
	OtherUsed    int32  `json:"OtherUsed"`
	Available    int32  `json:"Available"`
	ID           string `json:"ID"`
	// True if the usage of this machine size is restricted  to selected projects, false if the machine size is available to anyone.
	Restricted bool `json:"Restricted"`
}

type MultiPartFile struct {
	FileName *os.File `json:"fileName"`
}

type Netmask string

type Network struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// Time when the resource was created in the database
	Created time.Time `json:"Created"`
	// Time when the resource was last modified in the database
	Modified time.Time `json:"Modified"`
	// The location ID is the data center location of the resource.  The LocationID must be one of those provided by the LocationInfo array returned as part of the get /available-resources call.  The locations are typically described by country, region, and data center.
	LocationID  string         `json:"LocationID"`
	Description string         `json:"Description"`
	HostUse     NetworkHostUse `json:"HostUse"`
	Purpose     NetworkPurpose `json:"Purpose"`
	IPPoolID    string         `json:"IPPoolID"`
	// VLAN ID of the network
	VLAN int32 `json:"VLAN"`
	// VNI ID of the network
	VNI int32 `json:"VNI"`
}

type NetworkAllOf struct {
	// The location ID is the data center location of the resource.  The LocationID must be one of those provided by the LocationInfo array returned as part of the get /available-resources call.  The locations are typically described by country, region, and data center.
	LocationID  string         `json:"LocationID"`
	Description string         `json:"Description"`
	HostUse     NetworkHostUse `json:"HostUse"`
	Purpose     NetworkPurpose `json:"Purpose"`
	IPPoolID    string         `json:"IPPoolID"`
	// VLAN ID of the network
	VLAN int32 `json:"VLAN"`
	// VNI ID of the network
	VNI int32 `json:"VNI"`
}

type NetworkHostUse string

type NetworkPurpose string

type NetworksAPI interface {
	/*
	   Add Add a new network
	   Adds a new network that can be referenced when creating a Host
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param newNetwork Network that is to be added to the project

	   @return Network
	*/
	Add(ctx _context.Context, newNetwork NewNetwork) (Network, *_nethttp.Response, error)
	/*
	   Delete Delete a network
	   Deletes the network with the matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param networkId ID of network to delete
	*/
	Delete(ctx _context.Context, networkId string) (*_nethttp.Response, error)
	/*
	   GetByID Retrieve network by ID
	   Returns a single network with matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param networkId ID of network to return

	   @return Network
	*/
	GetByID(ctx _context.Context, networkId string) (Network, *_nethttp.Response, error)
	/*
	   List List all networks in project
	   Returns an array of all network objects defined within the project.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

	   @return []Network
	*/
	List(ctx _context.Context) ([]Network, *_nethttp.Response, error)
	/*
	   Update Update an existing network.

	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param networkId ID of network to update
	     - @param updateNetwork Updated network

	   @return Network
	*/
	Update(ctx _context.Context, networkId string, updateNetwork UpdateNetwork) (Network, *_nethttp.Response, error)
}

type NetworksApiService service

type NewHost struct {
	// The host name used when installing the host operating system.  Note that some OS implementations may require the name to be formatted as a fully qualified domain name.
	Name        string `json:"Name"`
	Description string `json:"Description,omitempty"`
	// The image service identifier must be identifer of one of the available imaging services provided by the AvailableImage array returned as part of the get /available-resources call. Images are typically described by category (e.g. Linux), flavor (e.g. ubuntu) and version (e.g. 18.04-20190807)
	ServiceID string `json:"ServiceID"`
	// The location ID must be one of those provided by the LocationInfo array returned as part of the get /available-resources call.  The locations are typically described by country, region, and data center. The location ID must also be one that has sufficient inventory for the selected MachineSize.  See the MachineInventory array as returned by the get /available-resources call to select a location that has machines available with the correct machine size.
	LocationID string `json:"LocationID"`
	// The machine size ID must be one of those listed in the MachineSizes array returned as part of the get /available-resources call.  This array provides the name and detailed description for each machine size.  Use the MachineInventory array provided by the get /available-resources call to find a location with an adequate inventory of machines with the desired machine size.
	MachineSizeID string `json:"MachineSizeID"`
	// These IDs must correspond to the IDs for SSH keys already created within the context of the project.  These SSH keys and those included as SSHAuthorizedKeys will be used together to provision SSH keys when the machine is imaged.
	SSHKeyIDs []string `json:"SSHKeyIDs"`
	// The list of IDs corresponding to the networks that will be provisioned to the host. These networks must be among those listed in the Networks array returned by the get /available-resources call.  This list must include the ID for any network identified by the HostUseEnum as Required.
	NetworkIDs []string `json:"NetworkIDs"`
	// A list of pre-allocated IP addresses to be used for corresponding networks. This array of IP addresses, if present, is in one-to-one correspondence with Networks.
	PreAllocatedIPs []string `json:"PreAllocatedIPs,omitempty"`
	// The host's default network ID. This needs to be one of the values in the  \"NetworkIDs\" list.
	NetworkForDefaultRoute string `json:"NetworkForDefaultRoute"`
	// ID of the network selected to be untagged. This needs to be one of the values in the  \"NetworkIDs\" list.
	NetworkUntagged string `json:"NetworkUntagged,omitempty"`
	// The list of IDs corresponding to existing, unattached volumes that should be attached to the new host.  The volume must be one of those listed in the Volumes array returned by the get /available-resources call.  In addition, the volume must be in the visible state and not a part of any current VolumeAttachment (see get volume-attachments)
	VolumeIDs []string `json:"VolumeIDs,omitempty"`
	// The map of Service Network (Provider) ID to Provider MAC address.   The Service Network must be a provider network provisioned to this host. Any Service Networks not included here will default to the physical MAC learned during machine discovery.
	ServiceNetsProviderMAC map[string]string `json:"ServiceNetsProviderMAC,omitempty"`
	// New volumes may be created and connected to the Host when the host is provisioned. The information provided here to create a host is the same as required when doing a post /volumes call
	NewVolumes []AddVolume `json:"NewVolumes,omitempty"`
	// User-provided data to be attached to the image configuration data.
	UserData string `json:"UserData,omitempty"`
	// User-provided data to represent the identity of the host within an application environment. For example, this could be set to represent the Kubernetes node ID if the host is provisioned as a Kubernetes node.
	NodeID string `json:"NodeID,omitempty"`
	// The map of service/user specified label name to label value for this host. Setting service labels is restricted by role.
	Labels map[string]string `json:"Labels,omitempty"`
}

type NewIpPool struct {
	// Name for the IP pool
	Name string `json:"Name,omitempty"`
	// Description for the IP pool
	Description string `json:"Description,omitempty"`
	IPVersion   IpVer  `json:"IPVersion"`
	// Base address of the IP pool
	BaseIP  string  `json:"BaseIP"`
	Netmask Netmask `json:"Netmask"`
	// Default route associated with the IP pool
	DefaultRoute string     `json:"DefaultRoute,omitempty"`
	Sources      []IpSource `json:"Sources,omitempty"`
	// List of DNS servers for the IP pool
	DNS []string `json:"DNS,omitempty"`
	// Optional web-proxy for external internet access should the pool actually be behind a firewall
	Proxy string `json:"Proxy,omitempty"`
	// Addresses or CIDRs for which proxy requests are not made
	NoProxy string `json:"NoProxy,omitempty"`
	// List of NTP servers for the IP pool
	NTP []string `json:"NTP,omitempty"`
}

type NewNetwork struct {
	// Name of the network
	Name string `json:"Name"`
	// The location ID is the data center location of the resource.  The LocationID must be one of those provided by the LocationInfo array returned as part of the get /available-resources call.  The locations are typically described by country, region, and data center.
	LocationID  string         `json:"LocationID"`
	Description string         `json:"Description,omitempty"`
	HostUse     NetworkHostUse `json:"HostUse,omitempty"`
	Purpose     NetworkPurpose `json:"Purpose,omitempty"`
	NewIPPool   *NewIpPool     `json:"NewIPPool,omitempty"`
	// Optional VLAN ID of the network. If not specified, it is allocated from reserved pool.
	VLAN int32 `json:"VLAN,omitempty"`
	// Optional VNI ID of the network. If not specified, it is allocated from reserved pool if required.
	VNI int32 `json:"VNI,omitempty"`
}

type NewProject struct {
	Name    string  `json:"Name"`
	Profile Profile `json:"Profile"`
	Limits  Limits  `json:"Limits"`
	// Array listing the permitted site IDs
	PermittedSites []string `json:"PermittedSites,omitempty"`
	// Array listing the permitted OS service images.
	PermittedOSImages []string `json:"PermittedOSImages,omitempty"`
	// Indicates whether volume replication is enabled for this Project.
	VolumeReplicationEnabled bool `json:"VolumeReplicationEnabled,omitempty"`
}

type NewSshKey struct {
	Name string `json:"Name"`
	// SSH key value
	Key string `json:"Key"`
}

type NewVolume struct {
	Name        string `json:"Name"`
	Description string `json:"Description,omitempty"`
	// Adds a new volume to the project.  This object requires the LocationID and is used when a new volume is created independently from the host creation therefore requiring a specified location.
	FlavorID string `json:"FlavorID"`
	// The size of the volume in GiB
	Capacity int64 `json:"Capacity"`
	// Indicates if the volume can be attached to multiple hosts
	Shareable bool `json:"Shareable,omitempty"`
	// The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host.
	LocationID string `json:"LocationID"`
	// The map of service/user specified label name to label value for this volume. Setting service labels is restricted by role.
	Labels map[string]string `json:"Labels,omitempty"`
	// The storage pool is one of those listed by the StoragePools array returned as part of the get /available-resources call that are available to create volumes of the specified flavor and location.
	StoragePoolID string `json:"StoragePoolID,omitempty"`
	// The  optional volume collection is one of those listed by the VolumeCollections  array returned as part of the get /available-resources call
	VolumeCollectionID string `json:"VolumeCollectionID,omitempty"`
}

type NewVolumeAttachment struct {
	// Name for the volume attachment. Must be 128 or fewer printable characters
	Name string `json:"Name,omitempty"`
	// Unique ID of the volume attached to the host
	VolumeID string             `json:"VolumeID"`
	Protocol ProtocolParameters `json:"Protocol"`
}

type OpArg struct {
	Name        string    `json:"Name"`
	Value       string    `json:"Value"`
	Description string    `json:"Description"`
	Type        OpArgType `json:"Type"`
	// Value of the argument that should be kept secret.
	SecureValue string `json:"SecureValue"`
}

type OpArgType string

type OsServiceImage struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// Time when the resource was created in the database
	Created time.Time `json:"Created"`
	// Time when the resource was last modified in the database
	Modified    time.Time `json:"Modified"`
	Description string    `json:"Description"`
	// A high level classification of the service.
	Category string `json:"Category"`
	// An high level description of the OS image type.
	Flavor string `json:"Flavor"`
	// A specific version of the service flavor.
	Version string               `json:"Version"`
	Origin  OsServiceImageOrigin `json:"Origin"`
	// Maximum amount of time in seconds for the service to complete its work.  This time includes the amount of time to download the service image if necessary.
	Timeout int64 `json:"Timeout"`
	// Device partitioning information.
	DeviceLayouts []DiskPartitions `json:"DeviceLayouts"`
	// List of projects allowed to use this OS service image.
	PermittedProjects []string `json:"PermittedProjects"`
	// Files and relative information for this OS service image.
	Files []FileInfo `json:"Files"`
	// Defines a list of embedded contents to be attached to this OS service image in form of files.
	Info              []PassedInfo           `json:"Info"`
	Approach          OsServiceImageApproach `json:"Approach"`
	AssumedBootMethod BootMethod             `json:"AssumedBootMethod"`
	// Indicates if a LAG needs to be created on the switch connecting the host with this OS service image.
	NoSwitchLAG bool     `json:"NoSwitchLAG"`
	BondMode    BondMode `json:"BondMode"`
	// Unique id of the firmware baseline to be applied by the firmware update operation  in Maintenance Steps and Imaging Prep Steps.
	FWBaselineID     string           `json:"FWBaselineID"`
	UserDefinedSteps UserDefinedSteps `json:"UserDefinedSteps"`
	// Allows setting of restricted use for this service by machine attributes.  If rules are not defined, this OS service image is available to be installed on any machine.
	Classifiers []MachineClassifier `json:"Classifiers"`
}

type OsServiceImageAllOf struct {
	Description string `json:"Description"`
	// A high level classification of the service.
	Category string `json:"Category"`
	// An high level description of the OS image type.
	Flavor string `json:"Flavor"`
	// A specific version of the service flavor.
	Version string               `json:"Version"`
	Origin  OsServiceImageOrigin `json:"Origin"`
	// Maximum amount of time in seconds for the service to complete its work.  This time includes the amount of time to download the service image if necessary.
	Timeout int64 `json:"Timeout"`
	// Device partitioning information.
	DeviceLayouts []DiskPartitions `json:"DeviceLayouts"`
	// List of projects allowed to use this OS service image.
	PermittedProjects []string `json:"PermittedProjects"`
	// Files and relative information for this OS service image.
	Files []FileInfo `json:"Files"`
	// Defines a list of embedded contents to be attached to this OS service image in form of files.
	Info              []PassedInfo           `json:"Info"`
	Approach          OsServiceImageApproach `json:"Approach"`
	AssumedBootMethod BootMethod             `json:"AssumedBootMethod"`
	// Indicates if a LAG needs to be created on the switch connecting the host with this OS service image.
	NoSwitchLAG bool     `json:"NoSwitchLAG"`
	BondMode    BondMode `json:"BondMode"`
	// Unique id of the firmware baseline to be applied by the firmware update operation  in Maintenance Steps and Imaging Prep Steps.
	FWBaselineID     string           `json:"FWBaselineID"`
	UserDefinedSteps UserDefinedSteps `json:"UserDefinedSteps"`
	// Allows setting of restricted use for this service by machine attributes.  If rules are not defined, this OS service image is available to be installed on any machine.
	Classifiers []MachineClassifier `json:"Classifiers"`
}

type OsServiceImageApproach string

type OsServiceImageOrigin string

type Partition struct {
	Type    PartitionType    `json:"Type"`
	Formula PartitionFormula `json:"Formula"`
	// Name is an optional name for the partition, only usable with GPT partition table types.
	Name string `json:"Name"`
	// Where to mount the partition, it must be set for partitions that are filesystem types.
	MountPoint string `json:"MountPoint"`
	// A partitionID may be explicitly set for the partition and this allows for out-of-order partitions in the table (like VMWare).  If zero, sequential partitions are created starting at 1. Gaps in the partition ID numbering is also allowable (VMWare).
	PartitionID int64 `json:"PartitionID"`
	// Identify a bootable partition.
	Bootable bool `json:"Bootable"`
	// Provide options for the partition's creation.
	MakeOptions []string `json:"MakeOptions"`
	// Provide options for the patition mount. If empty, \"defaults\" will be used for filesystem partition types. MountOptions will be placed in the \"options\" field for the partition in /etc/fstab.
	MountOptions string `json:"MountOptions"`
}

type PartitionFormula struct {
	// Represents a partition size in MiB.  As a special case a size of 0 can be specified that will equate to the remaining space on the disk.
	Equation string `json:"Equation"`
	// It causes the value computed by formula execution to be rounded up to MinSize; if MinSize is non-zero. Multipliers like M and G maybe used, e.g. 1M == (1024*1024)bytes. An empty string means zero bytes.  If no multiplier is specified M is assumed.
	MinSize string `json:"MinSize"`
	// MaxSize causes the value computed by formula execution to be rounded up to MaxSize; if MaxSize is non-zero. Multipliers like M, G and T maybe used, e.g. 1M == (1024*1024)bytes. An empty string means zero bytes.  If no multiplier is specified M is assumed. Equations may also be used e.g. 25%disk means MaxSize will cause any partition  to never exceed 25% of device capacity.
	MaxSize string `json:"MaxSize"`
}

type PartitionTable string

type PartitionType string

type PassedInfo struct {
	// String encoded with file content.
	Contents        string         `json:"Contents"`
	Encoding        Encoding       `json:"Encoding"`
	Templating      Templating     `json:"Templating"`
	TemplatingInput TemplatingInfo `json:"TemplatingInput"`
	Target          Target         `json:"Target"`
	// File path and name within location.
	Path string `json:"Path"`
}

type Pool struct {
	// List of fragments for the IP pool
	Fragments []IpRange   `json:"Fragments"`
	Stats     IpPoolStats `json:"Stats"`
}

type Profile struct {
	// Name of the Project Team. Must not be empty, maximum 128 printable characters
	TeamName string `json:"TeamName"`
	// Optional description of the Project Team, maximum 256 printable characters
	TeamDesc string `json:"TeamDesc"`
	// Optional name of the company, maximum 256 printable characters
	Company string `json:"Company"`
	// Optional address of the company, maximum 256 printable characters
	Address string `json:"Address"`
	// Optional email address of the contact person for the team, maximum 256 printable characters
	Email string `json:"Email"`
	// Currently always false
	EmailVerified bool `json:"EmailVerified"`
	// Optional phone number of the contact person for the team, maximum 32 printable characters
	PhoneNumber string `json:"PhoneNumber"`
	// Currently always false
	PhoneVerified bool `json:"PhoneVerified"`
}

type Project struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// Time when the resource was created in the database
	Created time.Time `json:"Created"`
	// Time when the resource was last modified in the database
	Modified  time.Time        `json:"Modified"`
	Profile   Profile          `json:"Profile"`
	Limits    Limits           `json:"Limits"`
	Resources ProjectResources `json:"Resources"`
	// Array listing the permitted site IDs
	PermittedSites []string `json:"PermittedSites"`
	// Array listing the permitted OS service images.
	PermittedOSImages []string `json:"PermittedOSImages"`
	// Indicates whether volume replication is enabled for this Project.
	VolumeReplicationEnabled bool `json:"VolumeReplicationEnabled"`
}

type ProjectAllOf struct {
	Profile   Profile          `json:"Profile"`
	Limits    Limits           `json:"Limits"`
	Resources ProjectResources `json:"Resources"`
	// Array listing the permitted site IDs
	PermittedSites []string `json:"PermittedSites"`
	// Array listing the permitted OS service images.
	PermittedOSImages []string `json:"PermittedOSImages"`
	// Indicates whether volume replication is enabled for this Project.
	VolumeReplicationEnabled bool `json:"VolumeReplicationEnabled"`
}

type ProjectInfo struct {
	ID             string `json:"ID"`
	Name           string `json:"Name"`
	Description    string `json:"Description"`
	NumHosts       int32  `json:"NumHosts"`
	NumVolumes     int32  `json:"NumVolumes"`
	TotalStorageGB int32  `json:"TotalStorageGB"`
	Status         string `json:"Status"`
	// Number of project networks
	NumNetworks   int32        `json:"NumNetworks"`
	SummaryStatus HealthStatus `json:"SummaryStatus"`
	// Locations where project resources exist
	Locations []LocationInfo `json:"Locations"`
}

type ProjectResources struct {
	// Number of hosts in use
	Hosts int32 `json:"Hosts"`
	// Number of volumes in use
	Volumes int32 `json:"Volumes"`
	// Volume capacity in use in TiB
	VolumeCapacity int64 `json:"VolumeCapacity"`
	// Number of private networks in use
	PrivateNetworks int32 `json:"PrivateNetworks"`
	// Number of hosts with the instance type in use
	InstanceTypes map[string]int32 `json:"InstanceTypes"`
}

type ProjectsAPI interface {
	/*
	   Add Create a new project
	   Adds a new Project which creates an isolated space for creating Hosts, Volumes, and private Networks. A project is often aligned to a specific team within an organization or a cluster. If GreenLake IAM issued token is used for authentication, then it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored. Note that Hoster or BMaaS Access Owner role is required for this operation.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param newProject NewProject parameters to create a new Project
	     - @param optional nil or *ProjectsApiAddOpts - Optional Parameters:
	     - @param "Space" (optional.String) -  GreenLake space name
	     - @param "Spaceid" (optional.String) -  GreenLake space ID

	   @return Project
	*/
	Add(ctx _context.Context, newProject NewProject, localVarOptionals *ProjectsApiAddOpts) (Project, *_nethttp.Response, error)
	/*
	   Delete Delete a Project
	   Deletes the Project with the matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param projectId ID of project to delete
	*/
	Delete(ctx _context.Context, projectId string) (*_nethttp.Response, error)
	/*
	   GetByID Retrieve a project by its ID
	   Returns a single Project object with its matching ID This includes profile information for the project and project limits on resouces like hosts, private networks, volumes, and volume capacity.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param projectId ID of project to return

	   @return Project
	*/
	GetByID(ctx _context.Context, projectId string) (Project, *_nethttp.Response, error)
	/*
	   List List of all Projects within an organization or cluster
	   Returns an array of all Project objects that have been created. This includes profile information for the project and project limits on resouces like hosts, private networks, volumes, and volume capacity. If GreenLake IAM issued token is used for authentication, then it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param optional nil or *ProjectsApiListOpts - Optional Parameters:
	     - @param "Spaceid" (optional.String) -  GreenLake space ID
	     - @param "Space" (optional.String) -  GreenLake space name

	   @return []Project
	*/
	List(ctx _context.Context, localVarOptionals *ProjectsApiListOpts) ([]Project, *_nethttp.Response, error)
	/*
	   Update Update a project by its ID
	   Updates a project with a matching ID. Only Project 'Name', 'Profile' and 'Limits' can be updated with this operation. Note that Hoster or BMaaS Access Owner role is required for this operation.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param projectId ID of project to update
	     - @param updateProject Project parameters to update an existing Project

	   @return Project
	*/
	Update(ctx _context.Context, projectId string, updateProject UpdateProject) (Project, *_nethttp.Response, error)
}

type ProjectsApiAddOpts struct {
	Space   optional.String
	Spaceid optional.String
}

type ProjectsApiListOpts struct {
	Spaceid optional.String
	Space   optional.String
}

type ProjectsApiService service

type ProjectsInfo struct {
	Projects      []ProjectInfo       `json:"Projects"`
	MachineSizes  []MachineSizeInfo   `json:"MachineSizes"`
	VolumeFlavors []VolumeFlavorsInfo `json:"VolumeFlavors"`
	Summary       SummaryInfo         `json:"Summary"`
}

type ProjectsInfoAPI interface {
	/*
	   List List of all projects info within an organization or cluster for which user is authorized.
	   Returns an object with information on projects, machine sizes, and volume flavors.  The 'Projects' list includes projects authorized for a user, and the 'MachineSizes' and  'VolumeFlavors' list include only those machine sizes and volume flavors permitted for projects.  When GreenLake IAM issued token is used for authentication, it is required to  pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param optional nil or *ProjectsInfoApiListOpts - Optional Parameters:
	     - @param "Space" (optional.String) -  GreenLake space name
	     - @param "Spaceid" (optional.String) -  GreenLake space ID
	     - @param "Siteid" (optional.String) -  GreenLake site ID

	   @return ProjectsInfo
	*/
	List(ctx _context.Context, localVarOptionals *ProjectsInfoApiListOpts) (ProjectsInfo, *_nethttp.Response, error)
}

type ProjectsInfoApiListOpts struct {
	Space   optional.String
	Spaceid optional.String
	Siteid  optional.String
}

type ProjectsInfoApiService service

type ProtocolKind string

type ProtocolParameters struct {
	Protocol ProtocolKind    `json:"Protocol,omitempty"`
	ISCSI    IscsiParameters `json:"ISCSI,omitempty"`
}

type ResourceBase struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// Time when the resource was created in the database
	Created time.Time `json:"Created"`
	// Time when the resource was last modified in the database
	Modified time.Time `json:"Modified"`
}

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

type ServiceServerInfo struct {
	// Service type consuming the resource
	ServiceType string `json:"ServiceType"`
	// Allocated number of servers.
	AllocatedCount int32 `json:"AllocatedCount"`
	// Total available CPU cores.
	CoresCapacity int32 `json:"CoresCapacity"`
	// Total allocated CPU cores.
	CoresAllocated int32 `json:"CoresAllocated"`
	// Total available memory in GiB.
	RAMCapacity float64 `json:"RAMCapacity"`
	// Total allocated memory in GiB.
	RAMAllocated float64 `json:"RAMAllocated"`
}

type ServiceStorageInfo struct {
	// Service type consuming the resource
	ServiceType string `json:"ServiceType"`
	// Allocated number of volumes.
	AllocatedCount int32 `json:"AllocatedCount"`
	// Total capacity of all allocated volumes in TB for a service type.
	AllocatedCapacity float32 `json:"AllocatedCapacity"`
}

type ServicesAPI interface {
	/*
	   Add Create a new OS service image
	   Adds a new OS service image that can be referenced during host creation. If GreenLake IAM issued token is used for authentication, then it is required  to pass either 'spaceid' header or 'Space' header.  Note that Hoster or BMaaS Access Owner role is required for this operation.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param fileName
	     - @param optional nil or *ServicesApiAddOpts - Optional Parameters:
	     - @param "Spaceid" (optional.String) -  GreenLake space ID
	     - @param "Space" (optional.String) -  GreenLake space name

	   @return OsServiceImage
	*/
	Add(ctx _context.Context, fileName *os.File, localVarOptionals *ServicesApiAddOpts) (OsServiceImage, *_nethttp.Response, error)
	/*
	   Delete Delete an OS service image
	   Deletes the OS service image with the matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param serviceId ID of OS service image to delete
	*/
	Delete(ctx _context.Context, serviceId string) (*_nethttp.Response, error)
	/*
	   GetByID Retrieve an OS service image
	   Returns a single OS service image object with its matching ID.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param serviceId ID of OS service image to return

	   @return OsServiceImage
	*/
	GetByID(ctx _context.Context, serviceId string) (OsServiceImage, *_nethttp.Response, error)
	/*
	   List List of all OS service images within an tenant
	   Returns an array of all OS service images objects that have been created. If GreenLake IAM issued token is used for authentication,  then it is required to pass 'spaceid' header
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param optional nil or *ServicesApiListOpts - Optional Parameters:
	     - @param "Spaceid" (optional.String) -  GreenLake space ID
	     - @param "Space" (optional.String) -  GreenLake space name

	   @return []OsServiceImage
	*/
	List(ctx _context.Context, localVarOptionals *ServicesApiListOpts) ([]OsServiceImage, *_nethttp.Response, error)
	/*
	   Update Update an OS service image by its ID
	   Updates an OS service image with a matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param serviceId ID of OS service image to update
	     - @param fileName

	   @return OsServiceImage
	*/
	Update(ctx _context.Context, serviceId string, fileName *os.File) (OsServiceImage, *_nethttp.Response, error)
}

type ServicesApiAddOpts struct {
	Spaceid optional.String
	Space   optional.String
}

type ServicesApiListOpts struct {
	Spaceid optional.String
	Space   optional.String
}

type ServicesApiService service

type SshKey struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// Time when the resource was created in the database
	Created time.Time `json:"Created"`
	// Time when the resource was last modified in the database
	Modified time.Time `json:"Modified"`
	// SSH key value
	Key string `json:"Key"`
}

type SshKeyAllOf struct {
	// SSH key value
	Key string `json:"Key"`
}

type SshKeyEntry struct {
	// Unique ID of the SSH key entry
	ID string `json:"ID"`
	// Name or description of the stored SSH key
	Name string `json:"Name"`
	// SSH key value
	Key string `json:"Key"`
}

type SshkeysAPI interface {
	/*
	   Add Add a new SSH Key
	   Adds a new SSH Key that can be referenced when creating a Host
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param newSshKey SSH Key that is to be added to the project

	   @return SshKey
	*/
	Add(ctx _context.Context, newSshKey NewSshKey) (SshKey, *_nethttp.Response, error)
	/*
	   Delete Delete an SSH key
	   Deletes the SSH key with the matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param sshkeyId ID of sshkey to delete
	*/
	Delete(ctx _context.Context, sshkeyId string) (*_nethttp.Response, error)
	/*
	   GetByID Retrieve SSH Key by ID
	   Returns a single SSH key with matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param sshkeyId ID of sshkey to return

	   @return SshKey
	*/
	GetByID(ctx _context.Context, sshkeyId string) (SshKey, *_nethttp.Response, error)
	/*
	   List List all sshkeys in project
	   Returns an array of all SSHKey objects defined within the project.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

	   @return []SshKey
	*/
	List(ctx _context.Context) ([]SshKey, *_nethttp.Response, error)
	/*
	   Update Update an existing SSH Key.  Only 'Name' or 'Key' fields can be changed.

	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param sshkeyId ID of sshkey to update
	     - @param updateSshKey Updated SSH key

	   @return SshKey
	*/
	Update(ctx _context.Context, sshkeyId string, updateSshKey UpdateSshKey) (SshKey, *_nethttp.Response, error)
}

type SshkeysApiService service

type StorageInventory struct {
	// Unique ID of a volume flavor as listed in the the VolumeFlavors array
	FlavorID string `json:"FlavorID"`
	// Unique ID of a data center location
	LocationID string `json:"LocationID"`
	// Total capacity available (in GiB) to create new volumes of the indicated flavor at the indicated location
	Capacity int64 `json:"Capacity"`
	// Unique ID of the storage pool as listed in the StoragePools array
	StoragePoolID string `json:"StoragePoolID"`
	// IDs of the volume collections for this flavor as listed in the Volume collections array
	VolumeCollectionIDs []string `json:"VolumeCollectionIDs,omitempty"`
}

type StoragePool struct {
	// Storage pool unique ID
	ID string `json:"ID"`
	// User-visible name for a storage pool
	Name string `json:"Name"`
	// The location ID of the data center where the storage pool exists
	LocationID string `json:"LocationID,omitempty"`
	// Total capacity available (in GiB) to create new volumes in the storage pool
	Capacity int64 `json:"Capacity,omitempty"`
}

type SummaryInfo struct {
	// Locations where resources exist for all listed projects
	Locations []LocationInfo `json:"Locations"`
	// Number of hosts for all listed projects
	NumHosts int32 `json:"NumHosts"`
	// Number of volumes for all listed projects
	NumVolumes int32 `json:"NumVolumes"`
	// Total storage for all listed projects
	TotalStorageGB int32 `json:"TotalStorageGB"`
	// Number of projects with OK health summary status
	NumOK int32 `json:"NumOK"`
	// Number of projects with Warning health summary status
	NumWarning int32 `json:"NumWarning"`
	// Number of projects with Critical health summary status
	NumCritical int32 `json:"NumCritical"`
	// Number of projects with Unknown health summary status
	NumUnknown int32 `json:"NumUnknown"`
}

type Target string

type Templating string

type TemplatingInfo string

type UpdateHost struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name        string `json:"Name"`
	Description string `json:"Description"`
	// The list of IDs corresponding to the networks that were provisioned to the host. These networks are among those listed in the Networks array returned by the get /available-resources call.
	NetworkIDs []string `json:"NetworkIDs"`
	// The host's default network ID. This needs to be one of the values in the  \"NetworkIDs\" list.
	NetworkForDefaultRoute string `json:"NetworkForDefaultRoute"`
	// ID of the network selected to be untagged. This needs to be one of the values in the  \"NetworkIDs\" list.
	NetworkUntagged string                 `json:"NetworkUntagged"`
	ISCSIConfig     *UpdateHostIscsiConfig `json:"ISCSIConfig,omitempty"`
	// The list of pre-allocated IP addresses corresponding to the list of NetworkIDs. Pre-allocated IP addresses are optional, but required when updating a host containing pre-allocated IP addresses.
	PreAllocatedIPs []string `json:"PreAllocatedIPs"`
	// The map of Service Network (Provider) ID to Provider MAC address.   The Service Network must be a provider network provisioned to this host. Any Service Networks not included here will default to the physical MAC learned during machine discovery.
	ServiceNetsProviderMAC map[string]string `json:"ServiceNetsProviderMAC"`
	// The map of service/user specified label name to label value for this host. Setting service labels is restricted by role. At minimum, this field should be set to the values specified during create.
	Labels map[string]string `json:"Labels"`
}

type UpdateHostAllOf struct {
	Description string `json:"Description"`
	// The list of IDs corresponding to the networks that were provisioned to the host. These networks are among those listed in the Networks array returned by the get /available-resources call.
	NetworkIDs []string `json:"NetworkIDs"`
	// The host's default network ID. This needs to be one of the values in the  \"NetworkIDs\" list.
	NetworkForDefaultRoute string `json:"NetworkForDefaultRoute"`
	// ID of the network selected to be untagged. This needs to be one of the values in the  \"NetworkIDs\" list.
	NetworkUntagged string                 `json:"NetworkUntagged"`
	ISCSIConfig     *UpdateHostIscsiConfig `json:"ISCSIConfig,omitempty"`
	// The list of pre-allocated IP addresses corresponding to the list of NetworkIDs. Pre-allocated IP addresses are optional, but required when updating a host containing pre-allocated IP addresses.
	PreAllocatedIPs []string `json:"PreAllocatedIPs"`
	// The map of Service Network (Provider) ID to Provider MAC address.   The Service Network must be a provider network provisioned to this host. Any Service Networks not included here will default to the physical MAC learned during machine discovery.
	ServiceNetsProviderMAC map[string]string `json:"ServiceNetsProviderMAC"`
	// The map of service/user specified label name to label value for this host. Setting service labels is restricted by role. At minimum, this field should be set to the values specified during create.
	Labels map[string]string `json:"Labels"`
}

type UpdateHostIscsiConfig struct {
	// Fully qualified iSCSI intiator name of this host. This is generated when a host is created and the information is pushed to the new host
	InitiatorName string `json:"InitiatorName"`
	// CHAP secret as generated by the system when attaching a volume.   Visible in VolumeAttachment object.
	CHAPSecret string `json:"CHAPSecret,omitempty"`
	// CHAP user as generated by the system when attaching a volume.   Visible in VolumeAttachment object.
	CHAPUser              string `json:"CHAPUser,omitempty"`
	ISCSIDiscoveryAddress string `json:"ISCSIDiscoveryAddress,omitempty"`
}

type UpdateIpPool struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name         string `json:"Name"`
	Description  string `json:"Description"`
	DefaultRoute string `json:"DefaultRoute"`
	// List of DNS servers for the IP pool
	DNS []string `json:"DNS"`
	// Optional web-proxy for external internet access should the pool actually be behind a firewall
	Proxy string `json:"Proxy"`
	// Addresses or CIDRs for which proxy requests are not made
	NoProxy string `json:"NoProxy"`
	// List of NTP servers for the IP pool
	NTP []string `json:"NTP"`
}

type UpdateIpPoolAllOf struct {
	Description  string `json:"Description"`
	DefaultRoute string `json:"DefaultRoute"`
	// List of DNS servers for the IP pool
	DNS []string `json:"DNS"`
	// Optional web-proxy for external internet access should the pool actually be behind a firewall
	Proxy string `json:"Proxy"`
	// Addresses or CIDRs for which proxy requests are not made
	NoProxy string `json:"NoProxy"`
	// List of NTP servers for the IP pool
	NTP []string `json:"NTP"`
}

type UpdateLimits struct {
	// Maximum number of hosts to allow
	Hosts int32 `json:"Hosts"`
	// Maximum number of volumes to allow
	Volumes int32 `json:"Volumes"`
	// Maximum capacity to allow in TiB
	VolumeCapacity int64 `json:"VolumeCapacity"`
	// Maximum number of private networks to allow
	PrivateNetworks int32 `json:"PrivateNetworks"`
	// Map of instance type ID to maximum number of hosts that can be created with that instance type
	InstanceTypes map[string]int32 `json:"InstanceTypes,omitempty"`
}

type UpdateNetwork struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name        string         `json:"Name"`
	Description string         `json:"Description"`
	HostUse     NetworkHostUse `json:"HostUse"`
	Purpose     NetworkPurpose `json:"Purpose"`
}

type UpdateNetworkAllOf struct {
	Description string         `json:"Description"`
	HostUse     NetworkHostUse `json:"HostUse"`
	Purpose     NetworkPurpose `json:"Purpose"`
}

type UpdateProfile struct {
	// Name of the Project Team. Must not be empty, maximum 128 printable characters
	TeamName string `json:"TeamName"`
	// Optional description of the Project Team, maximum 256 printable characters
	TeamDesc string `json:"TeamDesc,omitempty"`
	// Optional name of the company, maximum 256 printable characters
	Company string `json:"Company,omitempty"`
	// Optional address of the company, maximum 256 printable characters
	Address string `json:"Address,omitempty"`
	// Optional email address of the contact person for the team, maximum 256 printable characters
	Email string `json:"Email,omitempty"`
	// Currently always false
	EmailVerified bool `json:"EmailVerified,omitempty"`
	// Optional phone number of the contact person for the team, maximum 32 printable characters
	PhoneNumber string `json:"PhoneNumber,omitempty"`
	// Currently always false
	PhoneVerified bool `json:"PhoneVerified,omitempty"`
}

type UpdateProject struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name    string        `json:"Name"`
	Profile UpdateProfile `json:"Profile"`
	Limits  UpdateLimits  `json:"Limits"`
	// Array listing the permitted OS service images.
	PermittedOSImages []string `json:"PermittedOSImages"`
}

type UpdateProjectAllOf struct {
	Profile UpdateProfile `json:"Profile"`
	Limits  UpdateLimits  `json:"Limits"`
	// Array listing the permitted OS service images.
	PermittedOSImages []string `json:"PermittedOSImages"`
}

type UpdateResourceBase struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
}

type UpdateSshKey struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// SSH key value
	Key string `json:"Key"`
}

type UpdateVolume struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// The size of the volume in KiB
	Capacity int64 `json:"Capacity"`
	// The volume collection the volume is a part of
	VolumeCollectionID string `json:"VolumeCollectionID,omitempty"`
	// The map of service/user specified label name to label value for this volume. Setting service labels is restricted by role. At minimum, this field should be set to the values specified during create.
	Labels map[string]string `json:"Labels"`
}

type UpdateVolumeAllOf struct {
	// The size of the volume in KiB
	Capacity int64 `json:"Capacity"`
	// The volume collection the volume is a part of
	VolumeCollectionID string `json:"VolumeCollectionID,omitempty"`
	// The map of service/user specified label name to label value for this volume. Setting service labels is restricted by role. At minimum, this field should be set to the values specified during create.
	Labels map[string]string `json:"Labels"`
}

type UseRecord struct {
	// Address of the record
	Base string `json:"Base"`
	// Unique ID of the host associated with the record
	HostID string `json:"HostID"`
	// Unique ID of the rack associated with the record
	RackID string `json:"RackID"`
	// Unique ID of the device associated with the record
	DeviceID string `json:"DeviceID"`
	// Indicates if the record is used for non Metal scope
	External bool `json:"External"`
	// Usage of the record
	Usage string `json:"Usage"`
	// User which performed the allocation of the record
	AllocatedBy string `json:"AllocatedBy"`
}

type UserDefinedSteps struct {
	// Allows setting operations to be executed before host imaging.  If a firmware update operation is defined, Firmware Baseline must be set.
	ImagingPrepSteps []UserOp `json:"ImagingPrepSteps"`
	// Allows setting operations to be executed during host maintenance.  If a firmware update operation is defined, Firmware Baseline must be set.
	MaintenanceSteps []UserOp `json:"MaintenanceSteps"`
}

type UserOp struct {
	// Unique ID of this user operation.
	ID          string     `json:"ID"`
	Operation   UserOpEnum `json:"Operation"`
	Description string     `json:"Description"`
	Parameters  []OpArg    `json:"Parameters"`
}

type UserOpEnum string

type VaStateEnum string

type VafsConfig struct {
	// Storage identifier for an array or a SDS
	StorageID string `json:"StorageID"`
	// Storage array or SDS user
	UserName string `json:"UserName"`
	// SDS token acquired by login into the SDS for a given user. This is required by the FUSE client to mount volumes on host.
	Ticket string `json:"Ticket"`
	// Ticket expiry time to help client to refresh the ticket.
	TicketExpiryTime string `json:"TicketExpiryTime"`
}

type Version struct {
	Build string `json:"Build"`
}

type VersionAPI interface {
	/*
	   Get Get api server build version
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

	   @return Version
	*/
	Get(ctx _context.Context) (Version, *_nethttp.Response, error)
}

type VersionApiService service

type Volume struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// Time when the resource was created in the database
	Created time.Time `json:"Created"`
	// Time when the resource was last modified in the database
	Modified    time.Time `json:"Modified"`
	Description string    `json:"Description"`
	// The VolumeFlavorID matching an entry in the VolumeFlavors array returned as part of the get /available-resources call
	FlavorID string `json:"FlavorID"`
	// The storage pool ID matching an entry in the StoragePools array returned as part of the get /available-resources call
	StoragePoolID string `json:"StoragePoolID"`
	// The size of the volume in KiB
	Capacity int64 `json:"Capacity"`
	// Indicates if the volume can be attached to multiple hosts
	Shareable bool `json:"Shareable"`
	// The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host.
	LocationID string `json:"LocationID"`
	// The optional volume collection ID matching an entry in the VolumeCollections array returned as part of the get /available-resources call
	VolumeCollectionID string         `json:"VolumeCollectionID,omitempty"`
	State              VolumeState    `json:"State"`
	SubState           VolumeSubState `json:"SubState"`
	Status             VolumeStatus   `json:"Status"`
	// The map of label name to label value for the resource.
	Labels map[string]string `json:"Labels"`
	// Serial number of the volume.
	WWN string `json:"WWN"`
}

type VolumeAllOf struct {
	Description string `json:"Description"`
	// The VolumeFlavorID matching an entry in the VolumeFlavors array returned as part of the get /available-resources call
	FlavorID string `json:"FlavorID"`
	// The storage pool ID matching an entry in the StoragePools array returned as part of the get /available-resources call
	StoragePoolID string `json:"StoragePoolID"`
	// The size of the volume in KiB
	Capacity int64 `json:"Capacity"`
	// Indicates if the volume can be attached to multiple hosts
	Shareable bool `json:"Shareable"`
	// The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host.
	LocationID string `json:"LocationID"`
	// The optional volume collection ID matching an entry in the VolumeCollections array returned as part of the get /available-resources call
	VolumeCollectionID string         `json:"VolumeCollectionID,omitempty"`
	State              VolumeState    `json:"State"`
	SubState           VolumeSubState `json:"SubState"`
	Status             VolumeStatus   `json:"Status"`
	// The map of label name to label value for the resource.
	Labels map[string]string `json:"Labels"`
	// Serial number of the volume.
	WWN string `json:"WWN"`
}

type VolumeAttachHostUuid struct {
	// Unique ID of the Host to attach or detach volume
	HostID string `json:"HostID"`
}

type VolumeAttachment struct {
	// Unique ID for the resource instance as generated by the Metal service
	ID string `json:"ID"`
	// Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation.
	ETag string `json:"ETag"`
	// Common name for the resource instance. Must be 128 or fewer printable characters
	Name string `json:"Name"`
	// Time when the resource was created in the database
	Created time.Time `json:"Created"`
	// Time when the resource was last modified in the database
	Modified time.Time `json:"Modified"`
	// Unique ID of the volume attached to the host
	VolumeID string `json:"VolumeID"`
	// Unique ID of the host connected to the volume
	HostID string `json:"HostID"`
	// Host IP address for the network connection that connects to the storage array
	HostIPAddress string `json:"HostIPAddress"`
	// IQN is the full initiator name used for identification during iSCSI login
	IQN string `json:"IQN"`
	// CHAPSecret is the Challenge Authentication Protocol secret to be shared between array and initiator.
	CHAPSecret string `json:"CHAPSecret"`
	// CHAPUserName is the CHAP username to use for CHAP authentication
	CHAPUserName string `json:"CHAPUserName"`
	// LUN is the Logical Unit Number to be assigned to the volume on export
	LUN int32 `json:"LUN"`
	// VolumeTargetIQN is the iQN for the volume, assigned by the array corresponding to the volume
	VolumeTargetIQN string `json:"VolumeTargetIQN"`
	// VolumeTargetIPAddress is the IPV4 address of the iSCSI volume export
	VolumeTargetIPAddress string      `json:"VolumeTargetIPAddress"`
	State                 VaStateEnum `json:"State"`
	// File share specific configuration parameters
	FSConfig       *VafsConfig  `json:"FSConfig"`
	AttachProtocol ProtocolKind `json:"AttachProtocol"`
}

type VolumeAttachmentAllOf struct {
	// Unique ID of the volume attached to the host
	VolumeID string `json:"VolumeID"`
	// Unique ID of the host connected to the volume
	HostID string `json:"HostID"`
	// Host IP address for the network connection that connects to the storage array
	HostIPAddress string `json:"HostIPAddress"`
	// IQN is the full initiator name used for identification during iSCSI login
	IQN string `json:"IQN"`
	// CHAPSecret is the Challenge Authentication Protocol secret to be shared between array and initiator.
	CHAPSecret string `json:"CHAPSecret"`
	// CHAPUserName is the CHAP username to use for CHAP authentication
	CHAPUserName string `json:"CHAPUserName"`
	// LUN is the Logical Unit Number to be assigned to the volume on export
	LUN int32 `json:"LUN"`
	// VolumeTargetIQN is the iQN for the volume, assigned by the array corresponding to the volume
	VolumeTargetIQN string `json:"VolumeTargetIQN"`
	// VolumeTargetIPAddress is the IPV4 address of the iSCSI volume export
	VolumeTargetIPAddress string      `json:"VolumeTargetIPAddress"`
	State                 VaStateEnum `json:"State"`
	// File share specific configuration parameters
	FSConfig       *VafsConfig  `json:"FSConfig"`
	AttachProtocol ProtocolKind `json:"AttachProtocol"`
}

type VolumeAttachmentsAPI interface {
	/*
	   Add Create a new VolumeAttachment
	   Adds a new VolumeAttachment which enables a machine to use a volume. Note that this API is for creation of a VolumeAttachment for non-Hosts. A VolumeAttachment resource must be deleted using the 'DELETE /volume-attachments/{attachmentId}' API. For regular hosts, a VolumeAttachment is created via the 'POST /volumes/{volumeId}/attach' API.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param newVolumeAttachment NewVolumeAttachement parameters to create a new VolumeAttachment.

	   @return VolumeAttachment
	*/
	Add(ctx _context.Context, newVolumeAttachment NewVolumeAttachment) (VolumeAttachment, *_nethttp.Response, error)
	/*
	   Delete Delete a VolumeAttachment
	   Deletes the VolumeAttachment with the matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param attachmentId ID of VolumeAttachment to delete
	*/
	Delete(ctx _context.Context, attachmentId string) (*_nethttp.Response, error)
	/*
	   GetByID Retrieve volume attachment by ID
	   Returns a single volume attachment with matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param attachmentId ID of volume attachment to return

	   @return VolumeAttachment
	*/
	GetByID(ctx _context.Context, attachmentId string) (VolumeAttachment, *_nethttp.Response, error)
	/*
	   List List all volume attachments in project
	   Returns an array of all VolumeAttachments defined within the project.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

	   @return []VolumeAttachment
	*/
	List(ctx _context.Context) ([]VolumeAttachment, *_nethttp.Response, error)
}

type VolumeAttachmentsApiService service

type VolumeCollection struct {
	// The ID of the volume collection resource that can be used while creating a volume
	ID string `json:"ID"`
	// The name of the volume collection resource
	Name string `json:"Name"`
	// The location ID of the data center where the volume collection resides
	LocationID string `json:"LocationID"`
	// The description of the volume collection resource
	Description string `json:"Description"`
	// IDs of the storage pools that are valid for this volume collection as listed in the Storage Pools array
	StoragePoolIDs []string `json:"StoragePoolIDs,omitempty"`
}

type VolumeFlavor struct {
	// Volume flavor unique ID
	ID string `json:"ID"`
	// Typical user-visible name for a volume flavor
	Name    string     `json:"Name"`
	Details FlavorDesc `json:"Details"`
}

type VolumeFlavorsInfo struct {
	Name         string `json:"Name"`
	ProjectsUsed int32  `json:"ProjectsUsed"`
	OtherUsed    int32  `json:"OtherUsed"`
	Available    int32  `json:"Available"`
}

type VolumeInfo struct {
	// Unique ID for the volume.  Referenced if the volume is to be attached to a new Host
	ID string `json:"ID"`
	// User-provided name for the volume
	Name string `json:"Name"`
	// User-provided description of the volume
	Description string `json:"Description"`
	// The ID of the volume flavor requested when creating the volume
	FlavorID string `json:"FlavorID"`
	// The ID of the storage pool where volume resides
	StoragePoolID string `json:"StoragePoolID"`
	// The size of the volume in KiB
	Capacity int64 `json:"Capacity"`
	// Indicates if the volume can be attached to multiple hosts
	Shareable bool `json:"Shareable"`
	// The location ID of the data center where the volume exists
	LocationID string `json:"LocationID"`
	// The ID of volume collection of which this volume is a member
	VolumeCollectionID string `json:"VolumeCollectionID"`
	// The discovery IP for the iSCSI volume
	DiscoveryIP string `json:"DiscoveryIP"`
	// The target IQN for the iSCSI volume
	TargetIQN string       `json:"TargetIQN"`
	State     VolumeState  `json:"State"`
	Status    VolumeStatus `json:"Status"`
}

type VolumeState string

type VolumeStatus string

type VolumeSubState string

type VolumesAPI interface {
	/*
	   Add Add a new volume
	   Adds a new volume to the project.  Volumes may be created separately and then referenced in the create Host call; or volumes may be created directly within the create Host call.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param newVolume Volume that is to be added to the project

	   @return Volume
	*/
	Add(ctx _context.Context, newVolume NewVolume) (Volume, *_nethttp.Response, error)
	/*
	   Attach Attach existing volume to Host
	   Attaches the indicated volume to a host identified in the requestBody.   This attachment will create a VolumeAttachment object that contains  details about the connection of the volume and will update the Host  with iSCSI configuration information.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param volumeId ID of volume to attach
	     - @param volumeAttachHostUuid Unique ID of the Host to which the volume will be attached

	   @return VolumeAttachment
	*/
	Attach(ctx _context.Context, volumeId string, volumeAttachHostUuid VolumeAttachHostUuid) (VolumeAttachment, *_nethttp.Response, error)
	/*
	   Delete Delete a volume
	   Deletes the volume with the matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param volumeId ID of volume to delete
	*/
	Delete(ctx _context.Context, volumeId string) (*_nethttp.Response, error)
	/*
	   Detach Detach existing volume from Host
	   Detaches the indicated volume from the host identified in the requestBody.   This detachment will delete the VolumeAttachment object that contains  details about the connection of the volume and will update the Host  to remove selected iSCSI configuration information. Note that the HostID is required in the body of the request to ensure that the operation is well understood and that a volume is not accidently being removed from the wrong host.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param volumeId ID of volume to attach
	     - @param volumeAttachHostUuid Unique ID of the Host from which a volume will be detached
	*/
	Detach(ctx _context.Context, volumeId string, volumeAttachHostUuid VolumeAttachHostUuid) (*_nethttp.Response, error)
	/*
	   GetByID Retrieve volume by ID
	   Returns a single volume with matching ID
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param volumeId ID of volume to return

	   @return Volume
	*/
	GetByID(ctx _context.Context, volumeId string) (Volume, *_nethttp.Response, error)
	/*
	   List List all volumes in project
	   Returns an array of all volumes defined within the project.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

	   @return []Volume
	*/
	List(ctx _context.Context) ([]Volume, *_nethttp.Response, error)
	/*
	   Update Update an existing volume
	   Updates volume with matching ID. Update is permitted only when volume is in 'Allocated' or 'Visible' state. Only the Volume 'Capacity' can be updated with a value greater than the existing one to expand the volume.
	     - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	     - @param volumeId ID of volume to return
	     - @param updateVolume Volume object with its ID and Capacity in GiB indicating the expanded size to be specified.

	   @return Volume
	*/
	Update(ctx _context.Context, volumeId string, updateVolume UpdateVolume) (Volume, *_nethttp.Response, error)
}

type VolumesApiService service