commonMain.aws.sdk.kotlin.services.finspace.FinspaceClient.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.finspace
import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.manage
import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig
import aws.sdk.kotlin.runtime.config.AbstractAwsSdkClientFactory
import aws.sdk.kotlin.runtime.http.retries.AwsDefaultRetryPolicy
import aws.sdk.kotlin.services.finspace.endpoints.DefaultEndpointProvider
import aws.sdk.kotlin.services.finspace.endpoints.EndpointParameters
import aws.sdk.kotlin.services.finspace.endpoints.EndpointProvider
import aws.sdk.kotlin.services.finspace.model.CreateEnvironmentRequest
import aws.sdk.kotlin.services.finspace.model.CreateEnvironmentResponse
import aws.sdk.kotlin.services.finspace.model.DeleteEnvironmentRequest
import aws.sdk.kotlin.services.finspace.model.DeleteEnvironmentResponse
import aws.sdk.kotlin.services.finspace.model.GetEnvironmentRequest
import aws.sdk.kotlin.services.finspace.model.GetEnvironmentResponse
import aws.sdk.kotlin.services.finspace.model.ListEnvironmentsRequest
import aws.sdk.kotlin.services.finspace.model.ListEnvironmentsResponse
import aws.sdk.kotlin.services.finspace.model.ListTagsForResourceRequest
import aws.sdk.kotlin.services.finspace.model.ListTagsForResourceResponse
import aws.sdk.kotlin.services.finspace.model.TagResourceRequest
import aws.sdk.kotlin.services.finspace.model.TagResourceResponse
import aws.sdk.kotlin.services.finspace.model.UntagResourceRequest
import aws.sdk.kotlin.services.finspace.model.UntagResourceResponse
import aws.sdk.kotlin.services.finspace.model.UpdateEnvironmentRequest
import aws.sdk.kotlin.services.finspace.model.UpdateEnvironmentResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.client.SdkClientFactory
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.auth.HttpAuthScheme
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpEngineConfig
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpEngineConfigImpl
import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
import aws.smithy.kotlin.runtime.net.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.StandardRetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.tracing.DefaultTracer
import aws.smithy.kotlin.runtime.tracing.LoggingTraceProbe
import aws.smithy.kotlin.runtime.tracing.Tracer
import aws.smithy.kotlin.runtime.tracing.TracingClientConfig
import kotlin.collections.List
import kotlin.jvm.JvmStatic
/**
* The FinSpace management service provides the APIs for managing FinSpace environments.
*/
public interface FinspaceClient : SdkClient {
/**
* FinspaceClient's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory() {
@JvmStatic
override fun builder(): Builder = Builder()
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): FinspaceClient = DefaultFinspaceClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), SdkClientConfig, TracingClientConfig {
override val clientName: String = builder.clientName
override val region: String = requireNotNull(builder.region) { "region is a required configuration property" }
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: EndpointProvider = builder.endpointProvider ?: DefaultEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsDefaultRetryPolicy
override val retryStrategy: RetryStrategy = builder.retryStrategy ?: StandardRetryStrategy()
override val tracer: Tracer = builder.tracer ?: DefaultTracer(LoggingTraceProbe, clientName)
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
public companion object {
public inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
}
public fun toBuilder(): Builder = Builder().apply {
clientName = [email protected]
region = [email protected]
authSchemes = [email protected]
credentialsProvider = [email protected]
endpointProvider = [email protected]
endpointUrl = [email protected]
httpClient = [email protected]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
tracer = [email protected]
useDualStack = [email protected]
useFips = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TracingClientConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "finspace"
/**
* The AWS region (e.g. `us-west-2`) to make requests to. See about AWS
* [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more
* information
*/
override var region: String? = null
/**
* Register new or override default [HttpAuthScheme]s configured for this client. By default, the set
* of auth schemes configured comes from the service model. An auth scheme configured explicitly takes
* precedence over the defaults and can be used to customize identity resolution and signing for specific
* authentication schemes.
*/
override var authSchemes: kotlin.collections.List = emptyList()
/**
* The AWS credentials provider to use for authenticating requests. If not provided a
* [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used.
* NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK
* client will not close it when the client is closed.
*/
override var credentialsProvider: CredentialsProvider? = null
/**
* The endpoint provider used to determine where to make service requests. **This is an advanced config
* option.**
*
* Endpoint resolution occurs as part of the workflow for every request made via the service client.
*
* The inputs to endpoint resolution are defined on a per-service basis (see [EndpointParameters]).
*/
public var endpointProvider: EndpointProvider? = null
/**
* A custom endpoint to route requests to. The endpoint set here is passed to the configured
* [endpointProvider], which may inspect and modify it as needed.
*
* Setting a custom endpointUrl should generally be preferred to overriding the [endpointProvider] and is
* the recommended way to route requests to development or preview instances of a service.
*
* **This is an advanced config option.**
*/
public var endpointUrl: Url? = null
/**
* Add an [aws.smithy.kotlin.runtime.client.Interceptor] that will have access to read and modify
* the request and response objects as they are processed by the SDK.
* Interceptors added using this method are executed in the order they are configured and are always
* later than any added automatically by the SDK.
*/
override var interceptors: kotlin.collections.MutableList = kotlin.collections.mutableListOf()
/**
* Configure events that will be logged. By default clients will not output
* raw requests or responses. Use this setting to opt-in to additional debug logging.
*
* This can be used to configure logging of requests, responses, retries, etc of SDK clients.
*
* **NOTE**: Logging of raw requests or responses may leak sensitive information! It may also have
* performance considerations when dumping the request/response body. This is primarily a tool for
* debug purposes.
*/
override var logMode: LogMode? = null
/**
* The policy to use for evaluating operation results and determining whether/how to retry.
*/
override var retryPolicy: RetryPolicy? = null
/**
* The [RetryStrategy] implementation to use for service calls. All API calls will be wrapped by the
* strategy.
*/
override var retryStrategy: RetryStrategy? = null
/**
* The tracer that is responsible for creating trace spans and wiring them up to a tracing backend (e.g.,
* a trace probe). By default, this will create a standard tracer that uses the service name for the root
* trace span and delegates to a logging trace probe (i.e.,
* `DefaultTracer(LoggingTraceProbe, "")`).
*/
override var tracer: Tracer? = null
/**
* Flag to toggle whether to use dual-stack endpoints when making requests.
* See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information.
* ` Disabled by default.
*/
override var useDualStack: Boolean? = null
/**
* Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests.
* ` Disabled by default.
*/
override var useFips: Boolean? = null
override fun build(): Config = Config(this)
}
}
/**
* Create a new FinSpace environment.
*/
public suspend fun createEnvironment(input: CreateEnvironmentRequest): CreateEnvironmentResponse
/**
* Delete an FinSpace environment.
*/
public suspend fun deleteEnvironment(input: DeleteEnvironmentRequest): DeleteEnvironmentResponse
/**
* Returns the FinSpace environment object.
*/
public suspend fun getEnvironment(input: GetEnvironmentRequest): GetEnvironmentResponse
/**
* A list of all of your FinSpace environments.
*/
public suspend fun listEnvironments(input: ListEnvironmentsRequest = ListEnvironmentsRequest {}): ListEnvironmentsResponse
/**
* A list of all tags for a resource.
*/
public suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse
/**
* Adds metadata tags to a FinSpace resource.
*/
public suspend fun tagResource(input: TagResourceRequest): TagResourceResponse
/**
* Removes metadata tags from a FinSpace resource.
*/
public suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse
/**
* Update your FinSpace environment.
*/
public suspend fun updateEnvironment(input: UpdateEnvironmentRequest): UpdateEnvironmentResponse
}
/**
* Create a copy of the client with one or more configuration values overridden.
* This method allows the caller to perform scoped config overrides for one or more client operations.
*
* Any resources created on your behalf will be shared between clients, and will only be closed when ALL clients using them are closed.
* If you provide a resource (e.g. [HttpClientEngine]) to the SDK, you are responsible for managing the lifetime of that resource.
*/
public fun FinspaceClient.withConfig(block: FinspaceClient.Config.Builder.() -> Unit): FinspaceClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultFinspaceClient(newConfig)
}
/**
* Create a new FinSpace environment.
*/
public suspend inline fun FinspaceClient.createEnvironment(crossinline block: CreateEnvironmentRequest.Builder.() -> Unit): CreateEnvironmentResponse = createEnvironment(CreateEnvironmentRequest.Builder().apply(block).build())
/**
* Delete an FinSpace environment.
*/
public suspend inline fun FinspaceClient.deleteEnvironment(crossinline block: DeleteEnvironmentRequest.Builder.() -> Unit): DeleteEnvironmentResponse = deleteEnvironment(DeleteEnvironmentRequest.Builder().apply(block).build())
/**
* Returns the FinSpace environment object.
*/
public suspend inline fun FinspaceClient.getEnvironment(crossinline block: GetEnvironmentRequest.Builder.() -> Unit): GetEnvironmentResponse = getEnvironment(GetEnvironmentRequest.Builder().apply(block).build())
/**
* A list of all of your FinSpace environments.
*/
public suspend inline fun FinspaceClient.listEnvironments(crossinline block: ListEnvironmentsRequest.Builder.() -> Unit): ListEnvironmentsResponse = listEnvironments(ListEnvironmentsRequest.Builder().apply(block).build())
/**
* A list of all tags for a resource.
*/
public suspend inline fun FinspaceClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse = listTagsForResource(ListTagsForResourceRequest.Builder().apply(block).build())
/**
* Adds metadata tags to a FinSpace resource.
*/
public suspend inline fun FinspaceClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse = tagResource(TagResourceRequest.Builder().apply(block).build())
/**
* Removes metadata tags from a FinSpace resource.
*/
public suspend inline fun FinspaceClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse = untagResource(UntagResourceRequest.Builder().apply(block).build())
/**
* Update your FinSpace environment.
*/
public suspend inline fun FinspaceClient.updateEnvironment(crossinline block: UpdateEnvironmentRequest.Builder.() -> Unit): UpdateEnvironmentResponse = updateEnvironment(UpdateEnvironmentRequest.Builder().apply(block).build())
© 2015 - 2025 Weber Informatics LLC | Privacy Policy