com.oracle.bmc.Service Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oci-java-sdk-shaded-full Show documentation

This project contains the SDK distribution used for Oracle Cloud Infrastructure, and all the dependencies that can be shaded. It also has Maven dependencies that cannot be shaded. Therefore, use this module to depend on the shaded distribution via Maven -- it will shade everything that can be shaded, and automatically pull in the other dependencies.

There is a newer version: 3.55.2

Show newest version

/**
 * Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
 * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 */
package com.oracle.bmc;

import java.util.Map;

/**
 * Interface representing a service definition.
 *
 * See {@link Services} to create new instances.
 */
@InternalSdk
public interface Service {

    /** The unique service name, ex "BLOCKSTORAGE". Must not be null. */
    String getServiceName();

    /**
     * The service endpoint prefix that will be used, ex "iaas" for
     * "https://iaas.us-phoenix-1.oraclecloud.com".
     */
    String getServiceEndpointPrefix();

    /**
     * The service endpoint template that will be used, ex
     * "{serviceEndpointPrefix}.{region}.service.oci.oraclecloud.com".
     *
     * 
This overrides the template used in {@link DefaultEndpointConfiguration}, but can still
     * use the same variables.
     */
    String getServiceEndpointTemplate();

    /**
     * The map of all realm-specific service endpoint templates with realmId as key and endpoint
     * template for corresponding realmId as the value ex
     * "oc1={serviceParameter}{serviceEndpointPrefix}.{region}.{serviceSecondLevelDomain}".
     *
     * This overrides the template used in {@link DefaultEndpointConfiguration}, but can still
     * use the same variables.
     */
    Map getServiceEndpointTemplateForRealmMap();

    /**
     * This method adds service endpoint templates for the realm to a map
     *
     * @param realmId Key in the map
     * @param endpoint Value in the map
     */
    void addServiceEndpointTemplateForRealm(String realmId, String endpoint);

    /**
     * The service endpoint name that will be used only for dotted regions if set by the service.
     * {service} in "https://{service}.{region}". The service endpoint template (if specified) will
     * be ignored in this case.
     */
    String getEndpointServiceName();
}