models

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Mar 16, 2021 License: MPL-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GoogleProtobufFieldMask 

type GoogleProtobufFieldMask struct {

	// The set of field mask paths.
	Paths []string `json:"paths"`
}

GoogleProtobufFieldMask `FieldMask` represents a set of symbolic field paths, for example:

paths: "f.a" 

paths: "f.b.d"

Here `f` represents a field in some root message, `a` and `b` fields in the message found in `f`, and `d` a field found in the message in `f.b`.

Field masks are used to specify a subset of fields that should be returned by a get operation or modified by an update operation. Field masks also have a custom JSON encoding (see below).

Field Masks in Projections

When used in the context of a projection, a response message or sub-message is filtered by the API to only contain those fields as specified in the mask. For example, if the mask in the previous example is applied to a response message as follows: 

f {
  a : 22
  b {
    d : 1
    x : 2
  }
  y : 13
}
z: 8

The result will not contain specific values for fields x,y and z (their value will be set to the default, and omitted in proto text output): 

f {
  a : 22
  b {
    d : 1
  }
}

A repeated field is not allowed except at the last position of a paths string.

If a FieldMask object is not present in a get operation, the operation applies to all fields (as if a FieldMask of all fields had been specified).

Note that a field mask does not necessarily apply to the top-level response message. In case of a REST get operation, the field mask applies directly to the response, but in case of a REST list operation, the mask instead applies to each individual message in the returned resource list. In case of a REST custom method, other definitions may be used. Where the mask applies will be clearly documented together with its declaration in the API. In any case, the effect on the returned resource/resources is required behavior for APIs.

Field Masks in Update Operations

A field mask in update operations specifies which fields of the targeted resource are going to be updated. The API is required to only change the values of the fields as specified in the mask and leave the others untouched. If a resource is passed in to describe the updated values, the API ignores the values of all fields not covered by the mask.

If a repeated field is specified for an update operation, new values will be appended to the existing repeated field in the target resource. Note that a repeated field is only allowed in the last position of a `paths` string.

If a sub-message is specified in the last position of the field mask for an update operation, then new value will be merged into the existing sub-message in the target resource.

For example, given the target message: 

f {
  b {
    d: 1
    x: 2
  }
  c: [1]
}

And an update message: 

f {
  b {
    d: 10
  }
  c: [2]
}

then if the field mask is: 

paths: ["f.b", "f.c"]

then the result will be: 

f {
  b {
    d: 10
    x: 2
  }
  c: [1, 2]
}

An implementation may provide options to override this default behavior for repeated and message fields.

In order to reset a field's value to the default, the field must be in the mask and set to the default value in the provided resource. Hence, in order to reset all fields of a resource, provide a default instance of the resource and set all fields in the mask, or do not provide a mask as described below.

If a field mask is not present on update, the operation applies to all fields (as if a field mask of all fields has been specified). Note that in the presence of schema evolution, this may mean that fields the client does not know and has therefore not filled into the request will be reset to their default. If this is unwanted behavior, a specific service may require a client to always specify a field mask, producing an error if not.

As with get operations, the location of the resource which describes the updated values in the request message depends on the operation kind. In any case, the effect of the field mask is required to be honored by the API.

## Considerations for HTTP REST

The HTTP kind of an update operation which uses a field mask must be set to PATCH instead of PUT in order to satisfy HTTP semantics (PUT must only be used for full updates).

JSON Encoding of Field Masks

In JSON, a field mask is encoded as a single string where paths are separated by a comma. Fields name in each path are converted to/from lower-camel naming conventions.

As an example, consider the following message declarations: 

message Profile {
  User user = 1;
  Photo photo = 2;
}
message User {
  string display_name = 1;
  string address = 2;
}

In proto a field mask for `Profile` may look as such: 

mask {
  paths: "user.display_name"
  paths: "photo"
}

In JSON, the same mask is represented as below: 

{
  mask: "user.displayName,photo"
}

Field Masks and Oneof Fields

Field masks treat fields in oneofs just as regular fields. Consider the following message: 

message SampleMessage {
  oneof test_oneof {
    string name = 4;
    SubMessage sub_message = 9;
  }
}

The field mask can be: 

