Skip to content

Commit

Permalink
fix(object): change name from S3 to Object Storage (#2283)
Browse files Browse the repository at this point in the history
  • Loading branch information
scaleway-bot authored Oct 29, 2024
1 parent 2a48843 commit 0f78995
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion api/documentdb/v1beta1/documentdb_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -1270,7 +1270,7 @@ type ListInstanceLogsDetailsResponseInstanceLogDetail struct {

// InstanceLog: instance log.
type InstanceLog struct {
// DownloadURL: presigned S3 URL to download your log file.
// DownloadURL: presigned Object Storage URL to download your log file.
DownloadURL *string `json:"download_url"`

// ID: UUID of the Database Instance log.
Expand Down
6 changes: 3 additions & 3 deletions api/inference/v1beta1/inference_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ type Model struct {
// Description: purpose of the model.
Description string `json:"description"`

// HasEula: defines whether the model has an end user licence agreement.
// HasEula: defines whether the model has an end user license agreement.
HasEula bool `json:"has_eula"`

// CreatedAt: creation date of the model.
Expand All @@ -384,7 +384,7 @@ type Model struct {
// Region: region of the model.
Region scw.Region `json:"region"`

// S3Model: s3 URL pointing to the model source weight.
// S3Model: object Storage URL pointing to the model source weight.
// Precisely one of S3Model must be set.
S3Model *ModelS3Model `json:"s3_model,omitempty"`

Expand Down Expand Up @@ -531,7 +531,7 @@ type DeleteEndpointRequest struct {

// Eula: eula.
type Eula struct {
// Content: content of the end user licence agreement.
// Content: content of the end user license agreement.
Content string `json:"content"`
}

Expand Down
6 changes: 3 additions & 3 deletions api/instance/v1/instance_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -2581,10 +2581,10 @@ type ExportSnapshotRequest struct {
// SnapshotID: snapshot ID.
SnapshotID string `json:"-"`

// Bucket: s3 bucket name.
// Bucket: object Storage bucket name.
Bucket string `json:"bucket,omitempty"`

// Key: s3 object key.
// Key: object key.
Key string `json:"key,omitempty"`
}

Expand Down Expand Up @@ -5122,7 +5122,7 @@ func (s *API) DeleteSnapshot(req *DeleteSnapshotRequest, opts ...scw.RequestOpti
return nil
}

// ExportSnapshot: Export a snapshot to a specified S3 bucket in the same region.
// ExportSnapshot: Export a snapshot to a specified Object Storage bucket in the same region.
func (s *API) ExportSnapshot(req *ExportSnapshotRequest, opts ...scw.RequestOption) (*ExportSnapshotResponse, error) {
var err error

Expand Down
16 changes: 8 additions & 8 deletions api/iot/v1/iot_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -883,16 +883,16 @@ type RouteRestConfig struct {

// RouteS3Config: route s3 config.
type RouteS3Config struct {
// BucketRegion: region of the S3 route's destination bucket (e.g., 'fr-par').
// BucketRegion: region of the Amazon S3 route's destination bucket (e.g., 'fr-par').
BucketRegion string `json:"bucket_region"`

// BucketName: destination bucket name of the S3 route.
// BucketName: destination bucket name of the Amazon S3 route.
BucketName string `json:"bucket_name"`

// ObjectPrefix: optional string to prefix object names with.
ObjectPrefix string `json:"object_prefix"`

// Strategy: how the S3 route's objects will be created: one per topic or one per message.
// Strategy: how the Amazon S3 route's objects will be created: one per topic or one per message.
// Default value: unknown
Strategy RouteS3ConfigS3Strategy `json:"strategy"`
}
Expand Down Expand Up @@ -1038,7 +1038,7 @@ type CreateRouteRequest struct {
// Topic: topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters.
Topic string `json:"topic"`

// S3Config: if creating S3 Route, S3-specific configuration fields.
// S3Config: if creating Amazon S3 Routes, Amazon S3-specific configuration fields.
// Precisely one of S3Config, DbConfig, RestConfig must be set.
S3Config *CreateRouteRequestS3Config `json:"s3_config,omitempty"`

Expand Down Expand Up @@ -1570,7 +1570,7 @@ type Route struct {
// CreatedAt: date at which the route was created.
CreatedAt *time.Time `json:"created_at"`

// S3Config: when using S3 Route, S3-specific configuration fields.
// S3Config: when using Amazon S3 Routes, Amazon S3-specific configuration fields.
// Precisely one of S3Config, DbConfig, RestConfig must be set.
S3Config *RouteS3Config `json:"s3_config,omitempty"`

Expand Down Expand Up @@ -1702,7 +1702,7 @@ type UpdateRouteRequest struct {
// Topic: topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters.
Topic *string `json:"topic,omitempty"`

// S3Config: when updating S3 Route, S3-specific configuration fields.
// S3Config: when updating Amazon S3 Route, Amazon S3-specific configuration fields.
// Precisely one of S3Config, DbConfig, RestConfig must be set.
S3Config *UpdateRouteRequestS3Config `json:"s3_config,omitempty"`

Expand Down Expand Up @@ -2516,8 +2516,8 @@ func (s *API) ListRoutes(req *ListRoutesRequest, opts ...scw.RequestOption) (*Li
// <b>You need to manage the database by yourself</b>.
// - REST Route.
// Create a route that will call a REST API on received subscribed MQTT messages.
// - S3 Routes.
// Create a route that will put subscribed MQTT messages into an S3 bucket.
// - Amazon S3 Routes.
// Create a route that will put subscribed MQTT messages into an Object Storage bucket.
// You need to create the bucket yourself and grant write access.
// Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket> --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
func (s *API) CreateRoute(req *CreateRouteRequest, opts ...scw.RequestOption) (*Route, error) {
Expand Down
10 changes: 5 additions & 5 deletions api/lb/v1/lb_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -1460,7 +1460,7 @@ type Backend struct {
// UpdatedAt: date at which the backend was updated.
UpdatedAt *time.Time `json:"updated_at"`

// FailoverHost: scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
// FailoverHost: scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
FailoverHost *string `json:"failover_host"`

// SslBridging: defines whether to enable SSL bridging between the Load Balancer and backend servers.
Expand Down Expand Up @@ -1960,7 +1960,7 @@ type CreateBackendRequest struct {
// Default value: proxy_protocol_unknown
ProxyProtocol ProxyProtocol `json:"proxy_protocol"`

// FailoverHost: scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
// FailoverHost: scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
FailoverHost *string `json:"failover_host,omitempty"`

// SslBridging: defines whether to enable SSL bridging between the Load Balancer and backend servers.
Expand Down Expand Up @@ -3081,7 +3081,7 @@ type UpdateBackendRequest struct {
// Default value: proxy_protocol_unknown
ProxyProtocol ProxyProtocol `json:"proxy_protocol"`

// FailoverHost: scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
// FailoverHost: scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
FailoverHost *string `json:"failover_host,omitempty"`

// SslBridging: defines whether to enable SSL bridging between the Load Balancer and backend servers.
Expand Down Expand Up @@ -3489,7 +3489,7 @@ type ZonedAPICreateBackendRequest struct {
// Default value: proxy_protocol_unknown
ProxyProtocol ProxyProtocol `json:"proxy_protocol"`

// FailoverHost: scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
// FailoverHost: scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
FailoverHost *string `json:"failover_host,omitempty"`

// SslBridging: defines whether to enable SSL bridging between the Load Balancer and backend servers.
Expand Down Expand Up @@ -4280,7 +4280,7 @@ type ZonedAPIUpdateBackendRequest struct {
// Default value: proxy_protocol_unknown
ProxyProtocol ProxyProtocol `json:"proxy_protocol"`

// FailoverHost: scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
// FailoverHost: scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
FailoverHost *string `json:"failover_host,omitempty"`

// SslBridging: defines whether to enable SSL bridging between the Load Balancer and backend servers.
Expand Down
2 changes: 1 addition & 1 deletion api/rdb/v1/rdb_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -1459,7 +1459,7 @@ type ListInstanceLogsDetailsResponseInstanceLogDetail struct {

// InstanceLog: instance log.
type InstanceLog struct {
// DownloadURL: presigned S3 URL to download your log file.
// DownloadURL: presigned Object Storage URL to download your log file.
DownloadURL *string `json:"download_url"`

// ID: UUID of the Database Instance log.
Expand Down

0 comments on commit 0f78995

Please sign in to comment.