public static interface Protos.FrameworkInfoOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsOfferFilters(java.lang.String key)
Specifc resource requirements for each of the framework's roles.
|
Protos.FrameworkInfo.Capability |
getCapabilities(int index)
This field allows a framework to advertise its set of
capabilities (e.g., ability to receive offers for revocable
resources).
|
int |
getCapabilitiesCount()
This field allows a framework to advertise its set of
capabilities (e.g., ability to receive offers for revocable
resources).
|
java.util.List<Protos.FrameworkInfo.Capability> |
getCapabilitiesList()
This field allows a framework to advertise its set of
capabilities (e.g., ability to receive offers for revocable
resources).
|
Protos.FrameworkInfo.CapabilityOrBuilder |
getCapabilitiesOrBuilder(int index)
This field allows a framework to advertise its set of
capabilities (e.g., ability to receive offers for revocable
resources).
|
java.util.List<? extends Protos.FrameworkInfo.CapabilityOrBuilder> |
getCapabilitiesOrBuilderList()
This field allows a framework to advertise its set of
capabilities (e.g., ability to receive offers for revocable
resources).
|
boolean |
getCheckpoint()
If set, agents running tasks started by this framework will write
the framework pid, executor pids and status updates to disk.
|
double |
getFailoverTimeout()
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.
|
java.lang.String |
getHostname()
Used to indicate the current host from which the scheduler is
registered in the Mesos Web UI.
|
com.google.protobuf.ByteString |
getHostnameBytes()
Used to indicate the current host from which the scheduler is
registered in the Mesos Web UI.
|
Protos.FrameworkID |
getId()
Used to uniquely identify the framework.
|
Protos.FrameworkIDOrBuilder |
getIdOrBuilder()
Used to uniquely identify the framework.
|
Protos.Labels |
getLabels()
Labels are free-form key value pairs supplied by the framework
scheduler (e.g., to describe additional functionality offered by
the framework).
|
Protos.LabelsOrBuilder |
getLabelsOrBuilder()
Labels are free-form key value pairs supplied by the framework
scheduler (e.g., to describe additional functionality offered by
the framework).
|
java.lang.String |
getName()
Name of the framework that shows up in the Mesos Web UI.
|
com.google.protobuf.ByteString |
getNameBytes()
Name of the framework that shows up in the Mesos Web UI.
|
java.util.Map<java.lang.String,Protos.OfferFilters> |
getOfferFilters()
Deprecated.
|
int |
getOfferFiltersCount()
Specifc resource requirements for each of the framework's roles.
|
java.util.Map<java.lang.String,Protos.OfferFilters> |
getOfferFiltersMap()
Specifc resource requirements for each of the framework's roles.
|
Protos.OfferFilters |
getOfferFiltersOrDefault(java.lang.String key,
Protos.OfferFilters defaultValue)
Specifc resource requirements for each of the framework's roles.
|
Protos.OfferFilters |
getOfferFiltersOrThrow(java.lang.String key)
Specifc resource requirements for each of the framework's roles.
|
java.lang.String |
getPrincipal()
This field should match the credential's principal the framework
uses for authentication.
|
com.google.protobuf.ByteString |
getPrincipalBytes()
This field should match the credential's principal the framework
uses for authentication.
|
java.lang.String |
getRole()
Deprecated.
|
com.google.protobuf.ByteString |
getRoleBytes()
Deprecated.
|
java.lang.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; |
java.util.List<java.lang.String> |
getRolesList()
repeated string roles = 12; |
java.lang.String |
getUser()
Used to determine the Unix user that an executor or task should be
launched as.
|
com.google.protobuf.ByteString |
getUserBytes()
Used to determine the Unix user that an executor or task should be
launched as.
|
java.lang.String |
getWebuiUrl()
This field allows a framework to advertise its web UI, so that
the Mesos web UI can link to it.
|
com.google.protobuf.ByteString |
getWebuiUrlBytes()
This field allows a framework to advertise its web UI, so that
the Mesos web UI can link to it.
|
boolean |
hasCheckpoint()
If set, agents running tasks started by this framework will write
the framework pid, executor pids and status updates to disk.
|
boolean |
hasFailoverTimeout()
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.
|
boolean |
hasHostname()
Used to indicate the current host from which the scheduler is
registered in the Mesos Web UI.
|
boolean |
hasId()
Used to uniquely identify the framework.
|
boolean |
hasLabels()
Labels are free-form key value pairs supplied by the framework
scheduler (e.g., to describe additional functionality offered by
the framework).
|
boolean |
hasName()
Name of the framework that shows up in the Mesos Web UI.
|
boolean |
hasPrincipal()
This field should match the credential's principal the framework
uses for authentication.
|
boolean |
hasRole()
Deprecated.
|
boolean |
hasUser()
Used to determine the Unix user that an executor or task should be
launched as.
|
boolean |
hasWebuiUrl()
This field allows a framework to advertise its web UI, so that
the Mesos web UI can link to it.
|
boolean hasUser()
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.
required string user = 1;java.lang.String getUser()
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.
required string user = 1;com.google.protobuf.ByteString getUserBytes()
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.
required string user = 1;boolean hasName()
Name of the framework that shows up in the Mesos Web UI.
required string name = 2;java.lang.String getName()
Name of the framework that shows up in the Mesos Web UI.
required string name = 2;com.google.protobuf.ByteString getNameBytes()
Name of the framework that shows up in the Mesos Web UI.
required string name = 2;boolean hasId()
Used to uniquely identify the framework. This field must be unset when the framework subscribes for the first time upon which the master will assign a new ID. To resubscribe after scheduler failover the framework should set 'id' to the ID assigned by the master. Setting 'id' to values not assigned by Mesos masters is unsupported.
optional .mesos.FrameworkID id = 3;Protos.FrameworkID getId()
Used to uniquely identify the framework. This field must be unset when the framework subscribes for the first time upon which the master will assign a new ID. To resubscribe after scheduler failover the framework should set 'id' to the ID assigned by the master. Setting 'id' to values not assigned by Mesos masters is unsupported.
optional .mesos.FrameworkID id = 3;Protos.FrameworkIDOrBuilder getIdOrBuilder()
Used to uniquely identify the framework. This field must be unset when the framework subscribes for the first time upon which the master will assign a new ID. To resubscribe after scheduler failover the framework should set 'id' to the ID assigned by the master. Setting 'id' to values not assigned by Mesos masters is unsupported.
optional .mesos.FrameworkID id = 3;boolean hasFailoverTimeout()
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).
optional double failover_timeout = 4 [default = 0];double getFailoverTimeout()
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).
optional double failover_timeout = 4 [default = 0];boolean hasCheckpoint()
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.
optional bool checkpoint = 5 [default = false];boolean getCheckpoint()
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.
optional bool checkpoint = 5 [default = false];@Deprecated boolean hasRole()
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.
optional string role = 6 [default = "*", deprecated = true];@Deprecated java.lang.String getRole()
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.
optional string role = 6 [default = "*", deprecated = true];@Deprecated com.google.protobuf.ByteString getRoleBytes()
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.
optional string role = 6 [default = "*", deprecated = true];java.util.List<java.lang.String> getRolesList()
repeated string roles = 12;int getRolesCount()
repeated string roles = 12;java.lang.String getRoles(int index)
repeated string roles = 12;com.google.protobuf.ByteString getRolesBytes(int index)
repeated string roles = 12;boolean hasHostname()
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.
optional string hostname = 7;java.lang.String getHostname()
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.
optional string hostname = 7;com.google.protobuf.ByteString getHostnameBytes()
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.
optional string hostname = 7;boolean hasPrincipal()
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.
optional string principal = 8;java.lang.String getPrincipal()
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.
optional string principal = 8;com.google.protobuf.ByteString getPrincipalBytes()
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.
optional string principal = 8;boolean hasWebuiUrl()
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/.
optional string webui_url = 9;java.lang.String getWebuiUrl()
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/.
optional string webui_url = 9;com.google.protobuf.ByteString getWebuiUrlBytes()
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/.
optional string webui_url = 9;java.util.List<Protos.FrameworkInfo.Capability> getCapabilitiesList()
This field allows a framework to advertise its set of capabilities (e.g., ability to receive offers for revocable resources).
repeated .mesos.FrameworkInfo.Capability capabilities = 10;Protos.FrameworkInfo.Capability getCapabilities(int index)
This field allows a framework to advertise its set of capabilities (e.g., ability to receive offers for revocable resources).
repeated .mesos.FrameworkInfo.Capability capabilities = 10;int getCapabilitiesCount()
This field allows a framework to advertise its set of capabilities (e.g., ability to receive offers for revocable resources).
repeated .mesos.FrameworkInfo.Capability capabilities = 10;java.util.List<? extends Protos.FrameworkInfo.CapabilityOrBuilder> getCapabilitiesOrBuilderList()
This field allows a framework to advertise its set of capabilities (e.g., ability to receive offers for revocable resources).
repeated .mesos.FrameworkInfo.Capability capabilities = 10;Protos.FrameworkInfo.CapabilityOrBuilder getCapabilitiesOrBuilder(int index)
This field allows a framework to advertise its set of capabilities (e.g., ability to receive offers for revocable resources).
repeated .mesos.FrameworkInfo.Capability capabilities = 10;boolean hasLabels()
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.
optional .mesos.Labels labels = 11;Protos.Labels getLabels()
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.
optional .mesos.Labels labels = 11;Protos.LabelsOrBuilder getLabelsOrBuilder()
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.
optional .mesos.Labels labels = 11;int getOfferFiltersCount()
Specifc resource requirements for each of the framework's roles. This field is used by e.g., the default allocator to decide whether a framework is interested in seeing a resource of a certain shape.
map<string, .mesos.OfferFilters> offer_filters = 13;boolean containsOfferFilters(java.lang.String key)
Specifc resource requirements for each of the framework's roles. This field is used by e.g., the default allocator to decide whether a framework is interested in seeing a resource of a certain shape.
map<string, .mesos.OfferFilters> offer_filters = 13;@Deprecated java.util.Map<java.lang.String,Protos.OfferFilters> getOfferFilters()
getOfferFiltersMap() instead.java.util.Map<java.lang.String,Protos.OfferFilters> getOfferFiltersMap()
Specifc resource requirements for each of the framework's roles. This field is used by e.g., the default allocator to decide whether a framework is interested in seeing a resource of a certain shape.
map<string, .mesos.OfferFilters> offer_filters = 13;Protos.OfferFilters getOfferFiltersOrDefault(java.lang.String key, Protos.OfferFilters defaultValue)
Specifc resource requirements for each of the framework's roles. This field is used by e.g., the default allocator to decide whether a framework is interested in seeing a resource of a certain shape.
map<string, .mesos.OfferFilters> offer_filters = 13;Protos.OfferFilters getOfferFiltersOrThrow(java.lang.String key)
Specifc resource requirements for each of the framework's roles. This field is used by e.g., the default allocator to decide whether a framework is interested in seeing a resource of a certain shape.
map<string, .mesos.OfferFilters> offer_filters = 13;