models

type HashicorpCloudConsul20210204ACLToken struct {

	// accessor_id is the Consul Accessor ID for this ACL token.
	AccessorID string `json:"accessor_id,omitempty"`

	// secret_id is the Consul Secret ID for this ACL Token, it is sensitive.
	SecretID string `json:"secret_id,omitempty"`
}

type HashicorpCloudConsul20210204CapacityConfig struct {

	// scale is the number of nodes this Consul cluster is provisioned with.
	Scale int32 `json:"scale,omitempty"`

	// size is the t-shirt size representation of the VM that this Consul cluster
	// is provisioned with.
	Size *HashicorpCloudConsul20210204CapacityConfigSize `json:"size,omitempty"`
}

type HashicorpCloudConsul20210204CapacityConfigSize string

type HashicorpCloudConsul20210204CidrRange struct {

	// The IPv4 or IPv6 address range including prefix.
	// E.g. 172.25.16.0/24 or 2001:d00::/24
	Address string `json:"address,omitempty"`

	// An optional description of the IP address range.
	Description string `json:"description,omitempty"`
}

type HashicorpCloudConsul20210204Cluster struct {

	// config holds the configuration of the cluster.
	Config *HashicorpCloudConsul20210204ClusterConfig `json:"config,omitempty"`

	// consul_version is the current Consul version the server nodes are running.
	ConsulVersion string `json:"consul_version,omitempty"`

	// created_at is the timestamp of when the cluster was first created.
	// Output only.
	// Read Only: true
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"created_at,omitempty"`

	// dns_names holds the cluster's public and private DNS names.
	// Output only.
	// Read Only: true
	DNSNames *HashicorpCloudConsul20210204ClusterDNSNames `json:"dns_names,omitempty"`

	// id is ID of the Consul cluster.
	ID string `json:"id,omitempty"`

	// location is the location of the cluster.
	Location *cloud.HashicorpCloudLocationLocation `json:"location,omitempty"`

	// resource_id is the unique identifier for the consul cluster
	ResourceID string `json:"resource_id,omitempty"`

	// state is the current state of the cluster.
	// Output only.
	// Read Only: true
	State *HashicorpCloudConsul20210204ClusterState `json:"state,omitempty"`
}

type HashicorpCloudConsul20210204ClusterConfig struct {

	// auto_hvn_to_hvn_peering is only used together with the field
	// consul_config.primary when creating secondary clusters in a federation.
	// Enable auto_hvn_to_hvn_peering if the secondary HVN should be peered
	// automatically to every other cluster's HVN in the federation. If left
	// disabled, the peering has to be done manually.
	AutoHvnToHvnPeering bool `json:"auto_hvn_to_hvn_peering,omitempty"`

	// capacity_config contains the configuration for the cluster size settings.
	CapacityConfig *HashicorpCloudConsul20210204CapacityConfig `json:"capacity_config,omitempty"`

	// consul_config allows altering certain fields relating to the Consul
	// cluster’s configuration.
	ConsulConfig *HashicorpCloudConsul20210204ConsulConfig `json:"consul_config,omitempty"`

	// maintenance_config contains the configuration for maintenance events such
	// as auto upgrades.
	MaintenanceConfig HashicorpCloudConsul20210204MaintenanceConfig `json:"maintenance_config,omitempty"`

	// NetworkConfig contains the network to launch the Consul cluster into.
	NetworkConfig *HashicorpCloudConsul20210204NetworkConfig `json:"network_config,omitempty"`

	// primary is readonly and contains a link to the primary consul cluster in a
	// federation. If this link points to itself, this cluster is the primary of a
	// federation. If the link points to another cluster, this cluster is a
	// secondary in a federation. Use consul_config.primary to federate clusters.
	// The difference between these two fields is that this field is present on
	// primaries and secondaries. Whereas consul_config.primary is only present on
	// secondaries. Output only.
	// Read Only: true
	Primary *cloud.HashicorpCloudLocationLink `json:"primary,omitempty"`

	// snapshot_config contains the configuration for how often to snapshot and
	// how many to maintain.
	SnapshotConfig HashicorpCloudConsul20210204SnapshotConfig `json:"snapshot_config,omitempty"`

	// tier is the type of tier this Consul cluster should be provisioned as.
	Tier *HashicorpCloudConsul20210204ClusterConfigTier `json:"tier,omitempty"`
}

type HashicorpCloudConsul20210204ClusterConfigTier string

type HashicorpCloudConsul20210204ClusterDNSNames struct {

	// private is the DNS name pointing to the cluster's private IP addresses.
	Private string `json:"private,omitempty"`

	// public is the DNS name pointing to the cluster's public IP addresses.
	Public string `json:"public,omitempty"`
}

type HashicorpCloudConsul20210204ClusterState string

type HashicorpCloudConsul20210204ClusterTelemetry struct {

	// client_count is the number of consul agents connected to this consul
	// cluster
	ClientCount int32 `json:"client_count,omitempty"`
}

type HashicorpCloudConsul20210204ConsulConfig struct {

	// connect_enabled toggles Consul Connect on the Consul servers.
	ConnectEnabled bool `json:"connect_enabled,omitempty"`

	// datacenter sets the datacenter the Consul servers will be running in. If
	// not set, a default value will be used.
	//
	// https://www.consul.io/docs/agent/options.html#datacenter
	Datacenter string `json:"datacenter,omitempty"`

	// primary contains a link to the primary consul cluster in a federation.
	Primary *cloud.HashicorpCloudLocationLink `json:"primary,omitempty"`
}

type HashicorpCloudConsul20210204CreateCustomerMasterACLTokenRequest struct {

	// id is the ID of the cluster to create a token on.
	ID string `json:"id,omitempty"`

	// location is the location of the cluster.
	Location *cloud.HashicorpCloudLocationLocation `json:"location,omitempty"`
}

type HashicorpCloudConsul20210204CreateCustomerMasterACLTokenResponse struct {

	// acl_token is the newly created master token.
	ACLToken *HashicorpCloudConsul20210204ACLToken `json:"acl_token,omitempty"`
}

type HashicorpCloudConsul20210204CreateRequest struct {

	// Cluster is the Consul Cluster to create.
	Cluster *HashicorpCloudConsul20210204Cluster `json:"cluster,omitempty"`
}

type HashicorpCloudConsul20210204CreateResponse struct {

	// cluster is the newly created Consul cluster.
	Cluster *HashicorpCloudConsul20210204Cluster `json:"cluster,omitempty"`

	// operation tracks the asynchronous creation of the Consul cluster.
	Operation *cloud.HashicorpCloudOperationOperation `json:"operation,omitempty"`
}

type HashicorpCloudConsul20210204CreateSnapshotRequest struct {

	// name identifies the name of the snapshot.
	Name string `json:"name,omitempty"`

	// resource identifies what resource to take a snapshot from.
	Resource *cloud.HashicorpCloudLocationLink `json:"resource,omitempty"`
}

type HashicorpCloudConsul20210204CreateSnapshotResponse struct {

	// operation represents the newly created snapshot.
	Operation *cloud.HashicorpCloudOperationOperation `json:"operation,omitempty"`

	// snapshot_id is the identifer of the newly created snapshot.
	SnapshotID string `json:"snapshot_id,omitempty"`
}

type HashicorpCloudConsul20210204DeleteResponse struct {

	// operation is the operation used to track the deletion of the Consul
	// cluster.
	Operation *cloud.HashicorpCloudOperationOperation `json:"operation,omitempty"`
}

type HashicorpCloudConsul20210204DeleteSnapshotResponse struct {

	// operation represents the deletion of the requested snapshot.
	Operation *cloud.HashicorpCloudOperationOperation `json:"operation,omitempty"`
}

type HashicorpCloudConsul20210204GetClientConfigResponse struct {

	// ca_file is the body of an intermediate certificate authority file.
	// Format: byte
	CaFile strfmt.Base64 `json:"ca_file,omitempty"`

	// consul_config_file is the body of JSON config file.
	// Format: byte
	ConsulConfigFile strfmt.Base64 `json:"consul_config_file,omitempty"`

	// file_bundle_zip is the contents of a zip archive containing the other
	// two files, if the request specified it.
	// Format: byte
	FileBundleZip strfmt.Base64 `json:"file_bundle_zip,omitempty"`
}

type HashicorpCloudConsul20210204GetClusterTelemetryResponse struct {

	// telemetry is the cluster telemetry associated with this cluster
	Telemetry *HashicorpCloudConsul20210204ClusterTelemetry `json:"telemetry,omitempty"`
}

type HashicorpCloudConsul20210204GetResponse struct {

	// cluster is the retrieved Consul cluster.
	Cluster *HashicorpCloudConsul20210204Cluster `json:"cluster,omitempty"`
}

type HashicorpCloudConsul20210204GetSnapshotResponse struct {

	// snapshot is the requested snapshot.
	Snapshot *HashicorpCloudConsul20210204Snapshot `json:"snapshot,omitempty"`
}

type HashicorpCloudConsul20210204ListResponse struct {

	// clusters are the retrieved Consul clusters.
	Clusters []*HashicorpCloudConsul20210204Cluster `json:"clusters"`

	// Pagination contains the pagination tokens for a subsequent request.
	Pagination *cloud.HashicorpCloudCommonPaginationResponse `json:"pagination,omitempty"`
}

type HashicorpCloudConsul20210204ListSnapshotsResponse struct {

	// Pagination contains the pagination tokens for a subsequent request.
	Pagination *cloud.HashicorpCloudCommonPaginationResponse `json:"pagination,omitempty"`

	// snapshots is a list of available snapshots.
	Snapshots []*HashicorpCloudConsul20210204Snapshot `json:"snapshots"`
}

type HashicorpCloudConsul20210204ListUpgradeVersionsResponse struct {

	// versions
	Versions []*HashicorpCloudConsul20210204Version `json:"versions"`
}

type HashicorpCloudConsul20210204ListVersionsResponse struct {

	// versions
	Versions []*HashicorpCloudConsul20210204Version `json:"versions"`
}

type HashicorpCloudConsul20210204MaintenanceConfig interface{}

type HashicorpCloudConsul20210204NetworkConfig struct {

	// A list of IP addresses used to restrict access to a cluster.
	IPAllowlist []*HashicorpCloudConsul20210204CidrRange `json:"ip_allowlist"`

	// network is the link of the HVN to launch the Consul cluster in.
	// The network cannot be updated once the cluster is created.
	Network *cloud.HashicorpCloudLocationLink `json:"network,omitempty"`

	// private indicates if this cluster's instances should be configured in a
	// non-externally accessible way.
	Private bool `json:"private,omitempty"`
}

type HashicorpCloudConsul20210204PlatformType string

type HashicorpCloudConsul20210204RestoreSnapshotRequest struct {

	// cluster_id represents the cluster to restore to.
	ClusterID string `json:"cluster_id,omitempty"`

	// location specifies the location to the cluster is in.
	Location *cloud.HashicorpCloudLocationLocation `json:"location,omitempty"`

	// snapshot represents the snapshot to restore.
	Snapshot *cloud.HashicorpCloudLocationLink `json:"snapshot,omitempty"`

	// take_snapshot determines if a snapshot should be taken before performing a restore.
	TakeSnapshot bool `json:"take_snapshot,omitempty"`
}

type HashicorpCloudConsul20210204RestoreSnapshotResponse struct {

	// operation represents the restore operation acting on the specified cluster.
	Operation *cloud.HashicorpCloudOperationOperation `json:"operation,omitempty"`
}

type HashicorpCloudConsul20210204Snapshot struct {

	// created_at is the time that this snapshot was requested.
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"created_at,omitempty"`

	// finished_at is the time that this snapshot was finished.
	// Format: date-time
	FinishedAt strfmt.DateTime `json:"finished_at,omitempty"`

	// id is the snapshot’s ID.
	ID string `json:"id,omitempty"`

	// location is the snapshot’s location.
	Location *cloud.HashicorpCloudLocationLocation `json:"location,omitempty"`

	// meta is the snapshot metadata.
	Meta *HashicorpCloudConsul20210204SnapshotSnapshotMeta `json:"meta,omitempty"`

	// name is the name of the snapshot.
	Name string `json:"name,omitempty"`

	// resource is the resource the snapshot was taken from.
	Resource *cloud.HashicorpCloudLocationLink `json:"resource,omitempty"`

	// running_operation_id is the ID of an operation performing work related to the current state of the snapshot.
	RunningOperationID string `json:"running_operation_id,omitempty"`

	// self_link is a link referring to this snapshot.
	SelfLink *cloud.HashicorpCloudLocationLink `json:"self_link,omitempty"`

	// state represents the current status for this snapshot.
	State *HashicorpCloudConsul20210204SnapshotSnapshotState `json:"state,omitempty"`

	// type represents the type of this snapshot.
	Type *HashicorpCloudConsul20210204SnapshotSnapshotType `json:"type,omitempty"`
}

