Crate nomad_api_types Copy item path Source AclAuthMethod ACLAuthMethod is used to capture the properties of an authentication method
used for single sing-on. AclAuthMethodBuilder Builder for AclAuthMethod AclAuthMethodConfig ACLAuthMethodConfig is used to store configuration of an auth method. AclAuthMethodConfigBuilder Builder for AclAuthMethodConfig AclAuthMethodListStub ACLAuthMethodListStub is the stub object returned when performing a listing
of ACL auth-methods. It is intentionally minimal due to the unauthenticated
nature of the list endpoint. AclAuthMethodListStubBuilder Builder for AclAuthMethodListStub AclBindingRule ACLBindingRule contains a direct relation to an ACLAuthMethod and represents
a rule to apply when logging in via the named AuthMethod. This allows the
transformation of OIDC provider claims, to Nomad based ACL concepts such as
ACL Roles and Policies. AclBindingRuleBuilder Builder for AclBindingRule AclBindingRuleListStub ACLBindingRuleListStub is the stub object returned when performing a listing
of ACL binding rules. AclBindingRuleListStubBuilder Builder for AclBindingRuleListStub AclLoginRequest ACLLoginRequest is the request object to begin auth with an external bearer
token provider. AclLoginRequestBuilder Builder for AclLoginRequest AclOidcAuthUrlRequest ACLOIDCAuthURLRequest is the request to make when starting the OIDC
authentication login flow. AclOidcAuthUrlRequestBuilder Builder for AclOidcAuthUrlRequest AclOidcAuthUrlResponse ACLOIDCAuthURLResponse is the response when starting the OIDC authentication
login flow. AclOidcAuthUrlResponseBuilder Builder for AclOidcAuthUrlResponse AclOidcCompleteAuthRequest ACLOIDCCompleteAuthRequest is the request object to begin completing the
OIDC auth cycle after receiving the callback from the OIDC provider. AclOidcCompleteAuthRequestBuilder Builder for AclOidcCompleteAuthRequest AclPolicy ACLPolicy is used to represent an ACL policy AclPolicyBuilder Builder for AclPolicy AclPolicyListStub ACLPolicyListStub is used to for listing ACL policies AclPolicyListStubBuilder Builder for AclPolicyListStub AclRole ACLRole is an abstraction for the ACL system which allows the grouping of
ACL policies into a single object. ACL tokens can be created and linked to
a role; the token then inherits all the permissions granted by the policies. AclRoleBuilder Builder for AclRole AclRoleListStub ACLRoleListStub is the stub object returned when performing a listing of ACL
roles. While it might not currently be different to the full response
object, it allows us to future-proof the RPC in the event the ACLRole object
grows over time. AclRoleListStubBuilder Builder for AclRoleListStub AclRolePolicyLink ACLRolePolicyLink is used to link a policy to an ACL role. We use a struct
rather than a list of strings as in the future we will want to add IDs to
policies and then link via these. AclRolePolicyLinkBuilder Builder for AclRolePolicyLink AclToken ACLToken represents a client token which is used to Authenticate AclTokenBuilder Builder for AclToken AclTokenListStub This struct was generated based on the Go types of the official Nomad API client. AclTokenListStubBuilder Builder for AclTokenListStub AclTokenRoleLink ACLTokenRoleLink is used to link an ACL token to an ACL role. The ACL token
can therefore inherit all the ACL policy permissions that the ACL role
contains. AclTokenRoleLinkBuilder Builder for AclTokenRoleLink Action This struct was generated based on the Go types of the official Nomad API client. ActionBuilder Builder for Action Affinity Affinity is used to serialize task group affinities AffinityBuilder Builder for Affinity AgentHealth AgentHealth describes the Client or Server’s health in a Health request. AgentHealthBuilder Builder for AgentHealth AgentHealthResponse AgentHealthResponse is the response from the Health endpoint describing an
agent’s health. AgentHealthResponseBuilder Builder for AgentHealthResponse AgentMember AgentMember represents a cluster member known to the agent AgentMemberBuilder Builder for AgentMember AgentSchedulerWorkerInfo AgentSchedulerWorkerInfo holds the detailed status information for a single scheduler worker. AgentSchedulerWorkerInfoBuilder Builder for AgentSchedulerWorkerInfo AgentSchedulerWorkersInfo AgentSchedulerWorkersInfo is the response from the scheduler information endpoint containing
a detailed status of each scheduler worker running on the server. AgentSchedulerWorkersInfoBuilder Builder for AgentSchedulerWorkersInfo AgentSelf This struct was generated based on the Go types of the official Nomad API client. AgentSelfBuilder Builder for AgentSelf AllocCheckStatus AllocCheckStatus contains the current status of a nomad service discovery check. AllocCheckStatusBuilder Builder for AllocCheckStatus AllocDeploymentStatus AllocDeploymentStatus captures the status of the allocation as part of the
deployment. This can include things like if the allocation has been marked as
healthy. AllocDeploymentStatusBuilder Builder for AllocDeploymentStatus AllocFileInfo AllocFileInfo holds information about a file inside the AllocDir AllocFileInfoBuilder Builder for AllocFileInfo AllocNetworkStatus AllocNetworkStatus captures the status of an allocation’s network during runtime.
Depending on the network mode, an allocation’s address may need to be known to other
systems in Nomad such as service registration. AllocNetworkStatusBuilder Builder for AllocNetworkStatus AllocResourceUsage AllocResourceUsage holds the aggregated task resource usage of the
allocation. AllocResourceUsageBuilder Builder for AllocResourceUsage AllocStopResponse AllocStopResponse is the response to an AllocStopRequest AllocStopResponseBuilder Builder for AllocStopResponse AllocatedCpuResources This struct was generated based on the Go types of the official Nomad API client. AllocatedCpuResourcesBuilder Builder for AllocatedCpuResources AllocatedDeviceResource This struct was generated based on the Go types of the official Nomad API client. AllocatedDeviceResourceBuilder Builder for AllocatedDeviceResource AllocatedMemoryResources This struct was generated based on the Go types of the official Nomad API client. AllocatedMemoryResourcesBuilder Builder for AllocatedMemoryResources AllocatedResources This struct was generated based on the Go types of the official Nomad API client. AllocatedResourcesBuilder Builder for AllocatedResources AllocatedSharedResources This struct was generated based on the Go types of the official Nomad API client. AllocatedSharedResourcesBuilder Builder for AllocatedSharedResources AllocatedTaskResources This struct was generated based on the Go types of the official Nomad API client. AllocatedTaskResourcesBuilder Builder for AllocatedTaskResources Allocation Allocation is used for serialization of allocations. AllocationBuilder Builder for Allocation AllocationListStub AllocationListStub is used to return a subset of an allocation
during list operations. AllocationListStubBuilder Builder for AllocationListStub AllocationMetric AllocationMetric is used to deserialize allocation metrics. AllocationMetricBuilder Builder for AllocationMetric ApplyLicenseOptions This struct was generated based on the Go types of the official Nomad API client. ApplyLicenseOptionsBuilder Builder for ApplyLicenseOptions Attribute Attribute is used to describe the value of an attribute, optionally
specifying units AttributeBuilder Builder for Attribute AutopilotConfiguration AutopilotConfiguration is used for querying/setting the Autopilot configuration.
Autopilot helps manage operator tasks related to Nomad servers like removing
failed servers from the Raft quorum. AutopilotConfigurationBuilder Builder for AutopilotConfiguration AutopilotUpgrade AutopilotUpgrade holds the current upgrade status. (Enterprise only) AutopilotUpgradeBuilder Builder for AutopilotUpgrade AutopilotZone AutopilotZone holds the list of servers in a redundancy zone. (Enterprise only) AutopilotZoneBuilder Builder for AutopilotZone AutopilotZoneUpgradeVersions AutopilotZoneUpgradeVersions holds the list of servers
in a redundancy zone for a specific version. (Enterprise only) AutopilotZoneUpgradeVersionsBuilder Builder for AutopilotZoneUpgradeVersions ChangeScript This struct was generated based on the Go types of the official Nomad API client. ChangeScriptBuilder Builder for ChangeScript CheckRestart CheckRestart describes if and when a task should be restarted based on
failing health checks. CheckRestartBuilder Builder for CheckRestart CniConfig This struct was generated based on the Go types of the official Nomad API client. CniConfigBuilder Builder for CniConfig Constraint Constraint is used to serialize a job placement constraint. ConstraintBuilder Builder for Constraint Consul Consul represents configuration related to consul. ConsulBuilder Builder for Consul ConsulConnect ConsulConnect represents a Consul Connect jobspec block. ConsulConnectBuilder Builder for ConsulConnect ConsulExposeConfig This struct was generated based on the Go types of the official Nomad API client. ConsulExposeConfigBuilder Builder for ConsulExposeConfig ConsulExposePath This struct was generated based on the Go types of the official Nomad API client. ConsulExposePathBuilder Builder for ConsulExposePath ConsulGateway ConsulGateway is used to configure one of the Consul Connect Gateway types. ConsulGatewayBindAddress This struct was generated based on the Go types of the official Nomad API client. ConsulGatewayBindAddressBuilder Builder for ConsulGatewayBindAddress ConsulGatewayBuilder Builder for ConsulGateway ConsulGatewayProxy ConsulGatewayProxy is used to tune parameters of the proxy instance acting as
one of the forms of Connect gateways that Consul supports. ConsulGatewayProxyBuilder Builder for ConsulGatewayProxy ConsulGatewayTlsConfig ConsulGatewayTLSConfig is used to configure TLS for a gateway. Both
ConsulIngressConfigEntry and ConsulIngressService use this struct. For more
details, consult the Consul documentation:
https://developer.hashicorp.com/consul/docs/connect/config-entries/ingress-gateway#listeners-services-tls ConsulGatewayTlsConfigBuilder Builder for ConsulGatewayTlsConfig ConsulGatewayTlssdsConfig ConsulGatewayTLSSDSConfig is used to configure the gateway’s TLS listener to
load certificates from an external Secret Discovery Service (SDS) ConsulGatewayTlssdsConfigBuilder Builder for ConsulGatewayTlssdsConfig ConsulHttpHeaderModifiers ConsulHTTPHeaderModifiers is a set of rules for HTTP header modification that
should be performed by proxies as the request passes through them. It can
operate on either request or response headers depending on the context in
which it is used. ConsulHttpHeaderModifiersBuilder Builder for ConsulHttpHeaderModifiers ConsulIngressConfigEntry ConsulIngressConfigEntry represents the Consul Configuration Entry type for
an Ingress Gateway. ConsulIngressConfigEntryBuilder Builder for ConsulIngressConfigEntry ConsulIngressListener ConsulIngressListener is used to configure a listener on a Consul Ingress
Gateway. ConsulIngressListenerBuilder Builder for ConsulIngressListener ConsulIngressService ConsulIngressService is used to configure a service fronted by the ingress
gateway. For more details, consult the Consul documentation:
https://developer.hashicorp.com/consul/docs/connect/config-entries/ingress-gateway ConsulIngressServiceBuilder Builder for ConsulIngressService ConsulLinkedService This struct was generated based on the Go types of the official Nomad API client. ConsulLinkedServiceBuilder Builder for ConsulLinkedService ConsulMeshConfigEntry ConsulMeshConfigEntry is a stub used to represent that the gateway service type
should be for a Mesh Gateway. Unlike Ingress and Terminating, there is no
actual Consul Config Entry type for mesh-gateway, at least for now. We still
create a type for future proofing, instead just using a bool for example. ConsulMeshConfigEntryBuilder Builder for ConsulMeshConfigEntry ConsulMeshGateway ConsulMeshGateway is used to configure mesh gateway usage when connecting to
a connect upstream in another datacenter. ConsulMeshGatewayBuilder Builder for ConsulMeshGateway ConsulProxy ConsulProxy represents a Consul Connect sidecar proxy jobspec block. ConsulProxyBuilder Builder for ConsulProxy ConsulSidecarService ConsulSidecarService represents a Consul Connect SidecarService jobspec
block. ConsulSidecarServiceBuilder Builder for ConsulSidecarService ConsulTerminatingConfigEntry ConsulTerminatingConfigEntry represents the Consul Configuration Entry type
for a Terminating Gateway. ConsulTerminatingConfigEntryBuilder Builder for ConsulTerminatingConfigEntry ConsulTransparentProxy ConsulTransparentProxy is used to configure the Envoy sidecar for
“transparent proxying”, which creates IP tables rules inside the network
namespace to ensure traffic flows thru the Envoy proxy ConsulTransparentProxyBuilder Builder for ConsulTransparentProxy ConsulUpstream ConsulUpstream represents a Consul Connect upstream jobspec block. ConsulUpstreamBuilder Builder for ConsulUpstream CpuStats CpuStats holds cpu usage related stats CpuStatsBuilder Builder for CpuStats CsiControllerInfo CSIControllerInfo is the fingerprinted data from a CSI Plugin that is specific to
the Controller API. CsiControllerInfoBuilder Builder for CsiControllerInfo CsiInfo CSIInfo is the current state of a single CSI Plugin. This is updated regularly
as plugin health changes on the node. CsiInfoBuilder Builder for CsiInfo CsiMountOptions CSIMountOptions contain optional additional configuration that can be used
when specifying that a Volume should be used with VolumeAccessTypeMount. CsiMountOptionsBuilder Builder for CsiMountOptions CsiNodeInfo CSINodeInfo is the fingerprinted data from a CSI Plugin that is specific to
the Node API. CsiNodeInfoBuilder Builder for CsiNodeInfo CsiPlugin CSIPlugin is used for serialization, see also nomad/structs/csi.go CsiPluginBuilder Builder for CsiPlugin CsiPluginListStub This struct was generated based on the Go types of the official Nomad API client. CsiPluginListStubBuilder Builder for CsiPluginListStub CsiSnapshot CSISnapshot is the storage provider’s view of a volume snapshot CsiSnapshotBuilder Builder for CsiSnapshot CsiSnapshotCreateResponse This struct was generated based on the Go types of the official Nomad API client. CsiSnapshotCreateResponseBuilder Builder for CsiSnapshotCreateResponse CsiSnapshotListRequest CSISnapshotListRequest is a request to a controller plugin to list all the
snapshot known to the storage provider. This request is paginated by
the plugin and accepts the QueryOptions.PerPage and QueryOptions.NextToken
fields CsiSnapshotListRequestBuilder Builder for CsiSnapshotListRequest CsiSnapshotListResponse This struct was generated based on the Go types of the official Nomad API client. CsiSnapshotListResponseBuilder Builder for CsiSnapshotListResponse CsiTopology This struct was generated based on the Go types of the official Nomad API client. CsiTopologyBuilder Builder for CsiTopology CsiTopologyRequest This struct was generated based on the Go types of the official Nomad API client. CsiTopologyRequestBuilder Builder for CsiTopologyRequest CsiVolume CSIVolume is used for serialization, see also nomad/structs/csi.go CsiVolumeBuilder Builder for CsiVolume CsiVolumeCapability CSIVolumeCapability is a requested attachment and access mode for a
volume CsiVolumeCapabilityBuilder Builder for CsiVolumeCapability CsiVolumeDeleteRequest This struct was generated based on the Go types of the official Nomad API client. CsiVolumeDeleteRequestBuilder Builder for CsiVolumeDeleteRequest CsiVolumeExternalStub CSIVolumeExternalStub is the storage provider’s view of a volume, as
returned from the controller plugin; all IDs are for external resources CsiVolumeExternalStubBuilder Builder for CsiVolumeExternalStub CsiVolumeListExternalResponse This struct was generated based on the Go types of the official Nomad API client. CsiVolumeListExternalResponseBuilder Builder for CsiVolumeListExternalResponse CsiVolumeListStub CSIVolumeListStub omits allocations. See also nomad/structs/csi.go CsiVolumeListStubBuilder Builder for CsiVolumeListStub Deployment Deployment is used to serialize an deployment. DeploymentBuilder Builder for Deployment DeploymentState DeploymentState tracks the state of a deployment for a given task group. DeploymentStateBuilder Builder for DeploymentState DeploymentUpdateResponse DeploymentUpdateResponse is used to respond to a deployment change. The
response will include the modify index of the deployment as well as details
of any triggered evaluation. DeploymentUpdateResponseBuilder Builder for DeploymentUpdateResponse DeregisterOptions DeregisterOptions is used to pass through job deregistration parameters DeregisterOptionsBuilder Builder for DeregisterOptions DesiredTransition DesiredTransition is used to mark an allocation as having a desired state
transition. This information can be used by the scheduler to make the
correct decision. DesiredTransitionBuilder Builder for DesiredTransition DesiredUpdates This struct was generated based on the Go types of the official Nomad API client. DesiredUpdatesBuilder Builder for DesiredUpdates DeviceGroupStats DeviceGroupStats contains statistics for each device of a particular
device group, identified by the vendor, type and name of the device. DeviceGroupStatsBuilder Builder for DeviceGroupStats DeviceStats DeviceStats is the statistics for an individual device DeviceStatsBuilder Builder for DeviceStats DisconnectStrategy Disconnect strategy defines how both clients and server should behave in case of
disconnection between them. DisconnectStrategyBuilder Builder for DisconnectStrategy DiskUsage This struct was generated based on the Go types of the official Nomad API client. DiskUsageBuilder Builder for DiskUsage DispatchOptions DispatchOptions is used to pass through job dispatch parameters DispatchOptionsBuilder Builder for DispatchOptions DispatchPayloadConfig DispatchPayloadConfig configures how a task gets its input from a job dispatch DispatchPayloadConfigBuilder Builder for DispatchPayloadConfig DnsConfig This struct was generated based on the Go types of the official Nomad API client. DnsConfigBuilder Builder for DnsConfig DrainMetadata DrainMetadata contains information about the most recent drain operation for a given Node. DrainMetadataBuilder Builder for DrainMetadata DrainOptions DrainOptions is used to pass through node drain parameters DrainOptionsBuilder Builder for DrainOptions DrainSpec DrainSpec describes a Node’s drain behavior. DrainSpecBuilder Builder for DrainSpec DrainStrategy DrainStrategy describes a Node’s drain behavior. DrainStrategyBuilder Builder for DrainStrategy DriverInfo DriverInfo is used to deserialize a DriverInfo entry DriverInfoBuilder Builder for DriverInfo EphemeralDisk EphemeralDisk is an ephemeral disk object EphemeralDiskBuilder Builder for EphemeralDisk EvalCountResponse This struct was generated based on the Go types of the official Nomad API client. EvalCountResponseBuilder Builder for EvalCountResponse EvalDeleteRequest This struct was generated based on the Go types of the official Nomad API client. EvalDeleteRequestBuilder Builder for EvalDeleteRequest EvalDeleteResponse This struct was generated based on the Go types of the official Nomad API client. EvalDeleteResponseBuilder Builder for EvalDeleteResponse EvalOptions EvalOptions is used to encapsulate options when forcing a job evaluation EvalOptionsBuilder Builder for EvalOptions Evaluation Evaluation is used to serialize an evaluation. EvaluationBuilder Builder for Evaluation EvaluationStub EvaluationStub is used to serialize parts of an evaluation returned in the
RelatedEvals field of an Evaluation. EvaluationStubBuilder Builder for EvaluationStub Event Event holds information related to an event that occurred in Nomad.
The Payload is a hydrated object related to the Topic EventBuilder Builder for Event Events Events is a set of events for a corresponding index. Events returned for the
index depend on which topics are subscribed to when a request is made. EventsBuilder Builder for Events FieldDiff This struct was generated based on the Go types of the official Nomad API client. FieldDiffBuilder Builder for FieldDiff ForceLeaveOpts ForceLeaveOpts are used to configure the ForceLeave method. ForceLeaveOptsBuilder Builder for ForceLeaveOpts FuzzyMatch FuzzyMatch is used to describe the ID of an object which may be a machine
readable UUID or a human readable Name. If the object is a component of a Job,
the Scope is a list of IDs starting from Namespace down to the parent object of
ID. FuzzyMatchBuilder Builder for FuzzyMatch FuzzySearchResponse FuzzySearchResponse is used to return fuzzy matches and information about
whether the match list is truncated specific to each type of searchable Context. FuzzySearchResponseBuilder Builder for FuzzySearchResponse GaugeValue This struct was generated based on the Go types of the official Nomad API client. GaugeValueBuilder Builder for GaugeValue HostCpuStats This struct was generated based on the Go types of the official Nomad API client. HostCpuStatsBuilder Builder for HostCpuStats HostData This struct was generated based on the Go types of the official Nomad API client. HostDataBuilder Builder for HostData HostDataResponse This struct was generated based on the Go types of the official Nomad API client. HostDataResponseBuilder Builder for HostDataResponse HostDiskStats This struct was generated based on the Go types of the official Nomad API client. HostDiskStatsBuilder Builder for HostDiskStats HostMemoryStats This struct was generated based on the Go types of the official Nomad API client. HostMemoryStatsBuilder Builder for HostMemoryStats HostNetworkInfo HostNetworkInfo is used to return metadata about a given HostNetwork HostNetworkInfoBuilder Builder for HostNetworkInfo HostStats HostStats represents resource usage stats of the host running a Nomad client HostStatsBuilder Builder for HostStats HostVolumeInfo HostVolumeInfo is used to return metadata about a given HostVolume. HostVolumeInfoBuilder Builder for HostVolumeInfo Job Job is used to serialize a job. JobAcl JobACL represents an ACL policy’s attachment to a job, group, or task. JobAclBuilder Builder for JobAcl JobBuilder Builder for Job JobChildrenSummary JobChildrenSummary contains the summary of children job status JobChildrenSummaryBuilder Builder for JobChildrenSummary JobDiff This struct was generated based on the Go types of the official Nomad API client. JobDiffBuilder Builder for JobDiff JobDispatchResponse This struct was generated based on the Go types of the official Nomad API client. JobDispatchResponseBuilder Builder for JobDispatchResponse JobListFields This struct was generated based on the Go types of the official Nomad API client. JobListFieldsBuilder Builder for JobListFields JobListOptions This struct was generated based on the Go types of the official Nomad API client. JobListOptionsBuilder Builder for JobListOptions JobListStub JobListStub is used to return a subset of information about
jobs during list operations. JobListStubBuilder Builder for JobListStub JobPlanResponse This struct was generated based on the Go types of the official Nomad API client. JobPlanResponseBuilder Builder for JobPlanResponse JobRegisterResponse JobRegisterResponse is used to respond to a job registration JobRegisterResponseBuilder Builder for JobRegisterResponse JobScaleStatusResponse JobScaleStatusResponse is used to return information about job scaling status JobScaleStatusResponseBuilder Builder for JobScaleStatusResponse JobStabilityResponse JobStabilityResponse is the response when marking a job as stable. JobStabilityResponseBuilder Builder for JobStabilityResponse JobSubmission JobSubmission is used to hold information about the original content of a job
specification being submitted to Nomad. JobSubmissionBuilder Builder for JobSubmission JobSummary JobSummary summarizes the state of the allocations of a job JobSummaryBuilder Builder for JobSummary JobUiConfig This struct was generated based on the Go types of the official Nomad API client. JobUiConfigBuilder Builder for JobUiConfig JobUiLink This struct was generated based on the Go types of the official Nomad API client. JobUiLinkBuilder Builder for JobUiLink JobValidateResponse JobValidateResponse is the response from validate request JobValidateResponseBuilder Builder for JobValidateResponse JobVersionTag This struct was generated based on the Go types of the official Nomad API client. JobVersionTagBuilder Builder for JobVersionTag JobsParseRequest JobsParseRequest is used for arguments of the /v1/jobs/parse endpoint JobsParseRequestBuilder Builder for JobsParseRequest KeyringResponse KeyringResponse is a unified key response and can be used for install,
remove, use, as well as listing key queries. KeyringResponseBuilder Builder for KeyringResponse Label This struct was generated based on the Go types of the official Nomad API client. LabelBuilder Builder for Label License This struct was generated based on the Go types of the official Nomad API client. LicenseBuilder Builder for License LicenseReply This struct was generated based on the Go types of the official Nomad API client. LicenseReplyBuilder Builder for LicenseReply LogConfig LogConfig provides configuration for log rotation LogConfigBuilder Builder for LogConfig MemoryStats MemoryStats holds memory usage related stats MemoryStatsBuilder Builder for MemoryStats MetricsSummary MetricsSummary holds a roll-up of metrics info for a given interval MetricsSummaryBuilder Builder for MetricsSummary MigrateStrategy MigrateStrategy describes how allocations for a task group should be
migrated between nodes (eg when draining). MigrateStrategyBuilder Builder for MigrateStrategy MonitorMessage MonitorMessage contains a message and log level. MonitorMessageBuilder Builder for MonitorMessage Multiregion This struct was generated based on the Go types of the official Nomad API client. MultiregionBuilder Builder for Multiregion MultiregionRegion This struct was generated based on the Go types of the official Nomad API client. MultiregionRegionBuilder Builder for MultiregionRegion MultiregionStrategy This struct was generated based on the Go types of the official Nomad API client. MultiregionStrategyBuilder Builder for MultiregionStrategy Namespace Namespace is used to serialize a namespace. NamespaceBuilder Builder for Namespace NamespaceCapabilities NamespaceCapabilities represents a set of capabilities allowed for this
namespace, to be checked at job submission time. NamespaceCapabilitiesBuilder Builder for NamespaceCapabilities NamespaceConsulConfiguration NamespaceConsulConfiguration stores configuration about permissions to Consul
clusters for a namespace, for use with Nomad Enterprise. NamespaceConsulConfigurationBuilder Builder for NamespaceConsulConfiguration NamespaceNodePoolConfiguration NamespaceNodePoolConfiguration stores configuration about node pools for a
namespace. NamespaceNodePoolConfigurationBuilder Builder for NamespaceNodePoolConfiguration NamespaceVaultConfiguration NamespaceVaultConfiguration stores configuration about permissions to Vault
clusters for a namespace, for use with Nomad Enterprise. NamespaceVaultConfigurationBuilder Builder for NamespaceVaultConfiguration NetworkResource NetworkResource is used to describe required network
resources of a given task. NetworkResourceBuilder Builder for NetworkResource Node Node is used to deserialize a node entry. NodeBuilder Builder for Node NodeCpuResources This struct was generated based on the Go types of the official Nomad API client. NodeCpuResourcesBuilder Builder for NodeCpuResources NodeDevice NodeDevice is an instance of a particular device. NodeDeviceBuilder Builder for NodeDevice NodeDeviceLocality NodeDeviceLocality stores information about the devices hardware locality on
the node. NodeDeviceLocalityBuilder Builder for NodeDeviceLocality NodeDeviceResource NodeDeviceResource captures a set of devices sharing a common
vendor/type/device_name tuple. NodeDeviceResourceBuilder Builder for NodeDeviceResource NodeDiskResources This struct was generated based on the Go types of the official Nomad API client. NodeDiskResourcesBuilder Builder for NodeDiskResources NodeDrainUpdateResponse NodeDrainUpdateResponse is used to respond to a node drain update NodeDrainUpdateResponseBuilder Builder for NodeDrainUpdateResponse NodeEligibilityUpdateResponse NodeEligibilityUpdateResponse is used to respond to a node eligibility update NodeEligibilityUpdateResponseBuilder Builder for NodeEligibilityUpdateResponse NodeEvent NodeEvent is a single unit representing a node’s state change NodeEventBuilder Builder for NodeEvent NodeListStub NodeListStub is a subset of information returned during
node list operations. NodeListStubBuilder Builder for NodeListStub NodeMemoryResources This struct was generated based on the Go types of the official Nomad API client. NodeMemoryResourcesBuilder Builder for NodeMemoryResources NodeMetaApplyRequest NodeMetaApplyRequest contains the Node meta update. NodeMetaApplyRequestBuilder Builder for NodeMetaApplyRequest NodeMetaResponse NodeMetaResponse contains the merged Node metadata. NodeMetaResponseBuilder Builder for NodeMetaResponse NodePool NodePool is used to serialize a node pool. NodePoolBuilder Builder for NodePool NodePoolSchedulerConfiguration NodePoolSchedulerConfiguration is used to serialize the scheduler
configuration of a node pool. NodePoolSchedulerConfigurationBuilder Builder for NodePoolSchedulerConfiguration NodePurgeResponse NodePurgeResponse is used to deserialize a Purge response. NodePurgeResponseBuilder Builder for NodePurgeResponse NodeReservedCpuResources This struct was generated based on the Go types of the official Nomad API client. NodeReservedCpuResourcesBuilder Builder for NodeReservedCpuResources NodeReservedDiskResources This struct was generated based on the Go types of the official Nomad API client. NodeReservedDiskResourcesBuilder Builder for NodeReservedDiskResources NodeReservedMemoryResources This struct was generated based on the Go types of the official Nomad API client. NodeReservedMemoryResourcesBuilder Builder for NodeReservedMemoryResources NodeReservedNetworkResources This struct was generated based on the Go types of the official Nomad API client. NodeReservedNetworkResourcesBuilder Builder for NodeReservedNetworkResources NodeReservedResources This struct was generated based on the Go types of the official Nomad API client. NodeReservedResourcesBuilder Builder for NodeReservedResources NodeResources This struct was generated based on the Go types of the official Nomad API client. NodeResourcesBuilder Builder for NodeResources NodeScoreMeta NodeScoreMeta is used to serialize node scoring metadata
displayed in the CLI during verbose mode NodeScoreMetaBuilder Builder for NodeScoreMeta NumaResource NUMAResource contains the NUMA affinity request for scheduling purposes. NumaResourceBuilder Builder for NumaResource ObjectDiff This struct was generated based on the Go types of the official Nomad API client. ObjectDiffBuilder Builder for ObjectDiff OidcClientAssertion OIDCClientAssertion (a.k.a private_key_jwt) is used to send
a client_assertion along with an OIDC token request.
Reference: https://oauth.net/private-key-jwt/
See also: structs.OIDCClientAssertion OidcClientAssertionBuilder Builder for OidcClientAssertion OidcClientAssertionKey OIDCClientAssertionKey contains key material provided by users for Nomad
to use to sign the private key JWT. OidcClientAssertionKeyBuilder Builder for OidcClientAssertionKey OneTimeToken This struct was generated based on the Go types of the official Nomad API client. OneTimeTokenBuilder Builder for OneTimeToken OperatorHealthReply OperatorHealthReply is a representation of the overall health of the cluster OperatorHealthReplyBuilder Builder for OperatorHealthReply OperatorUtilizationOptions This struct was generated based on the Go types of the official Nomad API client. OperatorUtilizationOptionsBuilder Builder for OperatorUtilizationOptions OperatorUtilizationSnapshotResponse This struct was generated based on the Go types of the official Nomad API client. OperatorUtilizationSnapshotResponseBuilder Builder for OperatorUtilizationSnapshotResponse ParameterizedJobConfig ParameterizedJobConfig is used to configure the parameterized job. ParameterizedJobConfigBuilder Builder for ParameterizedJobConfig PeriodicConfig PeriodicConfig is for serializing periodic config for a job. PeriodicConfigBuilder Builder for PeriodicConfig PlanAnnotations This struct was generated based on the Go types of the official Nomad API client. PlanAnnotationsBuilder Builder for PlanAnnotations PlanOptions PlanOptions is used to pass through job planning parameters PlanOptionsBuilder Builder for PlanOptions PointValue This struct was generated based on the Go types of the official Nomad API client. PointValueBuilder Builder for PointValue Port This struct was generated based on the Go types of the official Nomad API client. PortBuilder Builder for Port PortMapping This struct was generated based on the Go types of the official Nomad API client. PortMappingBuilder Builder for PortMapping PprofOptions PprofOptions contain a set of parameters for profiling a node or server. PprofOptionsBuilder Builder for PprofOptions PreemptionConfig PreemptionConfig specifies whether preemption is enabled based on scheduler type PreemptionConfigBuilder Builder for PreemptionConfig QueryMeta QueryMeta is used to return meta data about a query QueryMetaBuilder Builder for QueryMeta QueryOptions QueryOptions are used to parametrize a query QueryOptionsBuilder Builder for QueryOptions QuotaLimit QuotaLimit describes the resource limit in a particular region. QuotaLimitBuilder Builder for QuotaLimit QuotaResources This struct was generated based on the Go types of the official Nomad API client. QuotaResourcesBuilder Builder for QuotaResources QuotaSpec QuotaSpec specifies the allowed resource usage across regions. QuotaSpecBuilder Builder for QuotaSpec QuotaStorageResources This struct was generated based on the Go types of the official Nomad API client. QuotaStorageResourcesBuilder Builder for QuotaStorageResources QuotaUsage QuotaUsage is the resource usage of a Quota QuotaUsageBuilder Builder for QuotaUsage RaftConfiguration RaftConfiguration is returned when querying for the current Raft configuration. RaftConfigurationBuilder Builder for RaftConfiguration RaftServer RaftServer has information about a server in the Raft configuration. RaftServerBuilder Builder for RaftServer Recommendation Recommendation is used to serialize a recommendation. RecommendationApplyResponse RecommendationApplyResponse is used to apply a set of recommendations RecommendationApplyResponseBuilder Builder for RecommendationApplyResponse RecommendationBuilder Builder for Recommendation RegisterOptions RegisterOptions is used to pass through job registration parameters RegisterOptionsBuilder Builder for RegisterOptions RequestedDevice RequestedDevice is used to request a device for a task. RequestedDeviceBuilder Builder for RequestedDevice RescheduleEvent RescheduleEvent is used to keep track of previous attempts at rescheduling an allocation RescheduleEventBuilder Builder for RescheduleEvent ReschedulePolicy Reschedule configures how Tasks are rescheduled when they crash or fail. ReschedulePolicyBuilder Builder for ReschedulePolicy RescheduleTracker RescheduleTracker encapsulates previous reschedule events RescheduleTrackerBuilder Builder for RescheduleTracker ResourceUsage ResourceUsage holds information related to cpu and memory stats ResourceUsageBuilder Builder for ResourceUsage Resources Resources encapsulates the required resources of
a given task or task group. ResourcesBuilder Builder for Resources RestartPolicy RestartPolicy defines how the Nomad client restarts
tasks in a taskgroup when they fail RestartPolicyBuilder Builder for RestartPolicy SampledValue This struct was generated based on the Go types of the official Nomad API client. SampledValueBuilder Builder for SampledValue ScalingEvent This struct was generated based on the Go types of the official Nomad API client. ScalingEventBuilder Builder for ScalingEvent ScalingPolicy ScalingPolicy is the user-specified API object for an autoscaling policy ScalingPolicyBuilder Builder for ScalingPolicy ScalingPolicyListStub ScalingPolicyListStub is used to return a subset of scaling policy information
for the scaling policy list ScalingPolicyListStubBuilder Builder for ScalingPolicyListStub ScalingRequest ScalingRequest is the payload for a generic scaling action ScalingRequestBuilder Builder for ScalingRequest SchedulerConfiguration SchedulerConfiguration is the config for controlling scheduler behavior SchedulerConfigurationBuilder Builder for SchedulerConfiguration SchedulerConfigurationResponse SchedulerConfigurationResponse is the response object that wraps SchedulerConfiguration SchedulerConfigurationResponseBuilder Builder for SchedulerConfigurationResponse SchedulerSetConfigurationResponse SchedulerSetConfigurationResponse is the response object used
when updating scheduler configuration SchedulerSetConfigurationResponseBuilder Builder for SchedulerSetConfigurationResponse SchedulerWorkerPoolArgs This struct was generated based on the Go types of the official Nomad API client. SchedulerWorkerPoolArgsBuilder Builder for SchedulerWorkerPoolArgs SearchResponse This struct was generated based on the Go types of the official Nomad API client. SearchResponseBuilder Builder for SearchResponse SentinelPolicy This struct was generated based on the Go types of the official Nomad API client. SentinelPolicyBuilder Builder for SentinelPolicy SentinelPolicyListStub This struct was generated based on the Go types of the official Nomad API client. SentinelPolicyListStubBuilder Builder for SentinelPolicyListStub ServerHealth ServerHealth is the health (from the leader’s point of view) of a server. ServerHealthBuilder Builder for ServerHealth ServerMembers This struct was generated based on the Go types of the official Nomad API client. ServerMembersBuilder Builder for ServerMembers Service Service represents a Nomad job-submitters view of a Consul or Nomad service. ServiceBuilder Builder for Service ServiceCheck ServiceCheck represents a Nomad job-submitters view of a Consul service health check. ServiceCheckBuilder Builder for ServiceCheck ServiceRegistration ServiceRegistration is an instance of a single allocation advertising itself
as a named service with a specific address. Each registration is constructed
from the job specification Service block. Whether the service is registered
within Nomad, and therefore generates a ServiceRegistration is controlled by
the Service.Provider parameter. ServiceRegistrationBuilder Builder for ServiceRegistration ServiceRegistrationListStub ServiceRegistrationListStub represents all service registrations held within a
single namespace. ServiceRegistrationListStubBuilder Builder for ServiceRegistrationListStub ServiceRegistrationStub ServiceRegistrationStub is the stub object describing an individual
namespaced service. The object is built in a manner which would allow us to
add additional fields in the future, if we wanted. ServiceRegistrationStubBuilder Builder for ServiceRegistrationStub ServiceWeights ServiceWeights is the jobspec block which configures how a service instance
is weighted in a DNS SRV request based on the service’s health status. ServiceWeightsBuilder Builder for ServiceWeights SidecarTask SidecarTask represents a subset of Task fields that can be set to override
the fields of the Task generated for the sidecar SidecarTaskBuilder Builder for SidecarTask SingleRecommendationApplyError This struct was generated based on the Go types of the official Nomad API client. SingleRecommendationApplyErrorBuilder Builder for SingleRecommendationApplyError SingleRecommendationApplyResult This struct was generated based on the Go types of the official Nomad API client. SingleRecommendationApplyResultBuilder Builder for SingleRecommendationApplyResult Spread Spread is used to serialize task group allocation spread preferences SpreadBuilder Builder for Spread SpreadTarget SpreadTarget is used to serialize target allocation spread percentages SpreadTargetBuilder Builder for SpreadTarget StatObject StatObject is a collection of statistics either exposed at the top
level or via nested StatObjects. StatObjectBuilder Builder for StatObject StatValue StatValue exposes the values of a particular statistic. The value may be of
type float, integer, string or boolean. Numeric types can be exposed as a
single value or as a fraction. StatValueBuilder Builder for StatValue StreamFrame StreamFrame is used to frame data of a file when streaming StreamFrameBuilder Builder for StreamFrame Task Task is a single process in a task group. TaskArtifact TaskArtifact is used to download artifacts before running a task. TaskArtifactBuilder Builder for TaskArtifact TaskBuilder Builder for Task TaskCsiPluginConfig TaskCSIPluginConfig contains the data that is required to setup a task as a
CSI plugin. This will be used by the csi_plugin_supervisor_hook to configure
mounts for the plugin and initiate the connection to the plugin catalog. TaskCsiPluginConfigBuilder Builder for TaskCsiPluginConfig TaskDiff This struct was generated based on the Go types of the official Nomad API client. TaskDiffBuilder Builder for TaskDiff TaskEvent TaskEvent is an event that effects the state of a task and contains meta-data
appropriate to the events type. TaskEventBuilder Builder for TaskEvent TaskGroup TaskGroup is the unit of scheduling. TaskGroupBuilder Builder for TaskGroup TaskGroupDiff This struct was generated based on the Go types of the official Nomad API client. TaskGroupDiffBuilder Builder for TaskGroupDiff TaskGroupScaleStatus This struct was generated based on the Go types of the official Nomad API client. TaskGroupScaleStatusBuilder Builder for TaskGroupScaleStatus TaskGroupSummary TaskGroup summarizes the state of all the allocations of a particular
TaskGroup TaskGroupSummaryBuilder Builder for TaskGroupSummary TaskLifecycle This struct was generated based on the Go types of the official Nomad API client. TaskLifecycleBuilder Builder for TaskLifecycle TaskResourceUsage TaskResourceUsage holds aggregated resource usage of all processes in a Task
and the resource usage of the individual pids TaskResourceUsageBuilder Builder for TaskResourceUsage TaskSchedule This struct was generated based on the Go types of the official Nomad API client. TaskScheduleBuilder Builder for TaskSchedule TaskScheduleCron This struct was generated based on the Go types of the official Nomad API client. TaskScheduleCronBuilder Builder for TaskScheduleCron TaskState TaskState tracks the current state of a task and events that caused state
transitions. TaskStateBuilder Builder for TaskState Template This struct was generated based on the Go types of the official Nomad API client. TemplateBuilder Builder for Template TerminalSize TerminalSize represents the size of the terminal TerminalSizeBuilder Builder for TerminalSize UpdateStrategy UpdateStrategy defines a task groups update strategy. UpdateStrategyBuilder Builder for UpdateStrategy Variable Variable specifies the metadata and contents to be stored in the
encrypted Nomad backend. VariableBuilder Builder for Variable VariableLock This struct was generated based on the Go types of the official Nomad API client. VariableLockBuilder Builder for VariableLock VariableMetadata VariableMetadata specifies the metadata for a variable and
is used as the list object VariableMetadataBuilder Builder for VariableMetadata Vault This struct was generated based on the Go types of the official Nomad API client. VaultAccessor VaultAccessor is a Vault ACL token created by Nomad for a task to access
Vault using the legacy authentication flow. VaultAccessorBuilder Builder for VaultAccessor VaultBuilder Builder for Vault VaultWorkloadIdentityUpgradeCheck VaultWorkloadIdentityUpgradeCheck is the result of verifying if the cluster
is ready to switch to workload identities for Vault. VaultWorkloadIdentityUpgradeCheckBuilder Builder for VaultWorkloadIdentityUpgradeCheck VersionsOptions This struct was generated based on the Go types of the official Nomad API client. VersionsOptionsBuilder Builder for VersionsOptions VolumeMount VolumeMount represents the relationship between a destination path in a task
and the task group volume that should be mounted there. VolumeMountBuilder Builder for VolumeMount VolumeRequest VolumeRequest is a representation of a storage volume that a TaskGroup wishes to use. VolumeRequestBuilder Builder for VolumeRequest WaitConfig WaitConfig is the Min/Max duration to wait for the Consul cluster to reach a
consistent state before attempting to render Templates. WaitConfigBuilder Builder for WaitConfig WorkloadIdentity WorkloadIdentity is the jobspec block which determines if and how a workload
identity is exposed to tasks. WorkloadIdentityBuilder Builder for WorkloadIdentity WriteMeta WriteMeta is used to return meta data about a write WriteMetaBuilder Builder for WriteMeta WriteOptions WriteOptions are used to parametrize a write WriteOptionsBuilder Builder for WriteOptions CsiPluginType CSIPluginType is an enum string that encapsulates the valid options for a
CSIPlugin block’s Type. These modes will allow the plugin to be used in
different ways by the client. CsiVolumeAccessMode CSIVolumeAccessMode indicates how a volume should be used in a storage topology
e.g whether the provider should make the volume available concurrently. (Duplicated in nomad/structs/csi.go) CsiVolumeAttachmentMode CSIVolumeAttachmentMode chooses the type of storage api that will be used to
interact with the device. (Duplicated in nomad/structs/csi.go) DrainStatus This enum was generated based on the Go types of the official Nomad API client. OidcClientAssertionKeyIdHeader OIDCClientAssertionKeyIDHeader is the header that the OIDC provider will use
to look up the certificate or public key that it needs to verify the
private key JWT signature. OidcClientAssertionKeySource OIDCClientAssertionKeySource specifies what key material should be used
to sign an OIDCClientAssertion. SchedulerAlgorithm SchedulerAlgorithm is an enum string that encapsulates the valid options for a
SchedulerConfiguration block’s SchedulerAlgorithm. These modes will allow the
scheduler to be user-selectable. Topic Topic is an event Topic deserialize_duration deserialize_duration_option deserialize_null_as_default serialize_duration serialize_duration_option