DefaultConfig returns a default configuration for the client.

DefaultResources is a small resources object that contains the default resources requests that we will provide to an object.

DefaultUpdateStrategy provides a baseline that can be used to upgrade jobs with the old policy or for populating field defaults.

Messagef formats a new MonitorMessage.

MinResources is a small resources object that contains the absolute minimum resources that we will provide to an object.

NewBatchJob creates and returns a new batch-style job for short-lived processes using the provided name and ID along with the relative job priority.

NewClient returns a new client.

NewConstraint generates a new job placement constraint.

NewFrameReader takes a channel of frames and returns a FrameReader which implements io.ReadCloser.

NewServiceJob creates and returns a new service-style job for long-lived processes using the provided name, ID, and relative job priority.

NewTask creates and initializes a new Task.

NewTaskGroup creates a new TaskGroup.

DefaultNamespace is the default namespace.

JobTypeBatch indicates a short-lived process.

JobTypeService indicates a long-running processes.

OriginStart and OriginEnd are the available parameters for the origin argument when streaming a file.

PeriodicSpecCron is used for a cron spec.

RegisterEnforceIndexErrPrefix is the prefix to use in errors caused by enforcing the job modify index during registers.

ClientConnTimeout is the timeout applied when attempting to contact a client directly before switching to a connection through the Nomad server.

NodeDownErr marks an operation as not able to complete since the node is down.

ACLPolicies is used to query the ACL Policy endpoints.

ACLPolicy is used to represent an ACL policy.

ACLPolicyListStub is used to for listing ACL policies.

ACLToken represents a client token which is used to Authenticate.

ACLTokens is used to query the ACL token endpoints.

Agent encapsulates an API client which talks to Nomad's agent endpoints for a specific node.

AgentHealth describes the Client or Server's health in a Health request.

AgentHealthResponse is the response from the Health endpoint describing an agent's health.

AgentMember represents a cluster member known to the agent.

Allocation is used for serialization of allocations.

AllocationListStub is used to return a subset of an allocation during list operations.

AllocationMetric is used to deserialize allocation metrics.

Allocations is used to query the alloc-related endpoints.

AllocDeploymentStatus captures the status of the allocation as part of the deployment.

AllocFileInfo holds information about a file inside the AllocDir.

AllocFS is used to introspect an allocation directory on a Nomad client.

AllocResourceUsage holds the aggregated task resource usage of the allocation.

AutopilotConfiguration is used for querying/setting the Autopilot configuration.

CheckRestart describes if and when a task should be restarted based on failing health checks.

Client provides a client to the Nomad API.

Config is used to configure the creation of a client.

Constraint is used to serialize a job placement constraint.

CpuStats holds cpu usage related stats.

Deployment is used to serialize an deployment.

DeploymentAllocHealthRequest is used to set the health of a set of allocations as part of a deployment.

DeploymentFailRequest is used to fail a particular deployment.

DeploymentPauseRequest is used to pause a deployment.

DeploymentPromoteRequest is used to promote task groups in a deployment.

Deployments is used to query the deployments endpoints.

DeploymentSpecificRequest is used to make a request specific to a particular deployment.

DeploymentState tracks the state of a deployment for a given task group.

DeploymentUpdateResponse is used to respond to a deployment change.

DesiredTransition is used to mark an allocation as having a desired state transition.

DispatchPayloadConfig configures how a task gets its input from a job dispatch.

DrainSpec describes a Node's drain behavior.

DrainStrategy describes a Node's drain behavior.

DriverInfo is used to deserialize a DriverInfo entry.

EphemeralDisk is an ephemeral disk object.

EvalOptions is used to encapsulate options when forcing a job evaluation.

Evaluation is used to serialize an evaluation.

Evaluations is used to query the evaluation endpoints.

FrameReader is used to convert a stream of frames into a read closer.

HostStats represents resource usage stats of the host running a Nomad client.

HttpBasicAuth is used to authenticate http client with HTTP Basic Authentication.

Job is used to serialize a job.

JobChildrenSummary contains the summary of children job status.

JobDeregisterResponse is used to respond to a job deregistration.

JobEvaluateRequest is used when we just need to re-evaluate a target job.

JobListStub is used to return a subset of information about jobs during list operations.

JobUpdateRequest is used to update a job.

JobRegisterResponse is used to respond to a job registration.

JobRevertRequest is used to revert a job to a prior version.

Jobs is used to access the job-specific endpoints.

JobsParseRequest is used for arguments of the /vi/jobs/parse endpoint.

JobStabilityRequest is used to marked a job as stable.