mask {
  paths: "name"
}

Or: 

mask {
  paths: "sub_message"
}

Note that oneof type names ("test_oneof" in this case) cannot be used in paths.

## Field Mask Verification

The implementation of any API method which has a FieldMask type field in the request should verify the included field paths, and return an `INVALID_ARGUMENT` error if any path is duplicated or unmappable.

swagger:model google.protobuf.FieldMask

func (*GoogleProtobufFieldMask) MarshalBinary 

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

MarshalBinary interface implementation

func (*GoogleProtobufFieldMask) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*GoogleProtobufFieldMask) Validate 

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

Validate validates this google protobuf field mask

type GrpcGatewayRuntimeError 

type GrpcGatewayRuntimeError struct {

	// code
	Code int32 `json:"code,omitempty"`

	// details
	Details []*cloud.GoogleProtobufAny `json:"details"`

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

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

GrpcGatewayRuntimeError grpc gateway runtime error

swagger:model grpc.gateway.runtime.Error

func (*GrpcGatewayRuntimeError) MarshalBinary 

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

MarshalBinary interface implementation

func (*GrpcGatewayRuntimeError) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*GrpcGatewayRuntimeError) Validate 

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

Validate validates this grpc gateway runtime error

type HashicorpCloudConsul20210204ACLToken 

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"`
}

HashicorpCloudConsul20210204ACLToken ACLToken is represents a single ACL token for a cluster.

swagger:model hashicorp.cloud.consul_20210204.ACLToken

func (*HashicorpCloudConsul20210204ACLToken) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ACLToken) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ACLToken) Validate 

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

Validate validates this hashicorp cloud consul 20210204 ACL token

type HashicorpCloudConsul20210204CapacityConfig 

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"`
}

HashicorpCloudConsul20210204CapacityConfig CapacityConfig configures capacity settings like number of nodes and vm sizes.

swagger:model hashicorp.cloud.consul_20210204.CapacityConfig

func (*HashicorpCloudConsul20210204CapacityConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CapacityConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CapacityConfig) Validate 

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

Validate validates this hashicorp cloud consul 20210204 capacity config

type HashicorpCloudConsul20210204CapacityConfigSize 

type HashicorpCloudConsul20210204CapacityConfigSize string

HashicorpCloudConsul20210204CapacityConfigSize Size represents the different VM sizes a Consul cluster can be provisioned with. These are bucketed as "t-shirt" sizes which each correspond to a specific instance type depending on the cloud provider.

swagger:model hashicorp.cloud.consul_20210204.CapacityConfig.Size 

const (

	// HashicorpCloudConsul20210204CapacityConfigSizeUNSET captures enum value "UNSET"
	HashicorpCloudConsul20210204CapacityConfigSizeUNSET HashicorpCloudConsul20210204CapacityConfigSize = "UNSET"

	// HashicorpCloudConsul20210204CapacityConfigSizeXSMALL captures enum value "X_SMALL"
	HashicorpCloudConsul20210204CapacityConfigSizeXSMALL HashicorpCloudConsul20210204CapacityConfigSize = "X_SMALL"

	// HashicorpCloudConsul20210204CapacityConfigSizeSMALL captures enum value "SMALL"
	HashicorpCloudConsul20210204CapacityConfigSizeSMALL HashicorpCloudConsul20210204CapacityConfigSize = "SMALL"

	// HashicorpCloudConsul20210204CapacityConfigSizeMEDIUM captures enum value "MEDIUM"
	HashicorpCloudConsul20210204CapacityConfigSizeMEDIUM HashicorpCloudConsul20210204CapacityConfigSize = "MEDIUM"

	// HashicorpCloudConsul20210204CapacityConfigSizeLARGE captures enum value "LARGE"
	HashicorpCloudConsul20210204CapacityConfigSizeLARGE HashicorpCloudConsul20210204CapacityConfigSize = "LARGE"
)

func (HashicorpCloudConsul20210204CapacityConfigSize) Validate 

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

Validate validates this hashicorp cloud consul 20210204 capacity config size

type HashicorpCloudConsul20210204Cluster 

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"`

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

HashicorpCloudConsul20210204Cluster Cluster represents a single Consul cluster.

