com.ibm.cos.v2.regions

Interface ServiceMetadata

All Known Implementing Classes:

DefaultServiceMetadata, EnhancedS3ServiceMetadata, S3ControlServiceMetadata, S3OutpostsServiceMetadata, S3ServiceMetadata

public interface ServiceMetadata

Metadata about a service, like S3, DynamoDB, etc.

This is useful for building meta-functionality around AWS services. For example, UIs that list the available regions for a service would use the regions() method for a service.

This is usually created by calling the serviceMetadata method on the service client's interface, but can also be created by calling the of(String) method and providing the service's unique endpoint prefix.

Method Summary

Modifier and Type	Method and Description
default URI	endpointFor(Region region) Retrieve the AWS endpoint that should be used for this service in the provided region, if no EndpointTags are desired.
default URI	endpointFor(ServiceEndpointKey key) Retrieve the AWS endpoint that should be used for this service associated with the provided ServiceEndpointKey.
static ServiceMetadata	of(String serviceEndpointPrefix) Load the service metadata for the provided service endpoint prefix.
default ServiceMetadata	reconfigure(Consumer<ServiceMetadataConfiguration.Builder> consumer) Reconfigure this service metadata using the provided ServiceMetadataConfiguration.
default ServiceMetadata	reconfigure(ServiceMetadataConfiguration configuration) Reconfigure this service metadata using the provided ServiceMetadataConfiguration.
List<Region>	regions() Retrieve the list of regions this service is currently available in.
List<ServicePartitionMetadata>	servicePartitions() Retrieve the service-specific partition configuration of each partition in which this service is currently available.
default Region	signingRegion(Region region) Retrieve the region that should be used for message signing when communicating with this service in the provided region.
default Region	signingRegion(ServiceEndpointKey key) Retrieve the region that should be used for message signing when communicating with this service in the provided region and with the provided endpoint tags.

Method Detail

endpointFor

default URI endpointFor(Region region)

Retrieve the AWS endpoint that should be used for this service in the provided region, if no EndpointTags are desired.

Parameters:

region - The region that should be used to load the service endpoint.

Returns:

The region-specific endpoint for this service.

Throws:

RuntimeException - if an endpoint cannot be determined.

endpointFor

default URI endpointFor(ServiceEndpointKey key)

Retrieve the AWS endpoint that should be used for this service associated with the provided ServiceEndpointKey.

Parameters:

key - The service endpoint key with which an endpoint should be retrieved.

Returns:

The region-specific endpoint for this service.

Throws:

RuntimeException - if an endpoint cannot be determined.

signingRegion

default Region signingRegion(Region region)

Retrieve the region that should be used for message signing when communicating with this service in the provided region. For most services, this will match the provided region, but it may differ for unusual services or when using a region that does not correspond to a physical location, like Region.AWS_GLOBAL.

Parameters:

region - The region from which the signing region should be derived.

Returns:

The region that should be used for signing messages when communicating with this service in the requested region.

signingRegion

default Region signingRegion(ServiceEndpointKey key)

Retrieve the region that should be used for message signing when communicating with this service in the provided region and with the provided endpoint tags. For most services, this will match the provided region, but it may differ for unusual services or when using a region that does not correspond to a physical location, like Region.AWS_GLOBAL.

Parameters:

key - The service endpoint key with which an endpoint should be retrieved.

Returns:

The region that should be used for signing messages when communicating with this service in the requested region.

regions

List<Region> regions()

Retrieve the list of regions this service is currently available in.

Returns:

The list of regions this service is currently available in.

servicePartitions

List<ServicePartitionMetadata> servicePartitions()

Retrieve the service-specific partition configuration of each partition in which this service is currently available.

Returns:

The list of service-specific service metadata for each partition in which this service is available.

of

static ServiceMetadata of(String serviceEndpointPrefix)

Load the service metadata for the provided service endpoint prefix. This should only be used when you do not wish to have a dependency on the service for which you are retrieving the metadata. When you have a dependency on the service client, the metadata should instead be loaded using the service client's serviceMetadata() method.

Parameters:

serviceEndpointPrefix - The service-specific endpoint prefix of the service about which you wish to load metadata.

Returns:

The service metadata for the requested service.

reconfigure

default ServiceMetadata reconfigure(ServiceMetadataConfiguration configuration)

Reconfigure this service metadata using the provided ServiceMetadataConfiguration. This is useful, because some service metadata instances refer to external configuration that might wish to be modified, like a ProfileFile.

reconfigure

default ServiceMetadata reconfigure(Consumer<ServiceMetadataConfiguration.Builder> consumer)

Reconfigure this service metadata using the provided ServiceMetadataConfiguration. This is useful, because some service metadata instances refer to external configuration that might wish to be modified, like a ProfileFile. This is a shorthand form of reconfigure(ServiceMetadataConfiguration), without the need to call builder() or build().