Protos.FrameworkInfo

java.lang.Object
- com.google.protobuf.GeneratedMessageV3
- - org.apache.mesos.Protos.FrameworkInfo

All Implemented Interfaces:: Protos.FrameworkInfoOrBuilder

Enclosing class:: Protos

public static final class Protos.FrameworkInfo
extends com.google.protobuf.GeneratedMessageV3
implements Protos.FrameworkInfoOrBuilder


 Describes a framework.

Protobuf type mesos.FrameworkInfo

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Protos.FrameworkInfo.Builder` Describes a framework.
`static class`	`Protos.FrameworkInfo.Capability` Protobuf type `mesos.FrameworkInfo.Capability`
`static interface`	`Protos.FrameworkInfo.CapabilityOrBuilder`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CAPABILITIES_FIELD_NUMBER`
`static int`	`CHECKPOINT_FIELD_NUMBER`
`static int`	`FAILOVER_TIMEOUT_FIELD_NUMBER`
`static int`	`HOSTNAME_FIELD_NUMBER`
`static int`	`ID_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`OFFER_FILTERS_FIELD_NUMBER`
`static <any>`	`PARSER` Deprecated.
`static int`	`PRINCIPAL_FIELD_NUMBER`
`static int`	`ROLE_FIELD_NUMBER`
`static int`	`ROLES_FIELD_NUMBER`
`static int`	`USER_FIELD_NUMBER`
`static int`	`WEBUI_URL_FIELD_NUMBER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsOfferFilters(java.lang.String key)` Specifc resource requirements for each of the framework's roles.
`boolean`	`equals(java.lang.Object obj)`
`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.
`static Protos.FrameworkInfo`	`getDefaultInstance()`
`Protos.FrameworkInfo`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`<any>`	`getParserForType()`
`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;`
`com.google.protobuf.ProtocolStringList`	`getRolesList()` `repeated string roles = 12;`
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`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.
`int`	`hashCode()`
`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.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static Protos.FrameworkInfo.Builder`	`newBuilder()`
`static Protos.FrameworkInfo.Builder`	`newBuilder(Protos.FrameworkInfo prototype)`
`Protos.FrameworkInfo.Builder`	`newBuilderForType()`
`protected Protos.FrameworkInfo.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static Protos.FrameworkInfo`	`parseDelimitedFrom(java.io.InputStream input)`
`static Protos.FrameworkInfo`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Protos.FrameworkInfo`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Protos.FrameworkInfo`	`parseFrom(java.nio.ByteBuffer data)`
`static Protos.FrameworkInfo`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Protos.FrameworkInfo`	`parseFrom(com.google.protobuf.ByteString data)`
`static Protos.FrameworkInfo`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Protos.FrameworkInfo`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Protos.FrameworkInfo`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Protos.FrameworkInfo`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static <any>`	`parser()`
`Protos.FrameworkInfo.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail
- USER_FIELD_NUMBER
```
public static final int USER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ID_FIELD_NUMBER
```
public static final int ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FAILOVER_TIMEOUT_FIELD_NUMBER
```
public static final int FAILOVER_TIMEOUT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CHECKPOINT_FIELD_NUMBER
```
public static final int CHECKPOINT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ROLE_FIELD_NUMBER
```
public static final int ROLE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ROLES_FIELD_NUMBER
```
public static final int ROLES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HOSTNAME_FIELD_NUMBER
```
public static final int HOSTNAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PRINCIPAL_FIELD_NUMBER
```
public static final int PRINCIPAL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WEBUI_URL_FIELD_NUMBER
```
public static final int WEBUI_URL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CAPABILITIES_FIELD_NUMBER
```
public static final int CAPABILITIES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OFFER_FILTERS_FIELD_NUMBER
```
public static final int OFFER_FILTERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARSER
```
@Deprecated
public static final <any> PARSER
```
  Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

hasUser

public 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;

