Regex.MatchesKV (core 2.44.0 API)

java.lang.Object
- org.apache.beam.sdk.transforms.PTransform<PCollection<java.lang.String>,PCollection<KV<java.lang.String,java.lang.String>>>
- - org.apache.beam.sdk.transforms.Regex.MatchesKV

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

Regex
```
public static class Regex.MatchesKV
extends PTransform<PCollection<java.lang.String>,PCollection<KV<java.lang.String,java.lang.String>>>
```
Regex.MatchesKV<KV<String, String>> takes a PCollection<String> and returns a PCollection<KV<String, String>> representing the key and value extracted from the Regex groups of the input PCollection to the number of times that element occurs in the input.
This transform runs a Regex on the entire input line. If the entire line does not match the Regex, the line will not be output. If it does match the entire line, the groups in the Regex will be used. The key will be the key's group and the value will be the value's group.
Example of use:
```
 PCollection<String> words = ...;
 PCollection<KV<String, String>> keysAndValues =
     words.apply(Regex.matchesKV("myregex (mykeygroup) (myvaluegroup)", 1, 2));
 
```
See Also:

Serialized Form

Field Summary
- Fields inherited from class org.apache.beam.sdk.transforms.PTransform
  name, resourceHints

Constructor Summary

Constructors
Constructor Description

MatchesKV(java.util.regex.Pattern pattern, int keyGroup, int valueGroup)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PCollection<KV<java.lang.String,java.lang.String>>`	`expand(PCollection<java.lang.String> in)`	Override this method to specify how this `PTransform` should be expanded on the given `InputT`.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform
compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MatchesKV
```
public MatchesKV(java.util.regex.Pattern pattern,
                 int keyGroup,
                 int valueGroup)
```
- Method Detail
  - expand
```
public PCollection<KV<java.lang.String,java.lang.String>> expand(PCollection<java.lang.String> in)
```
    Description copied from class: PTransform
    
    Override this method to specify how this PTransform should be expanded on the given InputT.
    NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.
    Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).
    
    Specified by:
    
    expand in class PTransform<PCollection<java.lang.String>,PCollection<KV<java.lang.String,java.lang.String>>>