org.apache.mesos.v1

Interface Protos.FrameworkInfoOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Protos.FrameworkInfo, Protos.FrameworkInfo.Builder

Enclosing class:

Protos

public static interface Protos.FrameworkInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Protos.FrameworkInfo.Capability	getCapabilities(int index) repeated .mesos.v1.FrameworkInfo.Capability capabilities = 10;
int	getCapabilitiesCount() repeated .mesos.v1.FrameworkInfo.Capability capabilities = 10;
List<Protos.FrameworkInfo.Capability>	getCapabilitiesList() repeated .mesos.v1.FrameworkInfo.Capability capabilities = 10;
Protos.FrameworkInfo.CapabilityOrBuilder	getCapabilitiesOrBuilder(int index) repeated .mesos.v1.FrameworkInfo.Capability capabilities = 10;
List<? extends Protos.FrameworkInfo.CapabilityOrBuilder>	getCapabilitiesOrBuilderList() repeated .mesos.v1.FrameworkInfo.Capability capabilities = 10;
boolean	getCheckpoint() optional bool checkpoint = 5 [default = false];
double	getFailoverTimeout() optional double failover_timeout = 4 [default = 0];
String	getHostname() optional string hostname = 7;
com.google.protobuf.ByteString	getHostnameBytes() optional string hostname = 7;
Protos.FrameworkID	getId() optional .mesos.v1.FrameworkID id = 3;
Protos.FrameworkIDOrBuilder	getIdOrBuilder() optional .mesos.v1.FrameworkID id = 3;
Protos.Labels	getLabels() optional .mesos.v1.Labels labels = 11;
Protos.LabelsOrBuilder	getLabelsOrBuilder() optional .mesos.v1.Labels labels = 11;
String	getName() required string name = 2;
com.google.protobuf.ByteString	getNameBytes() required string name = 2;
String	getPrincipal() optional string principal = 8;
com.google.protobuf.ByteString	getPrincipalBytes() optional string principal = 8;
String	getRole() Deprecated.
com.google.protobuf.ByteString	getRoleBytes() Deprecated.
String	getRoles(int index) repeated string roles = 12;
com.google.protobuf.ByteString	getRolesBytes(int index) repeated string roles = 12;
int	getRolesCount() repeated string roles = 12;
com.google.protobuf.ProtocolStringList	getRolesList() repeated string roles = 12;
String	getUser() required string user = 1;
com.google.protobuf.ByteString	getUserBytes() required string user = 1;
String	getWebuiUrl() optional string webui_url = 9;
com.google.protobuf.ByteString	getWebuiUrlBytes() optional string webui_url = 9;
boolean	hasCheckpoint() optional bool checkpoint = 5 [default = false];
boolean	hasFailoverTimeout() optional double failover_timeout = 4 [default = 0];
boolean	hasHostname() optional string hostname = 7;
boolean	hasId() optional .mesos.v1.FrameworkID id = 3;
boolean	hasLabels() optional .mesos.v1.Labels labels = 11;
boolean	hasName() required string name = 2;
boolean	hasPrincipal() optional string principal = 8;
boolean	hasRole() Deprecated.
boolean	hasUser() required string user = 1;
boolean	hasWebuiUrl() optional string webui_url = 9;

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasUser

boolean hasUser()

required string user = 1;

 Used to determine the Unix user that an executor or task should be
 launched as.
 When using the MesosSchedulerDriver, if the field is set to an
 empty string, it will automagically set it to the current user.
 When using the HTTP Scheduler API, the user has to be set
 explicitly.
 

getUser

String getUser()

required string user = 1;

 Used to determine the Unix user that an executor or task should be
 launched as.
 When using the MesosSchedulerDriver, if the field is set to an
 empty string, it will automagically set it to the current user.
 When using the HTTP Scheduler API, the user has to be set
 explicitly.
 

getUserBytes

com.google.protobuf.ByteString getUserBytes()

required string user = 1;

 Used to determine the Unix user that an executor or task should be
 launched as.
 When using the MesosSchedulerDriver, if the field is set to an
 empty string, it will automagically set it to the current user.
 When using the HTTP Scheduler API, the user has to be set
 explicitly.
 

hasName

boolean hasName()

required string name = 2;

 Name of the framework that shows up in the Mesos Web UI.
 

getName

String getName()

required string name = 2;

 Name of the framework that shows up in the Mesos Web UI.
 

getNameBytes

com.google.protobuf.ByteString getNameBytes()

required string name = 2;

 Name of the framework that shows up in the Mesos Web UI.
 

hasId

boolean hasId()

