flink-clients/src/main/java/org/apache/flink/client/deployment/ClusterSpecification.java

/*
 * 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.client.deployment;

import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.JobManagerOptions;
import org.apache.flink.configuration.TaskManagerOptions;

/**
 * Description of the cluster to start by the {@link ClusterDescriptor}.
 */
public final class ClusterSpecification {
	private final int masterMemoryMB;
	private final int taskManagerMemoryMB;
	private final int numberTaskManagers;
	private final int slotsPerTaskManager;

	private ClusterSpecification(int masterMemoryMB, int taskManagerMemoryMB, int numberTaskManagers, int slotsPerTaskManager) {
		this.masterMemoryMB = masterMemoryMB;
		this.taskManagerMemoryMB = taskManagerMemoryMB;
		this.numberTaskManagers = numberTaskManagers;
		this.slotsPerTaskManager = slotsPerTaskManager;
	}

	public int getMasterMemoryMB() {
		return masterMemoryMB;
	}

	public int getTaskManagerMemoryMB() {
		return taskManagerMemoryMB;
	}

	public int getNumberTaskManagers() {
		return numberTaskManagers;
	}

	public int getSlotsPerTaskManager() {
		return slotsPerTaskManager;
	}

	@Override
	public String toString() {
		return "ClusterSpecification{" +
			"masterMemoryMB=" + masterMemoryMB +
			", taskManagerMemoryMB=" + taskManagerMemoryMB +
			", numberTaskManagers=" + numberTaskManagers +
			", slotsPerTaskManager=" + slotsPerTaskManager +
			'}';
	}

	public static ClusterSpecification fromConfiguration(Configuration configuration) {
		int slots = configuration.getInteger(TaskManagerOptions.NUM_TASK_SLOTS, 1);

		int jobManagerMemoryMb = configuration.getInteger(JobManagerOptions.JOB_MANAGER_HEAP_MEMORY);
		int taskManagerMemoryMb = configuration.getInteger(TaskManagerOptions.TASK_MANAGER_HEAP_MEMORY);

		return new ClusterSpecificationBuilder()
			.setMasterMemoryMB(jobManagerMemoryMb)
			.setTaskManagerMemoryMB(taskManagerMemoryMb)
			.setNumberTaskManagers(1)
			.setSlotsPerTaskManager(slots)
			.createClusterSpecification();
	}

	/**
	 * Builder for the {@link ClusterSpecification} instance.
	 */
	public static class ClusterSpecificationBuilder {
		private int masterMemoryMB = 768;
		private int taskManagerMemoryMB = 768;
		private int numberTaskManagers = 1;
		private int slotsPerTaskManager = 1;

		public ClusterSpecificationBuilder setMasterMemoryMB(int masterMemoryMB) {
			this.masterMemoryMB = masterMemoryMB;
			return this;
		}

		public ClusterSpecificationBuilder setTaskManagerMemoryMB(int taskManagerMemoryMB) {
			this.taskManagerMemoryMB = taskManagerMemoryMB;
			return this;
		}

		public ClusterSpecificationBuilder setNumberTaskManagers(int numberTaskManagers) {
			this.numberTaskManagers = numberTaskManagers;
			return this;
		}

		public ClusterSpecificationBuilder setSlotsPerTaskManager(int slotsPerTaskManager) {
			this.slotsPerTaskManager = slotsPerTaskManager;
			return this;
		}

		public ClusterSpecification createClusterSpecification() {
			return new ClusterSpecification(
				masterMemoryMB,
				taskManagerMemoryMB,
				numberTaskManagers,
				slotsPerTaskManager);
		}
	}
}