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. This version of the API only supports reading bucket metadata and setting IP access controls.

Version:

v1

See Also:

ResourceConfiguration

Field Summary

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

JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN

Constructor Summary

Constructors

Constructor and Description
ResourceConfiguration() Instantiates a new `ResourceConfiguration`.
ResourceConfiguration(com.ibm.cloud.sdk.core.service.security.IamOptions iamOptions) Instantiates a new `ResourceConfiguration` with IAM.

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.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	updateBucketConfig(UpdateBucketConfigOptions updateBucketConfigOptions) Make changes to a bucket's configuration.

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

configureClient, configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getUsername, isJsonMimeType, isJsonPatchMimeType, isTokenManagerSet, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setIamCredentials, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceConfiguration

public ResourceConfiguration()

Instantiates a new `ResourceConfiguration`.

ResourceConfiguration

public ResourceConfiguration(com.ibm.cloud.sdk.core.service.security.IamOptions iamOptions)

Instantiates a new `ResourceConfiguration` with IAM. Note that if the access token is specified in the iamOptions, you accept responsibility for managing the access token yourself. You must set a new access token before this one expires or after receiving a 401 error from the service. Failing to do so will result in authentication errors after this token expires.

Parameters:

iamOptions - the options for authenticating through IAM

Method Detail

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 response type of Bucket

updateBucketConfig

public com.ibm.cloud.sdk.core.http.ServiceCall<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 `[]`. 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 response type of Void