package
0.0.11
Repository: https://github.com/mesos/mesos-go.git
Documentation: pkg.go.dev

# Packages

Package agent is a generated protocol buffer package.
Package allocator is a generated protocol buffer package.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package executor is a generated protocol buffer package.
No description provided by the author
No description provided by the author
Package maintenance is a generated protocol buffer package.
Package master is a generated protocol buffer package.
Package quota is a generated protocol buffer package.
Package recordio implements the Mesos variant of RecordIO framing, whereby each record is prefixed by a line that indicates the length of the record in decimal ASCII.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package scheduler is a generated protocol buffer package.
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPortRanges returns Ranges from the "ports" resource in the given *Offer.
NewRanges returns squashed Ranges from the given numbers.
No description provided by the author
No description provided by the author

# Constants

This expresses the ability for the agent to automatically drain tasks in preparation for operator maintenance.
This expresses the ability of the agent to handle operation feedback for operations on agent default resources.
This expresses the ability for the agent to be able to launch tasks, reserve resources, and create volumes using resources allocated to a 'hierarchical-role'.
This expresses the ability for the agent to be able to launch tasks of a 'multi-role' framework.
This capability has three effects for an agent.
This expresses the capability for the agent to handle persistent volume resize operations safely.
This expresses the ability for the agent to handle resource provider related operations.
This expresses the ability for the agent to launch tasks which specify resource limits for CPU and/or memory.
This must be the first enum value in this list, to ensure that if 'type' is not set, the default value is UNKNOWN.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
In this mode, a machine is not running any tasks and will not offer any of its resources.
In this mode, all agents on the machine are expected to cooperate with frameworks to drain resources.
The agent has been drained: all tasks have terminated, all terminal task status updates have been acknowledged by the frameworks, and all operations have finished and had their terminal updates acknowledged.
The agent is currently draining.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
For frameworks that need custom functionality to run tasks, a `CUSTOM` executor can be used.
Mesos provides a simple built-in default executor that frameworks can leverage to run shell commands and containers.
No description provided by the author
No description provided by the author
No description provided by the author
Indicates whether the framework is aware of GPU resources.
This expresses the ability for the framework to be "multi-tenant" via using the newly introduced `roles` field, and examining `Offer.allocation_info` to determine which role the offers are being made to.
Indicates that (1) the framework is prepared to handle the following TaskStates: TASK_UNREACHABLE, TASK_DROPPED, TASK_GONE, TASK_GONE_BY_OPERATOR, and TASK_UNKNOWN, and (2) the framework will assume responsibility for managing partitioned tasks that reregister with the master.
Indicates that the framework is prepared to receive offers for agents whose region is different from the master's region.
This capability has two effects for a framework.
Receive offers with revocable resources.
Receive offers with resources that are shared.
Receive the TASK_KILLING TaskState when a task is being killed by an executor.
This must be the first enum value in this list, to ensure that if 'type' is not set, the default value is UNKNOWN.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The container will have its own IPC namespace and /dev/shm, with a possibility to share them with its child containers.
The container will share the IPC namespace and /dev/shm from its parent.
No description provided by the author
The master can drain or deactivate agents when requested via operator APIs.
The master can handle slaves whose state changes after reregistering.
No description provided by the author
The volume in a container will receive new mounts from the host or other containers, and its own mounts will be propagated from the container to the host or other containers.
The volume in a container will receive new mounts from the host or other containers, but filesystems mounted inside the container won't be propagated to the host or other containers.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TERMINAL: The operation was dropped due to a transient error.
TERMINAL: The operation description contains an error.
TERMINAL: The operation failed to apply.
TERMINAL: The operation was successfully applied.
The operation affected an agent that the master cannot contact; the operator has asserted that the agent has been shutdown, but this has not been directly confirmed by the master.
Initial state.
The operation affects an agent that the master recovered from its state, but that agent has not yet re-registered.
The master has no knowledge of the operation.
The operation affects an agent that has lost contact with the master, typically due to a network failure or partition.
Default value if the enum is not set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO(jieyu): The default value when a caller doesn't check for presence is 0 and so ideally the 0 reason is not a valid one.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The task failed to launch because of a transient error.
No description provided by the author
No description provided by the author
The task finished successfully on its own without external interference.
The task is no longer running.
The task was running on an agent that the master cannot contact; the operator has asserted that the agent has been shutdown, but this has not been directly confirmed by the master.
No description provided by the author
NOTE: This should only be sent when the framework has the TASK_KILLING_STATE capability.
In Mesos 1.3, this will only be sent when the framework does NOT opt-in to the PARTITION_AWARE capability.
No description provided by the author
No description provided by the author
No description provided by the author
The master has no knowledge of the task.
The task was running on an agent that has lost contact with the master, typically due to a network failure or partition.
No description provided by the author
In this mode, a machine is behaving normally; offering resources, executing tasks, etc.
TODO(gyliu513): Add IMAGE as volume source type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This must be the first enum value in this list, to ensure that if 'type' is not set, the default value is UNKNOWN.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CapabilityReservationRefinement should be set to "1" for frameworks that opt-in to RESERVATION_REFINEMENT.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

