lostluck commented on a change in pull request #15896: URL: https://github.com/apache/beam/pull/15896#discussion_r745118726
########## File path: sdks/go/pkg/beam/util/harnessopts/cache.go ########## @@ -0,0 +1,44 @@ +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package harnessopts defines user-facing entrypoints into Beam hooks affecting +// the SDK harness, providing input validation and removing potential errors +// arising from typos in hook names. This also allows hook failures to occur earlier +// when the hook is enabled, not when the hooks are called. All harness-defined hooks +// that accept input from users should have harnessopts functions associated with them. +package harnessopts Review comment: We can probably just cut down this description to the 1st clause of the first sentence, and make the user use more obvious. ```suggestion // Package harnessopts defines user-facing entrypoints into Beam hooks // affecting the SDK harness. Call these functions at any time before // submitting your pipeline to a runner, for that pipeline's workers to be affected. package harnessopts ``` ########## File path: sdks/go/pkg/beam/util/harnessopts/cache.go ########## @@ -0,0 +1,44 @@ +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package harnessopts defines user-facing entrypoints into Beam hooks affecting +// the SDK harness, providing input validation and removing potential errors +// arising from typos in hook names. This also allows hook failures to occur earlier +// when the hook is enabled, not when the hooks are called. All harness-defined hooks +// that accept input from users should have harnessopts functions associated with them. +package harnessopts + +import ( + "fmt" + "strconv" + + "github.com/apache/beam/sdks/v2/go/pkg/beam/core/util/hooks" +) + +const ( + cacheCapacityHook = "beam:go:hook:sideinputcache:capacity" +) + +// SideInputCacheCapacity accepts a desired maximum size for the side input cache. A non-zero positive Review comment: ```suggestion // SideInputCacheCapacity accepts a desired capacity for the side input cache. A non-zero positive ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