JobStabilityResponse is the response when marking a job as stable.

JobSummary summarizes the state of the allocations of a job.

JobValidateRequest is used to validate a job.

JobValidateResponse is the response from validate request.

JobVersionsResponse is used for a job get versions request.

KeyringRequest is request objects for serf key operations.

KeyringResponse is a unified key response and can be used for install, remove, use, as well as listing key queries.

LogConfig provides configuration for log rotation.

MemoryStats holds memory usage related stats.

MigrateStrategy describes how allocations for a task group should be migrated between nodes (eg when draining).

MonitorMessage contains a message and log level.

Namespace is used to serialize a namespace.

Namespaces is used to query the namespace endpoints.

NetworkResource is used to describe required network resources of a given task.

Node is used to deserialize a node entry.

NodeDrainUpdateResponse is used to respond to a node drain update.

NodeEligibilityUpdateResponse is used to respond to a node eligibility update.

NodeEvent is a single unit representing a node’s state change.

NodeListStub is a subset of information returned during node list operations.

Nodes is used to query node-related API endpoints.

NodeUpdateDrainRequest is used to update the drain specification for a node.

NodeUpdateEligibilityRequest is used to update the drain specification for a node.

Operator can be used to perform low-level operator tasks for Nomad.

OperatorHealthReply is a representation of the overall health of the cluster.

ParameterizedJobConfig is used to configure the parameterized job.

PeriodicConfig is for serializing periodic config for a job.

PlanOptions is used to pass through job planning parameters.

QueryMeta is used to return meta data about a query.

QueryOptions are used to parameterize a query.

QuotaLimit describes the resource limit in a particular region.

Quotas is used to query the quotas endpoints.

QuotaSpec specifies the allowed resource usage across regions.

QuotaUsage is the resource usage of a Quota.

RaftConfiguration is returned when querying for the current Raft configuration.

RaftServer has information about a server in the Raft configuration.

Raw can be used to do raw queries against custom endpoints.

Regions is used to query the regions in the cluster.

RegisterJobRequest is used to serialize a job registration.

RegisterOptions is used to pass through job registration parameters.

RescheduleEvent is used to keep track of previous attempts at rescheduling an allocation.

Reschedule configures how Tasks are rescheduled when they crash or fail.

RescheduleTracker encapsulates previous reschedule events.

Resources encapsulates the required resources of a given task or task group.

ResourceUsage holds information related to cpu and memory stats.

RestartPolicy defines how the Nomad client restarts tasks in a taskgroup when they fail.

SentinelPolicies is used to query the Sentinel Policy endpoints.

ServerHealth is the health (from the leader's point of view) of a server.

The Service model represents a Consul service definition.

The ServiceCheck data model represents the consul health check that Nomad registers for a Task.

SingleDeploymentResponse is used to respond with a single deployment.

Status is used to query the status-related endpoints.

StreamFrame is used to frame data of a file when streaming.

Status is used to query the status-related endpoints.

Task is a single process in a task group.

TaskArtifact is used to download artifacts before running a task.

TaskEvent is an event that effects the state of a task and contains meta-data appropriate to the events type.

TaskGroup is the unit of scheduling.

TaskGroup summarizes the state of all the allocations of a particular TaskGroup.

TaskResourceUsage holds aggregated resource usage of all processes in a Task and the resource usage of the individual pids.

TaskState tracks the current state of a task and events that caused state transitions.

TLSConfig contains the parameters needed to configure TLS on the HTTP client used to communicate with Nomad.

UpdateStrategy defines a task groups update strategy.

WriteMeta is used to return meta data about a write.

WriteOptions are used to parameterize a write.

AgentMembersNameSort implements sort.Interface for []*AgentMembersNameSort based on the Name, DC and Region.

AllocationSort reverse sorts allocs by CreateIndex.

AllocIndexSort reverse sorts allocs by CreateIndex.

DeploymentIndexSort is a wrapper to sort deployments by CreateIndex.

EvalIndexSort is a wrapper to sort evaluations by CreateIndex.

JobIDSort is used to sort jobs by their job ID's.

MonitorMsgLevels represents the severity log level of a MonitorMessage.

NamespaceIndexSort is a wrapper to sort Namespaces by CreateIndex.

NodeIndexSort reverse sorts nodes by CreateIndex.

QuotaLimitSort is a wrapper to sort QuotaLimits.

QuotaSpecIndexSort is a wrapper to sort QuotaSpecs by CreateIndex.

QuotaUsageIndexSort is a wrapper to sort QuotaUsages by CreateIndex.