* A network address.
* A unique ID assigned to an agent.
* Describes an agent.
No description provided by the author
* Describes an attribute that can be set on a machine.
* Encapsulation of `Capabilities` supported by Linux.
* Linux control group (cgroup) information.
Configuration of a blkio cgroup subsystem.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Describes a stat value without the device descriptor part.
Configuration of a net_cls cgroup subsystem.
* Describes a general non-interpreting non-killing check for a task or executor (or any arbitrary process/command).
Describes a command check.
Describes an HTTP check.
Describes a TCP check, i.e.
* Describes the status of a check.
No description provided by the author
No description provided by the author
No description provided by the author
* Describes a command, executed via: '/bin/sh -c value'.
No description provided by the author
* ID used to uniquely identify a container.
* Describes a container configuration and allows extensible configurations for different container implementations.
No description provided by the author
No description provided by the author
No description provided by the author
* Container related information that is resolved during container setup.
* Credential used in various places for authentication and authorization.
* Credentials used for framework authentication, HTTP authentication (where the common 'username' and 'password' are captured as 'principal' and 'secret' respectively), etc.
* Describes the container configuration to run a CSI plugin component.
* Describes a CSI plugin.
* Describes information about a device.
No description provided by the author
* Describes a device whitelist entry that expose from host to container.
No description provided by the author
No description provided by the author
* Service discovery information.
No description provided by the author
* Describes a domain.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Represents duration in nanoseconds.
* Describes a collection of environment variables.
No description provided by the author
* A framework-generated ID to distinguish an executor.
* Describes information about an executor.
* Describes a File.
* Describes possible filters that can be applied to unused resources (see SchedulerDriver::launchTasks) to influence the allocator.
* Flag consists of a name and optionally its value.
* A unique ID assigned to a framework.
* Describes a framework.
No description provided by the author
* Describes a health check for a task or executor (or any arbitrary process/command).
Describes an HTTP health check.
Describes a TCP health check, i.e.
No description provided by the author
* Describe an image used by tasks or executors.
Protobuf for specifying an Appc container image.
No description provided by the author
* A request to return some resources occupied by a framework.
No description provided by the author
* Describes a kill policy for a task.
* Key, value pair used to store free form user-data.
* Collection of labels.
* Encapsulation for Linux specific configuration.
* Represents a single machine, which may hold one or more agents.
* Holds information about a single machine, its `mode`, and any other relevant information which may affect the behavior of the machine.
* Describes a master.
No description provided by the author
* Metric consists of a name and optionally its value.
* Describes how the mount will be propagated for a volume.
* Describes a network request from a framework as well as network resolution provided by Mesos.
Specifies a request for an IP address, or reports the assigned container IP address.
Specifies a port mapping request for the task on this network.
* Describes some resources available on an agent.
Defines an operation that can be performed against offers.
No description provided by the author
Create a `MOUNT` or `BLOCK` disk resource backed by a CSI volume from a `RAW` disk resource.
No description provided by the author
Destroy a disk resource backed by a CSI volume.
Grow a volume by an additional disk resource.
TODO(vinod): Deprecate this in favor of `LaunchGroup` below.
Unlike `Launch` above, all the tasks in a `task_group` are atomically delivered to an executor.
No description provided by the author
Shrink a volume by the size specified in the `subtract` field.
No description provided by the author
* Represents filters that allow a framework to control the shape of offers that will be sent to its role(s).
No description provided by the author
No description provided by the author
* A unique ID assigned to an offer.
* Describes an operation, similar to `Offer.Operation`, with some additional information.
* A framework-generated ID to distinguish an operation.
* Describes the current status of an operation.
* A generic (key, value) pair used in various places for parameters.
* Collection of Parameter.
* Describes a sample of events from "perf stat".
* Named port used for service discovery.
* Collection of ports.
* Rate (queries per second, QPS) limit for messages from a framework to master.
* Collection of RateLimit.
* Describes a request for resources that can be used by a framework to proactively influence the allocator.
* Describes a resource from a resource provider.
This was initially introduced to support MULTI_ROLE capable frameworks.
No description provided by the author
Describes a persistent disk volume.
Describes where a disk originates from.
A mounted file-system set up by the Agent administrator.
A folder that can be located on a separate disk device.
No description provided by the author
No description provided by the author
Allow the resource to be shared across tasks.
* A unique ID assigned to a resource provider.
* Describes a resource provider.
Storage resource provider related information.
No description provided by the author
* A snapshot of resource usage statistics.
* Describes a snapshot of the resource usage for executors.
No description provided by the author
No description provided by the author
ResponseWrapper delegates to optional overrides for invocations of Response methods.
* Encapsulation for POSIX rlimits, see http://pubs.opengroup.org/onlinepubs/009695399/functions/getrlimit.html.
No description provided by the author
* Describes a Role.
* Encapsulation for Seccomp configuration, which is Linux specific.
* Secret used to pass privileged information.
Can be used by modules to refer to a secret stored in a secure back-end.
Used to pass the value of a secret.
No description provided by the author
* Describes a task, similar to `TaskInfo`.
* Describes a group of tasks that belong to an executor.
* A framework-generated ID to distinguish a task.
* Describes a task.
* Describes a resource limitation that caused a task failure.
* Describes the current status of a task.
No description provided by the author
* Represents time since the epoch, in nanoseconds.
* When the network bandwidth caps are enabled and the container is over its limit, outbound packets may be either delayed or dropped completely either because it exceeds the maximum bandwidth allocation for a single container (the cap) or because the combined network traffic of multiple containers on the host exceeds the transmit capacity of the host (the share).
* Describes the information about (pseudo) TTY that can be attached to a process running in a container.
No description provided by the author
No description provided by the author
* Represents an interval, from a given start time over a given duration.
* Represents a URL.
* A 128 bit (16 byte) UUID, see RFC 4122.
* Describes an Attribute or Resource "value".
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Version information of a component.
* Describes a volume mapping either from host to container or vice versa.
Describes where a volume originates from.
No description provided by the author
Absolute path pointing to a directory or file on the host.
Describe a path from a container's sandbox.
* Named WeightInfo to indicate resource allocation priority between the different roles.

# Interfaces

A Client represents a Mesos API client which can send Calls and return a streaming Decoder from which callers can read Events from, an io.Closer to close the event stream on graceful termination and an error in case of failure.
Response captures the output of a Mesos API operation.
ResponseDecorator optionally modifies the behavior of a Response.

# Type aliases

No description provided by the author
We start the actual values at an offset(1000) because Protobuf 2 uses the first value as the default one.
No description provided by the author
No description provided by the author
ClientFunc is a functional adapter of the Client interface.
CloseFunc is the functional adapter for io.Closer.
Network options.
All container implementation types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Describes the several states that a machine can be in.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Describes possible operation states.
Ranges represents a list of Ranges.
No description provided by the author
No description provided by the author
No description provided by the author
ResponseDecoratorFunc is the functional adapter for ResponseDecorator.
No description provided by the author
No description provided by the author
* Status is used to indicate the state of the scheduler and executor driver after function calls.
* Describes possible task states.
Detailed reason for the task status update.
Describes the source of the task status update.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author