_BindRouteServiceInstanceRequest.java

/*
 * Copyright 2013-2017 the original author or authors.
 *
 * Licensed 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.cloudfoundry.operations.services;

import org.cloudfoundry.AllowNulls;
import org.cloudfoundry.Nullable;
import org.immutables.value.Value;

import java.util.Map;

/**
 * The request options for the bind service instance operation
 */
@Value.Immutable
abstract class _BindRouteServiceInstanceRequest {

    /**
     * The domain for the bound route
     */
    abstract String getDomainName();

    /**
     * The hostname for the bound route
     */
    @Nullable
    abstract String getHostname();

    /**
     * The parameters for the bound route
     */
    @AllowNulls
    @Nullable
    abstract Map<String, Object> getParameters();

    /**
     * The path for the bound route
     */
    @Nullable
    abstract String getPath();

    /**
     * The name of the service instance to bind
     */
    abstract String getServiceInstanceName();

}