Specified by:: hasUser in interface Protos.FrameworkInfoOrBuilder

getUser

public 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;

Specified by:: getUser in interface Protos.FrameworkInfoOrBuilder

getUserBytes

public 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;

Specified by:: getUserBytes in interface Protos.FrameworkInfoOrBuilder

hasName
```
public boolean hasName()
```
```
 Name of the framework that shows up in the Mesos Web UI.
 
```
required string name = 2;
Specified by:

hasName in interface Protos.FrameworkInfoOrBuilder

getName

public java.lang.String getName()

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

required string name = 2;

Specified by:: getName in interface Protos.FrameworkInfoOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

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

required string name = 2;

Specified by:: getNameBytes in interface Protos.FrameworkInfoOrBuilder

hasId

public 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;

Specified by:: hasId in interface Protos.FrameworkInfoOrBuilder

getId

public 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;

Specified by:: getId in interface Protos.FrameworkInfoOrBuilder

getIdOrBuilder

public 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;

Specified by:: getIdOrBuilder in interface Protos.FrameworkInfoOrBuilder

hasFailoverTimeout

public 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];

Specified by:: hasFailoverTimeout in interface Protos.FrameworkInfoOrBuilder

getFailoverTimeout

public 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];

Specified by:: getFailoverTimeout in interface Protos.FrameworkInfoOrBuilder

hasCheckpoint

public 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];

Specified by:: hasCheckpoint in interface Protos.FrameworkInfoOrBuilder

getCheckpoint

public 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];

Specified by:: getCheckpoint in interface Protos.FrameworkInfoOrBuilder

hasRole

@Deprecated
public boolean hasRole()

Deprecated.

 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];

Specified by:: hasRole in interface Protos.FrameworkInfoOrBuilder

getRole

@Deprecated
public java.lang.String getRole()

Deprecated.

 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];

Specified by:: getRole in interface Protos.FrameworkInfoOrBuilder

getRoleBytes

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

Deprecated.

 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];

Specified by:: getRoleBytes in interface Protos.FrameworkInfoOrBuilder

getRolesList
```
public com.google.protobuf.ProtocolStringList getRolesList()
```
repeated string roles = 12;

Specified by:

getRolesList in interface Protos.FrameworkInfoOrBuilder

getRolesCount
```
public int getRolesCount()
```
repeated string roles = 12;

Specified by:

getRolesCount in interface Protos.FrameworkInfoOrBuilder

getRoles
```
public java.lang.String getRoles(int index)
```
repeated string roles = 12;

Specified by:

getRoles in interface Protos.FrameworkInfoOrBuilder

getRolesBytes
```
public com.google.protobuf.ByteString getRolesBytes(int index)
```
repeated string roles = 12;

Specified by:

getRolesBytes in interface Protos.FrameworkInfoOrBuilder

hasHostname

public 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;

Specified by:: hasHostname in interface Protos.FrameworkInfoOrBuilder

getHostname

public 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;

Specified by:: getHostname in interface Protos.FrameworkInfoOrBuilder

getHostnameBytes

public 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;

Specified by:: getHostnameBytes in interface Protos.FrameworkInfoOrBuilder

hasPrincipal

public 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;

Specified by:: hasPrincipal in interface Protos.FrameworkInfoOrBuilder

getPrincipal

public 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;

Specified by:: getPrincipal in interface Protos.FrameworkInfoOrBuilder

getPrincipalBytes

public 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;

Specified by:: getPrincipalBytes in interface Protos.FrameworkInfoOrBuilder

hasWebuiUrl

public 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;

Specified by:: hasWebuiUrl in interface Protos.FrameworkInfoOrBuilder

getWebuiUrl

public 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;

Specified by:: getWebuiUrl in interface Protos.FrameworkInfoOrBuilder

getWebuiUrlBytes

public 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;

Specified by:: getWebuiUrlBytes in interface Protos.FrameworkInfoOrBuilder