swagger:model hashicorp.cloud.consul_20210204.Cluster

func (*HashicorpCloudConsul20210204Cluster) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204Cluster) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204Cluster) Validate 

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

Validate validates this hashicorp cloud consul 20210204 cluster

type HashicorpCloudConsul20210204ClusterConfig 

type HashicorpCloudConsul20210204ClusterConfig struct {

	// 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"`

	// 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"`
}

HashicorpCloudConsul20210204ClusterConfig ClusterConfig holds the configuration for a Consul cluster.

swagger:model hashicorp.cloud.consul_20210204.ClusterConfig

func (*HashicorpCloudConsul20210204ClusterConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ClusterConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ClusterConfig) Validate 

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

Validate validates this hashicorp cloud consul 20210204 cluster config

type HashicorpCloudConsul20210204ClusterConfigTier 

type HashicorpCloudConsul20210204ClusterConfigTier string

HashicorpCloudConsul20210204ClusterConfigTier Tier represents the different tiers a Consul cluster can be provisioned as.

swagger:model hashicorp.cloud.consul_20210204.ClusterConfig.Tier 

const (

	// HashicorpCloudConsul20210204ClusterConfigTierUNSET captures enum value "UNSET"
	HashicorpCloudConsul20210204ClusterConfigTierUNSET HashicorpCloudConsul20210204ClusterConfigTier = "UNSET"

	// HashicorpCloudConsul20210204ClusterConfigTierDEVELOPMENT captures enum value "DEVELOPMENT"
	HashicorpCloudConsul20210204ClusterConfigTierDEVELOPMENT HashicorpCloudConsul20210204ClusterConfigTier = "DEVELOPMENT"

	// HashicorpCloudConsul20210204ClusterConfigTierSTANDARD captures enum value "STANDARD"
	HashicorpCloudConsul20210204ClusterConfigTierSTANDARD HashicorpCloudConsul20210204ClusterConfigTier = "STANDARD"
)

func (HashicorpCloudConsul20210204ClusterConfigTier) Validate 

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

Validate validates this hashicorp cloud consul 20210204 cluster config tier

type HashicorpCloudConsul20210204ClusterDNSNames 

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"`
}

HashicorpCloudConsul20210204ClusterDNSNames DNSNames holds all of the cluster's DNS names.

swagger:model hashicorp.cloud.consul_20210204.Cluster.DNSNames

func (*HashicorpCloudConsul20210204ClusterDNSNames) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ClusterDNSNames) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ClusterDNSNames) Validate 

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

Validate validates this hashicorp cloud consul 20210204 cluster DNS names

type HashicorpCloudConsul20210204ClusterState 

type HashicorpCloudConsul20210204ClusterState string

HashicorpCloudConsul20210204ClusterState State is the state of the Consul cluster. Note that this state represents the abstract Consul cluster itself, not necessarily whether Consul cluster is currently available or not.

  • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be

detected.

  • PENDING: PENDING is the state the cluster is in while it is waiting to be created.
  • CREATING: CREATING is the state the cluster is in while it is being provisioned for

the first time.

  • RUNNING: RUNNING is the steady state while the cluster is running.
  • FAILED: FAILED is a failure state in which the cluster is unavailable and may

required an operator restore action to recover.

  • UPDATING: UPDATING is the state the cluster is in while undergoing a version

update.

  • RESTORING: RESTORING is the state the cluster is in while restoring from a snapshot.
  • DELETING: DELETING is the state the cluster is in while it is being de-provisioned.
  • DELETED: DELETED is the state the cluster is in when it has been de-provisioned. At

this point, the cluster is eligible for garbage collection.

swagger:model hashicorp.cloud.consul_20210204.Cluster.State 