type HashicorpCloudConsul20210204SnapshotConfig interface{}

type HashicorpCloudConsul20210204SnapshotSnapshotMeta struct {

	// additional_meta contains additional metadata of the snapshot.
	AdditionalMeta map[string]string `json:"additional_meta,omitempty"`

	// product_version is the version of the product of the cluster at creation.
	ProductVersion string `json:"product_version,omitempty"`

	// restored_at notes the time that this snapshot was restored.
	// Format: date-time
	RestoredAt strfmt.DateTime `json:"restored_at,omitempty"`

	// size is the size of the snapshot in bytes.
	Size string `json:"size,omitempty"`
}

type HashicorpCloudConsul20210204SnapshotSnapshotState string

type HashicorpCloudConsul20210204SnapshotSnapshotType string

type HashicorpCloudConsul20210204UpdateResponse struct {

	// operation is used to track the progress of the asynchronous update.
	// Depending on what was updated in the configuration the update may
	// require deploying new server nodes which may take some time to complete.
	Operation *cloud.HashicorpCloudOperationOperation `json:"operation,omitempty"`
}

type HashicorpCloudConsul20210204UpdateSnapshotResponse struct {

	// snapshot is the updated snapshot.
	Snapshot *HashicorpCloudConsul20210204Snapshot `json:"snapshot,omitempty"`
}

type HashicorpCloudConsul20210204Version struct {

	// status defines the version availability.
	Status *HashicorpCloudConsul20210204VersionStatus `json:"status,omitempty"`

	// version is the string representation of the Consul version.
	Version string `json:"version,omitempty"`
}

type HashicorpCloudConsul20210204VersionStatus string