Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[yaml] remove PubSubLite from API docs #33184

Merged
merged 2 commits into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,13 @@ protected Class<PubsubLiteReadSchemaTransformConfiguration> configurationClass()
return PubsubLiteReadSchemaTransformConfiguration.class;
}

@Override
public String description() {
return "Performs a read from Google Pub/Sub Lite.\n"
+ "\n"
+ "**Note**: This provider is deprecated. See Pub/Sub Lite <a href=\"https://cloud.google.com/pubsub/lite/docs\">documentation</a> for more information.";
}

public static class ErrorFn extends DoFn<SequencedMessage, Row> {
private final SerializableFunction<byte[], Row> valueMapper;
private final Counter errorCounter;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,13 @@ protected Class<PubsubLiteWriteSchemaTransformConfiguration> configurationClass(
return PubsubLiteWriteSchemaTransformConfiguration.class;
}

@Override
public String description() {
return "Performs a write to Google Pub/Sub Lite.\n"
+ "\n"
+ "**Note**: This provider is deprecated. See Pub/Sub Lite <a href=\"https://cloud.google.com/pubsub/lite/docs\">documentation</a> for more information.";
}

public static class ErrorCounterFn extends DoFn<Row, PubSubMessage> {
private final SerializableFunction<Row, byte[]> toBytesFn;
private final Counter errorCounter;
Expand Down
10 changes: 4 additions & 6 deletions sdks/python/apache_beam/yaml/generate_yaml_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,11 +189,8 @@ def io_grouping_key(transform_name):
return 0, transform_name


SKIP = [
'Combine',
'Filter',
'MapToFields',
]
# Exclude providers
SKIP = {}


def transform_docs(transform_base, transforms, providers, extra_docs=''):
Expand Down Expand Up @@ -236,7 +233,8 @@ def main():
options = parser.parse_args()
include = re.compile(options.include).match
exclude = (
re.compile(options.exclude).match if options.exclude else lambda _: False)
re.compile(options.exclude).match
if options.exclude else lambda x: x in SKIP)

with subprocess_server.SubprocessServer.cache_subprocesses():
json_config_schemas = []
Expand Down
Loading