org.apache.mesos

Class Protos.NetworkInfo

java.lang.Object

com.google.protobuf.GeneratedMessageV3

org.apache.mesos.Protos.NetworkInfo

All Implemented Interfaces:

Protos.NetworkInfoOrBuilder

Enclosing class:

Protos

public static final class Protos.NetworkInfo
extends com.google.protobuf.GeneratedMessageV3
implements Protos.NetworkInfoOrBuilder

 Describes a network request from a framework as well as network resolution
 provided by Mesos.
 A framework may request the network isolator on the Agent to isolate the
 container in a network namespace and create a virtual network interface.
 The `NetworkInfo` message describes the properties of that virtual
 interface, including the IP addresses and network isolation policy
 (network group membership).
 The NetworkInfo message is not interpreted by the Master or Agent and is
 intended to be used by Agent and Master modules implementing network
 isolation. If the modules are missing, the message is simply ignored. In
 future, the task launch will fail if there is no module providing the
 network isolation capabilities (MESOS-3390).
 An executor, Agent, or an Agent module may append NetworkInfos inside
 TaskStatus::container_status to provide information such as the container IP
 address and isolation groups.
 

Protobuf type mesos.NetworkInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Protos.NetworkInfo.Builder Describes a network request from a framework as well as network resolution provided by Mesos.
static class	Protos.NetworkInfo.IPAddress Specifies a request for an IP address, or reports the assigned container IP address.
static interface	Protos.NetworkInfo.IPAddressOrBuilder
static class	Protos.NetworkInfo.PortMapping Specifies a port mapping request for the task on this network.
static interface	Protos.NetworkInfo.PortMappingOrBuilder
static class	Protos.NetworkInfo.Protocol Protobuf enum mesos.NetworkInfo.Protocol

Field Summary

Fields

Modifier and Type	Field and Description
static int	GROUPS_FIELD_NUMBER
static int	IP_ADDRESSES_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static <any>	PARSER Deprecated.
static int	PORT_MAPPINGS_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static Protos.NetworkInfo	getDefaultInstance()
Protos.NetworkInfo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.lang.String	getGroups(int index) A group is the name given to a set of logically-related interfaces that are allowed to communicate among themselves.
com.google.protobuf.ByteString	getGroupsBytes(int index) A group is the name given to a set of logically-related interfaces that are allowed to communicate among themselves.
int	getGroupsCount() A group is the name given to a set of logically-related interfaces that are allowed to communicate among themselves.
com.google.protobuf.ProtocolStringList	getGroupsList() A group is the name given to a set of logically-related interfaces that are allowed to communicate among themselves.
Protos.NetworkInfo.IPAddress	getIpAddresses(int index) When included in a ContainerInfo, each of these represent a request for an IP address.
int	getIpAddressesCount() When included in a ContainerInfo, each of these represent a request for an IP address.
java.util.List<Protos.NetworkInfo.IPAddress>	getIpAddressesList() When included in a ContainerInfo, each of these represent a request for an IP address.
Protos.NetworkInfo.IPAddressOrBuilder	getIpAddressesOrBuilder(int index) When included in a ContainerInfo, each of these represent a request for an IP address.
java.util.List<? extends Protos.NetworkInfo.IPAddressOrBuilder>	getIpAddressesOrBuilderList() When included in a ContainerInfo, each of these represent a request for an IP address.
Protos.Labels	getLabels() To tag certain metadata to be used by Isolator/IPAM, e.g., rack, etc.
Protos.LabelsOrBuilder	getLabelsOrBuilder() To tag certain metadata to be used by Isolator/IPAM, e.g., rack, etc.
java.lang.String	getName() Name of the network which will be used by network isolator to determine the network that the container joins.
com.google.protobuf.ByteString	getNameBytes() Name of the network which will be used by network isolator to determine the network that the container joins.
<any>	getParserForType()
Protos.NetworkInfo.PortMapping	getPortMappings(int index) repeated .mesos.NetworkInfo.PortMapping port_mappings = 7;
int	getPortMappingsCount() repeated .mesos.NetworkInfo.PortMapping port_mappings = 7;
java.util.List<Protos.NetworkInfo.PortMapping>	getPortMappingsList() repeated .mesos.NetworkInfo.PortMapping port_mappings = 7;
Protos.NetworkInfo.PortMappingOrBuilder	getPortMappingsOrBuilder(int index) repeated .mesos.NetworkInfo.PortMapping port_mappings = 7;
java.util.List<? extends Protos.NetworkInfo.PortMappingOrBuilder>	getPortMappingsOrBuilderList() repeated .mesos.NetworkInfo.PortMapping port_mappings = 7;
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasLabels() To tag certain metadata to be used by Isolator/IPAM, e.g., rack, etc.
boolean	hasName() Name of the network which will be used by network isolator to determine the network that the container joins.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Protos.NetworkInfo.Builder	newBuilder()
static Protos.NetworkInfo.Builder	newBuilder(Protos.NetworkInfo prototype)
Protos.NetworkInfo.Builder	newBuilderForType()
protected Protos.NetworkInfo.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Protos.NetworkInfo	parseDelimitedFrom(java.io.InputStream input)
static Protos.NetworkInfo	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.NetworkInfo	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.NetworkInfo	parseFrom(java.nio.ByteBuffer data)
static Protos.NetworkInfo	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.NetworkInfo	parseFrom(com.google.protobuf.ByteString data)
static Protos.NetworkInfo	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.NetworkInfo	parseFrom(com.google.protobuf.CodedInputStream input)
static Protos.NetworkInfo	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.NetworkInfo	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static <any>	parser()
Protos.NetworkInfo.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

