Skip to content
This repository has been archived by the owner on Oct 23, 2024. It is now read-only.

Latest commit

 

History

History
259 lines (177 loc) · 7.57 KB

WebsiteApi.md

File metadata and controls

259 lines (177 loc) · 7.57 KB
Raw

\WebsiteApi

All URIs are relative to https://s3.eu-central-3.ionoscloud.com

Method HTTP request Description
DeleteBucketWebsite Delete /{Bucket}?website DeleteBucketWebsite
GetBucketWebsite Get /{Bucket}?website GetBucketWebsite
PutBucketWebsite Put /{Bucket}?website PutBucketWebsite

DeleteBucketWebsite

var result  = DeleteBucketWebsite(ctx, bucket)
                      .Execute()

DeleteBucketWebsite

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.WebsiteApi.DeleteBucketWebsite(context.Background(), bucket).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WebsiteApi.DeleteBucketWebsite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucket string

Other Parameters

Other parameters are passed through a pointer to an apiDeleteBucketWebsiteRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "WebsiteApiService.DeleteBucketWebsite" 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{
    "WebsiteApiService.DeleteBucketWebsite": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "WebsiteApiService.DeleteBucketWebsite": {
    "port": "8443",
},
})

GetBucketWebsite

var result GetBucketWebsiteOutput = GetBucketWebsite(ctx, bucket)
                      .Execute()

GetBucketWebsite

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.WebsiteApi.GetBucketWebsite(context.Background(), bucket).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WebsiteApi.GetBucketWebsite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `GetBucketWebsite`: GetBucketWebsiteOutput
    fmt.Fprintf(os.Stdout, "Response from `WebsiteApi.GetBucketWebsite`: %v\n", resource)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucket string

Other Parameters

Other parameters are passed through a pointer to an apiGetBucketWebsiteRequest struct via the builder pattern

Name Type Description Notes

Return type

GetBucketWebsiteOutput

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 "WebsiteApiService.GetBucketWebsite" 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{
    "WebsiteApiService.GetBucketWebsite": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "WebsiteApiService.GetBucketWebsite": {
    "port": "8443",
},
})

PutBucketWebsite

var result  = PutBucketWebsite(ctx, bucket)
                      .PutBucketWebsiteRequest(putBucketWebsiteRequest)
                      .ContentMD5(contentMD5)
                      .Execute()

PutBucketWebsite

Example

package main

import (
    "context"
    "fmt"
    "os"

    ionoscloud "github.com/ionos-cloud/sdk-go-s3"
)

func main() {
    bucket := "bucket_example" // string | 
    putBucketWebsiteRequest := *openapiclient.NewPutBucketWebsiteRequest() // PutBucketWebsiteRequest | 
    contentMD5 := "contentMD5_example" // string |  (optional)

    configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := ionoscloud.NewAPIClient(configuration)
    resource, resp, err := apiClient.WebsiteApi.PutBucketWebsite(context.Background(), bucket).PutBucketWebsiteRequest(putBucketWebsiteRequest).ContentMD5(contentMD5).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WebsiteApi.PutBucketWebsite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucket string

Other Parameters

Other parameters are passed through a pointer to an apiPutBucketWebsiteRequest struct via the builder pattern

Name Type Description Notes
putBucketWebsiteRequest PutBucketWebsiteRequest
contentMD5 string

Return type

(empty response body)

HTTP request headers

  • Content-Type: application/xml
  • Accept: Not defined

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "WebsiteApiService.PutBucketWebsite" 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{
    "WebsiteApiService.PutBucketWebsite": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "WebsiteApiService.PutBucketWebsite": {
    "port": "8443",
},
})