Top Description Fields Constructors Methods
com.oracle.bmc.internal

public Class DefaultEndpointConfiguration

extends Object
Class Inheritance
Imports
jakarta.annotation.Nonnull

DefaultEndpointConfiguration provides a way to construct the host endpoint for a service given a template and some variables based on the default Oracle Cloud Infrastructure naming convention.

The available variables are: - {serviceEndpointPrefix} : The service prefix in the URL. - {region} : The public region id, ex, "us-phoenix-1". - {secondLevelDomain} : The second level domain associated with the Realm.

Field Summary

Modifier and TypeField and Description
private static final String
private String
private final String
private static final String
private String
private static final String
private String
private static final String
private String

Constructor Summary

AccessConstructor and Description
private
DefaultEndpointConfiguration(final String endpointTemplate)

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The endpoint.
build
()

Builds the final endpoint based on the variables provided.

public static DefaultEndpointConfiguration

Returns:

A new builder.
builder
(String
The template
endpointTemplate
)

Creates a new builder starting with the given template.

public DefaultEndpointConfiguration

Returns:

This builder
endpointServiceName
(String
The endpoint service name.
endpointServiceName
)

Sets the endpoint service name, if one.

public DefaultEndpointConfiguration

Returns:

This builder
regionId
(String
The region id.
regionId
)

Sets the regionId, if one.

public DefaultEndpointConfiguration

Returns:

This builder
secondLevelDomain
(String
The second level domain of the Realm.
secondLevelDomain
)

Sets the second level domain, if one.

public DefaultEndpointConfiguration

Returns:

This builder
serviceEndpointPrefix
(String
The service endpoint prefix.
serviceEndpointPrefix
)

Sets the service endpoint prefix, if one.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ENDPOINT_SERVICE_NAME_TEMPLATEback to summary
private static final String ENDPOINT_SERVICE_NAME_TEMPLATE
endpointServiceNameback to summary
private String endpointServiceName
endpointTemplateback to summary
private final String endpointTemplate
REGION_ID_TEMPLATEback to summary
private static final String REGION_ID_TEMPLATE
regionIdback to summary
private String regionId
SECOND_LEVEL_DOMAIN_TEMPLATEback to summary
private static final String SECOND_LEVEL_DOMAIN_TEMPLATE
secondLevelDomainback to summary
private String secondLevelDomain
SERVICE_ENDPOINT_PREFIX_TEMPLATEback to summary
private static final String SERVICE_ENDPOINT_PREFIX_TEMPLATE
serviceEndpointPrefixback to summary
private String serviceEndpointPrefix

Constructor Detail

DefaultEndpointConfigurationback to summary
private DefaultEndpointConfiguration(final String endpointTemplate)
Annotations
@java.beans.ConstructorProperties

Method Detail

buildback to summary
public String build()

Builds the final endpoint based on the variables provided.

Returns:String

The endpoint.

builderback to summary
public static DefaultEndpointConfiguration builder(String endpointTemplate)

Creates a new builder starting with the given template.

Parameters
endpointTemplate:String

The template

Returns:DefaultEndpointConfiguration

A new builder.

endpointServiceNameback to summary
public DefaultEndpointConfiguration endpointServiceName(String endpointServiceName)

Sets the endpoint service name, if one.

Parameters
endpointServiceName:String

The endpoint service name.

Returns:DefaultEndpointConfiguration

This builder

regionIdback to summary
public DefaultEndpointConfiguration regionId(String regionId)

Sets the regionId, if one.

Parameters
regionId:String

The region id.

Returns:DefaultEndpointConfiguration

This builder

secondLevelDomainback to summary
public DefaultEndpointConfiguration secondLevelDomain(String secondLevelDomain)

Sets the second level domain, if one.

Parameters
secondLevelDomain:String

The second level domain of the Realm.

Returns:DefaultEndpointConfiguration

This builder

serviceEndpointPrefixback to summary
public DefaultEndpointConfiguration serviceEndpointPrefix(String serviceEndpointPrefix)

Sets the service endpoint prefix, if one.

Parameters
serviceEndpointPrefix:String

The service endpoint prefix.

Returns:DefaultEndpointConfiguration

This builder