rezarokni commented on a change in pull request #12645: URL: https://github.com/apache/beam/pull/12645#discussion_r487927710
########## File path: sdks/java/io/contextual-text-io/src/main/java/org/apache/beam/sdk/io/contextualtextio/RecordWithMetadata.java ########## @@ -0,0 +1,84 @@ +/* + * 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 org.apache.beam.sdk.io.contextualtextio; + +import com.google.auto.value.AutoValue; +import org.apache.beam.sdk.annotations.Experimental; +import org.apache.beam.sdk.schemas.AutoValueSchema; +import org.apache.beam.sdk.schemas.annotations.DefaultSchema; + +/** + * Helper Class based on {@link AutoValueSchema}, it provides Metadata associated with each Record + * when reading from file(s) using {@link ContextualTextIO}. + * + * <h3>Fields:</h3> + * + * <ul> + * <li>recordOffset: The offset of a record (the byte at which the record begins) in a file. This + * information can be useful if you wish to reconstruct the file. {@link + * RecordWithMetadata#getRecordOffset()} + * <li>recordNum: The ordinal number of the record in its file. {@link + * RecordWithMetadata#getRecordNum()} + * <li>recordValue: The value / contents of the record {@link RecordWithMetadata#getRecordValue()} + * <li>rangeOffset: The starting offset of the range (split), which contained the record, when the + * record was read. {@link RecordWithMetadata#getRangeOffset()} + * <li>recordNumInOffset: The record number relative to the Range. (line number within the range) + * {@link RecordWithMetadata#getRecordNumInOffset()} + * <li>fileName: Name of the file to which the record belongs (this is the full filename, + * eg:path/to/file.txt) {@link RecordWithMetadata#getFileName()} + * </ul> + */ +@Experimental(Experimental.Kind.SCHEMAS) +@DefaultSchema(AutoValueSchema.class) +@AutoValue +public abstract class RecordWithMetadata { Review comment: @lukecwik This class is a Schema class, looking into this we cant make it generic, until schemas supports generics. But for ContextualTextIO we would be setting it to ContextualTextIO<String> anyway ... So while it will be useful in the future, I am not sure it adds much for now? WDYT? ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
