Skip to content

Commit

Permalink
[s3provider] Delete deprecated New function
Browse files Browse the repository at this point in the history
  • Loading branch information
atoulme committed Feb 14, 2025
1 parent 77d4e0b commit 26c9fd7
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 17 deletions.
27 changes: 27 additions & 0 deletions .chloggen/delete_deprecated_new_function.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: breaking

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: s3provider

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Delete deprecated `New` factory function. Use `NewFactory` instead.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [37921]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [api]
17 changes: 0 additions & 17 deletions confmap/provider/s3provider/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,6 @@ func newWithSettings(_ confmap.ProviderSettings) confmap.Provider {
return &provider{client: nil}
}

// New returns a new confmap.Provider that reads the configuration from a file.
//
// This Provider supports "s3" scheme, and can be called with a "uri" that follows:
//
// s3-uri : s3://[BUCKET].s3.[REGION].amazonaws.com/[KEY]
//
// One example for s3-uri be like: s3://doc-example-bucket.s3.us-west-2.amazonaws.com/photos/puppy.jpg
// References: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
//
// Examples:
// `s3://DOC-EXAMPLE-BUCKET.s3.us-west-2.amazonaws.com/photos/puppy.jpg` - (unix, windows)
//
// Deprecated: [v0.100.0] Use NewFactory() instead.
func New() confmap.Provider {
return &provider{client: nil}
}

func (fmp *provider) Retrieve(ctx context.Context, uri string, _ confmap.WatcherFunc) (*confmap.Retrieved, error) {
if !strings.HasPrefix(uri, schemeName+":") {
return nil, fmt.Errorf("%q uri is not supported by %q provider", uri, schemeName)
Expand Down

0 comments on commit 26c9fd7

Please sign in to comment.