/
CoLocationGroup.java
59 lines (52 loc) · 2.22 KB
/
CoLocationGroup.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.flink.runtime.jobmanager.scheduler;
import org.apache.flink.runtime.jobgraph.JobVertex;
import org.apache.flink.runtime.jobgraph.JobVertexID;
import org.apache.flink.util.AbstractID;
import java.util.List;
/**
* {@code CoLocationGroup} refers to a list of {@link JobVertex} instances, where the <i>i-th</i>
* subtask of one vertex has to be executed on the same {@code TaskManager} as the <i>i-th</i>
* subtask of all other {@code JobVertex} instances in the same group.
*
* <p>The co-location group is used to make sure that the i-th subtasks for iteration head and
* iteration tail are scheduled on the same TaskManager.
*/
public interface CoLocationGroup {
/**
* Returns the unique identifier describing this co-location constraint as a group.
*
* @return The group's identifier.
*/
AbstractID getId();
/**
* Returns the IDs of the {@link JobVertex} instances participating in this group.
*
* @return The group's members represented by their {@link JobVertexID}s.
*/
List<JobVertexID> getVertexIds();
/**
* Returns the {@link CoLocationConstraint} for a specific {@code subTaskIndex}.
*
* @param subTaskIndex The index of the subtasks for which a {@code CoLocationConstraint} shall
* be returned.
* @return The corresponding {@code CoLocationConstraint} instance.
*/
CoLocationConstraint getLocationConstraint(final int subTaskIndex);
}