optional .mesos.v1.FrameworkID id = 3;

 Note that 'id' is only available after a framework has
 registered, however, it is included here in order to facilitate
 scheduler failover (i.e., if it is set then the
 MesosSchedulerDriver expects the scheduler is performing
 failover).
 

getId

Protos.FrameworkID getId()

optional .mesos.v1.FrameworkID id = 3;

 Note that 'id' is only available after a framework has
 registered, however, it is included here in order to facilitate
 scheduler failover (i.e., if it is set then the
 MesosSchedulerDriver expects the scheduler is performing
 failover).
 

getIdOrBuilder

Protos.FrameworkIDOrBuilder getIdOrBuilder()

optional .mesos.v1.FrameworkID id = 3;

 Note that 'id' is only available after a framework has
 registered, however, it is included here in order to facilitate
 scheduler failover (i.e., if it is set then the
 MesosSchedulerDriver expects the scheduler is performing
 failover).
 

hasFailoverTimeout

boolean hasFailoverTimeout()

optional double failover_timeout = 4 [default = 0];

 The amount of time (in seconds) that the master will wait for the
 scheduler to failover before it tears down the framework by
 killing all its tasks/executors. This should be non-zero if a
 framework expects to reconnect after a failure and not lose its
 tasks/executors.
 NOTE: To avoid accidental destruction of tasks, production
 frameworks typically set this to a large value (e.g., 1 week).
 

getFailoverTimeout

double getFailoverTimeout()

optional double failover_timeout = 4 [default = 0];

 The amount of time (in seconds) that the master will wait for the
 scheduler to failover before it tears down the framework by
 killing all its tasks/executors. This should be non-zero if a
 framework expects to reconnect after a failure and not lose its
 tasks/executors.
 NOTE: To avoid accidental destruction of tasks, production
 frameworks typically set this to a large value (e.g., 1 week).
 

hasCheckpoint

boolean hasCheckpoint()

optional bool checkpoint = 5 [default = false];

 If set, agents running tasks started by this framework will write
 the framework pid, executor pids and status updates to disk. If
 the agent exits (e.g., due to a crash or as part of upgrading
 Mesos), this checkpointed data allows the restarted agent to
 reconnect to executors that were started by the old instance of
 the agent. Enabling checkpointing improves fault tolerance, at
 the cost of a (usually small) increase in disk I/O.
 

getCheckpoint

boolean getCheckpoint()

optional bool checkpoint = 5 [default = false];

 If set, agents running tasks started by this framework will write
 the framework pid, executor pids and status updates to disk. If
 the agent exits (e.g., due to a crash or as part of upgrading
 Mesos), this checkpointed data allows the restarted agent to
 reconnect to executors that were started by the old instance of
 the agent. Enabling checkpointing improves fault tolerance, at
 the cost of a (usually small) increase in disk I/O.
 

hasRole

@Deprecated
boolean hasRole()

Deprecated.

optional string role = 6 [default = "*", deprecated = true];

 Roles are the entities to which allocations are made.
 The framework must have at least one role in order to
 be offered resources. Note that `role` is deprecated
 in favor of `roles` and only one of these fields must
 be used. Since we cannot distinguish between empty
 `roles` and the default unset `role`, we require that
 frameworks set the `MULTI_ROLE` capability if
 setting the `roles` field.
 

getRole

@Deprecated
String getRole()

Deprecated.

optional string role = 6 [default = "*", deprecated = true];

 Roles are the entities to which allocations are made.
 The framework must have at least one role in order to
 be offered resources. Note that `role` is deprecated
 in favor of `roles` and only one of these fields must
 be used. Since we cannot distinguish between empty
 `roles` and the default unset `role`, we require that
 frameworks set the `MULTI_ROLE` capability if
 setting the `roles` field.
 

getRoleBytes

@Deprecated
com.google.protobuf.ByteString getRoleBytes()

Deprecated.

optional string role = 6 [default = "*", deprecated = true];

 Roles are the entities to which allocations are made.
 The framework must have at least one role in order to
 be offered resources. Note that `role` is deprecated
 in favor of `roles` and only one of these fields must
 be used. Since we cannot distinguish between empty
 `roles` and the default unset `role`, we require that
 frameworks set the `MULTI_ROLE` capability if
 setting the `roles` field.
 

getRolesList

com.google.protobuf.ProtocolStringList getRolesList()

repeated string roles = 12;

getRolesCount

int getRolesCount()

repeated string roles = 12;

getRoles

String getRoles(int index)

repeated string roles = 12;

getRolesBytes

com.google.protobuf.ByteString getRolesBytes(int index)

repeated string roles = 12;

hasHostname

boolean hasHostname()

optional string hostname = 7;

 Used to indicate the current host from which the scheduler is
 registered in the Mesos Web UI. If set to an empty string Mesos
 will automagically set it to the current hostname if one is
 available.
 

