ObjectLockApi
All URIs are relative to https://s3.eu-central-3.ionoscloud.com
GetObjectLegalHold
var result ObjectLegalHoldConfiguration = GetObjectLegalHold(ctx, bucket, key)
.VersionId(versionId)
.Execute()GetObjectLegalHold
Example
package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-s3"
)
func main() {
bucket := "bucket_example" // string |
key := "key_example" // string | The key name of the object whose Legal Hold status you want to retrieve.
versionId := "versionId_example" // string | The version ID of the object whose Legal Hold status you want to retrieve. (optional)
configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.ObjectLockApi.GetObjectLegalHold(context.Background(), bucket, key).VersionId(versionId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ObjectLockApi.GetObjectLegalHold``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `GetObjectLegalHold`: ObjectLegalHoldConfiguration
fmt.Fprintf(os.Stdout, "Response from `ObjectLockApi.GetObjectLegalHold`: %v\n", resource)
}Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
bucket
string
key
string
The key name of the object whose Legal Hold status you want to retrieve.
Other Parameters
Other parameters are passed through a pointer to an apiGetObjectLegalHoldRequest struct via the builder pattern
versionId
string
The version ID of the object whose Legal Hold status you want to retrieve.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/xml
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "ObjectLockApiService.GetObjectLegalHold" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
"ObjectLockApiService.GetObjectLegalHold": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
"ObjectLockApiService.GetObjectLegalHold": {
"port": "8443",
},
})GetObjectLockConfiguration
var result GetObjectLockConfigurationOutput = GetObjectLockConfiguration(ctx, bucket)
.Execute()GetObjectLockConfiguration
Example
package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-s3"
)
func main() {
bucket := "bucket_example" // string |
configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.ObjectLockApi.GetObjectLockConfiguration(context.Background(), bucket).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ObjectLockApi.GetObjectLockConfiguration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `GetObjectLockConfiguration`: GetObjectLockConfigurationOutput
fmt.Fprintf(os.Stdout, "Response from `ObjectLockApi.GetObjectLockConfiguration`: %v\n", resource)
}Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
bucket
string
Other Parameters
Other parameters are passed through a pointer to an apiGetObjectLockConfigurationRequest struct via the builder pattern
Return type
GetObjectLockConfigurationOutput
HTTP request headers
Content-Type: Not defined
Accept: application/xml
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "ObjectLockApiService.GetObjectLockConfiguration" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
"ObjectLockApiService.GetObjectLockConfiguration": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
"ObjectLockApiService.GetObjectLockConfiguration": {
"port": "8443",
},
})GetObjectRetention
var result ObjectLockRetention = GetObjectRetention(ctx, bucket, key)
.VersionId(versionId)
.Execute()GetObjectRetention
Example
package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-s3"
)
func main() {
bucket := "bucket_example" // string |
key := "key_example" // string | The key name of the object whose retention settings you want to retrieve.
versionId := "versionId_example" // string | The version ID of the object whose retention settings you want to retrieve. (optional)
configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.ObjectLockApi.GetObjectRetention(context.Background(), bucket, key).VersionId(versionId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ObjectLockApi.GetObjectRetention``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `GetObjectRetention`: ObjectLockRetention
fmt.Fprintf(os.Stdout, "Response from `ObjectLockApi.GetObjectRetention`: %v\n", resource)
}Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
bucket
string
key
string
The key name of the object whose retention settings you want to retrieve.
Other Parameters
Other parameters are passed through a pointer to an apiGetObjectRetentionRequest struct via the builder pattern
versionId
string
The version ID of the object whose retention settings you want to retrieve.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/xml
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "ObjectLockApiService.GetObjectRetention" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
"ObjectLockApiService.GetObjectRetention": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
"ObjectLockApiService.GetObjectRetention": {
"port": "8443",
},
})PutObjectLegalHold
var result = PutObjectLegalHold(ctx, bucket, key)
.ObjectLegalHoldConfiguration(objectLegalHoldConfiguration)
.VersionId(versionId)
.ContentMD5(contentMD5)
.Execute()PutObjectLegalHold
Example
package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-s3"
)
func main() {
bucket := "bucket_example" // string |
key := "key_example" // string | The key name of the object on which you want to place a Legal Hold.
objectLegalHoldConfiguration := *openapiclient.NewObjectLegalHoldConfiguration() // ObjectLegalHoldConfiguration |
versionId := "versionId_example" // string | The version ID of the object on which you want to place a Legal Hold. (optional)
contentMD5 := "contentMD5_example" // string | (optional)
configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.ObjectLockApi.PutObjectLegalHold(context.Background(), bucket, key).ObjectLegalHoldConfiguration(objectLegalHoldConfiguration).VersionId(versionId).ContentMD5(contentMD5).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ObjectLockApi.PutObjectLegalHold``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
}Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
bucket
string
key
string
The key name of the object on which you want to place a Legal Hold.
Other Parameters
Other parameters are passed through a pointer to an apiPutObjectLegalHoldRequest struct via the builder pattern
versionId
string
The version ID of the object on which you want to place a Legal Hold.
contentMD5
string
Return type
(empty response body)
HTTP request headers
Content-Type: application/xml
Accept: application/xml
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "ObjectLockApiService.PutObjectLegalHold" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
"ObjectLockApiService.PutObjectLegalHold": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
"ObjectLockApiService.PutObjectLegalHold": {
"port": "8443",
},
})PutObjectLockConfiguration
var result = PutObjectLockConfiguration(ctx, bucket)
.ContentMD5(contentMD5)
.PutObjectLockConfigurationRequest(putObjectLockConfigurationRequest)
.Execute()PutObjectLockConfiguration
Example
package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-s3"
)
func main() {
bucket := "bucket_example" // string |
contentMD5 := "contentMD5_example" // string |
putObjectLockConfigurationRequest := *openapiclient.NewPutObjectLockConfigurationRequest() // PutObjectLockConfigurationRequest |
configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.ObjectLockApi.PutObjectLockConfiguration(context.Background(), bucket).ContentMD5(contentMD5).PutObjectLockConfigurationRequest(putObjectLockConfigurationRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ObjectLockApi.PutObjectLockConfiguration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
}Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
bucket
string
Other Parameters
Other parameters are passed through a pointer to an apiPutObjectLockConfigurationRequest struct via the builder pattern
contentMD5
string
Return type
(empty response body)
HTTP request headers
Content-Type: application/xml
Accept: application/xml
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "ObjectLockApiService.PutObjectLockConfiguration" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
"ObjectLockApiService.PutObjectLockConfiguration": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
"ObjectLockApiService.PutObjectLockConfiguration": {
"port": "8443",
},
})PutObjectRetention
var result = PutObjectRetention(ctx, bucket, key)
.PutObjectRetentionRequest(putObjectRetentionRequest)
.VersionId(versionId)
.XAmzBypassGovernanceRetention(xAmzBypassGovernanceRetention)
.ContentMD5(contentMD5)
.Execute()PutObjectRetention
Example
package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-s3"
)
func main() {
bucket := "bucket_example" // string |
key := "key_example" // string | The key name of the object to which you want to apply the Object Retention configuration.
putObjectRetentionRequest := *openapiclient.NewPutObjectRetentionRequest() // PutObjectRetentionRequest |
versionId := "versionId_example" // string | The version ID of the object to which you want to apply the Object Retention configuration. (optional)
xAmzBypassGovernanceRetention := true // bool | Indicates whether this operation should bypass Governance mode's restrictions. (optional) (default to false)
contentMD5 := "contentMD5_example" // string | (optional)
configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.ObjectLockApi.PutObjectRetention(context.Background(), bucket, key).PutObjectRetentionRequest(putObjectRetentionRequest).VersionId(versionId).XAmzBypassGovernanceRetention(xAmzBypassGovernanceRetention).ContentMD5(contentMD5).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ObjectLockApi.PutObjectRetention``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
}Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
bucket
string
key
string
The key name of the object to which you want to apply the Object Retention configuration.
Other Parameters
Other parameters are passed through a pointer to an apiPutObjectRetentionRequest struct via the builder pattern
versionId
string
The version ID of the object to which you want to apply the Object Retention configuration.
xAmzBypassGovernanceRetention
bool
Indicates whether this operation should bypass Governance mode's restrictions.
[default to false]
contentMD5
string
Return type
(empty response body)
HTTP request headers
Content-Type: application/xml
Accept: application/xml
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "ObjectLockApiService.PutObjectRetention" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
"ObjectLockApiService.PutObjectRetention": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
"ObjectLockApiService.PutObjectRetention": {
"port": "8443",
},
})Last updated