Skip to content

Commit

Permalink
Refreshing website content from main repo.
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Action Website Snapshot committed Dec 10, 2024
1 parent 52ef9cf commit a8d893e
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 35 deletions.
3 changes: 2 additions & 1 deletion docs/client/java/partials/java_transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,8 @@ The `CompositeTransport` is designed to combine multiple transports, allowing ev

- `type` - string, must be "composite". Required.
- `transports` - a list or a map of transport configurations. Required.
- `continueOnFailure` - boolean flag, determines if the process should continue even when one of the transports fails. Default is `false`.
- `continueOnFailure` - boolean flag, determines if the process should continue even when one of the transports fails. Default is `true`.
- `withThreadPool` - boolean flag, determines if a thread pool for parallel event emission should be kept between event emissions. Default is `true`.

#### Behavior

Expand Down
12 changes: 6 additions & 6 deletions scripts/build-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@
SPEC_DIR="$(pwd)/static/spec"
APIDOC_DIR="$(pwd)/static/apidocs"

pushd $SPEC_DIR
pushd "$SPEC_DIR" || exit
LATEST_VERSION=$(find . -maxdepth 1 | grep -v 'facets' | grep '[0-9]*-[0-9]-[0-9]' | sort -Vr | head -1)
echo latest version is $LATEST_VERSION
echo latest version is "$LATEST_VERSION"
rm ./OpenLineage.json 2>/dev/null
perl -i -pe"s/version: [[:alnum:]\.-]*/version: ${LATEST_VERSION:2}/g" ./OpenLineage.yml