const (

	// HashicorpCloudConsul20210204ClusterStateUNSET captures enum value "UNSET"
	HashicorpCloudConsul20210204ClusterStateUNSET HashicorpCloudConsul20210204ClusterState = "UNSET"

	// HashicorpCloudConsul20210204ClusterStatePENDING captures enum value "PENDING"
	HashicorpCloudConsul20210204ClusterStatePENDING HashicorpCloudConsul20210204ClusterState = "PENDING"

	// HashicorpCloudConsul20210204ClusterStateCREATING captures enum value "CREATING"
	HashicorpCloudConsul20210204ClusterStateCREATING HashicorpCloudConsul20210204ClusterState = "CREATING"

	// HashicorpCloudConsul20210204ClusterStateRUNNING captures enum value "RUNNING"
	HashicorpCloudConsul20210204ClusterStateRUNNING HashicorpCloudConsul20210204ClusterState = "RUNNING"

	// HashicorpCloudConsul20210204ClusterStateFAILED captures enum value "FAILED"
	HashicorpCloudConsul20210204ClusterStateFAILED HashicorpCloudConsul20210204ClusterState = "FAILED"

	// HashicorpCloudConsul20210204ClusterStateUPDATING captures enum value "UPDATING"
	HashicorpCloudConsul20210204ClusterStateUPDATING HashicorpCloudConsul20210204ClusterState = "UPDATING"

	// HashicorpCloudConsul20210204ClusterStateRESTORING captures enum value "RESTORING"
	HashicorpCloudConsul20210204ClusterStateRESTORING HashicorpCloudConsul20210204ClusterState = "RESTORING"

	// HashicorpCloudConsul20210204ClusterStateDELETING captures enum value "DELETING"
	HashicorpCloudConsul20210204ClusterStateDELETING HashicorpCloudConsul20210204ClusterState = "DELETING"

	// HashicorpCloudConsul20210204ClusterStateDELETED captures enum value "DELETED"
	HashicorpCloudConsul20210204ClusterStateDELETED HashicorpCloudConsul20210204ClusterState = "DELETED"
)

func (HashicorpCloudConsul20210204ClusterState) Validate 

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

Validate validates this hashicorp cloud consul 20210204 cluster state

type HashicorpCloudConsul20210204ConsulConfig 

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"`
}

HashicorpCloudConsul20210204ConsulConfig ConsulConfig exposes user settable configurations for a Consul cluster.

swagger:model hashicorp.cloud.consul_20210204.ConsulConfig

func (*HashicorpCloudConsul20210204ConsulConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ConsulConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ConsulConfig) Validate 

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

Validate validates this hashicorp cloud consul 20210204 consul config

type HashicorpCloudConsul20210204CreateCustomerMasterACLTokenRequest 

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"`
}

HashicorpCloudConsul20210204CreateCustomerMasterACLTokenRequest CreateCustomerMasterACLTokenRequest is used to create a master token on a specific cluster.

swagger:model hashicorp.cloud.consul_20210204.CreateCustomerMasterACLTokenRequest

func (*HashicorpCloudConsul20210204CreateCustomerMasterACLTokenRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateCustomerMasterACLTokenRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateCustomerMasterACLTokenRequest) Validate 

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

Validate validates this hashicorp cloud consul 20210204 create customer master ACL token request

type HashicorpCloudConsul20210204CreateCustomerMasterACLTokenResponse 

