com.ibm.cloud.objectstorage.config.resource_configuration.v1

Class ResourceConfiguration

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.cloud.objectstorage.config.resource_configuration.v1.ResourceConfiguration

public class ResourceConfiguration
extends com.ibm.cloud.sdk.core.service.BaseService

REST API used to configure Cloud Object Storage buckets. API Version: 2.0.1

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SERVICE_NAME Default service name used when configuring the `ResourceConfiguration` client.
static java.lang.String	DEFAULT_SERVICE_URL Default service endpoint URL.

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
ResourceConfiguration(java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `ResourceConfiguration` client.

Method Summary

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<Bucket>	getBucketConfig(GetBucketConfigOptions getBucketConfigOptions) Returns metadata for the specified bucket.
static ResourceConfiguration	newInstance() Class method which constructs an instance of the `ResourceConfiguration` client.
static ResourceConfiguration	newInstance(java.lang.String serviceName) Class method which constructs an instance of the `ResourceConfiguration` client.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	updateBucketConfig(UpdateBucketConfigOptions updateBucketConfigOptions) Make changes to a bucket's configuration.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureHttpClient, configureService, constructServiceUrl, constructServiceURL, createServiceCall, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getDefaultHeaders, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, processServiceCall, setAuthentication, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final java.lang.String DEFAULT_SERVICE_NAME

Default service name used when configuring the `ResourceConfiguration` client.

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final java.lang.String DEFAULT_SERVICE_URL

Default service endpoint URL.

See Also:

Constant Field Values

Constructor Detail

ResourceConfiguration

public ResourceConfiguration(java.lang.String serviceName,
                             com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `ResourceConfiguration` client. The specified service name and authenticator are used to configure the client instance.

Parameters:

serviceName - the service name to be used when configuring the client instance

authenticator - the Authenticator instance to be configured for this client

Method Detail

newInstance

public static ResourceConfiguration newInstance()

Class method which constructs an instance of the `ResourceConfiguration` client. The default service name is used to configure the client instance.

Returns:

an instance of the `ResourceConfiguration` client using external configuration

newInstance

public static ResourceConfiguration newInstance(java.lang.String serviceName)

Class method which constructs an instance of the `ResourceConfiguration` client. The specified service name is used to configure the client instance.

Parameters:

serviceName - the service name to be used when configuring the client instance

Returns:

an instance of the `ResourceConfiguration` client using external configuration

getBucketConfig

public com.ibm.cloud.sdk.core.http.ServiceCall<Bucket> getBucketConfig(GetBucketConfigOptions getBucketConfigOptions)

Returns metadata for the specified bucket. Returns metadata for the specified bucket.

Parameters:

getBucketConfigOptions - the GetBucketConfigOptions containing the options for the call

Returns:

a ServiceCall with a result of type Bucket

updateBucketConfig

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> updateBucketConfig(UpdateBucketConfigOptions updateBucketConfigOptions)

Make changes to a bucket's configuration. Updates a bucket using [JSON Merge Patch](https://tools.ietf.org/html/rfc7396). This request is used to add functionality (like an IP access filter) or to update existing parameters. **Primitives are overwritten and replaced in their entirety. It is not possible to append a new (or to delete a specific) value to an array.** Arrays can be cleared by updating the parameter with an empty array `[]`. A `PATCH` operation only updates specified mutable fields. Please don't use `PATCH` trying to update the number of objects in a bucket, any timestamps, or other non-mutable fields.

Parameters:

updateBucketConfigOptions - the UpdateBucketConfigOptions containing the options for the call

Returns:

a ServiceCall with a void result