IP_ADDRESSES_FIELD_NUMBER

public static final int IP_ADDRESSES_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

GROUPS_FIELD_NUMBER

public static final int GROUPS_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

PORT_MAPPINGS_FIELD_NUMBER

public static final int PORT_MAPPINGS_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()

internalGetFieldAccessorTable

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

getIpAddressesList

public java.util.List<Protos.NetworkInfo.IPAddress> getIpAddressesList()

 When included in a ContainerInfo, each of these represent a
 request for an IP address. Each request can specify an explicit address
 or the IP protocol to use.
 When included in a TaskStatus message, these inform the framework
 scheduler about the IP addresses that are bound to the container
 interface. When there are no custom network isolator modules installed,
 this field is filled in automatically with the Agent IP address.
 

repeated .mesos.NetworkInfo.IPAddress ip_addresses = 5;

Specified by:

getIpAddressesList in interface Protos.NetworkInfoOrBuilder

getIpAddressesOrBuilderList

public java.util.List<? extends Protos.NetworkInfo.IPAddressOrBuilder> getIpAddressesOrBuilderList()

 When included in a ContainerInfo, each of these represent a
 request for an IP address. Each request can specify an explicit address
 or the IP protocol to use.
 When included in a TaskStatus message, these inform the framework
 scheduler about the IP addresses that are bound to the container
 interface. When there are no custom network isolator modules installed,
 this field is filled in automatically with the Agent IP address.
 

repeated .mesos.NetworkInfo.IPAddress ip_addresses = 5;

Specified by:

getIpAddressesOrBuilderList in interface Protos.NetworkInfoOrBuilder

getIpAddressesCount

public int getIpAddressesCount()

 When included in a ContainerInfo, each of these represent a
 request for an IP address. Each request can specify an explicit address
 or the IP protocol to use.
 When included in a TaskStatus message, these inform the framework
 scheduler about the IP addresses that are bound to the container
 interface. When there are no custom network isolator modules installed,
 this field is filled in automatically with the Agent IP address.
 

repeated .mesos.NetworkInfo.IPAddress ip_addresses = 5;

Specified by:

getIpAddressesCount in interface Protos.NetworkInfoOrBuilder

getIpAddresses

public Protos.NetworkInfo.IPAddress getIpAddresses(int index)

 When included in a ContainerInfo, each of these represent a
 request for an IP address. Each request can specify an explicit address
 or the IP protocol to use.
 When included in a TaskStatus message, these inform the framework
 scheduler about the IP addresses that are bound to the container
 interface. When there are no custom network isolator modules installed,
 this field is filled in automatically with the Agent IP address.
 

repeated .mesos.NetworkInfo.IPAddress ip_addresses = 5;

Specified by:

getIpAddresses in interface Protos.NetworkInfoOrBuilder

getIpAddressesOrBuilder

public Protos.NetworkInfo.IPAddressOrBuilder getIpAddressesOrBuilder(int index)

 When included in a ContainerInfo, each of these represent a
 request for an IP address. Each request can specify an explicit address
 or the IP protocol to use.
 When included in a TaskStatus message, these inform the framework
 scheduler about the IP addresses that are bound to the container
 interface. When there are no custom network isolator modules installed,
 this field is filled in automatically with the Agent IP address.
 

repeated .mesos.NetworkInfo.IPAddress ip_addresses = 5;

Specified by:

getIpAddressesOrBuilder in interface Protos.NetworkInfoOrBuilder

hasName

public boolean hasName()

 Name of the network which will be used by network isolator to determine
 the network that the container joins. It's up to the network isolator
 to decide how to interpret this field.
 

optional string name = 6;

Specified by:

hasName in interface Protos.NetworkInfoOrBuilder

getName

public java.lang.String getName()

 Name of the network which will be used by network isolator to determine
 the network that the container joins. It's up to the network isolator
 to decide how to interpret this field.
 

optional string name = 6;

Specified by:

getName in interface Protos.NetworkInfoOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Name of the network which will be used by network isolator to determine
 the network that the container joins. It's up to the network isolator
 to decide how to interpret this field.
 

optional string name = 6;

Specified by:

getNameBytes in interface Protos.NetworkInfoOrBuilder

getGroupsList

