com.aliyun.odps.table.enviroment.EnvironmentSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of odps-sdk-table-api Show documentation
The newest version!
/*
 * 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 com.aliyun.odps.table.enviroment;

import java.util.List;
import java.util.Optional;

import com.aliyun.odps.table.configuration.RestOptions;
import com.aliyun.odps.table.utils.Preconditions;

/**
 * Environment settings for table read/write
 */
public class EnvironmentSettings {

    private final ExecutionMode executionMode;

    private final String quotaName;
    private final String sharingQuotaToken;
    private final List tags;

    private final Credentials credentials;

    private final String defaultProject;

    private final String defaultSchema;

    private final String serviceEndpoint;

    private final String tunnelEndpoint;

    private final RestOptions restOptions;

    private final Long slotNum;

    // TODO: Environment Credentials

    private EnvironmentSettings(Builder builder) {
        this.executionMode = builder.executionMode;
        this.quotaName = builder.quotaName;
        this.sharingQuotaToken = builder.sharingQuotaToken;
        this.tags = builder.tags;
        this.credentials = builder.credentials;
        this.defaultProject = builder.defaultProject;
        this.defaultSchema = builder.defaultSchema;
        this.serviceEndpoint = builder.serviceEndPoint;
        this.tunnelEndpoint = builder.tunnelEndpoint;
        this.restOptions = builder.restOptions;
        this.slotNum = builder.slotNum;
    }

    public ExecutionMode getExecutionMode() {
        return executionMode;
    }

    public Credentials getCredentials() {
        return credentials;
    }

    public Optional getQuotaName() {
        return Optional.ofNullable(quotaName);
    }

    public Optional getSharingQuotaToken() {
        return Optional.ofNullable(sharingQuotaToken);
    }

    public Optional> getTags() {
        return Optional.ofNullable(tags);
    }

    public Optional getDefaultProject() {
        return Optional.ofNullable(defaultProject);
    }

    public Optional getDefaultSchema() {
        return Optional.ofNullable(defaultSchema);
    }

    public Optional getServiceEndpoint() {
        return Optional.ofNullable(serviceEndpoint);
    }

    public Optional getTunnelEndpoint() {
        return Optional.ofNullable(tunnelEndpoint);
    }

    public Optional getRestOptions() {
        return Optional.ofNullable(restOptions);
    }

    public Optional getSlotNum() {
        return Optional.ofNullable(slotNum);
    }

    public static Builder newBuilder() {
        return new Builder();
    }

    public enum ExecutionMode {
        REMOTE,
        LOCAL,
        AUTOMATIC
    }

    public static class Builder {
        private ExecutionMode executionMode = ExecutionMode.AUTOMATIC;
        private Credentials credentials;
        private String defaultProject;
        private String defaultSchema;
        private String quotaName;
        private String sharingQuotaToken;
        private List tags;
        private String serviceEndPoint;
        private String tunnelEndpoint;
        private RestOptions restOptions;
        private Long slotNum;

        public Builder inLocalMode() {
            this.executionMode = ExecutionMode.LOCAL;
            return this;
        }

        public Builder inRemoteMode() {
            this.executionMode = ExecutionMode.REMOTE;
            return this;
        }

        public Builder inAutoMode() {
            this.executionMode = ExecutionMode.AUTOMATIC;
            return this;
        }

        public Builder withCredentials(Credentials credentials) {
            Preconditions.checkNotNull(credentials, "Credentials");
            this.credentials = credentials;
            return this;
        }

        public Builder withDefaultProject(String projectName) {
            Preconditions.checkString(projectName, "Project");
            this.defaultProject = projectName;
            return this;
        }

        public Builder withDefaultSchema(String schema) {
            Preconditions.checkString(schema, "Schema");
            this.defaultSchema = schema;
            return this;
        }

        public Builder withServiceEndpoint(String endPoint) {
            Preconditions.checkString(endPoint, "End point");
            this.serviceEndPoint = endPoint;
            return this;
        }

        public Builder withTunnelEndpoint(String endPoint) {
            Preconditions.checkString(endPoint, "Tunnel end point");
            this.tunnelEndpoint = endPoint;
            return this;
        }

        public Builder withQuotaName(String quotaName) {
            this.quotaName = quotaName;
            return this;
        }
        public Builder withSharingQuotaToken(String sharingQuotaToken) {
            this.sharingQuotaToken = sharingQuotaToken;
            return this;
        }

        public Builder withTags(List tags) {
            this.tags = tags;
            return this;
        }

        public Builder withRestOptions(RestOptions restOptions) {
            Preconditions.checkNotNull(restOptions, "Rest Options");
            this.restOptions = restOptions;
            return this;
        }

        public Builder withSlotNum(Long slotNum) {
            Preconditions.checkLong(slotNum, 1, "Slot num");
            this.slotNum = slotNum;
            return this;
        }

        public EnvironmentSettings build() {
            Preconditions.checkNotNull(credentials,
                    "Credentials", "required");
            return new EnvironmentSettings(this);
        }
    }
}