type HashicorpCloudConsul20210204CreateCustomerMasterACLTokenResponse struct {

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

HashicorpCloudConsul20210204CreateCustomerMasterACLTokenResponse CreateCustomerMasterACLTokenResponse contains the newly created customer master ACL token.

swagger:model hashicorp.cloud.consul_20210204.CreateCustomerMasterACLTokenResponse

func (*HashicorpCloudConsul20210204CreateCustomerMasterACLTokenResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateCustomerMasterACLTokenResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateCustomerMasterACLTokenResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 create customer master ACL token response

type HashicorpCloudConsul20210204CreateRequest 

type HashicorpCloudConsul20210204CreateRequest struct {

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

HashicorpCloudConsul20210204CreateRequest hashicorp cloud consul 20210204 create request

swagger:model hashicorp.cloud.consul_20210204.CreateRequest

func (*HashicorpCloudConsul20210204CreateRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateRequest) Validate 

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

Validate validates this hashicorp cloud consul 20210204 create request

type HashicorpCloudConsul20210204CreateResponse 

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"`
}

HashicorpCloudConsul20210204CreateResponse hashicorp cloud consul 20210204 create response

swagger:model hashicorp.cloud.consul_20210204.CreateResponse

func (*HashicorpCloudConsul20210204CreateResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 create response

type HashicorpCloudConsul20210204CreateSnapshotRequest 

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"`
}

HashicorpCloudConsul20210204CreateSnapshotRequest CreateSnapshotRequest is a request to create a new snapshot.

swagger:model hashicorp.cloud.consul_20210204.CreateSnapshotRequest

func (*HashicorpCloudConsul20210204CreateSnapshotRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateSnapshotRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateSnapshotRequest) Validate 

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

Validate validates this hashicorp cloud consul 20210204 create snapshot request

type HashicorpCloudConsul20210204CreateSnapshotResponse 

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"`
}

HashicorpCloudConsul20210204CreateSnapshotResponse CreateSnapshotResponse is a response from creating a snapshot.

swagger:model hashicorp.cloud.consul_20210204.CreateSnapshotResponse

func (*HashicorpCloudConsul20210204CreateSnapshotResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateSnapshotResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204CreateSnapshotResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 create snapshot response

type HashicorpCloudConsul20210204DeleteResponse 

type HashicorpCloudConsul20210204DeleteResponse struct {

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

HashicorpCloudConsul20210204DeleteResponse hashicorp cloud consul 20210204 delete response

swagger:model hashicorp.cloud.consul_20210204.DeleteResponse

func (*HashicorpCloudConsul20210204DeleteResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204DeleteResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204DeleteResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 delete response

type HashicorpCloudConsul20210204DeleteSnapshotResponse 

type HashicorpCloudConsul20210204DeleteSnapshotResponse struct {

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

HashicorpCloudConsul20210204DeleteSnapshotResponse DeleteSnapshotResponse is a response to deleting a snapshot.

swagger:model hashicorp.cloud.consul_20210204.DeleteSnapshotResponse

func (*HashicorpCloudConsul20210204DeleteSnapshotResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204DeleteSnapshotResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204DeleteSnapshotResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 delete snapshot response

type HashicorpCloudConsul20210204GetClientConfigResponse 

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"`
}

HashicorpCloudConsul20210204GetClientConfigResponse GetClientConfigResponse the client config files for a Consul agent.

swagger:model hashicorp.cloud.consul_20210204.GetClientConfigResponse

func (*HashicorpCloudConsul20210204GetClientConfigResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204GetClientConfigResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204GetClientConfigResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 get client config response

type HashicorpCloudConsul20210204GetResponse 

type HashicorpCloudConsul20210204GetResponse struct {

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

HashicorpCloudConsul20210204GetResponse hashicorp cloud consul 20210204 get response

swagger:model hashicorp.cloud.consul_20210204.GetResponse

func (*HashicorpCloudConsul20210204GetResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204GetResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204GetResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 get response

type HashicorpCloudConsul20210204GetSnapshotResponse 

type HashicorpCloudConsul20210204GetSnapshotResponse struct {

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

HashicorpCloudConsul20210204GetSnapshotResponse GetSnapshotResponse is a response for retrieving a snapshot's information.

swagger:model hashicorp.cloud.consul_20210204.GetSnapshotResponse

func (*HashicorpCloudConsul20210204GetSnapshotResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204GetSnapshotResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204GetSnapshotResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 get snapshot response

type HashicorpCloudConsul20210204ListResponse 

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"`
}

HashicorpCloudConsul20210204ListResponse hashicorp cloud consul 20210204 list response

swagger:model hashicorp.cloud.consul_20210204.ListResponse

func (*HashicorpCloudConsul20210204ListResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ListResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ListResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 list response

type HashicorpCloudConsul20210204ListSnapshotsResponse 

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"`
}

HashicorpCloudConsul20210204ListSnapshotsResponse ListSnapshotsResponse is a response from listing snapshots.

swagger:model hashicorp.cloud.consul_20210204.ListSnapshotsResponse

func (*HashicorpCloudConsul20210204ListSnapshotsResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ListSnapshotsResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ListSnapshotsResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 list snapshots response

type HashicorpCloudConsul20210204ListUpgradeVersionsResponse 

type HashicorpCloudConsul20210204ListUpgradeVersionsResponse struct {

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

HashicorpCloudConsul20210204ListUpgradeVersionsResponse hashicorp cloud consul 20210204 list upgrade versions response

swagger:model hashicorp.cloud.consul_20210204.ListUpgradeVersionsResponse

func (*HashicorpCloudConsul20210204ListUpgradeVersionsResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ListUpgradeVersionsResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ListUpgradeVersionsResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 list upgrade versions response

type HashicorpCloudConsul20210204ListVersionsResponse 

type HashicorpCloudConsul20210204ListVersionsResponse struct {

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

HashicorpCloudConsul20210204ListVersionsResponse hashicorp cloud consul 20210204 list versions response

swagger:model hashicorp.cloud.consul_20210204.ListVersionsResponse

func (*HashicorpCloudConsul20210204ListVersionsResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ListVersionsResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204ListVersionsResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 list versions response

type HashicorpCloudConsul20210204MaintenanceConfig 

type HashicorpCloudConsul20210204MaintenanceConfig interface{}

HashicorpCloudConsul20210204MaintenanceConfig MaintenanceConfig configures when maintenance events should be taken on the Consul cluster.

swagger:model hashicorp.cloud.consul_20210204.MaintenanceConfig

type HashicorpCloudConsul20210204NetworkConfig 

type HashicorpCloudConsul20210204NetworkConfig struct {

	// 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"`
}

HashicorpCloudConsul20210204NetworkConfig NetworkConfig configures the network of the Consul cluster.

swagger:model hashicorp.cloud.consul_20210204.NetworkConfig

func (*HashicorpCloudConsul20210204NetworkConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204NetworkConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204NetworkConfig) Validate 

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

Validate validates this hashicorp cloud consul 20210204 network config

type HashicorpCloudConsul20210204RestoreSnapshotRequest 

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"`
}

HashicorpCloudConsul20210204RestoreSnapshotRequest RestoreSnapshotRequest is a request to restore a snapshot to a cluster.

swagger:model hashicorp.cloud.consul_20210204.RestoreSnapshotRequest

func (*HashicorpCloudConsul20210204RestoreSnapshotRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204RestoreSnapshotRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204RestoreSnapshotRequest) Validate 

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

Validate validates this hashicorp cloud consul 20210204 restore snapshot request

type HashicorpCloudConsul20210204RestoreSnapshotResponse 

type HashicorpCloudConsul20210204RestoreSnapshotResponse struct {

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

HashicorpCloudConsul20210204RestoreSnapshotResponse RestoreSnapshotResponse is a response to restoring a snapshot.

swagger:model hashicorp.cloud.consul_20210204.RestoreSnapshotResponse

func (*HashicorpCloudConsul20210204RestoreSnapshotResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204RestoreSnapshotResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204RestoreSnapshotResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 restore snapshot response

type HashicorpCloudConsul20210204Snapshot 

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"`
}

HashicorpCloudConsul20210204Snapshot Snapshot is our representation needed to back-up a cluster.

swagger:model hashicorp.cloud.consul_20210204.Snapshot

func (*HashicorpCloudConsul20210204Snapshot) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204Snapshot) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204Snapshot) Validate 

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

Validate validates this hashicorp cloud consul 20210204 snapshot

type HashicorpCloudConsul20210204SnapshotConfig 

type HashicorpCloudConsul20210204SnapshotConfig interface{}

HashicorpCloudConsul20210204SnapshotConfig SnapshotConfig configures how often cluster snapshot should be taken and how long they should be retained.

swagger:model hashicorp.cloud.consul_20210204.SnapshotConfig

type HashicorpCloudConsul20210204SnapshotSnapshotMeta 

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"`
}

HashicorpCloudConsul20210204SnapshotSnapshotMeta hashicorp cloud consul 20210204 snapshot snapshot meta

swagger:model hashicorp.cloud.consul_20210204.Snapshot.SnapshotMeta

func (*HashicorpCloudConsul20210204SnapshotSnapshotMeta) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204SnapshotSnapshotMeta) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204SnapshotSnapshotMeta) Validate 

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

Validate validates this hashicorp cloud consul 20210204 snapshot snapshot meta

type HashicorpCloudConsul20210204SnapshotSnapshotState 

type HashicorpCloudConsul20210204SnapshotSnapshotState string

HashicorpCloudConsul20210204SnapshotSnapshotState SnapshotState represents the different states a snapshot can be in.

  • QUEUED: QUEUED is used for snapshots that haven’t started and are waiting for a cluster operation to finish before starting.
  • CREATING: CREATING is used for snapshots that are creating.
  • CREATING_FAILED: CREATING_FAILED is used for snapshots that failed creating.
  • READY: READY is used for snapshots that are ready to be restored.
  • DELETING: DELETING is used for snapshots that are deleting.
  • DELETING_FAILED: DELETING_FAILED is used for snapshots that failed deleting.
  • RESTORING: RESTORING is used for snapshots that are being restored.

Progress can be tracked using cluster operations.

swagger:model hashicorp.cloud.consul_20210204.Snapshot.SnapshotState 

const (

	// HashicorpCloudConsul20210204SnapshotSnapshotStateSTATEUNSET captures enum value "STATE_UNSET"
	HashicorpCloudConsul20210204SnapshotSnapshotStateSTATEUNSET HashicorpCloudConsul20210204SnapshotSnapshotState = "STATE_UNSET"

	// HashicorpCloudConsul20210204SnapshotSnapshotStateQUEUED captures enum value "QUEUED"
	HashicorpCloudConsul20210204SnapshotSnapshotStateQUEUED HashicorpCloudConsul20210204SnapshotSnapshotState = "QUEUED"

	// HashicorpCloudConsul20210204SnapshotSnapshotStateCREATING captures enum value "CREATING"
	HashicorpCloudConsul20210204SnapshotSnapshotStateCREATING HashicorpCloudConsul20210204SnapshotSnapshotState = "CREATING"

	// HashicorpCloudConsul20210204SnapshotSnapshotStateCREATINGFAILED captures enum value "CREATING_FAILED"
	HashicorpCloudConsul20210204SnapshotSnapshotStateCREATINGFAILED HashicorpCloudConsul20210204SnapshotSnapshotState = "CREATING_FAILED"

	// HashicorpCloudConsul20210204SnapshotSnapshotStateREADY captures enum value "READY"
	HashicorpCloudConsul20210204SnapshotSnapshotStateREADY HashicorpCloudConsul20210204SnapshotSnapshotState = "READY"

	// HashicorpCloudConsul20210204SnapshotSnapshotStateDELETING captures enum value "DELETING"
	HashicorpCloudConsul20210204SnapshotSnapshotStateDELETING HashicorpCloudConsul20210204SnapshotSnapshotState = "DELETING"

	// HashicorpCloudConsul20210204SnapshotSnapshotStateDELETINGFAILED captures enum value "DELETING_FAILED"
	HashicorpCloudConsul20210204SnapshotSnapshotStateDELETINGFAILED HashicorpCloudConsul20210204SnapshotSnapshotState = "DELETING_FAILED"

	// HashicorpCloudConsul20210204SnapshotSnapshotStateRESTORING captures enum value "RESTORING"
	HashicorpCloudConsul20210204SnapshotSnapshotStateRESTORING HashicorpCloudConsul20210204SnapshotSnapshotState = "RESTORING"
)

func (HashicorpCloudConsul20210204SnapshotSnapshotState) Validate 

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

Validate validates this hashicorp cloud consul 20210204 snapshot snapshot state

type HashicorpCloudConsul20210204SnapshotSnapshotType 

type HashicorpCloudConsul20210204SnapshotSnapshotType string

HashicorpCloudConsul20210204SnapshotSnapshotType SnapshotType represents the type of a snapshot.

  • AUTOMATIC: AUTOMATIC is used for snapshots generated automatically, like a snapshot before update.
  • MANUAL: MANUAL is used for snapshots that are initiated by a user's actions.
  • SCHEDULED: SCHEDULED is used for snapshots that are generated based on a schedule.

swagger:model hashicorp.cloud.consul_20210204.Snapshot.SnapshotType 

const (

	// HashicorpCloudConsul20210204SnapshotSnapshotTypeTYPEUNSET captures enum value "TYPE_UNSET"
	HashicorpCloudConsul20210204SnapshotSnapshotTypeTYPEUNSET HashicorpCloudConsul20210204SnapshotSnapshotType = "TYPE_UNSET"

	// HashicorpCloudConsul20210204SnapshotSnapshotTypeAUTOMATIC captures enum value "AUTOMATIC"
	HashicorpCloudConsul20210204SnapshotSnapshotTypeAUTOMATIC HashicorpCloudConsul20210204SnapshotSnapshotType = "AUTOMATIC"

	// HashicorpCloudConsul20210204SnapshotSnapshotTypeMANUAL captures enum value "MANUAL"
	HashicorpCloudConsul20210204SnapshotSnapshotTypeMANUAL HashicorpCloudConsul20210204SnapshotSnapshotType = "MANUAL"

	// HashicorpCloudConsul20210204SnapshotSnapshotTypeSCHEDULED captures enum value "SCHEDULED"
	HashicorpCloudConsul20210204SnapshotSnapshotTypeSCHEDULED HashicorpCloudConsul20210204SnapshotSnapshotType = "SCHEDULED"
)

func (HashicorpCloudConsul20210204SnapshotSnapshotType) Validate 

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

Validate validates this hashicorp cloud consul 20210204 snapshot snapshot type

type HashicorpCloudConsul20210204UpdateResponse 

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"`
}

HashicorpCloudConsul20210204UpdateResponse hashicorp cloud consul 20210204 update response

swagger:model hashicorp.cloud.consul_20210204.UpdateResponse

func (*HashicorpCloudConsul20210204UpdateResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204UpdateResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204UpdateResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 update response

type HashicorpCloudConsul20210204UpdateSnapshotResponse 

type HashicorpCloudConsul20210204UpdateSnapshotResponse struct {

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

HashicorpCloudConsul20210204UpdateSnapshotResponse UpdateSnapshotResponse is a response to updating a snapshot.

swagger:model hashicorp.cloud.consul_20210204.UpdateSnapshotResponse

func (*HashicorpCloudConsul20210204UpdateSnapshotResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204UpdateSnapshotResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204UpdateSnapshotResponse) Validate 

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

Validate validates this hashicorp cloud consul 20210204 update snapshot response

type HashicorpCloudConsul20210204Version 

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"`
}

HashicorpCloudConsul20210204Version hashicorp cloud consul 20210204 version

swagger:model hashicorp.cloud.consul_20210204.Version

func (*HashicorpCloudConsul20210204Version) MarshalBinary 

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

MarshalBinary interface implementation

func (*HashicorpCloudConsul20210204Version) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HashicorpCloudConsul20210204Version) Validate 

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

Validate validates this hashicorp cloud consul 20210204 version

type HashicorpCloudConsul20210204VersionStatus 

type HashicorpCloudConsul20210204VersionStatus string

HashicorpCloudConsul20210204VersionStatus - AVAILABLE: AVAILABLE represents a version that is generally available but no longer the preferred/recommended version.

  • RECOMMENDED: RECOMMENDED represents a version that is generally available

and recommended by HashiCorp.

  • PREVIEW: PREVIEW represents a version that is not generally available.

swagger:model hashicorp.cloud.consul_20210204.Version.Status 

const (

	// HashicorpCloudConsul20210204VersionStatusAVAILABLE captures enum value "AVAILABLE"
	HashicorpCloudConsul20210204VersionStatusAVAILABLE HashicorpCloudConsul20210204VersionStatus = "AVAILABLE"

	// HashicorpCloudConsul20210204VersionStatusRECOMMENDED captures enum value "RECOMMENDED"
	HashicorpCloudConsul20210204VersionStatusRECOMMENDED HashicorpCloudConsul20210204VersionStatus = "RECOMMENDED"

	// HashicorpCloudConsul20210204VersionStatusPREVIEW captures enum value "PREVIEW"
	HashicorpCloudConsul20210204VersionStatusPREVIEW HashicorpCloudConsul20210204VersionStatus = "PREVIEW"
)

func (HashicorpCloudConsul20210204VersionStatus) Validate 

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

Validate validates this hashicorp cloud consul 20210204 version status

Source Files

View all Source files

Jump to

Keyboard shortcuts

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