getHostname

String getHostname()

optional string hostname = 7;

 Used to indicate the current host from which the scheduler is
 registered in the Mesos Web UI. If set to an empty string Mesos
 will automagically set it to the current hostname if one is
 available.
 

getHostnameBytes

com.google.protobuf.ByteString getHostnameBytes()

optional string hostname = 7;

 Used to indicate the current host from which the scheduler is
 registered in the Mesos Web UI. If set to an empty string Mesos
 will automagically set it to the current hostname if one is
 available.
 

hasPrincipal

boolean hasPrincipal()

optional string principal = 8;

 This field should match the credential's principal the framework
 uses for authentication. This field is used for framework API
 rate limiting and dynamic reservations. It should be set even
 if authentication is not enabled if these features are desired.
 

getPrincipal

String getPrincipal()

optional string principal = 8;

 This field should match the credential's principal the framework
 uses for authentication. This field is used for framework API
 rate limiting and dynamic reservations. It should be set even
 if authentication is not enabled if these features are desired.
 

getPrincipalBytes

com.google.protobuf.ByteString getPrincipalBytes()

optional string principal = 8;

 This field should match the credential's principal the framework
 uses for authentication. This field is used for framework API
 rate limiting and dynamic reservations. It should be set even
 if authentication is not enabled if these features are desired.
 

hasWebuiUrl

boolean hasWebuiUrl()

optional string webui_url = 9;

 This field allows a framework to advertise its web UI, so that
 the Mesos web UI can link to it. It is expected to be a full URL,
 for example http://my-scheduler.example.com:8080/.
 

getWebuiUrl

String getWebuiUrl()

optional string webui_url = 9;

 This field allows a framework to advertise its web UI, so that
 the Mesos web UI can link to it. It is expected to be a full URL,
 for example http://my-scheduler.example.com:8080/.
 

getWebuiUrlBytes

com.google.protobuf.ByteString getWebuiUrlBytes()

optional string webui_url = 9;

 This field allows a framework to advertise its web UI, so that
 the Mesos web UI can link to it. It is expected to be a full URL,
 for example http://my-scheduler.example.com:8080/.
 

getCapabilitiesList

List<Protos.FrameworkInfo.Capability> getCapabilitiesList()

repeated .mesos.v1.FrameworkInfo.Capability capabilities = 10;

 This field allows a framework to advertise its set of
 capabilities (e.g., ability to receive offers for revocable
 resources).
 

getCapabilities

Protos.FrameworkInfo.Capability getCapabilities(int index)

repeated .mesos.v1.FrameworkInfo.Capability capabilities = 10;

 This field allows a framework to advertise its set of
 capabilities (e.g., ability to receive offers for revocable
 resources).
 

getCapabilitiesCount

int getCapabilitiesCount()

repeated .mesos.v1.FrameworkInfo.Capability capabilities = 10;

 This field allows a framework to advertise its set of
 capabilities (e.g., ability to receive offers for revocable
 resources).
 

getCapabilitiesOrBuilderList

List<? extends Protos.FrameworkInfo.CapabilityOrBuilder> getCapabilitiesOrBuilderList()

repeated .mesos.v1.FrameworkInfo.Capability capabilities = 10;

 This field allows a framework to advertise its set of
 capabilities (e.g., ability to receive offers for revocable
 resources).
 

getCapabilitiesOrBuilder

Protos.FrameworkInfo.CapabilityOrBuilder getCapabilitiesOrBuilder(int index)

repeated .mesos.v1.FrameworkInfo.Capability capabilities = 10;

 This field allows a framework to advertise its set of
 capabilities (e.g., ability to receive offers for revocable
 resources).
 

hasLabels

boolean hasLabels()

optional .mesos.v1.Labels labels = 11;

 Labels are free-form key value pairs supplied by the framework
 scheduler (e.g., to describe additional functionality offered by
 the framework). These labels are not interpreted by Mesos itself.
 Labels should not contain duplicate key-value pairs.
 

getLabels

Protos.Labels getLabels()

optional .mesos.v1.Labels labels = 11;

 Labels are free-form key value pairs supplied by the framework
 scheduler (e.g., to describe additional functionality offered by
 the framework). These labels are not interpreted by Mesos itself.
 Labels should not contain duplicate key-value pairs.
 

getLabelsOrBuilder

Protos.LabelsOrBuilder getLabelsOrBuilder()

optional .mesos.v1.Labels labels = 11;

 Labels are free-form key value pairs supplied by the framework
 scheduler (e.g., to describe additional functionality offered by
 the framework). These labels are not interpreted by Mesos itself.
 Labels should not contain duplicate key-value pairs.