mkdir "${LATEST_VERSION}/facets"
for i in $(ls -d ./facets/* | sort); do cp $i/*.json ${LATEST_VERSION}/facets; done;
for i in $(find ./facets -type d | sort); do cp "$i"/*.json "${LATEST_VERSION}/facets"; done;

pushd $LATEST_VERSION
pushd "$LATEST_VERSION" || exit
ln -sf ../OpenLineage.yml .
yarn run redoc-cli build --output "${APIDOC_DIR}/openapi/index.html" "${SPEC_DIR}/${LATEST_VERSION}/OpenLineage.yml" --title 'OpenLineage API Docs'
rm -rf facets
rm OpenLineage.yml
popd
popd || exit

popd
popd || exit
14 changes: 9 additions & 5 deletions static/apidocs/javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,7 @@ <h2 class="title" id="I:C">C</h2>
</dd>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#%3Cinit%3E()" class="member-name-link">CompositeConfig()</a> - Constructor for class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#%3Cinit%3E(java.lang.Object,boolean)" class="member-name-link">CompositeConfig(Object, boolean)</a> - Constructor for class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#%3Cinit%3E(java.lang.Object,java.lang.Boolean,java.lang.Boolean)" class="member-name-link">CompositeConfig(Object, Boolean, Boolean)</a> - Constructor for class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/metrics/CompositeMeterRegistryFactory.html" class="type-name-link" title="class in io.openlineage.client.metrics">CompositeMeterRegistryFactory</a> - Class in <a href="io/openlineage/client/metrics/package-summary.html">io.openlineage.client.metrics</a></dt>
<dd>
Expand Down Expand Up @@ -525,7 +525,7 @@ <h2 class="title" id="I:C">C</h2>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/OpenLineage.LifecycleStateChangeDatasetFacet.LifecycleStateChange.html#CREATE" class="member-name-link">CREATE</a> - Enum constant in enum class io.openlineage.client.<a href="io/openlineage/client/OpenLineage.LifecycleStateChangeDatasetFacet.LifecycleStateChange.html" title="enum class in io.openlineage.client">OpenLineage.LifecycleStateChangeDatasetFacet.LifecycleStateChange</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#createFromTransportConfigs(java.util.List,boolean)" class="member-name-link">createFromTransportConfigs(List&lt;TransportConfig&gt;, boolean)</a> - Static method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#createFromTransportConfigs(java.util.List,boolean,boolean)" class="member-name-link">createFromTransportConfigs(List&lt;TransportConfig&gt;, boolean, boolean)</a> - Static method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/circuitBreaker/CircuitBreaker.html#currentState()" class="member-name-link">currentState()</a> - Method in interface io.openlineage.client.circuitBreaker.<a href="io/openlineage/client/circuitBreaker/CircuitBreaker.html" title="interface in io.openlineage.client.circuitBreaker">CircuitBreaker</a></dt>
<dd>&nbsp;</dd>
Expand Down Expand Up @@ -1411,6 +1411,8 @@ <h2 class="title" id="I:G">G</h2>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/transports/TransportBuilder.html#getConfig()" class="member-name-link">getConfig()</a> - Method in interface io.openlineage.client.transports.<a href="io/openlineage/client/transports/TransportBuilder.html" title="interface in io.openlineage.client.transports">TransportBuilder</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#getContinueOnFailure()" class="member-name-link">getContinueOnFailure()</a> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditional.html#getCount()" class="member-name-link">getCount()</a> - Method in class io.openlineage.client.<a href="io/openlineage/client/OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditional.html" title="class in io.openlineage.client">OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditional</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/transports/FacetsConfig.html#getCustomEnvironmentVariables()" class="member-name-link">getCustomEnvironmentVariables()</a> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/FacetsConfig.html" title="class in io.openlineage.client.transports">FacetsConfig</a></dt>
Expand Down Expand Up @@ -2039,6 +2041,8 @@ <h2 class="title" id="I:G">G</h2>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/OpenLineage.SourceCodeLocationJobFacet.html#getVersion()" class="member-name-link">getVersion()</a> - Method in class io.openlineage.client.<a href="io/openlineage/client/OpenLineage.SourceCodeLocationJobFacet.html" title="class in io.openlineage.client">OpenLineage.SourceCodeLocationJobFacet</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#getWithThreadPool()" class="member-name-link">getWithThreadPool()</a> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/transports/HttpConfig.Compression.html#GZIP" class="member-name-link">GZIP</a> - Enum constant in enum class io.openlineage.client.transports.<a href="io/openlineage/client/transports/HttpConfig.Compression.html" title="enum class in io.openlineage.client.transports">HttpConfig.Compression</a></dt>
<dd>&nbsp;</dd>
</dl>
Expand Down Expand Up @@ -2201,8 +2205,6 @@ <h2 class="title" id="I:I">I</h2>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/circuitBreaker/CircuitBreakerState.html#isClosed()" class="member-name-link">isClosed()</a> - Method in class io.openlineage.client.circuitBreaker.<a href="io/openlineage/client/circuitBreaker/CircuitBreakerState.html" title="class in io.openlineage.client.circuitBreaker">CircuitBreakerState</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#isContinueOnFailure()" class="member-name-link">isContinueOnFailure()</a> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/utils/jdbc/DerbyJdbcExtractor.html#isDefinedAt(java.lang.String)" class="member-name-link">isDefinedAt(String)</a> - Method in class io.openlineage.client.utils.jdbc.<a href="io/openlineage/client/utils/jdbc/DerbyJdbcExtractor.html" title="class in io.openlineage.client.utils.jdbc">DerbyJdbcExtractor</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/utils/jdbc/GenericJdbcExtractor.html#isDefinedAt(java.lang.String)" class="member-name-link">isDefinedAt(String)</a> - Method in class io.openlineage.client.utils.jdbc.<a href="io/openlineage/client/utils/jdbc/GenericJdbcExtractor.html" title="class in io.openlineage.client.utils.jdbc">GenericJdbcExtractor</a></dt>
Expand Down Expand Up @@ -4159,7 +4161,7 @@ <h2 class="title" id="I:S">S</h2>
<dd>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
&nbsp;</dd>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#setContinueOnFailure(boolean)" class="member-name-link">setContinueOnFailure(boolean)</a> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#setContinueOnFailure(java.lang.Boolean)" class="member-name-link">setContinueOnFailure(Boolean)</a> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/utils/jdbc/JdbcLocation.html#setDatabase(java.util.Optional)" class="member-name-link">setDatabase(Optional&lt;String&gt;)</a> - Method in class io.openlineage.client.utils.jdbc.<a href="io/openlineage/client/utils/jdbc/JdbcLocation.html" title="class in io.openlineage.client.utils.jdbc">JdbcLocation</a></dt>
<dd>&nbsp;</dd>
Expand Down Expand Up @@ -4267,6 +4269,8 @@ <h2 class="title" id="I:S">S</h2>
&nbsp;</dd>
<dt><a href="io/openlineage/client/circuitBreaker/StaticCircuitBreakerConfig.html#setValuesReturned(java.lang.String)" class="member-name-link">setValuesReturned(String)</a> - Method in class io.openlineage.client.circuitBreaker.<a href="io/openlineage/client/circuitBreaker/StaticCircuitBreakerConfig.html" title="class in io.openlineage.client.circuitBreaker">StaticCircuitBreakerConfig</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/transports/CompositeConfig.html#setWithThreadPool(java.lang.Boolean)" class="member-name-link">setWithThreadPool(Boolean)</a> - Method in class io.openlineage.client.transports.<a href="io/openlineage/client/transports/CompositeConfig.html" title="class in io.openlineage.client.transports">CompositeConfig</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/circuitBreaker/SimpleMemoryCircuitBreaker.html" class="type-name-link" title="class in io.openlineage.client.circuitBreaker">SimpleMemoryCircuitBreaker</a> - Class in <a href="io/openlineage/client/circuitBreaker/package-summary.html">io.openlineage.client.circuitBreaker</a></dt>
<dd>&nbsp;</dd>
<dt><a href="io/openlineage/client/circuitBreaker/SimpleMemoryCircuitBreaker.html#%3Cinit%3E(io.openlineage.client.circuitBreaker.SimpleMemoryCircuitBreakerConfig)" class="member-name-link">SimpleMemoryCircuitBreaker(SimpleMemoryCircuitBreakerConfig)</a> - Constructor for class io.openlineage.client.circuitBreaker.<a href="io/openlineage/client/circuitBreaker/SimpleMemoryCircuitBreaker.html" title="class in io.openlineage.client.circuitBreaker">SimpleMemoryCircuitBreaker</a></dt>
Expand Down
Loading

0 comments on commit a8d893e

Please sign in to comment.