public com.google.protobuf.ProtocolStringList getGroupsList()

 A group is the name given to a set of logically-related interfaces that
 are allowed to communicate among themselves. Network traffic is allowed
 between two container interfaces that share at least one network group.
 For example, one might want to create separate groups for isolating dev,
 testing, qa and prod deployment environments.
 

repeated string groups = 3;

Specified by:

getGroupsList in interface Protos.NetworkInfoOrBuilder

getGroupsCount

public int getGroupsCount()

 A group is the name given to a set of logically-related interfaces that
 are allowed to communicate among themselves. Network traffic is allowed
 between two container interfaces that share at least one network group.
 For example, one might want to create separate groups for isolating dev,
 testing, qa and prod deployment environments.
 

repeated string groups = 3;

Specified by:

getGroupsCount in interface Protos.NetworkInfoOrBuilder

getGroups

public java.lang.String getGroups(int index)

 A group is the name given to a set of logically-related interfaces that
 are allowed to communicate among themselves. Network traffic is allowed
 between two container interfaces that share at least one network group.
 For example, one might want to create separate groups for isolating dev,
 testing, qa and prod deployment environments.
 

repeated string groups = 3;

Specified by:

getGroups in interface Protos.NetworkInfoOrBuilder

getGroupsBytes

public com.google.protobuf.ByteString getGroupsBytes(int index)

 A group is the name given to a set of logically-related interfaces that
 are allowed to communicate among themselves. Network traffic is allowed
 between two container interfaces that share at least one network group.
 For example, one might want to create separate groups for isolating dev,
 testing, qa and prod deployment environments.
 

repeated string groups = 3;

Specified by:

getGroupsBytes in interface Protos.NetworkInfoOrBuilder

hasLabels

public boolean hasLabels()

 To tag certain metadata to be used by Isolator/IPAM, e.g., rack, etc.
 

optional .mesos.Labels labels = 4;

Specified by:

hasLabels in interface Protos.NetworkInfoOrBuilder

getLabels

public Protos.Labels getLabels()

 To tag certain metadata to be used by Isolator/IPAM, e.g., rack, etc.
 

optional .mesos.Labels labels = 4;

Specified by:

getLabels in interface Protos.NetworkInfoOrBuilder

getLabelsOrBuilder

public Protos.LabelsOrBuilder getLabelsOrBuilder()

 To tag certain metadata to be used by Isolator/IPAM, e.g., rack, etc.
 

optional .mesos.Labels labels = 4;

Specified by:

getLabelsOrBuilder in interface Protos.NetworkInfoOrBuilder

getPortMappingsList

public java.util.List<Protos.NetworkInfo.PortMapping> getPortMappingsList()

repeated .mesos.NetworkInfo.PortMapping port_mappings = 7;

Specified by:

getPortMappingsList in interface Protos.NetworkInfoOrBuilder

getPortMappingsOrBuilderList

public java.util.List<? extends Protos.NetworkInfo.PortMappingOrBuilder> getPortMappingsOrBuilderList()

repeated .mesos.NetworkInfo.PortMapping port_mappings = 7;

Specified by:

getPortMappingsOrBuilderList in interface Protos.NetworkInfoOrBuilder

getPortMappingsCount

public int getPortMappingsCount()

repeated .mesos.NetworkInfo.PortMapping port_mappings = 7;

Specified by:

getPortMappingsCount in interface Protos.NetworkInfoOrBuilder

getPortMappings

public Protos.NetworkInfo.PortMapping getPortMappings(int index)

repeated .mesos.NetworkInfo.PortMapping port_mappings = 7;

Specified by:

getPortMappings in interface Protos.NetworkInfoOrBuilder

getPortMappingsOrBuilder

public Protos.NetworkInfo.PortMappingOrBuilder getPortMappingsOrBuilder(int index)

repeated .mesos.NetworkInfo.PortMapping port_mappings = 7;

Specified by:

getPortMappingsOrBuilder in interface Protos.NetworkInfoOrBuilder

isInitialized

public final boolean isInitialized()

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

equals

public boolean equals(java.lang.Object obj)

hashCode

public int hashCode()

parseFrom

public static Protos.NetworkInfo parseFrom(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.NetworkInfo parseFrom(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.NetworkInfo parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.NetworkInfo parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.NetworkInfo parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.NetworkInfo parseFrom(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Protos.NetworkInfo parseDelimitedFrom(java.io.InputStream input)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Protos.NetworkInfo parseDelimitedFrom(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Protos.NetworkInfo parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Protos.NetworkInfo parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Protos.NetworkInfo.Builder newBuilderForType()

newBuilder

public static Protos.NetworkInfo.Builder newBuilder()

newBuilder

public static Protos.NetworkInfo.Builder newBuilder(Protos.NetworkInfo prototype)

toBuilder

public Protos.NetworkInfo.Builder toBuilder()

newBuilderForType

protected Protos.NetworkInfo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

getDefaultInstance

public static Protos.NetworkInfo getDefaultInstance()

parser

public static <any> parser()

getParserForType

public <any> getParserForType()

getDefaultInstanceForType

public Protos.NetworkInfo getDefaultInstanceForType()